Skip to main content
POST
/
v1
/
sms
cURL
curl --request POST \
  --url https://api.transmit.dev/v1/sms \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "from": "<string>",
  "to": "<string>",
  "body": "<string>",
  "media_urls": [
    "<string>"
  ]
}
'
{
  "id": "<string>",
  "from": "<string>",
  "to": "<string>",
  "body": "<string>",
  "segments_count": 123,
  "credits_consumed": 123,
  "status": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "workflow_id": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.transmit.dev/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

ā€‹
Authorization
string
header
required

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

Body

application/json
ā€‹
from
string
required
Pattern: ^\+[1-9]\d{1,14}$
ā€‹
to
string
required
Pattern: ^\+[1-9]\d{1,14}$
ā€‹
body
string
required
Required string length: 1 - 1600
ā€‹
media_urls
string<uri>[]

Response

SMS accepted for processing. Message record created and workflow started.

ā€‹
id
string
required

SMS message ID

ā€‹
from
string
required

Sender phone number (E.164 format)

ā€‹
to
string
required

Recipient phone number (E.164 format)

ā€‹
body
string
required

Message body

ā€‹
segments_count
number
required

Number of SMS segments

ā€‹
credits_consumed
number
required

Credits consumed for this message

ā€‹
status
string
required

SMS processing status

Allowed value: "processing"
ā€‹
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))$
ā€‹
workflow_id
string

Workflow ID for tracking durable execution