Skip to main content
POST
Send a message

Authorizations

Authorization
string
header
required

Use Authorization: Bearer pyai_live_... (or pyai_test_...).

Headers

Idempotency-Key
string
required
Required string length: 1 - 255

Body

application/json
from
string
required
Example:

"+14155550100"

to
string
required
Example:

"+14155550101"

body
string
required
Required string length: 1 - 4000
channel
enum<string>
default:sms
Available options:
sms,
mms
media_urls
string<uri>[]
use_case
enum<string>
default:transactional
Available options:
transactional,
marketing,
otp
campaign_id
string | null

Response

Message accepted

object
string
Example:

"message"

id
string
Example:

"msg_..."

direction
enum<string>
Available options:
outbound,
inbound
channel
enum<string>
Available options:
sms,
mms,
rcs,
link
from
string
to
string
body
string
media_urls
string<uri>[]
use_case
enum<string>
Available options:
transactional,
marketing,
otp
campaign_id
string | null
status
enum<string>
Available options:
queued,
blocked,
dispatching,
sent,
delivered,
undelivered,
failed,
received
failure_code
string | null
created_at
string<date-time>
updated_at
string<date-time>