Messages
Message endpoints are meant to send and monitor messages sent by the account. Message is a single one to one conversation entity.
A single SMS can contain 160 characters. If the message contains any characters not listed in the 7-bit alphabet, then the message encoding will be set to UCS-2. The message length is limited to 70 characters. Additionally, for long SMS messages exceeding above-mentioned limits, will be supported by splitting them into multiple segments. For WhatsApp and Viber messages the maximum limit of characters is 1024 and 1000 for any character set correspondingly.
Method: Create
Operation sends a message from a sender to one or many recipients.
| URL | /v1/messages |
| Method Type | POST |
| Authorization | API Key |
| Request Content-Type | JSON |
| Response Content-Type | JSON |
Headers
| Name | Type | Description | Status |
|---|---|---|---|
| X-Dexatel-Key | string | API key | Required |
Request Body
| Name | Type | Description | Status |
|---|---|---|---|
| data | object |
Details (see data object below) |
Required |
| Name | Type | Description |
|---|---|---|
| from | string | Identifier of the sender |
| to | array | List of recipients who will receive the message |
| text | string | Body of the message |
| channel | string |
Delivery channel of the massage. Possible values: SMS VIBER |
| image | string | URL of the image to be sent in the massage |
| caption | string | Caption for image |
| template | string | Identifier of the template O |
| variables | array | List of the template values |
| button | object |
Details (see button object below) |
| Name | Type | Description |
|---|---|---|
| caption | string | caption description |
| url | string | example description |
Response Parameters
| Name | Type | Description |
|---|---|---|
| data | array |
Details (see data object below) |
| Name | Type | Description |
|---|---|---|
| id | string | Unique identifier of the object |
| account_id | string | Unique identifier of the account |
| text | string | Body of the message |
| from | string | Identifier of the sender |
| to | string | List of recipients who will receive the message, can be up to 10 recipients. |
| channel | string |
Delivery channel of the massage. Possible values: SMS VIBER |
| status | string | Initial status of the message |
| segments_count | integer | The count of sent messages |
| encoding | string |
Encoding of the message. Possible values: • GSM -7 • UCS -2 |
Example of request body
Example of response body
Error Codes
The following error codes are returned in response to a user’s request which contains bad syntax or cannot be fulfilled.
| Code | Description |
|---|---|
| 1501 | Message is not found |
| 1502 | Invalid message identifier |
| 1503 | 'data.from' is required |
| 1504 | 'data.from' is invalid |
| 1505 | Message sender is not found |
| 1506 | 'data.to' is required |
| 1507 | 'data.to' must be at most [10] items in length |
| 1508 | 'data.text' is required |
| 1509 | 'data.text' is invalid |
| 1510 | 'data.text' is too long |
| 1512 | 'data.template' is invalid |
| 1513 | Template is not found |
| 1514 | 'data.variables' is required |
| 1515 | 'data.channel' should be in: [SMS, WHATSAPP, VIBER] |
| 1516 | One of text, image or template should be specified |
| 1517 | Button messages are not supported for whatsapp channel |
| 1518 | Image messages are not supported for sms channel |
| 1519 | Button messages are not supported for sms channel |
| 1520 | 'data.button' is required |
| 1523 | Invalid recipient number(s) |