...
...
Subscribe on SMS channel
Add (i.e. subscribe) recipients
In case of already existing recipients the following behaviour applies on subscription:
...
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 email text messages of specified list | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
HTTP Method | GET | ||||||||||||
URL | |||||||||||||
Description | Retrieve the email details (content, settings, attachment) by specified id | ||||||||||||
HTTP Method | GET | ||||||||||||
URL | Retrieve the email details by specified id
Get attachment list for the specified message id
| ||||||||||||
Reference | |||||||||||||
JSON request (example) | none | ||||||||||||
JSON response (example) | Message content
Message attachments
| ||||||||||||
Paging and filtering (example) | 2 items per page, get first page (count starts from zero)Retrieve all email messages of that list
Retrieve only email messages that have been published (i.e. with public visibility, see details)
Retrieve only email messages that have been archived (i.e. with public visibility, see details)
*an empty list is returned if public visibility of messages (aka Web library) is disabled. You shall enable it to Retrieve them | ||||||||||||
JSON request (example) | none | ||||||||||||
JSON response (example) | All email messages of specified list
List published messages (public URLs are also provided)
List archived messages
| ||||||||||||
Paging and filtering (example) | 2 items per page, get first page (count starts from zero)
Retrieve messages that contain the word "test" in the subject field and order by ID. Note: search by text is case sensitive
|
Read message details
| |||||
Reference | Go to automated doc | ||||
---|---|---|---|---|---|
JSON request (example) | none | ||||
JSON response (example) | All the text messages of specified list
| ||||
Paging and filtering (example) |
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 |
| List/2/Emails?PageNumber=0&PageSize=2
| |||
Reference | Go to automated doc | ||||
JSON request (example) |
| ||||
JSON response (example) |
| ||||
Paging and filtering (example) |
Send to group / list
Manage Send Queue
SMS Statistics
Summary report
Detailed report
...
Sending Queue Status
It is possible to retrieve the status of the sending queue for the outgoing messages by calling the following methods:
...
where {id_sending} is the unique identifier of the sending to consider. The result is the date UTC date specified with the format described in the section 'Type and cast definition' of this page: "Paging and filtering".
Update message
This method allows you to modify an existing message (content and settings).
...