...
On this page:
Table of Contents |
---|
...
Subscribe on SMS channel
Add (i.e. subscribe) recipients
In case of already existing recipients the following behaviour applies on subscription:
...
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.
Create a message
Please note that, when creating a new text message, any referenced tag must be created in advance for that list.
...
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
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) |