...
Please note that, when creating a new text message, any referenced tag must be created in advance for that list.
Known limitations:
- Any text between square brackets must match with the name of a dynamic field that is available for that account
- In some countries, like Italy, some restrictions on SMS senders apply. Use MailUp admin console to verify if the specified sender is subject to limitations in some countries
- MailUp REST API applies, on alphanumeric senders, looser format restrictions than the admin console. While admin console allows only letters and numbers, API also allow spaces, puntuaction and other special characters. Please consider that letters and numbers are supported by any carrier, while other characters may be replaced in some cases. It is recommended that you perform some tests before using a sender with spaces, puntuaction or special characters
- In case of empty Sender the default list settings are not applied, a random numeric sender is used instead
Description | Create a new text message | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
HTTP Method | POST | ||||||||||||||||||||||||||||||||
URL |
| ||||||||||||||||||||||||||||||||
Reference |
| ||||||||||||||||||||||||||||||||
JSON request (example) |
| ||||||||||||||||||||||||||||||||
JSON response (example) |
| ||||||||||||||||||||||||||||||||
Paging and filtering (example) |
|
...
- scheduled date and time cannot be modified
- at the moment there is no way to move from immediate/scheduled queues to "waiting to be sent" queue
- you can move to "immediate send" queue but you cannot start immediate sending using API
- when moving to deferred queue (POST /Console/Sms/Sendings/{id_Sending}/Deferred) date and time is set but it is not visible on admin console
Description | Query the send queue | ||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
HTTP Method | GET, POST | ||||||||||||||||||||||||||||||||||||
URL |
| ||||||||||||||||||||||||||||||||||||
Reference | Go to automated doc (all operations) | ||||||||||||||||||||||||||||||||||||
JSON request (example) |
| ||||||||||||||||||||||||||||||||||||
JSON response (example) |
| ||||||||||||||||||||||||||||||||||||
Paging and filtering (example) |
...
Description | Retrieve the SMS message sending report by specifying SMS ID. | |||||||
---|---|---|---|---|---|---|---|---|
HTTP Method | GET | |||||||
URL |
| |||||||
Reference | Go to automated doc | |||||||
JSON request (example) | none | |||||||
JSON response (example) |
| |||||||
Paging and filtering (example) |
Detailed report
Known limitations (see response example: in this case the expected results were 16, not 9 and TotalElementCount is empty):
- response is truncated
- paging and filtering are filtering is not working
- isCompleted field is useless
Description | Retrieve the SMS message sending report details by specifying SMS ID. | |||||
---|---|---|---|---|---|---|
HTTP Method | GET | |||||
URL |
| |||||
Reference | Go to automated doc | |||||
JSON request (example) | none | |||||
JSON response (example) |
| |||||
Paging and filtering (example) |
...