Messages

API Reference

Messages

Messages

Get message status

client.messages.getStatus(MessageGetStatusParamsquery, RequestOptionsoptions?): account_emailstringcontentstringdate_createdstringdate_updatedstringerror_codenumbererror_messagestringfrom_numberstringis_outboundbooleanmedia_urlstringmessage_handlestringnumberstringsend_styleunionstatusunionMessageResponse

get/api/status

Get messages

client.messages.list(MessageListParamsquery?, RequestOptionsoptions?): dataarraypaginationPaginationstatusstringMessageListResponse

get/api/v2/messages

Get a specific message

client.messages.retrieve(stringmessageID, RequestOptionsoptions?): dataDatastatusstringMessageRetrieveResponse

get/api/v2/messages/{message_id}

Send a message

client.messages.send(MessageSendParamsbody, RequestOptionsoptions?): account_emailstringcontentstringdate_createdstringdate_updatedstringerror_codenumbererror_messagestringfrom_numberstringis_outboundbooleanmedia_urlstringmessage_handlestringnumberstringsend_styleunionstatusunionMessageResponse

post/api/send-message

Message Content

MessageContent

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_styleunion

optional

"celebration" | "shooting_star" | "fireworks" | 10 more

Hide ParametersShow Parameters

"celebration"

"shooting_star"

"fireworks"

"lasers"

"love"

"confetti"

"balloons"

"spotlight"

"echo"

"invisible"

"gentle"

"loud"

"slam"

statusunion

optional

"QUEUED" | "SENT" | "DELIVERED" | 3 more

Hide ParametersShow Parameters

"QUEUED"

"SENT"

"DELIVERED"

"READ"

"ERROR"

"RECEIVED"

to_numberstring

optional

Recipient phone number

Message Response

MessageResponse

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_styleunion

optional

"celebration" | "shooting_star" | "fireworks" | 10 more

The iMessage expressive message style

Hide ParametersShow Parameters

"celebration"

"shooting_star"

"fireworks"

"lasers"

"love"

"confetti"

"balloons"

"spotlight"

"echo"

"invisible"

"gentle"

"loud"

"slam"

statusunion

optional

"QUEUED" | "SENT" | "DELIVERED" | 2 more

Hide ParametersShow Parameters

"QUEUED"

"SENT"

"DELIVERED"

"READ"

"ERROR"