Error List

The API returns the following HTTP status codes when it is unable to fulfill a request:

401 – Unauthorized - authentication error (e.g., invalid API Key)
400 – Bad Request - invalid parameterization or violation of a business rule that prevents fulfilling the request

Error Object

In certain error scenarios, the response body will contain an object with details about the occurred error:

{
    code: "",
    param: "",
    description: ""
}

The meaning of the fields is as follows:

code - error code;
param - name of the parameter that caused the error (if applicable);
description - textual description of the error.

Error Codes

The following error codes may be returned:

General

Code	Description
`PARAM_INVALID`	Invalid parameter value (parameter name specified in the `param` field).
`FEATURE_IS_DISABLED`	Feature not enabled for organization.
`PARAM_EXCEEDS_MAX_LENGTH`	Parameter value exceeds maximum length (parameter name specified in the `param` field).
`PAYLOAD_EXCEEDS_MAX_SIZE`	Request payload exceeds maximum size.
`INVALID_URL`	Invalid URL
`GENERIC_ERROR`	Generic error. Contact the support team

Audience

Code	Description
`INCOMPLETE_KEY_COLUMN_MAPPING`	Not all required key fields found in the provided object.
`INVALID_KEY_CONFIGURATION`	Invalid key field value.
`SCHEMA_MISMATCH`	Incompatible schema.
`AUDIENCE_SCHEMA_NOT_FOUND`	Organization schema not found.
`RECIPIENT_ALREADY_EXISTS`	Contact already exists.
`MAX_PLAN_RECIPIENT_COUNT_REACHED`	Maximum number of allowed audience contacts for the plan reached.

Send Email

Code	Description
`FROM_NOT_ALLOWED`	Email sender not authorized. Refer to the domain configuration section.
`NO_CONTENT_DEFINED`	No content defined for sending in the `TextContent` or `HtmlContent` fields.
`EMAIL_ATTACHMENTS_NOT_ALLOWED`	Email attachment sending not allowed.
`ATTACHMENT_PARAM_EMPTY`	Attachment parameter is empty.
`ATTACHMENT_PARAM_TOO_LONG`	Attachment parameter exceeds maximum size.
`ATTACHMENT_PARAM_INVALID`	Invalid attachment parameter.
`INVALID_WEBHOOK_URL`	Invalid webhook URL.
`INSUFFICIENT_BALANCE`	Organization does not have enough balance to send the message
`TOO_MANY_RECIPIENTS`	Too many recipients have been configured on the `To`, `CC`, `BCC` properties - there is a cumulative limit of 50 recipients for each individual Email message

Send SMS

Code	Description
`FROM_NOT_ALLOWED`	SMS sender not authorized. Refer to the domain configuration section.
`MOBILE_OPERATOR_NOT_FOUND`	Mobile operator not found.
`INVALID_WEBHOOK_URL`	Invalid webhook URL.
`INSUFFICIENT_BALANCE`	Organization does not have enough balance to send the message
`WEBHOOK_CUSTOM_PAYLOAD_EXCEEDS_MAX_LENGTH`	Content of the `CustomPayload` field exceeds the maximum size of 1KB

Send RCS

Code	Description
`INVALID_REQUEST`	The request is malformed or contains invalid properties.
`ORGANIZATION_NOT_FOUND`	The specified organization does not exist or is not accessible to the authenticated user.
`RCS_CHANNEL_NOT_ENABLED`	The RCS channel is not enabled for the organization.
`INVALID_RECIPIENT`	The recipient number is missing or invalid.
`INVALID_SENDER`	The specified sender is missing, invalid or not configured for the organization.
`INVALID_EXPIRATION_DATE`	The expiration date is invalid or has already passed.
`EMPTY_MESSAGES`	The `messages` array does not contain any elements.
`MAX_MESSAGES_EXCEEDED`	The request contains more than 10 messages.
`INVALID_CONTENT`	The RCS content does not satisfy the applicable validation rules.
`MULTIPLE_CONTENT_TYPES`	More than one primary RCS content type was provided.
`TEXT_LENGTH_EXCEEDED`	The text contains more than 3,072 characters.
`MESSAGE_SIZE_EXCEEDED`	A message exceeds the maximum size of 250 KB.
`MAX_SUGGESTIONS_EXCEEDED`	The applicable suggestion limit was exceeded.
`INVALID_SUGGESTION`	A suggestion is incomplete or contains invalid properties.
`INVALID_MEDIA_URL`	A media or thumbnail URL is invalid.
`MEDIA_NOT_ACCESSIBLE`	The media resource could not be accessed.
`UNSUPPORTED_MEDIA_TYPE`	The declared MIME type is not supported.
`INVALID_RICH_CARD`	The rich card does not contain valid content.
`INVALID_CAROUSEL`	The carousel contains an invalid number of cards or invalid card content.
`INSUFFICIENT_BALANCE`	The organization does not have sufficient RCS balance.
`RATE_LIMIT_EXCEEDED`	The applicable request rate limit was exceeded.
`INTERNAL_ERROR`	An unexpected internal error occurred.

Check Balance

Code	Description
`ORGANIZATION_ID_EMPTY`	Organization identifier not specified
`ORGANIZATION_BALANCE_CONFIG_NOT_FOUND`	Invalid balance configuration. If the issue persists, please contact the support team.

Transfer Email Balance

Code	Description
`SOURCE_ORGANIZATION_ID_EMPTY`	Source organization identifier not specified
`DESTINATION_ORGANIZATION_ID_EMPTY`	Destination organization identifier not specified
`BALANCE_TRANSFER_FAILED`	The balance transfer could not be completed. If the issue persists, please contact the support team.

Transfer SMS Balance

Code	Description
`SOURCE_ORGANIZATION_ID_EMPTY`	Source organization identifier not specified
`DESTINATION_ORGANIZATION_ID_EMPTY`	Destination organization identifier not specified
`COUNTRY_ID_EMPTY`	Country code not specified
`INVALID_COUNTRY_ID`	Invalid country code. This code must follow the ISO 3166-1 alpha-2 standard
`BALANCE_TRANSFER_FAILED`	The balance transfer could not be completed. If the issue persists, please contact the support team.

Error List

Error Object​

Error Codes​

General​

Audience​

Send Email​

Send SMS​

Send RCS​

Check Balance​

Transfer Email Balance​

Transfer SMS Balance​