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

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
to
string
required
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

workflow_id
string

Workflow ID for tracking durable execution