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: Read

Operation gets the message details.

URL /v1/messages/{id}
Method Type GET
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

-empty-

Response Parameters

Name Type Description Status
id string Unique identifier of the message Optional
account_id string Unique identifier of the account Optional
from string Identifier of the sender Optional
to string List of recipients who will receive the message Optional
channel string Delivery channel of the massage.
Possible values:
•SMS
•VIBER
•WHATSAPP
Optional
status string Delivery status of the message.
Possible values:
• scheduled
• enroute
• sent
• received
• delivered
• failed
Optional
text string Body of the message Optional
image string Optional
caption string Optional
button object

Details

(see button object below)
Optional
schedule string Optional
template_id string Optional
create_date string Creation date of the message in UTC, formatted as yyyyMM-dd HH:mm:ss Optional
update_date string Update date of the message in UTC, formatted as yyyy-MM-dd HH:mm:ss Optional
segments integer The count of message parts Optional
encoding string Encoding of the message. Possible values:
• GSM-7 • UCS-2
Optional
sender object

Details

(see sender object below)
Optional
direction string Optional
source string Optional
country string Optional
links object

Details

(see links object below)
Optional
button object
Name Type Description Status
caption string caption description Optional
url string example description Optional
sender object
Name Type Description Status
id string Optional
name string Optional
links object
Name Type Description Status
self string URL of the message Optional
account string URL of the account Optional
template string URL of the template Optional

Example of request body

GET: /v1/messages/48e200b7-be98-4360-b5c7-5dfac16b06f9
X-Dexatel-Key: 94d2f2f2884848bca861264ad86d8ace

Example of response body

status - 200

                
                        

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
1521 'data.schedule' is invalid
1522 'data.schedule' should be after current date
1523 Invalid recipient number(s)