Skip to content

API

Response formats

Unified response style: JSON with success and message.

Quick Answer

Parse JSON: success (bool) and message (string) are the required signals.

Summary

Success and error responses include a clear message; always check success.

Key Takeaways

  • Do not ignore success on HTTP 200.
  • expires_in and short_url are optional.
  • See examples and errors.

Successful send

{
  "success": true,
  "message": "OTP sent via WhatsApp",
  "expires_in": 300
}

Successful verify

{
  "success": true,
  "message": "Number confirmed"
}

Error

{
  "success": false,
  "message": "Insufficient broadcast tokens. Top up your balance."
}

Laravel validation responses may include an errors object — handle it alongside message.

See errors, statuses, documentation, blog.