This page provides you with information about how to use MailUp REST API to create text messages (SMS) and to send them to specified recipients.
...
title | Reference Links |
---|
...
...
On this page:
Table of Contents |
---|
...
Subscribe on SMS channel
Add recipients
In the case of already existing recipients the following behaviour behavior applies on subscriptionto subscriptions:
- already subscribed remain subscribed
- pending or unsubscribed on SMS channel do does not change their subscription status
The import process is able to can recognize existing recipients, using the mobile number as unique identifiers, and update them according to the given input details. It is possible to add some querystring query string parameters to specify some advanced behavior for the import process:
- clearMissingOrEmptyFields: when set to "true", the import process clears on the 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 query string 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) |
...
Description | Specific methods are available for retrieving recipients that are, respectively, subscribed, pending, or unsubscribed on the 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) |
...
- 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 the admin console allows only letters and numbers, API also allow spaces, punctuation, 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, punctuation, puntuaction or special characters
- In the case of an 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) |
...
Description | Retrieve text messages of a specified list | |||||||
---|---|---|---|---|---|---|---|---|
HTTP Method | GET | |||||||
URL |
| |||||||
Reference | Go to automated doc | |||||||
JSON request (example) | none | |||||||
JSON response (example) | All the text messages of a 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.
|
...
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) |
...
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) |
...
Note | ||
---|---|---|
| ||
Regardless of the sender, you set when creating a message, MailUp REST API always sends SMS using the sender that is specified at the list level. If you want to change the sender you must modify the list properties. |
...
Description | Send a text message to a mobile number by specifying message ID. Recipient The 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) |
...
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) |
...
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 |
...
Description | Retrieve several account details, including the amount number of available credits | |||||||
---|---|---|---|---|---|---|---|---|
HTTP Method | GET | |||||||
URL |
| |||||||
Reference | Go to automated doc | |||||||
JSON request (example) | none | |||||||
JSON response (example) |
| |||||||
Paging and filtering (example) |
...