...
Panel | ||
---|---|---|
| ||
On this page:
Table of Contents |
---|
...
Subscribe on SMS channel
Add recipients
...
- clearMissingOrEmptyFields: when set to "true", the import process clears on MailUp field that is not specified or set as empty in the request body.
- removeFromPrevGroups: when set to "true", first the import process removes the given recipients from any group they have been part of, then it adds them only to the group specified along with this request. This querystring parameter applies only to "Add to a MailUp group" cases.
Description | Asynchronous import of one or more recipients on SMS channel | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
HTTP Method | POST | ||||||||||||||
URL |
| ||||||||||||||
Reference |
|
|
JSON request (example) |
| |||||||
---|---|---|---|---|---|---|---|---|
JSON response (example) | Returns import ID |
Paging and filtering (example) |
---|
Read recipients
Description | Specific methods are available for retrieving recipients that are, respectively, subscribed, pending or unsubscribed on SMS channel. | |||||
---|---|---|---|---|---|---|
HTTP Method | GET | |||||
URL |
| |||||
Reference | Automated docs are available for Subscribed, Pending and Unsubscribed |
JSON request (example) |
---|
JSON response (example) |
|
---|
Paging and filtering (example) |
---|
Text messages
A text message is always created inside the environment of a MailUp list, so it cannot be managed outside of that list.
...
- 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 applied
Description | Create a new text message | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
HTTP Method | POST | ||||||||||||||||||||||||||||||||
URL |
| ||||||||||||||||||||||||||||||||
Reference |
|
| ||||||||
JSON request (example) |
| |||||||
---|---|---|---|---|---|---|---|---|
JSON response (example) |
|
Paging and filtering (example) |
---|
List Messages
Description | Retrieve text messages of specified list | |||||||
---|---|---|---|---|---|---|---|---|
HTTP Method | GET | |||||||
URL |
| |||||||
Reference | Go to automated doc | |||||||
JSON request (example) | none | |||||||
JSON response (example) | All the text messages of specified list
| |||||||
Paging and filtering (example) | Use this filter to extract only the SMS messages of list 1 that contain the word "promo" in their subject.
|
Read message details
Description | Retrieve the text message details by specified message id | |||||||
---|---|---|---|---|---|---|---|---|
HTTP Method | GET | |||||||
URL | Retrieve the SMS details by specified id
| |||||||
Reference | Go to automated doc | |||||||
JSON request (example) | none | |||||||
JSON response (example) |
| |||||||
Paging and filtering (example) |
Update message
Description | Update a text message by specifying the message id | |||||||
---|---|---|---|---|---|---|---|---|
HTTP Method | PUT | |||||||
URL |
| |||||||
Reference | Go to automated doc | |||||||
JSON request (example) |
| |||||||
JSON response (example) |
| |||||||
Paging and filtering (example) |
Delete Message
Description | Delete a text message by specifying its ID | |||||
---|---|---|---|---|---|---|
HTTP Method | DELETE | |||||
URL |
| |||||
Reference | Go to automated doc | |||||
JSON request (example) | none | |||||
JSON response (example) | none | |||||
Paging and filtering (example) |
Send a text message
Note | ||
---|---|---|
| ||
Regardless the sender you set when creating a message, MailUp REST API always sends SMS using the sender that is specified at list level. If you want to change the sender you must modify the list properties. |
Single Send
Description | Send a text message to a mobile number by specifying message ID. Recipient is automatically subscribed to the SMS channel of the list in which the message was created. | |||||||
---|---|---|---|---|---|---|---|---|
HTTP Method | POST | |||||||
URL |
| |||||||
Reference | Go to automated doc | |||||||
JSON request (example) |
| |||||||
JSON response (example) |
| |||||||
Paging and filtering (example) |
Send to group / list
Description | Immediate or scheduled mailing to a list or to a group | |||||||
---|---|---|---|---|---|---|---|---|
HTTP Method | POST | |||||||
URL |
| |||||||
Reference | Go to automated doc (all operations) | |||||||
JSON request (example) | none | |||||||
JSON response (example) |
| |||||||
Paging and filtering (example) |
...
Manage Send Queue
Known limitations:
- 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
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) |
...
SMS Statistics
Summary report
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
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) | Use this filter to extract the result of the latest message with ID=24 that was sent to number +3933512345678 If you used the sending method of the Transactional API for SMS you can also filter by the DeliveryId that was returned by that method. GET /Console/Sms/24/Sendings/ReportDetails?DeliveryId=1648 In this case paging and further filtering is not required, since no more than one result can be returned |
...
SMS Credits
Summary report
Description | Retrieve several account details, including the amount of available credits | |||||
---|---|---|---|---|---|---|
HTTP Method | GET | |||||
URL |
| |||||
Reference | Go to automated doc | |||||
JSON request (example) | none | |||||
JSON response (example) |
|
| ||||||
Paging and filtering (example) |
---|