Send SMS Universal
POST/message-server/sms/send
Send an SMS message to the specified recipient.
Supports:
- Placeholders — Insert
{name}in the body and populate theplaceholdersmap - Concatenation — Long messages are automatically split into parts (multipart SMS)
- UDH — Custom User Data Header data for binary SMS
- Scheduling — Set
scheduledDatefor deferred sending - Dry run — Set
simulation: trueto validate the request without sending
A request that passes validation is answered 202, also when the message is rejected: check results.sms.accepted and, if it is false, results.sms.reasons.
Request
Responses
- 202
- 400
- 401
- 500
- 511
Request accepted. Check results.sms.accepted to verify whether the message was accepted.
Note: accepted: true means the message was accepted for sending, not that it was delivered. Delivery confirmation arrives via webhook. reasons is present only when the message is rejected.
Invalid request. Fields that fail validation are listed in data, one list of messages per invalid object; a body that cannot be read, for example a scheduledDate in another format, gives data: "Invalid request body".
Missing or invalid credentials. The body is empty.
Unexpected error while handling the message
The calling IP address is outside the IP ranges configured for your account