|
| 1 | +--- |
| 2 | +title: Sendblue |
| 3 | +description: Send and receive iMessage and SMS |
| 4 | +--- |
| 5 | + |
| 6 | +import { BlockInfoCard } from "@/components/ui/block-info-card" |
| 7 | + |
| 8 | +<BlockInfoCard |
| 9 | + type="sendblue" |
| 10 | + color="#008BFF" |
| 11 | +/> |
| 12 | + |
| 13 | +{/* MANUAL-CONTENT-START:intro */} |
| 14 | +## Manual Description |
| 15 | + |
| 16 | +Sendblue connects your agents to iMessage and SMS through your own dedicated phone number. Use it to text one person or a group, attach images and other media, check whether a number can receive iMessage before you send, show a typing indicator, and look up the delivery status of any message. |
| 17 | + |
| 18 | +Authentication uses a Sendblue **API Key ID** and **API Secret Key**, sent as the `sb-api-key-id` and `sb-api-secret-key` headers. You can find both in your [Sendblue dashboard](https://dashboard.sendblue.com). Every message is sent from one of your registered Sendblue lines, supplied as the **From Number** in E.164 format (for example `+15551234567`). |
| 19 | + |
| 20 | +**Operations** |
| 21 | + |
| 22 | +- **Send Message** — send an iMessage or SMS to a single recipient. Provide message text, a media URL, or both, and optionally apply an iMessage expressive style (celebration, fireworks, lasers, confetti, and more). |
| 23 | +- **Send Group Message** — send to multiple recipients at once. Pass one recipient per line; reuse the returned `group_id` to keep replying in the same thread. |
| 24 | +- **Evaluate Service** — check whether a number is reachable on iMessage or only SMS, so you can branch before sending. |
| 25 | +- **Send Typing Indicator** — show a recipient that a reply is being composed (one-to-one chats only). |
| 26 | +- **Get Message** — retrieve a single message and its current status by message handle. |
| 27 | + |
| 28 | +**Triggers** |
| 29 | + |
| 30 | +- **Message Received** — fires on every inbound message. Configure it as the **Receive** webhook in your Sendblue dashboard. |
| 31 | +- **Message Status Updated** — fires when an outbound message changes state (`SENT`, `DELIVERED`, `ERROR`). Configure it as the **Outbound** webhook, or pass its URL per message as `status_callback`. |
| 32 | + |
| 33 | +Each trigger generates its own webhook URL — paste the matching URL into the corresponding field in your Sendblue dashboard. |
| 34 | +{/* MANUAL-CONTENT-END */} |
| 35 | + |
| 36 | + |
| 37 | +## Usage Instructions |
| 38 | + |
| 39 | +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. |
| 40 | + |
| 41 | + |
| 42 | + |
| 43 | +## Tools |
| 44 | + |
| 45 | +### `sendblue_send_message` |
| 46 | + |
| 47 | +Send an iMessage or SMS to a single recipient via Sendblue. |
| 48 | + |
| 49 | +#### Input |
| 50 | + |
| 51 | +| Parameter | Type | Required | Description | |
| 52 | +| --------- | ---- | -------- | ----------- | |
| 53 | +| `number` | string | Yes | Recipient phone number in E.164 format \(e.g., +19998887777\) | |
| 54 | +| `from_number` | string | Yes | One of your registered Sendblue phone numbers to send from, in E.164 format \(e.g., +18887776666\) | |
| 55 | +| `content` | string | No | Message text content. Either content or media_url must be provided. | |
| 56 | +| `media_url` | string | No | URL of a media file to send. Either content or media_url must be provided. | |
| 57 | +| `send_style` | string | No | iMessage expressive style \(e.g., celebration, fireworks, lasers, confetti, balloons, invisible, slam\). | |
| 58 | +| `status_callback` | string | No | Webhook URL that Sendblue will POST message status updates to. | |
| 59 | + |
| 60 | +#### Output |
| 61 | + |
| 62 | +| Parameter | Type | Description | |
| 63 | +| --------- | ---- | ----------- | |
| 64 | +| `status` | string | Message status: QUEUED, SENT, DELIVERED, or ERROR | |
| 65 | +| `message_handle` | string | Unique identifier for tracking the message | |
| 66 | +| `account_email` | string | Email of the account that sent the message | |
| 67 | +| `content` | string | Message content | |
| 68 | +| `is_outbound` | boolean | Whether this is an outbound message | |
| 69 | +| `from_number` | string | Sending phone number | |
| 70 | +| `number` | string | Recipient phone number | |
| 71 | +| `media_url` | string | URL of attached media | |
| 72 | +| `send_style` | string | iMessage expressive style applied | |
| 73 | +| `seat_id` | string | UUID of the seat that sent the message | |
| 74 | +| `sender_email` | string | Email of the seat \(user\) that sent the message | |
| 75 | +| `error_code` | number | Numeric error code if the message failed | |
| 76 | +| `error_message` | string | Error message if the message failed | |
| 77 | +| `date_created` | string | When the message was created | |
| 78 | +| `date_updated` | string | When the message was last updated | |
| 79 | + |
| 80 | +### `sendblue_send_group_message` |
| 81 | + |
| 82 | +Send an iMessage or SMS to a group of recipients via Sendblue. |
| 83 | + |
| 84 | +#### Input |
| 85 | + |
| 86 | +| Parameter | Type | Required | Description | |
| 87 | +| --------- | ---- | -------- | ----------- | |
| 88 | +| `numbers` | array | Yes | Recipient phone numbers in E.164 format \(e.g., \["+19998887777", "+13334445555"\]\) | |
| 89 | +| `from_number` | string | Yes | One of your registered Sendblue phone numbers to send from, in E.164 format \(e.g., +18887776666\) | |
| 90 | +| `content` | string | No | Message text content. Either content or media_url must be provided. | |
| 91 | +| `media_url` | string | No | URL of a media file to send. Either content or media_url must be provided. | |
| 92 | +| `send_style` | string | No | iMessage expressive style \(e.g., celebration, fireworks, lasers, confetti, balloons, invisible, slam\). | |
| 93 | +| `group_id` | string | No | Unique identifier of an existing group to send to. Omit to start a new group. | |
| 94 | +| `status_callback` | string | No | Webhook URL that Sendblue will POST message status updates to. | |
| 95 | + |
| 96 | +#### Output |
| 97 | + |
| 98 | +| Parameter | Type | Description | |
| 99 | +| --------- | ---- | ----------- | |
| 100 | +| `status` | string | Message status: QUEUED, SENT, DELIVERED, or ERROR | |
| 101 | +| `message_handle` | string | Unique identifier for tracking the message | |
| 102 | +| `group_id` | string | Identifier of the group the message was sent to | |
| 103 | +| `participants` | array | Phone numbers participating in the group | |
| 104 | +| `account_email` | string | Email of the account that sent the message | |
| 105 | +| `content` | string | Message content | |
| 106 | +| `is_outbound` | boolean | Whether this is an outbound message | |
| 107 | +| `from_number` | string | Sending phone number | |
| 108 | +| `number` | string | Recipient phone number | |
| 109 | +| `media_url` | string | URL of attached media | |
| 110 | +| `send_style` | string | iMessage expressive style applied | |
| 111 | +| `seat_id` | string | UUID of the seat that sent the message | |
| 112 | +| `sender_email` | string | Email of the seat \(user\) that sent the message | |
| 113 | +| `error_code` | number | Numeric error code if the message failed | |
| 114 | +| `error_message` | string | Error message if the message failed | |
| 115 | +| `date_created` | string | When the message was created | |
| 116 | +| `date_updated` | string | When the message was last updated | |
| 117 | + |
| 118 | +### `sendblue_evaluate_service` |
| 119 | + |
| 120 | +Check whether a phone number can receive iMessage or only SMS. |
| 121 | + |
| 122 | +#### Input |
| 123 | + |
| 124 | +| Parameter | Type | Required | Description | |
| 125 | +| --------- | ---- | -------- | ----------- | |
| 126 | +| `number` | string | Yes | Phone number to evaluate, in E.164 format \(e.g., +19998887777\) | |
| 127 | + |
| 128 | +#### Output |
| 129 | + |
| 130 | +| Parameter | Type | Description | |
| 131 | +| --------- | ---- | ----------- | |
| 132 | +| `number` | string | The evaluated phone number in E.164 format | |
| 133 | +| `service` | string | The service the number supports: iMessage or SMS | |
| 134 | + |
| 135 | +### `sendblue_send_typing_indicator` |
| 136 | + |
| 137 | +Display a typing indicator to a recipient (not supported in group chats). |
| 138 | + |
| 139 | +#### Input |
| 140 | + |
| 141 | +| Parameter | Type | Required | Description | |
| 142 | +| --------- | ---- | -------- | ----------- | |
| 143 | +| `number` | string | Yes | Recipient's phone number in E.164 format \(e.g., +19998887777\) | |
| 144 | +| `from_number` | string | No | Your Sendblue line number to send from, in E.164 format. | |
| 145 | + |
| 146 | +#### Output |
| 147 | + |
| 148 | +| Parameter | Type | Description | |
| 149 | +| --------- | ---- | ----------- | |
| 150 | +| `status` | string | Delivery status of the typing indicator \(e.g., QUEUED\) | |
| 151 | +| `status_code` | number | Numeric status code returned by Sendblue | |
| 152 | +| `number` | string | The recipient phone number | |
| 153 | +| `error_message` | string | Error details, null on success | |
| 154 | + |
| 155 | +### `sendblue_get_message` |
| 156 | + |
| 157 | +Retrieve a single message and its current status by message handle/ID. |
| 158 | + |
| 159 | +#### Input |
| 160 | + |
| 161 | +| Parameter | Type | Required | Description | |
| 162 | +| --------- | ---- | -------- | ----------- | |
| 163 | +| `message_id` | string | Yes | The message handle/ID returned when the message was sent. | |
| 164 | + |
| 165 | +#### Output |
| 166 | + |
| 167 | +| Parameter | Type | Description | |
| 168 | +| --------- | ---- | ----------- | |
| 169 | +| `status` | string | Current message status | |
| 170 | +| `message_handle` | string | Unique message identifier | |
| 171 | +| `account_email` | string | Email of the account | |
| 172 | +| `content` | string | Message content | |
| 173 | +| `is_outbound` | boolean | Whether the message is outbound | |
| 174 | +| `from_number` | string | Sending phone number | |
| 175 | +| `number` | string | Recipient phone number | |
| 176 | +| `to_number` | string | Destination phone number | |
| 177 | +| `media_url` | string | URL of attached media | |
| 178 | +| `message_type` | string | Message category: message or group | |
| 179 | +| `service` | string | Messaging service: iMessage, SMS, or RCS | |
| 180 | +| `group_id` | string | Group identifier \(empty for non-group\) | |
| 181 | +| `group_display_name` | string | Group chat name | |
| 182 | +| `participants` | array | Participant phone numbers | |
| 183 | +| `send_style` | string | Expressive style applied | |
| 184 | +| `was_downgraded` | boolean | True if the recipient lacks iMessage support | |
| 185 | +| `opted_out` | boolean | True if the recipient has opted out | |
| 186 | +| `plan` | string | Account plan type | |
| 187 | +| `sendblue_number` | string | Sendblue phone number used | |
| 188 | +| `seat_id` | string | Seat UUID | |
| 189 | +| `sender_email` | string | Email of the sending seat | |
| 190 | +| `error_code` | number | Numeric error code if failed | |
| 191 | +| `error_message` | string | Error message if failed | |
| 192 | +| `error_reason` | string | Additional error context | |
| 193 | +| `error_detail` | string | Detailed error information | |
| 194 | +| `date_sent` | string | ISO 8601 creation timestamp | |
| 195 | +| `date_updated` | string | ISO 8601 last-update timestamp | |
| 196 | + |
| 197 | + |
0 commit comments