Send and receive iMessage and SMS
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.
Send an iMessage or SMS to a single recipient via Sendblue.
| 参数 | 类型 | 必填 | 描述 |
|---|
number | string | 是 | Recipient phone number in E.164 format (e.g., +19998887777) |
from_number | string | 是 | One of your registered Sendblue phone numbers to send from, in E.164 format (e.g., +18887776666) |
content | string | 否 | Message text content. Either content or media_url must be provided. |
media_url | string | 否 | URL of a media file to send. Either content or media_url must be provided. |
send_style | string | 否 | iMessage expressive style (e.g., celebration, fireworks, lasers, confetti, balloons, invisible, slam). |
status_callback | string | 否 | Webhook URL that Sendblue will POST message status updates to. |
| 参数 | 类型 | 描述 |
|---|
status | string | Message status: QUEUED, SENT, DELIVERED, or ERROR |
message_handle | string | Unique identifier for tracking the message |
account_email | string | Email of the account that sent the message |
content | string | Message content |
is_outbound | boolean | Whether this is an outbound message |
from_number | string | Sending phone number |
number | string | Recipient phone number |
media_url | string | URL of attached media |
send_style | string | iMessage expressive style applied |
seat_id | string | UUID of the seat that sent the message |
sender_email | string | Email of the seat (user) that sent the message |
error_code | number | Numeric error code if the message failed |
error_message | string | Error message if the message failed |
date_created | string | When the message was created |
date_updated | string | When the message was last updated |
Send an iMessage or SMS to a group of recipients via Sendblue.
| 参数 | 类型 | 必填 | 描述 |
|---|
numbers | array | 是 | Recipient phone numbers in E.164 format (e.g., ["+19998887777", "+13334445555"]) |
items | string | 否 | No description |
from_number | string | 是 | One of your registered Sendblue phone numbers to send from, in E.164 format (e.g., +18887776666) |
content | string | 否 | Message text content. Either content or media_url must be provided. |
media_url | string | 否 | URL of a media file to send. Either content or media_url must be provided. |
send_style | string | 否 | iMessage expressive style (e.g., celebration, fireworks, lasers, confetti, balloons, invisible, slam). |
group_id | string | 否 | Unique identifier of an existing group to send to. Omit to start a new group. |
status_callback | string | 否 | Webhook URL that Sendblue will POST message status updates to. |
| 参数 | 类型 | 描述 |
|---|
status | string | Message status: QUEUED, SENT, DELIVERED, or ERROR |
message_handle | string | Unique identifier for tracking the message |
group_id | string | Identifier of the group the message was sent to |
participants | array | Phone numbers participating in the group |
account_email | string | Email of the account that sent the message |
content | string | Message content |
is_outbound | boolean | Whether this is an outbound message |
from_number | string | Sending phone number |
number | string | Recipient phone number |
media_url | string | URL of attached media |
send_style | string | iMessage expressive style applied |
seat_id | string | UUID of the seat that sent the message |
sender_email | string | Email of the seat (user) that sent the message |
error_code | number | Numeric error code if the message failed |
error_message | string | Error message if the message failed |
date_created | string | When the message was created |
date_updated | string | When the message was last updated |
Check whether a phone number can receive iMessage or only SMS.
| 参数 | 类型 | 必填 | 描述 |
|---|
number | string | 是 | Phone number to evaluate, in E.164 format (e.g., +19998887777) |
| 参数 | 类型 | 描述 |
|---|
number | string | The evaluated phone number in E.164 format |
service | string | The service the number supports: iMessage or SMS |
Display a typing indicator to a recipient (not supported in group chats).
| 参数 | 类型 | 必填 | 描述 |
|---|
number | string | 是 | Recipient's phone number in E.164 format (e.g., +19998887777) |
from_number | string | 否 | Your Sendblue line number to send from, in E.164 format. |
| 参数 | 类型 | 描述 |
|---|
status | string | Delivery status of the typing indicator (e.g., QUEUED) |
status_code | number | Numeric status code returned by Sendblue |
number | string | The recipient phone number |
error_message | string | Error details, null on success |
Retrieve a single message and its current status by message handle/ID.
| 参数 | 类型 | 必填 | 描述 |
|---|
message_id | string | 是 | The message handle/ID returned when the message was sent. |
| 参数 | 类型 | 描述 |
|---|
status | string | Current message status |
message_handle | string | Unique message identifier |
account_email | string | Email of the account |
content | string | Message content |
is_outbound | boolean | Whether the message is outbound |
from_number | string | Sending phone number |
number | string | Recipient phone number |
to_number | string | Destination phone number |
media_url | string | URL of attached media |
message_type | string | Message category: message or group |
service | string | Messaging service: iMessage, SMS, or RCS |
group_id | string | Group identifier (empty for non-group) |
group_display_name | string | Group chat name |
participants | array | Participant phone numbers |
send_style | string | Expressive style applied |
was_downgraded | boolean | True if the recipient lacks iMessage support |
opted_out | boolean | True if the recipient has opted out |
plan | string | Account plan type |
sendblue_number | string | Sendblue phone number used |
seat_id | string | Seat UUID |
sender_email | string | Email of the sending seat |
error_code | number | Numeric error code if failed |
error_message | string | Error message if failed |
error_reason | string | Additional error context |
error_detail | string | Detailed error information |
date_sent | string | ISO 8601 creation timestamp |
date_updated | string | ISO 8601 last-update timestamp |