Skip to main content

Generic API format

Request Headers

  • certification-code: af92196e-0d07-3c1d-a631-a71c...(Unique credential)

Response

Field name type Required Description
status string Yes Response status description
code int Yes Error Codes
message string Yes Error message
data object Yes Response payload
error object Yes Error details

Success Response Example

{
    "status": "success",
    "code": 200,
    "message": "",
    "data": {
        "msg_id": "wamid.HBgLODUyNjg0MTUwMjYVAgARGBIyMUQ4RjA5MTY1NUJERjE3NjYA"
    },
    "error": {}
}

Failure Response Example

{
    "status": "error",
    "code": 422,
    "message": "The phone number is invalid.",
    "data": {},
    "error": {
        "to": [
            "The phone number is invalid."
        ]
    }
}

Error Codes

Error Code Error Explanation
200 No error
404 Not found
422 Request parameter error
429 Too many attempts
500 Server error
10001 Certification code is invalid
10002 WhatsApp API error
10003 Viber API error
10004 RCS API error