Message Report

API Interface: HTTPS
Resource: Report
URI: /20100101/sms/report/
Methods: GET   
Response Schemas: CSV


The Report Resource provides the ability to access message reports by a specified date range.

Note: Reference URI (Uniform Resource Identifier) defaults to a XML response schema.

Method [GET] : Report Query

This method is used to generate a report based on the parameters provided. The request is initiated by your application.


The following request parameters are available for this resource and method

Optional Parameters (Report Filters)

  • startDate [string(15)]
    Filters the response records by the Start Date. Defaults to all dates.

  • endDate [string(15)]
    Filters the response records by the End Date. Defaults to all dates.

  • sourceAddress [string(15)]
    Filters the response records by the Source Address. Defaults to all source addresses.

  • destinationAddress [string(15)]
    Filters the response records by the Destination Address. Defaults to all destination addresses.

  • startRow [integer]
    Specifies the starting transactional record to retrieve. Defaults to 1.

  • maxRows [integer]
    Specifies the maximum number of records to be returned in the response. Defaults to 50 and has a maximum allowed value of 100.

  • messageType [string(2)]
    Filters the response records by the transaction message type. The filter options are either MO or MT. Defaults to MO. An MO is an Mobile Originate transaction and an MT is a Mobile Terminate transaction.

  • reportFormat [string(3)]
    Specifies the output format of the API response. The option values are CSV. The default is CSV.

Response (Synchronous)

Response Properties

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

  • type :
  • transactionGUID : The globally unique identifier for this transaction or API request
  • source : The source code or address. With an MO this is the destination user and with an MT this is the source address
  • destination : The destination code or address. With an MO this is the source user and with an MT this is the destination address
  • messageText : The transmitted message text
  • transactionDate : The transaction date as UTC timzone
  • status : The status of the message transaction
  • action : The action event performed on the message

Response Schema

CSV Format
If the CSV report option is requested, the http response will be formatted as CSV in the following comma deliminted format


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 “CSV Format”
    This CSV response will be formated with the fields described above.

  • API Negotiation Error “Simple String”
    This “Simple String” response will include a system error code. For a complete list of API Error Codes that relate to this API resource, see API Status Codes.
    An error has occurred with your request. Please try again or contact support. Error Code: XXXX,1234567890123


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