Get SMS message

GET /sms/message/{messageID}

Path parameters

  • messageID integer(int64) Required

    ID of message to return

Responses

  • 200 application/json

    Successful operation

    Hide response attributes Show response attributes object
    • to array[string]

      List of msisdns to whom the message is being sent

    • messageID integer

      The Id of the message

    • from string

      The msisdn of the sender; this is who the recipient will see as the sender of the message

    • body string

      Message contents to send

    • send_at string(date-time)

      When to send the message; default is to send now

    • expires_at string(date-time)

      When the message should expire; any recipients not yet attempted will be abandoned

    • ref string

      Client reference; this will be included in any callbacks

    • callbackURL string(uri)

      URL that delivery reports should be sent to for this message

    • paused boolean

      Whether to submit the message in a paused state (will not be sent until released)

      Default value is false.

  • 401 application/json

    Unauthorized

    Hide response attributes Show response attributes object
  • 404 application/json

    Not Found

    Hide response attributes Show response attributes object
  • 405 application/json

    Method Not Allowed

    Hide response attributes Show response attributes object
GET /sms/message/{messageID}
curl \
 -X GET https://sms.apicontrol.co.uk/v1/sms/message/{messageID} \
 -H "Authorization: $API_KEY"
Response examples (200)
{
  "to": [
    "+447700900111",
    "+447700900122"
  ],
  "messageID": 923934,
  "from": "+447700900001",
  "body": "Message to send",
  "send_at": "2024-06-03T10:05:22Z",
  "expires_at": "2024-06-04T10:05:22Z",
  "ref": "d93b9ec9-4e0d-42b8-80c0-ef3036acdafc",
  "callbackURL": "https://sms-callbacks.barbuck.com",
  "paused": false
}
Response examples (401)
{
  "status_code": 401,
  "status_msg": "Unauthorized"
}
Response examples (404)
{
  "status_code": 404,
  "status_msg": "Not Found",
  "info": "string"
}
Response examples (405)
{
  "status_code": 405,
  "status_msg": "Method Not Allowed",
  "Allow": [
    "POST"
  ]
}