Getting started
Errors
Status codes, error codes and the error body.
Errors use standard HTTP status codes and a JSON body:
Error body
{
"errCode": "MISSING_SCOPE",
"errMsg": {
"success": false,
"message": "Missing required scope: messages:send",
"required_scope": "messages:send",
"granted_scopes": ["chats:read", "groups:read"]
}
}| Status | errCode | When |
|---|---|---|
| 400 | Missing or invalid parameter. The message says which. | |
| 401 | Key missing, unknown, revoked or expired. | |
| 402 | BILLING_ACCESS_DENIED | The organization's subscription is inactive. Only sending is blocked. |
| 403 | ROUTE_NOT_PUBLIC | The route exists but is not available to API keys. |
| 403 | MISSING_SCOPE | The key lacks the scope this route needs. |
| 403 | INTEGRATION_NOT_ALLOWED | integration_id is outside the numbers the key is restricted to. |
| 403 | INTEGRATION_ID_REQUIRED | The key is restricted to several numbers and none was given. |
| 404 | The resource does not exist in your organization. | |
| 429 | TooManyRequests | Rate limit exceeded. See the Retry-After header. |
| 5xx | Something failed on our side. Safe to retry reads; check the inbox before retrying a send. |