Returns message statuses that had changed to a final delivery status since the last time the user executed the query.

REST

URL: /services/rest/user/unreadFinalStatuses

Works for POST and application/x-www-form-urlencoded parameters, or GET and query parameters

Example request:

(GET) /services/rest/user/unreadFinalStatuses?username=john&password=secret

Request parameters:

name	example value	required?	description
username	john	yes	only messages belonging to this user are returned
password	secret	yes

Example response:

{
  "statuses": [
    {
      "recipient": "123123123",
      "messageStatus": 2,
      "documentId": "52fb47a04b9020e419cb6454"
    },
    {
      "recipient": "234567890",
      "messageStatus": 2,
      "documentId": "52fe165b4b904f6c374f7eae"
    },
    {
      "recipient": "123123123",
      "messageStatus": 3,
      "documentId": "533939884b9014ca027244d1"
    }
  ],
  "hasMore": false,
  "queryStatus": 0
}

Response parameters:

name	description
hasMore	true if there are more statuses to retrieve from server, false otherwise
queryStatus	explained in User and Reseller REST API Response Status Codes

And for each status:

name	description
recipient	message destination number
messageStatus	final status code. See a list of codes in Status Codes
documentId	message ID

SOAP

Endpoint: https://mc5.smartmessagingservices.net/services/ws/message?wsdl (method: getUnreadFinalStatuses)

Example request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://ws.server.submission.mc5.smspl.com/">
   <soapenv:Header/>
   <soapenv:Body>
      <ws:getUnreadFinalStatuses>
         <username>john</username>
         <password>secret</password>
      </ws:getUnreadFinalStatuses>
   </soapenv:Body>
</soapenv:Envelope>

Example response:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Body>
      <ns1:getUnreadFinalStatusesResponse xmlns:ns1="http://ws.server.submission.mc5.smspl.com/">
         <return>
            <statuses>
               <recipient>12345678</recipient>
               <messageStatus>2</messageStatus>
               <documentId>53512d4617b297c05ee84bdf</documentId>
            </statuses>
            <statuses>
               <recipient>12345678</recipient>
               <messageStatus>2</messageStatus>
               <documentId>53512d4817b297c05ee84be0</documentId>
            </statuses>
            <hasMore>false</hasMore>
            <queryStatus>0</queryStatus>
         </return>
      </ns1:getUnreadFinalStatusesResponse>
   </soap:Body>
</soap:Envelope>

Browser not supported