Appearance
API Endpoints
Send Message
POST https://domain.com/api/v5/?action=send
Send WhatsApp messages to individual recipients.
Parameters
Parameter | Type | Required | Description |
---|---|---|---|
senderId | string | Yes | Your WhatsApp sender number |
authToken | string | Yes | Your authentication token |
messageText | string | Yes | The message content |
receiverId | string | Yes | Recipient's WhatsApp number |
mediaurl | string | No | URL of media to attach |
uploadFile | file | No | File to upload (Form Data only) |
Response
json
{
"status": "success",
"message": "Message sent successfully",
"messageId": "msg_123456789"
}
Error Codes
Code | Description |
---|---|
AUTH_ERROR | Invalid or expired auth token |
INVALID_SENDER | Invalid sender ID |
INVALID_RECEIVER | Invalid receiver ID |
MESSAGE_FAILED | Message failed to send |
Get Message Status
GET https://domain.com/api/v5/?action=status
Check the delivery status of a sent message.
Parameters
Parameter | Type | Required | Description |
---|---|---|---|
messageId | string | Yes | ID of the sent message |
authToken | string | Yes | Your authentication token |
Response
json
{
"status": "success",
"messageStatus": "delivered",
"deliveredAt": "2024-01-20T10:30:00Z"
}
Get Account Balance
GET https://domain.com/api/v5/?action=balance
Check your remaining API credits.
Parameters
Parameter | Type | Required | Description |
---|---|---|---|
authToken | string | Yes | Your authentication token |
Response
json
{
"status": "success",
"balance": 5000,
"plan": "standard"
}
Error Handling
All endpoints follow the same error response format:
json
{
"status": "error",
"code": "ERROR_CODE",
"message": "Human readable error message"
}
Common error codes:
AUTH_ERROR
: Authentication failedRATE_LIMIT
: Too many requestsINVALID_PARAMS
: Missing or invalid parametersSERVER_ERROR
: Internal server error