API Error Handling

Handle Waplix API errors gracefully inside your application code.

Error Payload Structure

Unsuccessful requests return a standard JSON body with a success: false property:

{
  "success": false,
  "message": "Invalid phone number format",
  "data": null,
  "error": {
    "code": "INVALID_PHONE_NUMBER",
    "message": "The recipient number must include country code and contain only digits."
  }
}
      

Key Error Codes

• UNAUTHORIZED: Invalid or missing API key in the request header.
• INSTANCE_DISCONNECTED: The instance must be scanned and connected before sending.
• FEATURE_NOT_SUPPORTED: The operation is not supported by the current instance engine.