Skip to content
  • Auto
  • Light
  • Dark
Get Started

Messages

Messages

Messages

Get message status
get/api/status
Get messages
get/api/v2/messages
Get a specific message
get/api/v2/messages/{message_id}
Send a message
post/api/send-message
Message Content
MessageContentobject
ShowShow
account_emailstring
optional

Email of the account

contentstring
optional

Message content

date_createdstring
optional

When the message was created

formatdate-time
date_sentstring
optional

When the message was sent

formatdate-time
date_updatedstring
optional

When the message was last updated

formatdate-time
from_numberstring
optional

Sender phone number

is_outboundboolean
optional

Whether this is an outbound message

media_urlstring
optional

URL of attached media

message_handlestring
optional

Unique message identifier

send_styleenum
optional
"celebration" OR "shooting_star" OR "fireworks" OR 10 more
Hide ParametersShow Parameters
"celebration"
"shooting_star"
"fireworks"
"lasers"
"love"
"confetti"
"balloons"
"spotlight"
"echo"
"invisible"
"gentle"
"loud"
"slam"
statusenum
optional
"QUEUED" OR "SENT" OR "DELIVERED" OR 3 more
Hide ParametersShow Parameters
"QUEUED"
"SENT"
"DELIVERED"
"READ"
"ERROR"
"RECEIVED"
to_numberstring
optional

Recipient phone number

Message Response
MessageResponseobject
ShowShow
account_emailstring
optional

Email of the account that sent the message

contentstring
optional

Message content

date_createdstring
optional

When the message was created

formatdate-time
date_updatedstring
optional

When the message was last updated

formatdate-time
error_codenumber
optional

Numeric error code if message failed

error_messagestring
optional

Error message if message failed

from_numberstring
optional

Sending phone number

is_outboundboolean
optional

Whether this is an outbound message

media_urlstring
optional

URL of attached media

message_handlestring
optional

Unique identifier for tracking the message

numberstring
optional

Recipient phone number

send_styleenum
optional
"celebration" OR "shooting_star" OR "fireworks" OR 10 more

The iMessage expressive message style

Hide ParametersShow Parameters
"celebration"
"shooting_star"
"fireworks"
"lasers"
"love"
"confetti"
"balloons"
"spotlight"
"echo"
"invisible"
"gentle"
"loud"
"slam"
statusenum
optional
"QUEUED" OR "SENT" OR "DELIVERED" OR 2 more
Hide ParametersShow Parameters
"QUEUED"
"SENT"
"DELIVERED"
"READ"
"ERROR"