Skip to content

API Endpoints

Send Message

POST https://domain.com/api/v5/?action=send

Send WhatsApp messages to individual recipients.

Parameters

ParameterTypeRequiredDescription
senderIdstringYesYour WhatsApp sender number
authTokenstringYesYour authentication token
messageTextstringYesThe message content
receiverIdstringYesRecipient's WhatsApp number
mediaurlstringNoURL of media to attach
uploadFilefileNoFile to upload (Form Data only)

Response

json
{
    "status": "success",
    "message": "Message sent successfully",
    "messageId": "msg_123456789"
}

Error Codes

CodeDescription
AUTH_ERRORInvalid or expired auth token
INVALID_SENDERInvalid sender ID
INVALID_RECEIVERInvalid receiver ID
MESSAGE_FAILEDMessage failed to send

Get Message Status

GET https://domain.com/api/v5/?action=status

Check the delivery status of a sent message.

Parameters

ParameterTypeRequiredDescription
messageIdstringYesID of the sent message
authTokenstringYesYour 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

ParameterTypeRequiredDescription
authTokenstringYesYour 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 failed
  • RATE_LIMIT: Too many requests
  • INVALID_PARAMS: Missing or invalid parameters
  • SERVER_ERROR: Internal server error

Released under the MIT License.