مرجع API

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 ...

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 for sending invoices via WhatsApp

Invoices Comprehensive API for sending invoices via WhatsApp with PDF attachment support. --- Send Invoice via WhatsApp ...

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...

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...

API for viewing and managing approved WhatsApp templates

Templates View and manage approved WhatsApp templates from Meta. --- Get Templates List <ApiEndpoint method="GET" endpoi...

API for managing support tickets linked to conversations

Tickets Manage support tickets linked to conversations. --- Open Ticket <ApiEndpoint method="POST" endpoint="/wechat/cha...

Understanding API versioning and migration guides

API Versioning Learn about our API versioning strategy and how to migrate between versions. --- Version Strategy We use ...

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 <ApiEndpoint me...

Complete guide to webhook events and handling

Webhooks Receive real-time notifications about events in your WhatsApp Business account via webhooks. --- Overview Webho...

Add a new branch with all details

Create New Branch Add a new branch with all details. <ApiEndpoint method="POST" endpoint="/branches"> </ApiEndpoint> Que...

Permanently delete a branch from the system

Delete Branch Permanently delete a branch from the system. <ApiEndpoint method="DELETE" endpoint="/branches/{id}"> </Api...

Comprehensive API for managing business branches in the system

Branches Comprehensive management of multiple business branches with support for organization and classification. Overvi...

Display all branches with search and pagination support

List Branches Display all branches with search and pagination support. <ApiEndpoint method="GET" endpoint="/branches"> <...

Modify an existing branch's data

Update Branch Modify an existing branch's data. <ApiEndpoint method="PATCH" endpoint="/branches/{id}"> </ApiEndpoint> Pa...

Recommended practices for secure authentication

Best Practices 1. Secure Storage <CodeBlock code={// ✅ Correct - use environment variables const hmacSecret = process....

Troubleshooting authentication errors

Common Authentication Errors 401 Unauthorized Cause: Invalid or missing signature Solutions: - Verify HMAC calculation i...

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...

Comprehensive guide for API authentication and required headers

Authentication All API requests require specific HTTP headers for authentication and security. Authentication Topics <di...

All HTTP headers required for API requests

Required Headers Every API request must include the following headers: <ParamsTable params={[ { name: "Accep...

Important security considerations

Security Notes <Callout type="error"> 🔒 Critical Security Never share hmacSecret: - Store it in environment variables (...

Understanding and generating timestamps

Timestamp <Callout type="info"> The timestamp must be in Unix timestamp format (in seconds) and recent (usually within 5...

Create a new group to organize contacts

Create Contact Group Create a new group to organize contacts. <ApiEndpoint method="POST" endpoint="/contact-groups"> </A...

Delete a contact group from the system

Delete Contact Group Delete a contact group from the system. <ApiEndpoint method="DELETE" endpoint="/contact-groups/{id}...

Comprehensive API for managing contact groups and organizing contacts

Contact Groups Comprehensive management of contact groups to efficiently organize contacts. Contact Group Operations <di...

Display all contact groups with search and pagination support

List Contact Groups Display all contact groups with search and pagination support. <ApiEndpoint method="GET" endpoint="/...

Modify an existing group's data

Update Contact Group Modify an existing group's data. <ApiEndpoint method="PATCH" endpoint="/contact-groups/{id}"> </Api...

Add a new contact with all details

Create Contact Add a new contact with all details. <ApiEndpoint method="POST" endpoint="/contacts"> </ApiEndpoint> Query...

Permanently delete a contact from the system

Delete Contact Permanently delete a contact from the system. <ApiEndpoint method="DELETE" endpoint="/contacts/{id}"> </A...

Comprehensive API for managing contacts in the system

Contacts Comprehensive contact management with organization and classification support. Contact Operations <div classNam...

View all contacts with search and pagination support

List Contacts View all contacts with search and pagination support. <ApiEndpoint method="GET" endpoint="/contacts"> </Ap...

Modify an existing contact's data

Update Contact Modify an existing contact's data. <ApiEndpoint method="PATCH" endpoint="/contacts/{id}"> </ApiEndpoint> ...

View all messages of a specific conversation

Get Conversation Messages View all messages of a specific conversation. <ApiEndpoint method="GET" endpoint="/conversatio...

Track status of sent messages

Get Message Status Track status of sent messages. <ApiEndpoint method="GET" endpoint="/fetch-message-status-app"> </ApiE...

Comprehensive API for managing conversations and messages in the system

Conversations Comprehensive conversation management with filtering and search support. Conversation Operations <div clas...

View all conversations with filtering by status

List Conversations View all conversations with filtering by status. <ApiEndpoint method="GET" endpoint="/conversations">...

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...

Update message status to "read"

Mark Message as Read Update message status to "read". <ApiEndpoint method="PUT" endpoint="/w/messages/{id}"> </ApiEndpoi...

Send interactive messages with quick response buttons

Send Button Message Send interactive messages with buttons for quick responses. <ApiEndpoint method="POST" endpoint="/w/...

Send messages with external link buttons

Send CTA URL Message Send messages with external link buttons. <ApiEndpoint method="POST" endpoint="/w/message/cta_url">...

Send organized lists with multiple options

Send List Message Send organized lists with multiple options. <ApiEndpoint method="POST" endpoint="/w/message/list"> </A...

Share precise geographic locations

Send Location Message Share geographic location with precise coordinates. <ApiEndpoint method="POST" endpoint="/w/messag...

Send images, videos, files, and audio clips

Send Media Message Send images, videos, files, and audio clips. <ApiEndpoint method="POST" endpoint="/w/message/media"> ...

Send approved WhatsApp templates with dynamic parameters

Send Template Message Send approved WhatsApp templates with dynamic parameters. <ApiEndpoint method="POST" endpoint="/w/...

Send simple text messages to your customers

Send Text Message The simplest way to send a text message to your customers. <ApiEndpoint method="POST" endpoint="/w/mes...

View details of a specific order

Get Order View details of a specific order with all information. <ApiEndpoint method="GET" endpoint="/orders/{id}"> </Ap...

Comprehensive API for managing and tracking orders in the system

Orders Comprehensive order management with filtering and tracking support. Order Operations <div className="grid sm:grid...

View all orders with filtering by status and date

List Orders View all orders with filtering support by status and date. <ApiEndpoint method="GET" endpoint="/orders"> </A...

Update order status and information

Update Order Update order status and information. <ApiEndpoint method="PUT" endpoint="/orders/{id}"> </ApiEndpoint> Path...