API Interface: HTTPS Resource: Status URI: /20100101/sms/status/ Methods: POST Response Schemas: XML
The Status Resource provides the ability to check the status on a past message transaction in which an API request was already processed against the Messages resource.
Note: Reference URI (Uniform Resource Identifier) defaults to a XML response schema.
Method [POST] : Check the Message Status
This method is used to query the current status for a message. The request is initiated by your application.
The following request parameters are available for this resource and method
- transactionGUID [string(36)]
The value of this parameter is the transactionGUID (transaction global unique identifier) for the message that you wish to query a status on. The transactionGUID would have been provided to you in the API response for a previous API request against the Messages API.
The parameters or elements returned in the response to an API request.
If the validateOnly parameter “is not” passed or is set to “0” the following response will be received.
- transactionGUID : The globally unique identifier for this transaction or API request
- status : The network transaction status. Confirms the current state of the processing of the transaction.
- deliveryStatus : The delivery status of the message. Reflects the delivery receipt details provided by the end carrier.
- statusText : The friendly description text of the status.
<?xml version="1.0" ?> <aerialink version="20100101" method="status"> <sms> <transactionGUID>xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx</transactionGUID> <status>X</status> <deliveryStatus>Y</deliveryStatus> <statusText>Z</statusText> </sms> </aerialink>
Status & Error Codes
For status codes related to Availability, Access, Security and Authentication, see HTTP Status Codes. HTTP Status Codes are consistent for all API resources.
Once your application has received an HTTP Status Code of 200 or 202 it signifies that you were able to successfully reach the Aerialink network and pass the preliminary security checks. At this point, you should expect to receive one of the following two API responses strings:
API Success Reponse “XML Packet”
This XML response will be formated as described above and will include one of the following transaction Status codes and Delivery Status codes.
10 (SUCCESS): Message has been successfully queued for delivery in the Aerialink network.
In almost all cases this will be the initial status code that will be returned.
20 (SUCCESS): Message was processed and delivered to the operator network for delivery to the handset.
In almost all cases this status will only be available after the initial request and response lifecycle for the transaction using our separate status API.
Delivery Status Codes
For a complete list of Delivery Status Codes for messages, see Delivery Status Codes. Please note that these status codes are applicable only to Short Code messaging and do not apply to Long Code or International A2P messaging.
API Negotiation Error “Simple String”
- Error Code (XXXX): This “Simple String” response will include a system error code.
An error has occurred with your request. Please try again or contact support. Error Code: XXXX,1234567890123
For a complete list of API Error Codes for this and other API resources, see API Error Codes.
If you are having trouble authenticating with the Aerialink API, verify that you have constructed the request URL properly and have prepared your authentication properly. See Base URL and Authentication for details.
You can view the API Authentication Error Log under Reports in the APi section of the Platform portal. This will confirm whether your authentication requests are being rejected or not.
If you require any additional assistance, please use one of these methods to contact the Aerialink Support Team.
This page was last updated 1515185923000