Message Status Query and Status Codes

Usage

Before implementing this method you must get Intelli to approve your implementation. The following plan should be used for querying message status

Use the query to Get UnRead Final Statuses (in the User API section)- the frequency you call this method will be determined on your message send rate and behaviour
Messages will receive a final status not later than 49 hours after it is sent.
Use the query by document Id (method shown below) to check for message status if you have not otherwise got a final status for a message after this 49 hour period.

Endpoints

We'll have two endpoints:

REST (GET): /services/rest/message/status?username=[]&password=[]&documentId=[]
SOAP: /services/ws/message?wsdl (method: status)

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://server.submission.mc5.smspl.com/">

<soapenv:Header/>

<soapenv:Body>

<ser:status>

<username>?</username>

<password>?</password>

<documentId>?</documentId>

</ser:status>

</soapenv:Body>

</soapenv:Envelope>

What information to return?

For the REST endpoint (JSON)

If documentId does exist

{

"documentId": "4fbb6c371a88393bc47baf32",

"recipient": "48660703691",

"messageStatus": "10"

}

for when documentId does not exist

{

"documentId": "4fbb6c371a88393bc47baf32",

"messageStatus": "0"

}

Note that we only guarantee to hold message for status query for 80 hours after message send datetime.

For the SOAP endpoint (XML):

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">

<soap:Body>

<ns1:sendSingle2Response xmlns:ns1="http://server.submission.mc5.smspl.com/">

<return>

<documentId>4fbb6cd21a88393bc47baf33</documentId>

<recipient>48660703691</recipient>

<messageStatus>10</messageStatus>

</return>

</ns1:sendSingle2Response>

</soap:Body>

</soap:Envelope>

Status codes

Full list of status code is available here Message Statuses

Submission URLs

To make the URLs uniform, the endpoints to submit messages will be:

REST (GET/POST): /services/rest/message/sendSingle2?username=[]&password=[]&documentId=[]&text=[]&replyTo=[]&recipient=[]&sender=[]
SOAP: /services/ws/message?wsdl (method: sendSingle2)

MC5 API