AptlyStar

Sendblue

Send and receive iMessage and SMS

Instructions d'utilisation

Send iMessages and SMS to individuals or groups, check whether a number supports iMessage, show typing indicators, and look up message status with Sendblue. Trigger workflows on inbound messages and delivery status updates.

Outils

sendblue_send_message

Send an iMessage or SMS to a single recipient via Sendblue.

Entrée

ParamètreTypeObligatoireDescription
numberstringOuiRecipient phone number in E.164 format (e.g., +19998887777)
from_numberstringOuiOne of your registered Sendblue phone numbers to send from, in E.164 format (e.g., +18887776666)
contentstringNonMessage text content. Either content or media_url must be provided.
media_urlstringNonURL of a media file to send. Either content or media_url must be provided.
send_stylestringNoniMessage expressive style (e.g., celebration, fireworks, lasers, confetti, balloons, invisible, slam).
status_callbackstringNonWebhook URL that Sendblue will POST message status updates to.

Sortie

ParamètreTypeDescription
statusstringMessage status: QUEUED, SENT, DELIVERED, or ERROR
message_handlestringUnique identifier for tracking the message
account_emailstringEmail of the account that sent the message
contentstringMessage content
is_outboundbooleanWhether this is an outbound message
from_numberstringSending phone number
numberstringRecipient phone number
media_urlstringURL of attached media
send_stylestringiMessage expressive style applied
seat_idstringUUID of the seat that sent the message
sender_emailstringEmail of the seat (user) that sent the message
error_codenumberNumeric error code if the message failed
error_messagestringError message if the message failed
date_createdstringWhen the message was created
date_updatedstringWhen the message was last updated

sendblue_send_group_message

Send an iMessage or SMS to a group of recipients via Sendblue.

Entrée

ParamètreTypeObligatoireDescription
numbersarrayOuiRecipient phone numbers in E.164 format (e.g., ["+19998887777", "+13334445555"])
itemsstringNonNo description
from_numberstringOuiOne of your registered Sendblue phone numbers to send from, in E.164 format (e.g., +18887776666)
contentstringNonMessage text content. Either content or media_url must be provided.
media_urlstringNonURL of a media file to send. Either content or media_url must be provided.
send_stylestringNoniMessage expressive style (e.g., celebration, fireworks, lasers, confetti, balloons, invisible, slam).
group_idstringNonUnique identifier of an existing group to send to. Omit to start a new group.
status_callbackstringNonWebhook URL that Sendblue will POST message status updates to.

Sortie

ParamètreTypeDescription
statusstringMessage status: QUEUED, SENT, DELIVERED, or ERROR
message_handlestringUnique identifier for tracking the message
group_idstringIdentifier of the group the message was sent to
participantsarrayPhone numbers participating in the group
account_emailstringEmail of the account that sent the message
contentstringMessage content
is_outboundbooleanWhether this is an outbound message
from_numberstringSending phone number
numberstringRecipient phone number
media_urlstringURL of attached media
send_stylestringiMessage expressive style applied
seat_idstringUUID of the seat that sent the message
sender_emailstringEmail of the seat (user) that sent the message
error_codenumberNumeric error code if the message failed
error_messagestringError message if the message failed
date_createdstringWhen the message was created
date_updatedstringWhen the message was last updated

sendblue_evaluate_service

Check whether a phone number can receive iMessage or only SMS.

Entrée

ParamètreTypeObligatoireDescription
numberstringOuiPhone number to evaluate, in E.164 format (e.g., +19998887777)

Sortie

ParamètreTypeDescription
numberstringThe evaluated phone number in E.164 format
servicestringThe service the number supports: iMessage or SMS

sendblue_send_typing_indicator

Display a typing indicator to a recipient (not supported in group chats).

Entrée

ParamètreTypeObligatoireDescription
numberstringOuiRecipient's phone number in E.164 format (e.g., +19998887777)
from_numberstringNonYour Sendblue line number to send from, in E.164 format.

Sortie

ParamètreTypeDescription
statusstringDelivery status of the typing indicator (e.g., QUEUED)
status_codenumberNumeric status code returned by Sendblue
numberstringThe recipient phone number
error_messagestringError details, null on success

sendblue_get_message

Retrieve a single message and its current status by message handle/ID.

Entrée

ParamètreTypeObligatoireDescription
message_idstringOuiThe message handle/ID returned when the message was sent.

Sortie

ParamètreTypeDescription
statusstringCurrent message status
message_handlestringUnique message identifier
account_emailstringEmail of the account
contentstringMessage content
is_outboundbooleanWhether the message is outbound
from_numberstringSending phone number
numberstringRecipient phone number
to_numberstringDestination phone number
media_urlstringURL of attached media
message_typestringMessage category: message or group
servicestringMessaging service: iMessage, SMS, or RCS
group_idstringGroup identifier (empty for non-group)
group_display_namestringGroup chat name
participantsarrayParticipant phone numbers
send_stylestringExpressive style applied
was_downgradedbooleanTrue if the recipient lacks iMessage support
opted_outbooleanTrue if the recipient has opted out
planstringAccount plan type
sendblue_numberstringSendblue phone number used
seat_idstringSeat UUID
sender_emailstringEmail of the sending seat
error_codenumberNumeric error code if failed
error_messagestringError message if failed
error_reasonstringAdditional error context
error_detailstringDetailed error information
date_sentstringISO 8601 creation timestamp
date_updatedstringISO 8601 last-update timestamp

On this page