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
ModelsExpand Collapse
MessageContent = object { account_email, content, date_created, 9 more }
MessageContent = object { account_email, content, date_created, 9 more }
account_email: optional string
account_email: optional string
Email of the account
content: optional string
content: optional string
Message content
date_created: optional string
date_created: optional string
When the message was created
formatdate-time
date_sent: optional string
date_sent: optional string
When the message was sent
formatdate-time
date_updated: optional string
date_updated: optional string
When the message was last updated
formatdate-time
from_number: optional string
from_number: optional string
Sender phone number
is_outbound: optional boolean
is_outbound: optional boolean
Whether this is an outbound message
media_url: optional string
media_url: optional string
URL of attached media
message_handle: optional string
message_handle: optional string
Unique message identifier
send_style: optional "celebration" or "shooting_star" or "fireworks" or 10 more
send_style: optional "celebration" or "shooting_star" or "fireworks" or 10 more
Accepts one of the following:
"celebration"
"shooting_star"
"fireworks"
"lasers"
"love"
"confetti"
"balloons"
"spotlight"
"echo"
"invisible"
"gentle"
"loud"
"slam"
status: optional "QUEUED" or "SENT" or "DELIVERED" or 3 more
status: optional "QUEUED" or "SENT" or "DELIVERED" or 3 more
Accepts one of the following:
"QUEUED"
"SENT"
"DELIVERED"
"READ"
"ERROR"
"RECEIVED"
to_number: optional string
to_number: optional string
Recipient phone number
MessageResponse = object { account_email, content, date_created, 10 more }
MessageResponse = object { account_email, content, date_created, 10 more }
account_email: optional string
account_email: optional string
Email of the account that sent the message
content: optional string
content: optional string
Message content
date_created: optional string
date_created: optional string
When the message was created
formatdate-time
date_updated: optional string
date_updated: optional string
When the message was last updated
formatdate-time
error_code: optional number
error_code: optional number
Numeric error code if message failed
error_message: optional string
error_message: optional string
Error message if message failed
from_number: optional string
from_number: optional string
Sending phone number
is_outbound: optional boolean
is_outbound: optional boolean
Whether this is an outbound message
media_url: optional string
media_url: optional string
URL of attached media
message_handle: optional string
message_handle: optional string
Unique identifier for tracking the message
number: optional string
number: optional string
Recipient phone number
send_style: optional "celebration" or "shooting_star" or "fireworks" or 10 more
send_style: optional "celebration" or "shooting_star" or "fireworks" or 10 more
The iMessage expressive message style
Accepts one of the following:
"celebration"
"shooting_star"
"fireworks"
"lasers"
"love"
"confetti"
"balloons"
"spotlight"
"echo"
"invisible"
"gentle"
"loud"
"slam"
status: optional "QUEUED" or "SENT" or "DELIVERED" or 2 more
status: optional "QUEUED" or "SENT" or "DELIVERED" or 2 more
Accepts one of the following:
"QUEUED"
"SENT"
"DELIVERED"
"READ"
"ERROR"