Messages
Messages are individual communications within a chat thread.
Messages can include text, media attachments, rich link previews, and reactions. All messages are associated with a specific chat and sent from a phone number you own.
Messages support delivery status tracking and read receipts.
Rich Link Previews
Send a URL as a link part to deliver it with a rich preview card showing the
page’s title, description, and image (when available). A URL inside a text
part renders a preview too.
Limitations:
- A message carries exactly one part, so a link is never combined with text or media.
- Maximum URL length: 2,048 characters.
Send a message to an existing chat
Get messages from a chat
ModelsExpand Collapse
SentMessage object { id, created_at, delivery_status, 7 more } A message that was sent (used in CreateChat and SendMessage responses)
A message that was sent (used in CreateChat and SendMessage responses)
DEPRECATED: Use delivery_status == "read" instead. Whether the message has been read.
parts: array of TextPartResponse { reactions, type, value } or MediaPartResponse { id, filename, mime_type, 4 more } or LinkPartResponse { reactions, type, value } Message parts in order (text, media, and link)
Message parts in order (text, media, and link)
TextPartResponse object { reactions, type, value } A text message part
A text message part
Reactions on this message part
Reactions on this message part
Messaging service type. Where this names the transport a message used,
it is per-message: a chat’s own service can differ from a message in
it, and a conversation can fall back from RCS to SMS.
Messaging service type. Where this names the transport a message used,
it is per-message: a chat’s own service can differ from a message in
it, and a conversation can fall back from RCS to SMS.
line_type: optional "iMessage" or "RCS"The kind of line: iMessage for an iMessage-capable line, RCS for an
RCS-only line, which sends RCS and SMS but never iMessage. Same values as
the type parameter on GET /v3/available_number. A property of the line
itself, so unlike service it does not change with the conversation:
an iMessage-capable line can still carry an RCS or SMS conversation.
The kind of line: iMessage for an iMessage-capable line, RCS for an
RCS-only line, which sends RCS and SMS but never iMessage. Same values as
the type parameter on GET /v3/available_number. A property of the line
itself, so unlike service it does not change with the conversation:
an iMessage-capable line can still carry an RCS or SMS conversation.
Type of reaction. Standard reactions are love, like, dislike, laugh, emphasize, question.
Custom reactions have type “custom” with the actual emoji in the custom_emoji field.
Type of reaction. Standard reactions are love, like, dislike, laugh, emphasize, question. Custom reactions have type “custom” with the actual emoji in the custom_emoji field.
MediaPartResponse object { id, filename, mime_type, 4 more } A media attachment part
A media attachment part
Reactions on this message part
Reactions on this message part
Messaging service type. Where this names the transport a message used,
it is per-message: a chat’s own service can differ from a message in
it, and a conversation can fall back from RCS to SMS.
Messaging service type. Where this names the transport a message used,
it is per-message: a chat’s own service can differ from a message in
it, and a conversation can fall back from RCS to SMS.
line_type: optional "iMessage" or "RCS"The kind of line: iMessage for an iMessage-capable line, RCS for an
RCS-only line, which sends RCS and SMS but never iMessage. Same values as
the type parameter on GET /v3/available_number. A property of the line
itself, so unlike service it does not change with the conversation:
an iMessage-capable line can still carry an RCS or SMS conversation.
The kind of line: iMessage for an iMessage-capable line, RCS for an
RCS-only line, which sends RCS and SMS but never iMessage. Same values as
the type parameter on GET /v3/available_number. A property of the line
itself, so unlike service it does not change with the conversation:
an iMessage-capable line can still carry an RCS or SMS conversation.
Type of reaction. Standard reactions are love, like, dislike, laugh, emphasize, question.
Custom reactions have type “custom” with the actual emoji in the custom_emoji field.
Type of reaction. Standard reactions are love, like, dislike, laugh, emphasize, question. Custom reactions have type “custom” with the actual emoji in the custom_emoji field.
LinkPartResponse object { reactions, type, value } A rich link preview part
A rich link preview part
Reactions on this message part
Reactions on this message part
Messaging service type. Where this names the transport a message used,
it is per-message: a chat’s own service can differ from a message in
it, and a conversation can fall back from RCS to SMS.
Messaging service type. Where this names the transport a message used,
it is per-message: a chat’s own service can differ from a message in
it, and a conversation can fall back from RCS to SMS.
line_type: optional "iMessage" or "RCS"The kind of line: iMessage for an iMessage-capable line, RCS for an
RCS-only line, which sends RCS and SMS but never iMessage. Same values as
the type parameter on GET /v3/available_number. A property of the line
itself, so unlike service it does not change with the conversation:
an iMessage-capable line can still carry an RCS or SMS conversation.
The kind of line: iMessage for an iMessage-capable line, RCS for an
RCS-only line, which sends RCS and SMS but never iMessage. Same values as
the type parameter on GET /v3/available_number. A property of the line
itself, so unlike service it does not change with the conversation:
an iMessage-capable line can still carry an RCS or SMS conversation.
Type of reaction. Standard reactions are love, like, dislike, laugh, emphasize, question.
Custom reactions have type “custom” with the actual emoji in the custom_emoji field.
Type of reaction. Standard reactions are love, like, dislike, laugh, emphasize, question. Custom reactions have type “custom” with the actual emoji in the custom_emoji field.
The sender of this message as a full handle object
The sender of this message as a full handle object
Messaging service type. Where this names the transport a message used,
it is per-message: a chat’s own service can differ from a message in
it, and a conversation can fall back from RCS to SMS.
Messaging service type. Where this names the transport a message used,
it is per-message: a chat’s own service can differ from a message in
it, and a conversation can fall back from RCS to SMS.
line_type: optional "iMessage" or "RCS"The kind of line: iMessage for an iMessage-capable line, RCS for an
RCS-only line, which sends RCS and SMS but never iMessage. Same values as
the type parameter on GET /v3/available_number. A property of the line
itself, so unlike service it does not change with the conversation:
an iMessage-capable line can still carry an RCS or SMS conversation.
The kind of line: iMessage for an iMessage-capable line, RCS for an
RCS-only line, which sends RCS and SMS but never iMessage. Same values as
the type parameter on GET /v3/available_number. A property of the line
itself, so unlike service it does not change with the conversation:
an iMessage-capable line can still carry an RCS or SMS conversation.
MessageSendResponse object { chat_id, message } Response for sending a message to a chat
Response for sending a message to a chat
A message that was sent (used in CreateChat and SendMessage responses)
A message that was sent (used in CreateChat and SendMessage responses)
DEPRECATED: Use delivery_status == "read" instead. Whether the message has been read.
parts: array of TextPartResponse { reactions, type, value } or MediaPartResponse { id, filename, mime_type, 4 more } or LinkPartResponse { reactions, type, value } Message parts in order (text, media, and link)
Message parts in order (text, media, and link)
TextPartResponse object { reactions, type, value } A text message part
A text message part
Reactions on this message part
Reactions on this message part
Messaging service type. Where this names the transport a message used,
it is per-message: a chat’s own service can differ from a message in
it, and a conversation can fall back from RCS to SMS.
Messaging service type. Where this names the transport a message used,
it is per-message: a chat’s own service can differ from a message in
it, and a conversation can fall back from RCS to SMS.
line_type: optional "iMessage" or "RCS"The kind of line: iMessage for an iMessage-capable line, RCS for an
RCS-only line, which sends RCS and SMS but never iMessage. Same values as
the type parameter on GET /v3/available_number. A property of the line
itself, so unlike service it does not change with the conversation:
an iMessage-capable line can still carry an RCS or SMS conversation.
The kind of line: iMessage for an iMessage-capable line, RCS for an
RCS-only line, which sends RCS and SMS but never iMessage. Same values as
the type parameter on GET /v3/available_number. A property of the line
itself, so unlike service it does not change with the conversation:
an iMessage-capable line can still carry an RCS or SMS conversation.
Type of reaction. Standard reactions are love, like, dislike, laugh, emphasize, question.
Custom reactions have type “custom” with the actual emoji in the custom_emoji field.
Type of reaction. Standard reactions are love, like, dislike, laugh, emphasize, question. Custom reactions have type “custom” with the actual emoji in the custom_emoji field.
MediaPartResponse object { id, filename, mime_type, 4 more } A media attachment part
A media attachment part
Reactions on this message part
Reactions on this message part
Messaging service type. Where this names the transport a message used,
it is per-message: a chat’s own service can differ from a message in
it, and a conversation can fall back from RCS to SMS.
Messaging service type. Where this names the transport a message used,
it is per-message: a chat’s own service can differ from a message in
it, and a conversation can fall back from RCS to SMS.
line_type: optional "iMessage" or "RCS"The kind of line: iMessage for an iMessage-capable line, RCS for an
RCS-only line, which sends RCS and SMS but never iMessage. Same values as
the type parameter on GET /v3/available_number. A property of the line
itself, so unlike service it does not change with the conversation:
an iMessage-capable line can still carry an RCS or SMS conversation.
The kind of line: iMessage for an iMessage-capable line, RCS for an
RCS-only line, which sends RCS and SMS but never iMessage. Same values as
the type parameter on GET /v3/available_number. A property of the line
itself, so unlike service it does not change with the conversation:
an iMessage-capable line can still carry an RCS or SMS conversation.
Type of reaction. Standard reactions are love, like, dislike, laugh, emphasize, question.
Custom reactions have type “custom” with the actual emoji in the custom_emoji field.
Type of reaction. Standard reactions are love, like, dislike, laugh, emphasize, question. Custom reactions have type “custom” with the actual emoji in the custom_emoji field.
LinkPartResponse object { reactions, type, value } A rich link preview part
A rich link preview part
Reactions on this message part
Reactions on this message part
Messaging service type. Where this names the transport a message used,
it is per-message: a chat’s own service can differ from a message in
it, and a conversation can fall back from RCS to SMS.
Messaging service type. Where this names the transport a message used,
it is per-message: a chat’s own service can differ from a message in
it, and a conversation can fall back from RCS to SMS.
line_type: optional "iMessage" or "RCS"The kind of line: iMessage for an iMessage-capable line, RCS for an
RCS-only line, which sends RCS and SMS but never iMessage. Same values as
the type parameter on GET /v3/available_number. A property of the line
itself, so unlike service it does not change with the conversation:
an iMessage-capable line can still carry an RCS or SMS conversation.
The kind of line: iMessage for an iMessage-capable line, RCS for an
RCS-only line, which sends RCS and SMS but never iMessage. Same values as
the type parameter on GET /v3/available_number. A property of the line
itself, so unlike service it does not change with the conversation:
an iMessage-capable line can still carry an RCS or SMS conversation.
Type of reaction. Standard reactions are love, like, dislike, laugh, emphasize, question.
Custom reactions have type “custom” with the actual emoji in the custom_emoji field.
Type of reaction. Standard reactions are love, like, dislike, laugh, emphasize, question. Custom reactions have type “custom” with the actual emoji in the custom_emoji field.
The sender of this message as a full handle object
The sender of this message as a full handle object
Messaging service type. Where this names the transport a message used,
it is per-message: a chat’s own service can differ from a message in
it, and a conversation can fall back from RCS to SMS.
Messaging service type. Where this names the transport a message used,
it is per-message: a chat’s own service can differ from a message in
it, and a conversation can fall back from RCS to SMS.
line_type: optional "iMessage" or "RCS"The kind of line: iMessage for an iMessage-capable line, RCS for an
RCS-only line, which sends RCS and SMS but never iMessage. Same values as
the type parameter on GET /v3/available_number. A property of the line
itself, so unlike service it does not change with the conversation:
an iMessage-capable line can still carry an RCS or SMS conversation.
The kind of line: iMessage for an iMessage-capable line, RCS for an
RCS-only line, which sends RCS and SMS but never iMessage. Same values as
the type parameter on GET /v3/available_number. A property of the line
itself, so unlike service it does not change with the conversation:
an iMessage-capable line can still carry an RCS or SMS conversation.