Messages

API Reference

Messages

Get message status

client.messages.getStatus(MessageGetStatusParams { handle } query, RequestOptionsoptions?): MessageResponse { account_email, content, date_created, 10 more }

get/api/status

Get messages

client.messages.list(MessageListParams { account_email, created_at_gte, created_at_lte, 16 more } query?, RequestOptionsoptions?): MessageListResponse { data, pagination, status }

get/api/v2/messages

Get a specific message

client.messages.retrieve(stringmessageID, RequestOptionsoptions?): MessageRetrieveResponse { data, status }

get/api/v2/messages/{message_id}

Send a message

client.messages.send(MessageSendParams { content, from_number, number, 3 more } body, RequestOptionsoptions?): MessageResponse { account_email, content, date_created, 10 more }

post/api/send-message

ModelsExpand Collapse

MessageContent { account_email, content, date_created, 9 more }

account_email?: string

Email of the account

content?: string

Message content

date_created?: string

When the message was created

formatdate-time

date_sent?: string

When the message was sent

formatdate-time

date_updated?: string

When the message was last updated

formatdate-time

from_number?: string

Sender phone number

is_outbound?: boolean

Whether this is an outbound message

media_url?: string

URL of attached media

message_handle?: string

Unique message identifier

send_style?: "celebration" | "shooting_star" | "fireworks" | 10 more

Accepts one of the following:

"celebration"

"shooting_star"

"fireworks"

"lasers"

"love"

"confetti"

"balloons"

"spotlight"

"echo"

"invisible"

"gentle"

"loud"

"slam"

status?: "QUEUED" | "SENT" | "DELIVERED" | 3 more

Accepts one of the following:

"QUEUED"

"SENT"

"DELIVERED"

"READ"

"ERROR"

"RECEIVED"

to_number?: string

Recipient phone number

MessageResponse { account_email, content, date_created, 10 more }

account_email?: string

Email of the account that sent the message

content?: string

Message content

date_created?: string

When the message was created

formatdate-time

date_updated?: string

When the message was last updated

formatdate-time

error_code?: number

Numeric error code if message failed

error_message?: string

Error message if message failed

from_number?: string

Sending phone number

is_outbound?: boolean

Whether this is an outbound message

media_url?: string

URL of attached media

message_handle?: string

Unique identifier for tracking the message

number?: string

Recipient phone number

send_style?: "celebration" | "shooting_star" | "fireworks" | 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?: "QUEUED" | "SENT" | "DELIVERED" | 2 more

Accepts one of the following:

"QUEUED"

"SENT"

"DELIVERED"

"READ"

"ERROR"