...
- 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> <username>?</username> <password>?</password> <documentId>?</documentId> </ser:status> </soapenv:Body></soapenv:Envelope> |
What information to return?
...
For the SOAP endpoint (XML):
<soap:Body> <return> <documentId>4fbb6cd21a88393bc47baf33</documentId> <recipient>48660703691</recipient> <messageStatus>10</messageStatus> </return> </soap:Body></soap:Envelope> |
Status codes
| Anchor | ||||
|---|---|---|---|---|
|
...
If message parts have different statuses, the status returned in the query process will be the lowest priority status within the relevant message parts. It is possible for one message part to show as delivered while the others show as sent. A multipart message will not display on a handset until all message parts are delivered so the valid total message status is sent and this is what your message status query will return. You can log into the user web application on MC5 and view the status of the individual message parts as each Outbound message to the SMSC shows as a separate entry in the SMS Out Volume Report
Status code | Final | Meaning | When? | |
|---|---|---|---|---|
-101 | Y | No username |
| |
-102 | Y | No password |
| |
-103 | Y | No document id |
| |
| -104 | Y | Invalid recipient | Recipient number invalid - validation rules - numeric length: 8-16 inclusive | |
| -105 | Y | Invalid source | Sender number invalid - validation rules - in the system - hardcoded So alpha <2, 11>, digit < 3, 16> | |
| -106 | Y | Empty text | SMS text was empty | |
| -107 | Y | Missing sender or replyTo | Both sender and replyTo value were missing. Exactly of them should be present. | |
| -108 | Y | Both sender and replyTo provided | Both sender and replyTo were provided. Exactly one of them is allowed. | |
| -109 | Y | Invalid rotation algorithm provided | Available algorithms are: max_rotation, conversation | |
| -110 | Y | Invalid encoding name | Available encodings are e.g. "utf-16", "gsm", "iso-8859-1" etc. (see Send Single Message) | |
-200 | Y | Invalid username/password | Last event: "invalid username/pass" | |
-201 | Y | User disabled | Last event: "user disabled" | |
| -202 | Y | User blocked | Last event: "user blocked" | |
-210 | Y | Insufficient credits | Last event: "no credits" | |
| -230 | Y | Document ID not matched | User does not have rights to check message status | |
| -240 | Y | Invalid (not supported) replyTo value | ||
-910 | Y | SMSC error | Last event: "send failure" | |
-999 | Y | Internal error |
Missing status codes:
- -110 (invalid xml): not possible? It would be an WS-framework error?
- -211 (invalid service), -930 (status query timeout): N/A
- -900 (service not available): ?
- -940 (query too fast)
...