Receiving Messages
caution
A client must be registered by sending them the first texts before their texts will be routed to you.
Need receive-first texting? Talk to us about our dedicated plans.
Receiving Messages
In order to enable receiving messages, you have to specify the webhooks that you want to use in your api dashboard.
Received Messages will be sent as a POST request to the webhook which you define. These messages will be delivered in the JSON of a POST body which looks like this:
{
"content": "Ahoy Developer!",
"is_outbound": false,
"status": "RECEIVED",
"error_code": null,
"error_message": null,
"message_handle": "xxxxx",
"date_sent": "2020-09-10T06:15:05.962Z",
"date_updated": "2020-09-10T06:15:05.962Z",
"from_number": "+19998887777",
"number": "+19998887777",
"to_number": "+15122164639",
"was_downgraded": false,
"plan": "blue"
}
important
You must send a response to our server in order to avoid receiving multiple webhook calls.
Webhook Body Parsing
| Callback Body Field | Type | Description |
|---|---|---|
| accountEmail | string | Associated account email |
| content | string | Message content |
| is_outbound | boolean | True if message is sent, false if message is received |
| status | string | The current status of the message |
| error_code | int | error code (null if no error) |
| error_message | string | descriptive error message (null if no error) |
| message_handle | string | Sendblue message handle |
| date_sent | string | ISO 8601 formatted date string of the date this message was created |
| date_updated | string | ISO 8601 formatted date string of the date this message was last updated |
| from_number | string | E.164 formatted phone number string of the message dispatcher |
| number | string | E.164 formatted phone number string of your end-user (not the Sendblue-provided phone number) |
| to_number | string | E.164 formatted phone number string of the message recipient |
| was_downgraded | boolean | true if the end user does not support iMessage, false otherwise |
| plan | string | Value of the Sendblue account plan |