API Reference
Comprehensive guide to all available APIs in the platform
API Reference
Comprehensive guide to all available APIs in the platform
API Reference Comprehensive and professional reference for all Application Programming Interfaces (APIs) available in th...
API Versioning
Understanding API versioning and migration guides
API Versioning Learn about our API versioning strategy and how to migrate between versions. --- Version Strategy We use ...
Authentication
Comprehensive guide for API authentication and required headers
Authentication All API requests require specific HTTP headers for authentication and security. Authentication Topics Req...
Branches
Comprehensive API for managing business branches in the system
Branches Comprehensive management of multiple business branches with support for organization and classification. Overvi...
Contact Groups
Comprehensive API for managing contact groups and organizing contacts
Contact Groups Comprehensive management of contact groups to efficiently organize contacts. Contact Group Operations Lis...
Contacts
Comprehensive API for managing contacts in the system
Contacts Comprehensive contact management with organization and classification support. Contact Operations List Contacts...
Conversations
Comprehensive API for managing conversations and messages in the system
Conversations Comprehensive conversation management with filtering and search support. Conversation Operations List Conv...
Error Handling
Comprehensive guide to API error codes and handling
Error Handling Complete reference for API error codes and how to handle them effectively. --- Error Response Format All ...
Invoices
API for sending invoices via WhatsApp
Invoices Comprehensive API for sending invoices via WhatsApp with PDF attachment support. --- Send Invoice via WhatsApp ...
Messages
Comprehensive API for sending all types of WhatsApp messages
Messages Powerful and comprehensive API for sending all types of WhatsApp messages: text, buttons, lists, media, locatio...
Orders
Comprehensive API for managing and tracking orders in the system
Orders Comprehensive order management with filtering and tracking support. Order Operations List Orders View all orders ...
Rate Limiting
Understanding API rate limits and best practices
Rate Limiting Learn about API rate limits and how to handle them effectively. --- Overview Rate limiting protects our AP...
SDKs & Code Examples
Official SDKs and code examples for popular programming languages
SDKs & Code Examples Official SDKs and code examples to help you integrate AwalChat API quickly. --- Official SDKs JavaS...
Templates
API for viewing and managing approved WhatsApp templates
Templates View and manage approved WhatsApp templates from Meta. --- Get Templates List View all available WhatsApp temp...
Tickets
API for managing support tickets linked to conversations
Tickets Manage support tickets linked to conversations. --- Open Ticket Open a new support ticket linked to a conversati...
WABA Numbers
API for viewing and managing linked WhatsApp Business numbers
WABA Numbers View and manage WhatsApp Business numbers linked to your account. --- Get WABA Numbers List View all connec...
Webhooks
Complete guide to webhook events and handling
Webhooks Receive real-time notifications about events in your WhatsApp Business account via webhooks. --- Overview Webho...
List Branches
Display all branches with search and pagination support
List Branches Display all branches with search and pagination support. Query Parameters Example Request Example Response...
List Contact Groups
Display all contact groups with search and pagination support
List Contact Groups Display all contact groups with search and pagination support. Query Parameters Example Request Exam...
List Contacts
View all contacts with search and pagination support
List Contacts View all contacts with search and pagination support. Query Parameters Example Request Example Response --...
List Conversations
View all conversations with filtering by status
List Conversations View all conversations with filtering by status. Query Parameters Example Request Example Response --...
List Orders
View all orders with filtering by status and date
List Orders View all orders with filtering support by status and date. Query Parameters Example Request Example Response...
Required Headers
All HTTP headers required for API requests
Required Headers Every API request must include the following headers: Complete Request Example --- Related ← Back to Au...
Send Text Message
Send simple text messages to your customers
Send Text Message The simplest way to send a text message to your customers. Query Parameters Request Body (JSON) Exampl...
Create Branch
Add a new branch with all details
Create New Branch Add a new branch with all details. Query Parameters Request Body (form-data) Example Request Example R...
Create Contact
Add a new contact with all details
Create Contact Add a new contact with all details. Query Parameters Request Body (form-data) Example Request Example Res...
Create Contact Group
Create a new group to organize contacts
Create Contact Group Create a new group to organize contacts. Request Body (JSON) Example Request Example Response --- R...
Generate HMAC Signature
Step-by-step guide to generate HMAC signatures
Generate HMAC Signature Steps 1. Create the string to sign Combine the following elements in this order: `` METHOD + PAT...
Get Conversation Messages
View all messages of a specific conversation
Get Conversation Messages View all messages of a specific conversation. Path Parameters Query Parameters Example Request...
Get Order
View details of a specific order
Get Order View details of a specific order with all information. Path Parameters Example Request Example Response --- Re...
Send Button Message
Send interactive messages with quick response buttons
Send Button Message Send interactive messages with buttons for quick responses. Query Parameters Request Body (JSON) But...
Get Message Status
Track status of sent messages
Get Message Status Track status of sent messages. Query Parameters Example Request Example Response --- Related ← Back t...
Send List Message
Send organized lists with multiple options
Send List Message Send organized lists with multiple options. Query Parameters Request Body (JSON) Section Specification...
Timestamp
Understanding and generating timestamps
Timestamp Important Details - Format: Unix timestamp in seconds (not milliseconds) - Validity: Must be within a specifie...
Update Branch
Modify an existing branch's data
Update Branch Modify an existing branch's data. Path Parameters Request Body (form-data) Same parameters as creation. Al...
Update Contact
Modify an existing contact's data
Update Contact Modify an existing contact's data. Path Parameters Request Body (form-data) All fields are optional - onl...
Update Contact Group
Modify an existing group's data
Update Contact Group Modify an existing group's data. Path Parameters Request Body (JSON) Example Request Example Respon...
Update Order
Update order status and information
Update Order Update order status and information. Path Parameters Query Parameters Request Body (JSON) Example Request E...
Common Authentication Errors
Troubleshooting authentication errors
Common Authentication Errors 401 Unauthorized Cause: Invalid or missing signature Solutions: - Verify HMAC calculation i...
Delete Branch
Permanently delete a branch from the system
Delete Branch Permanently delete a branch from the system. Path Parameters Example Request Example Response --- Error Co...
Delete Contact
Permanently delete a contact from the system
Delete Contact Permanently delete a contact from the system. Path Parameters Example Request Example Response --- Relate...
Delete Contact Group
Delete a contact group from the system
Delete Contact Group Delete a contact group from the system. Path Parameters Example Request Example Response --- Relate...
Send CTA URL Message
Send messages with external link buttons
Send CTA URL Message Send messages with external link buttons. Query Parameters Request Body (JSON) Example Request --- ...
Security Notes
Important security considerations
Security Notes --- Related ← Back to Authentication...
Send Media Message
Send images, videos, files, and audio clips
Send Media Message Send images, videos, files, and audio clips. Query Parameters Method 1: Send via URL Method 2: Upload...
Best Practices
Recommended practices for secure authentication
Best Practices 1. Secure Storage 2. Error Handling 3. Caching --- Related ← Back to Authentication...
Send Location Message
Share precise geographic locations
Send Location Message Share geographic location with precise coordinates. Query Parameters Request Body (JSON) Location ...
Send Template Message
Send approved WhatsApp templates with dynamic parameters
Send Template Message Send approved WhatsApp templates with dynamic parameters. Content-Type: multipart/form-data Query ...
Mark Message as Read
Update message status to "read"
Mark Message as Read Update message status to "read". Path Parameters Query Parameters Request Body (JSON) Example Reque...