Get a single TXT message by ID.

Required permissions: Messages and Reports

get

Path parameters

programmeIDstring · uuidRequired

messageIDstring · uuidRequired

Query parameters

apiTokenstringRequired

API authentication token

Responses

200

OK

application/json

messageIDstringOptional

programmeIDstringOptional

txtOutIDstringOptional

shortCodestringOptional

mobileNumberstringOptional

statusstringOptional

referenceIDstringOptional

messagestringOptional

messageTypestring · enumOptionalPossible values:

400

Missing Parameter Value

application/json

401

Incorrect Permissions or Invalid API Token

application/json

404

Unable to find message

application/json

500

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

application/json

get/txt/programmes/{programmeID}/messages/{messageID}

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

{
  "messageID": "text",
  "programmeID": "text",
  "txtOutID": "text",
  "shortCode": "text",
  "mobileNumber": "text",
  "status": "text",
  "referenceID": "text",
  "message": "text",
  "messageType": "Inbound"
}