Page Comparison

...

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

Code Block
https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/Sms/Send

Reference

Go to automated doc

JSON request (example)

Expand

Code Block
{ "Number":"3351234567", "Prefix":"0039", "idMessage":27 }

JSON response (example)

Expand

Code Block
{"InvalidRecipients":[],"Sent":1,"UnprocessedRecipients":[],"idMessage":4227}

Paging and filtering (example)

...

Description

Immediate or scheduled mailing to a list or to a group

HTTP Method

POST

URL

Code Block

language	xml

<!-- Immediate Send to all subscribers on SMS channel for specified list -->
https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/Sms/List/{id_List}/Message/{id_Message}/Send

<!-- Immediate Send to all subscribers on SMS channel for specified group -->
https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/Sms/Group/{id_Group}/Message/{id_Message}/Send

<!-- Scheduled Send to all subscribers on SMS channel for specified list -->
https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/Sms/List/{id_List}/Message/{id_Message}/Send?datetime="2015-10-20 05:00:00Z"

<!-- Schedule an immediate dispatch of the given sms message -->
https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/Sms/Sendings/{id_Sending}/Immediate 

<!-- Schedule a deferred dispatch of the given sms message -->

Reference

Go to automated doc (all operations)

JSON request (example)

none

JSON response (example)

Expand

"Sent" value refers to the number of recipients that will receive the message regardless the type of sending (immediate or deferred)

Code Block
{"InvalidRecipients":[],"Sent":10,"UnprocessedRecipients":[],"idMessage":42}

Paging and filtering (example)

Manage Send Queue

Description

Query the send queue

HTTP Method

GET, POST

URL

Code Block

language	xml

<!-- Retrieve the status of sms sending queues for immediate scheduled dispatches -->
GET https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/Sms/Sendings/Immediate

<!-- Retrieve the status of sms sending queues for deferred scheduled dispatches -->
GET https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/Sms/Sendings/{id_Sending}/Deferred

Reference

Go to automated doc (all operations)

JSON request (example)

JSON response (example)

Expand

Code Block
{"InvalidRecipients":[],"Sent":10,"UnprocessedRecipients":[],"idMessage":42}

Paging and filtering (example)

Manage Send Queue

Description

Query the send queue

HTTP Method

GET

URL

Code Block

language	xml

<!-- Retrieve the status of sms sending queues for immediate scheduled dispatches -->/Deferred

<!-- Retrieves the status of sms sending queues for dispatches to be scheduled -->
GET https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/Sms/Sendings/Undefined

<!-- Retrieves the earliest date and time to schedule the given sending task -->
GET https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/Sms/Sendings/Immediate/Sending/{id_Sending}/Deferred

<!-- RetrieveMove the status of sms sending queues for deferred scheduled dispatchesfrom "waiting to be sent" to "immediate sending" queue (without starting send) -->
POST https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/Sms/Sendings/Deferred/{id_Sending}/Immediate 

<!-- Retrieves the status of sms sending queues for dispatches to be scheduled Move from "waiting to be sent" to "scheduled sending" queue (scheduled date and time is passed as POST parameter) -->
POST https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/Sms/Sendings/Undefined

<!-- Retrieves the first useful date to schedule the given sending task -->
https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/Sms/Sending/{id_Sending}/Deferred

Reference

Go to automated doc (all operations)

JSON request (example)

JSON response (example)

{id_Sending}/Deferred

Reference

Go to automated doc (all operations)

JSON request (example)

Expand

Request example for POST /Console/Sms/Sendings/{id_Sending}/Deferred

Code Block
{ "Date":"2015-02-19 14:41:46Z" }

JSON response (example)

Expand

Code Block

language	xml
title	Immediate

 {"IsPaginated":false,"Items":[{"Id":74,"IdList":10,"IdMessage":41,"Notes":"","StartDate":"","State":"Running","Subject":"Welcome","Type":"Immediate"}],"PageNumber":0,"PageSize":20,"Skipped":0,"TotalElementsCount":1}

Code Block

language	xml
title	Deferred

{"IsPaginated":false,"Items":[
{"Id":72,"IdList":10,"IdMessage":29,"Notes":"This is a test message","StartDate":"2015-02-12 17:00:00Z","State":"Queued","Subject":"Test #1","Type":"Deferred"},{"Id":73,"IdList":3,"IdMessage":19,"Notes":"","StartDate":"2015-03-02 15:00:00Z","State":"Queued","Subject":"Customer credentials","Type":"Deferred"}
],"PageNumber":0,"PageSize":20,"Skipped":0,"TotalElementsCount":2}

Code Block

title	Undefined

{"IsPaginated":false,"Items":[
{"Id":36,"IdList":8,"IdMessage":12,"Notes":"msg to be sent after 3 warnings", "StartDate":null,"State":"ToBePlanned","Subject":"Final notice", "Type":"Undefined"},
{"Id":44,"IdList":3,"IdMessage":4,"Notes":"","StartDate":null,"State":"ToBePlanned","Subject":"Valentine's day","Type":"Undefined"},{"Id":46,"IdList":2,"IdMessage":14,"Notes":"","StartDate":null,"State":"ToBePlanned","Subject":"Welcome","Type":"Undefined"},{"Id":52,"IdList":2,"IdMessage":18,"Notes":"","StartDate":null,"State":"ToBePlanned","Subject":"Happy birthday","Type":"Undefined"},{"Id":48,"IdList":2,"IdMessage":15,"Notes":"","StartDate":null,"State":"ToBePlanned","Subject":"Season greetings","Type":"Undefined"},{"Id":71,"IdList":10,"IdMessage":30,"Notes":"","StartDate":null,"State":"ToBePlanned","Subject":"Password reminder","Type":"Undefined"}
],"PageNumber":0,"PageSize":20,"Skipped":0,"TotalElementsCount":6}

Code Block

title	Earliest date and time

"2015-02-09 14:41:46Z"

Code Block

title	Moved from waiting to immedate

{"Id":74,"IdList":10,"IdMessage":41,"Notes":"","StartDate":"","State":"Running","Subject":"Welcome","Type":"Immediate"}

Code Block

title	Moved from waining to deferred

{"Id":74,"IdList":10,"IdMessage":41,"Notes":"","StartDate":"2015-02-19 14:41:46Z","State":"Queued","Subject":"Welcome","Type":"Deferred"}

Paging and filtering (example)

...

Versions Compared

Old Version 5

New Version 6

Key

Manage Send Queue

Manage Send Queue