Skip to main content
GET
/
v1
/
sms
/
{id}
cURL
curl --request GET \
  --url https://api.transmit.dev/v1/sms/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "from": "<string>",
  "to": "<string>",
  "body": "<string>",
  "status": "<string>",
  "segments_count": 123,
  "credits_consumed": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "sent_at": "2023-11-07T05:31:56Z",
  "delivered_at": "2023-11-07T05:31:56Z",
  "customer_charge_dollars": 123,
  "telnyx_total_cost": 123,
  "margin_dollars": 123
}

Authorizations

ā€‹
Authorization
string
header
required

Enter your API key with 'tx_' prefix. Get your API key from the dashboard.

Path Parameters

ā€‹
id
string
required

Response

SMS details retrieved successfully

ā€‹
id
string
required

SMS message ID

ā€‹
from
string
required

Sender phone number

ā€‹
to
string
required

Recipient phone number

ā€‹
body
string
required

Message body

ā€‹
status
string
required

SMS status

ā€‹
segments_count
number
required

Number of SMS segments

ā€‹
credits_consumed
number
required

Credits consumed

ā€‹
created_at
string<date-time>
required

Creation timestamp

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
ā€‹
sent_at
string<date-time> | null
required

Sent timestamp

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
ā€‹
delivered_at
string<date-time> | null
required

Delivery timestamp

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
ā€‹
customer_charge_dollars
number

Amount charged to customer in dollars

ā€‹
telnyx_total_cost
number

Total cost from Telnyx in dollars

ā€‹
margin_dollars
number

Profit margin in dollars