Message Status

Overview

API Interface: HTTPS
URI: v4/messages/{guid}
Methods: GET
Response Schemas: JSON (default), XML
Response Types: Synchronous

The current status of an existing message can be accessed through the GET Method against the Messages resource.

Response Schema

Aerialink supports both JSON and XML response schemas, however the default response schema is JSON. If you wish to receive your response schema in XML or explicitly set the response schema to JSON, follow these examples as you construct your complete request URL.

/messages/{guid}
(defaults to JSON automatically)

/messages/{guid}.json
(explicitly sets the response to a JSON schema, same as default)

/messages/{guid}.xml
(sets the response to an XML schema)

Method [GET] : Check Status

This method queries and returns the current status of a message. The request is initiated by your application.

Request

The available request parameters for this resource and method are listed below and should be sent form-post.

Required Parameters

  • 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.

Important Note: The transactionGUID must be provided in the query string with the request.**

Response (Synchronous)

Response Properties

The parameters or elements returned in the response to an API request.

  • transactionGUID : The globally unique identifier for this transaction or API request
  • transactionGUIDlinked : The globally unique identifier for a related corresponding transaction, if applicable. In the case of a Submit transaction this may represent the corresponding Delivery Receipt or in the case of a Deliver Receipt transaction this will be original Submit transaction.
  • messageType : The type of the message; Submit or Deliver
  • source : The source code/number for the message.
  • destination : The destination code/number for the message.
  • dcs : The data coding scheme that was used in the processing of this message.
  • esmClass : The esmClass that was used in the processing of this message. For example a standard submit message would have an esmClass of 0, while a deliver message of type ‘delivery receipt’ would have an esmClass of 4.
  • status : The current status ID of the message.
  • messageState : The message state for the requested message.
  • registeredDelivery : Denotes whether registered delivery was requested for this message.
  • created : The date the transaction was created in UTC time.
  • processed : The date the transaction was processed in UTC time.
  • completed : The date the transaction was completed in UTC time.
  • lastUpdated : The date the transaction was lastUpdated in UTC time.

Response Schema

JSON Format

{
"aerialink": {
    "version": "v4",
    "resource": "messages",
    "method": "get",
    "type": "synchronous",
    "transaction": {
        "transactionGUID": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "transactionGUIDLinked": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "messageType": "Submit",
        "source": "wXXXyyyZZZZ",
        "destination": "wXXXyyyZZZZ",
        "dcs": 0,
        "esmClass": 0,
        "status": 0,
        "messageState": "X",
        "registeredDelivery": 0,
        "created": "01-01-2014 00:00:00",
        "processed": "01-01-2014 00:00:00",
        "completed": "01-01-2014 00:00:00",
        "lastUpdated": "01-01-2014 00:00:00"
        }
    }
}

XML Format

<?xml version="1.0" encoding="UTF-8"?>
<aerialink>
    <version>v4</version>
    <resource>messages</resource>
    <method>get</method>
    <type>synchronous</type>
    <transaction>
        <transactionGUID>xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx</transactionGUID>
        <transactionGUIDLinked>xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx</transactionGUIDLinked>
        <messageType>Submit</messageType>
        <source>wXXXyyyZZZZ</source>
        <destination>wXXXyyyZZZZ</destination>
        <dcs>0</dcs>
        <esmClass>0</esmClass>
        <status>0</status>
        <messageState>X</messageState>
        <registeredDelivery>0</registeredDelivery>
        <created>01-01-2014 00:00:00</created>
        <processed>01-01-2014 00:00:00</processed>
        <completed>01-01-2014 00:00:00</completed>
        <lastUpdated>01-01-2014 00:00:00</lastUpdated>
    </transaction>
</aerialink>

This page was last updated 1515185923000