Inbound Message

InboundMessageWebhook is sent to the MessagingConfig.InboundCallbackUrl when an Inbound Message is received for one of your Phone Numbers.

Authorization

basic

AuthorizationBasic <token>

Basic Authorization header using the BASIC scheme. Use a pair companySid:token to access the API.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

WebhookSid*string

Unique identifier of this webhook. This value could be used as an idempotency key when processing this webhook.

Length1 <= length

Example"WH08dba8f78b5eabd733eba3812a614e8e8257628ef32c888b"

Sid*string

Message unique identifier.

Length1 <= length

Example"IM99d9812a055b3da13d3faa216fcf4574b64b19be32626243"

From?|

Sender phone number

Example"+19876543210"

To*string

Recipient phone number

Length1 <= length

Example"+11234567890"

AdditionalRecipients*array<string>

Other recipients phone numbers. Not empty when the message represents a group MMS message.

Example

[  "+11234567891",  "+11234567892"]

EventDate*string

UTC date time of event

Formatdate-time

Text?|

Message text

Example"Glad to see you!"

MediaUrls?array<string>|

Media urls. Used for MMS

Items1 <= items

SegmentCount*integer

Message segment count.

Formatint32

Example1

ConversationMetadata?|

Conversation metadata for this message.

BrandSid?|

TCR Brand SID if the recipient Phone Number was attached to TCR campaign at the receiving moment.

CampaignSid?|

TCR Campaign SID if the recipient Phone Number was attached to TCR campaign at the receiving moment.

MessagingConfigSid?|

Messaging Config SID at message receiving moment.

Response Body

curl -X POST "https://example.com/v1/Webhooks/InboundMessageWebhook" \  -H "Content-Type: application/json" \  -d '{    "WebhookSid": "WH08dba8f78b5eabd733eba3812a614e8e8257628ef32c888b",    "Sid": "IM99d9812a055b3da13d3faa216fcf4574b64b19be32626243",    "From": "+19876543210",    "To": "+11234567890",    "AdditionalRecipients": [      "+11234567891",      "+11234567892"    ],    "EventDate": "2023-09-09T15:00:00.000Z",    "Text": "Glad to see you!",    "MediaUrls": [      "string"    ],    "SegmentCount": 1,    "ConversationMetadata": "string",    "BrandSid": "string",    "CampaignSid": "string",    "MessagingConfigSid": "string"  }'

Empty

Inbound Message

Authorization

Request Body

Response Body

200