Gets TXT messages sent as part of a TXT programme.

Required permissions: Messages and Reports

get

Path parameters

programmeIDstring · uuidRequired

The ID of the TXT programme.

Query parameters

numRecordsinteger · int32Optional

The maximum number of TXT messages to return. If numRecords is unspecified, it defaults to 150.

startIndexinteger · int32Optional

The position in the list of the programme's TXT messages at which to start retrieving messages.

apiTokenstringRequired

API authentication token

Responses

200

OK

application/json

400

Missing Parameter Value

application/json

401

Incorrect Permissions or Invalid API Token

application/json

500

Engage Server Error. Unable to process response at this time.

application/json

get/txt/programmes/{programmeID}/messages

GET /txt/programmes/{programmeID}/messages?apiToken=text HTTP/1.1
Host: api.ubiquity.co.nz
Accept: */*

{
  "inbound": [
    {
      "messageID": "text",
      "programmeID": "text",
      "txtOutID": "text",
      "shortCode": "text",
      "mobileNumber": "text",
      "status": "text",
      "messageType": "Inbound"
    }
  ],
  "outbound": [
    {
      "messageID": "text",
      "programmeID": "text",
      "txtOutID": "text",
      "shortCode": "text",
      "mobileNumber": "text",
      "status": "text",
      "messageType": "Inbound"
    }
  ],
  "txtOut": [
    {
      "messageID": "text",
      "programmeID": "text",
      "txtOutID": "text",
      "shortCode": "text",
      "mobileNumber": "text",
      "status": "text",
      "messageType": "Inbound"
    }
  ],
  "api": [
    {
      "messageID": "text",
      "programmeID": "text",
      "txtOutID": "text",
      "shortCode": "text",
      "mobileNumber": "text",
      "status": "text",
      "messageType": "Inbound"
    }
  ]
}