Get SMS message with options

GET /sms/message/{messageID}/{options}

Path parameters

messageID integer(int64) Required

ID of message to return
options array[string] Required

Comma seperated list of additional data to include in the response

At least 1 but not more than 2 elements. Values are meta or status.

Responses

200 application/json

Successful operation
One of:
GetOutboundSmsResponseMetaStatus object GetOutboundSmsResponseMeta object GetOutboundSmsResponseStatus object
Hide attributes Show attributes

to object

Object containing msisdns to status

Hide to attributes Show to attributes object

Additional properties

key string

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.

created_at string(date-time)

When the message was created

complete_at string(date-time)

When the message was completed

num_parts integer

Number of parts the message was sent in

balance_used integer

Total number of credits used to send all messages

status object

The status of the individual messages

Hide status attributes Show status attributes object

pending integer

The number of messages pending delivery

submitted integer

The number of messages submitted for delivery

sent integer

The number of messages sent

delivered integer

The number of messages delivered

cancelled integer

The number of messages cancelled

expired integer

The number of messages which have expired

aborted integer

The number of messages aborted

rejected integer

The number of messages rejected

failed integer

The number of messages failed to deliver

deleted integer

The number of messages deleted

unknown integer

The number of messages in an unknown state
Hide attributes Show attributes

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.

created_at string(date-time)

When the message was created

complete_at string(date-time)

When the message was completed

num_parts integer

Number of parts the message was sent in

balance_used integer

Total number of credits used to send all messages
Hide attributes Show attributes

to object

Object containing msisdns to status

Hide to attributes Show to attributes object

Additional properties

key string

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.

status object

The status of the individual messages

Hide status attributes Show status attributes object

pending integer

The number of messages pending delivery

submitted integer

The number of messages submitted for delivery

sent integer

The number of messages sent

delivered integer

The number of messages delivered

cancelled integer

The number of messages cancelled

expired integer

The number of messages which have expired

aborted integer

The number of messages aborted

rejected integer

The number of messages rejected

failed integer

The number of messages failed to deliver

deleted integer

The number of messages deleted

unknown integer

The number of messages in an unknown state
401 application/json

Unauthorized
Hide response attributes Show response attributes object
- status_code integer
  
  Status code 401
- status_msg string
  
  Error message text
404 application/json

Not Found
Hide response attributes Show response attributes object
- status_code integer
  
  Status code 404
- status_msg string
  
  Error message text
- info string
  
  Additional information
405 application/json

Method Not Allowed
Hide response attributes Show response attributes object
- status_code integer
  
  Status code 405
- status_msg string
  
  Error message text
- Allow array[string]
  
  HTTP Method

GET /sms/message/{messageID}/{options}

curl \
 -X GET https://sms.apicontrol.co.uk/v1/sms/message/{messageID}/{options} \
 -H "Authorization: $API_KEY"

Response examples (200)

{
  "to": {
    "+447700900111": "delivered",
    "+447700900122": "delivered",
    "+447700900133": "pending"
  },
  "messageID": 123123,
  "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,
  "created_at": "2024-06-03T10:05:22Z",
  "complete_at": "2024-06-03T10:06:22Z",
  "num_parts": 1,
  "balance_used": 3,
  "status": {
    "pending": 0,
    "submitted": 0,
    "sent": 0,
    "delivered": 2,
    "cancelled": 0,
    "expired": 0,
    "aborted": 0,
    "rejected": 0,
    "failed": 1,
    "deleted": 0,
    "unknown": 0
  }
}

{
  "to": [
    "+447700900111",
    "+447700900122"
  ],
  "messageID": 123123,
  "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,
  "created_at": "2024-06-03T10:05:22Z",
  "complete_at": "2024-06-03T10:06:22Z",
  "num_parts": 1,
  "balance_used": 3
}

{
  "to": {
    "+447700900111": "delivered",
    "+447700900122": "delivered",
    "+447700900133": "pending"
  },
  "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,
  "status": {
    "pending": 0,
    "submitted": 0,
    "sent": 0,
    "delivered": 2,
    "cancelled": 0,
    "expired": 0,
    "aborted": 0,
    "rejected": 0,
    "failed": 1,
    "deleted": 0,
    "unknown": 0
  }
}

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"
  ]
}