This page provides you with information about how to use MailUp REST API to create email 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
...
Description
...
Asynchronous import of one or more recipients on SMS channel
...
HTTP Method
...
POST
...
URL
...
Code Block |
---|
https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/Sms/{id_List}/Recipients |
...
Expand | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||
Request is composed of a list of comma separated objects, each one of them is composed of the following mandatory fields:
|
...
JSON request (example)
...
The import process 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 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 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) |
---|
Read recipients
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) |
---|
Text messages
A text message is always created inside the environment of a MailUp list, so it cannot be managed outside of that list.
Create a message
Please note that, when creating a new email text message, any referenced tag or attachment must be created in advance for that list.
...
Description
...
Create a new text message
...
HTTP Method
...
POST
...
URL
...
Code Block |
---|
https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/Sms/List/{id_List}/Message |
...
...
title | Click here to learn more about request parameters |
---|
...
Array of objects [0..39].
Each object is composed of
the following fields:
...
Known limitations:
- 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, 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, 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) |
---|
List Messages
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.
|
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
Single Send
...
HTTP Method
...
POST
...
URL
...
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. |
Single Send
Description | Send a text message to a mobile number by specifying message ID. 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) |
Send to group/list
Description | Immediate or scheduled mailing to a list or |
---|
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) |
|
Code Block | ||
---|---|---|
| ||
"2015-02-09 14:41:46Z" |
Code Block | ||
---|---|---|
| ||
{"Id":74,"IdList":10,"IdMessage":41,"Notes":"","StartDate":"","State":"Running","Subject":"Welcome","Type":"Immediate"} |
Code Block | ||
---|---|---|
| ||
{"Id":74,"IdList":10,"IdMessage":41,"Notes":"","StartDate":"2015-02-19 14:41:46Z","State":"Queued","Subject":"Welcome","Type":"Deferred"} |
Paging and filtering (example)
SMS Statistics
Summary report
Detailed report
...
| |||||||||||||||||
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 number of available credits | |||||||
---|---|---|---|---|---|---|---|---|
HTTP Method | GET | |||||||
URL |
| |||||||
Reference | Go to automated doc | |||||||
JSON request (example) | none | |||||||
JSON response (example) |
| |||||||
Paging and filtering (example) |