v1

latestOpenAPI 3.0.02026-07-244771176.5 KB

SMS

Get SMS

Retrieves information about an existing SMS message. You only need to supply the unique message id that was returned upon message creation.

get/v2/sms/{id}

Path parameters

idstring uuid required

Unique ID of the sent SMS

Response

A single SMS message

idstring required

Unique identifier for the SMS message.

recipientstring required

The destination number for delivery.

recipient_countrystring required

Recipient country code.

senderstring required

The sender number.

sender_countrystring required

Sender country code.

message_refstring required

Reference supplied by your system.

messagestring required

Body text of the SMS message.

statusstring required

Status of the message.

sms_countstring required

Number of SMS parts the message was split into.

is_gsmboolean required

Whether the message uses GSM encoding.

is_sandboxboolean required

Deprecated. Will be removed in a future version.

routed_viastring required

The route used to send the message.

track_linksboolean required

Whether link tracking is enabled.

directionstring required

Direction of the message (IN/OUT).

created_atstring required

Timestamp when the SMS was created.

updated_atstring required

Timestamp when the SMS was last updated.

Example response

{
  "id": "2d2c8fb6-e514-4f5f-9706-0672b0259218",
  "recipient": "61478038915",
  "recipient_country": "AU",
  "sender": "61481074185",
  "sender_country": "AU",
  "message_ref": "ncc1701d",
  "message": "Report to the ready room! Opt-out reply STOP",
  "status": "delivered",
  "sms_count": "1",
  "is_gsm": true,
  "routed_via": "",
  "track_links": true,
  "direction": "OUT",
  "created_at": "2022-03-28T06:12:52.450674000Z",
  "updated_at": "2022-03-28T06:12:52.450674000Z"
}