Skip to content
Sendblue Docs
Get Started
API Reference

Messages

Operations for sending and managing messages

Get messages
GET/api/v2/messages
Get a specific message
GET/api/v2/messages/{message_id}
Send a message
POST/api/send-message
Get message status
GET/api/status
ModelsExpand Collapse
MessageContent object { account_email, content, date_created, 9 more }
account_email: optional string

Email of the account

content: optional string

Message content

date_created: optional string

When the message was created

formatdate-time
date_sent: optional string

When the message was sent

formatdate-time
date_updated: optional string

When the message was last updated

formatdate-time
from_number: optional string

Sender phone number

is_outbound: optional boolean

Whether this is an outbound message

media_url: optional string

URL of attached media

message_handle: optional string

Unique message identifier

send_style: optional "celebration" or "shooting_star" or "fireworks" or 10 more
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
One of the following:
"QUEUED"
"SENT"
"DELIVERED"
"ERROR"
"RECEIVED"
to_number: optional string

Recipient phone number

MessageResponse object { account_email, content, date_created, 10 more }
account_email: optional string

Email of the account that sent the message

content: optional string

Message content

date_created: optional string

When the message was created

formatdate-time
date_updated: optional string

When the message was last updated

formatdate-time
error_code: optional number

Numeric error code if message failed

error_message: optional string

Error message if message failed

from_number: optional string

Sending phone number

is_outbound: optional boolean

Whether this is an outbound message

media_url: optional string

URL of attached media

message_handle: optional string

Unique identifier for tracking the message

number: optional string

Recipient phone number

send_style: optional "celebration" or "shooting_star" or "fireworks" or 10 more

The iMessage expressive message style

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 "ERROR"
One of the following:
"QUEUED"
"SENT"
"DELIVERED"
"ERROR"
MessageListResponse object { data, pagination, status }
data: optional array of object { accountEmail, content, date_sent, 22 more }
accountEmail: optional string

Email of the account

content: optional string

Message content

date_sent: optional string

When the message was sent

formatdate-time
date_updated: optional string

When the message was last updated

formatdate-time
error_code: optional number

Numeric error code if message failed

error_detail: optional string

Detailed error information

error_message: optional string

Error message if message failed

error_reason: optional string

Error reason if message failed

from_number: optional string

Sender phone number

group_display_name: optional string

Display name for group messages

group_id: optional string

Group ID for group messages

is_outbound: optional boolean

Whether this is an outbound message

media_url: optional string

URL of attached media

message_handle: optional string

Unique message identifier

message_type: optional "message" or "group"
One of the following:
"message"
"group"
number: optional string

Primary phone number (to_number for outbound, from_number for inbound)

opted_out: optional boolean

Whether the recipient has opted out

participants: optional array of string

List of participants for group messages

plan: optional string

Account plan used for this message

send_style: optional "celebration" or "shooting_star" or "fireworks" or 10 more

The iMessage expressive message style

One of the following:
"celebration"
"shooting_star"
"fireworks"
"lasers"
"love"
"confetti"
"balloons"
"spotlight"
"echo"
"invisible"
"gentle"
"loud"
"slam"
sendblue_number: optional string

Sendblue phone number used

service: optional "iMessage" or "SMS" or "RCS"

The messaging service used

One of the following:
"iMessage"
"SMS"
"RCS"
status: optional "REGISTERED" or "PENDING" or "SENT" or 7 more
One of the following:
"REGISTERED"
"PENDING"
"SENT"
"DELIVERED"
"RECEIVED"
"QUEUED"
"ERROR"
"DECLINED"
"ACCEPTED"
"SUCCESS"
to_number: optional string

Recipient phone number

was_downgraded: optional boolean

Whether the message was downgraded from iMessage to SMS

Whether there are more messages available

Number of messages returned in this request

Number of messages skipped

Total number of messages matching the filters

status: optional string
MessageRetrieveResponse object { data, status }
data: optional object { accountEmail, content, date_sent, 22 more }
accountEmail: optional string

Email of the account

content: optional string

Message content

date_sent: optional string

When the message was sent

formatdate-time
date_updated: optional string

When the message was last updated

formatdate-time
error_code: optional number

Numeric error code if message failed

error_detail: optional string

Detailed error information

error_message: optional string

Error message if message failed

error_reason: optional string

Error reason if message failed

from_number: optional string

Sender phone number

group_display_name: optional string

Display name for group messages

group_id: optional string

Group ID for group messages

is_outbound: optional boolean

Whether this is an outbound message

media_url: optional string

URL of attached media

message_handle: optional string

Unique message identifier

message_type: optional "message" or "group"
One of the following:
"message"
"group"
number: optional string

Primary phone number (to_number for outbound, from_number for inbound)

opted_out: optional boolean

Whether the recipient has opted out

participants: optional array of string

List of participants for group messages

plan: optional string

Account plan used for this message

send_style: optional "celebration" or "shooting_star" or "fireworks" or 10 more

The iMessage expressive message style

One of the following:
"celebration"
"shooting_star"
"fireworks"
"lasers"
"love"
"confetti"
"balloons"
"spotlight"
"echo"
"invisible"
"gentle"
"loud"
"slam"
sendblue_number: optional string

Sendblue phone number used

service: optional "iMessage" or "SMS" or "RCS"

The messaging service used

One of the following:
"iMessage"
"SMS"
"RCS"
status: optional "REGISTERED" or "PENDING" or "SENT" or 7 more
One of the following:
"REGISTERED"
"PENDING"
"SENT"
"DELIVERED"
"RECEIVED"
"QUEUED"
"ERROR"
"DECLINED"
"ACCEPTED"
"SUCCESS"
to_number: optional string

Recipient phone number

was_downgraded: optional boolean

Whether the message was downgraded from iMessage to SMS

status: optional string