RCS User Action

RcsInboundUserActionWebhook is sent to the account-level URL configured for the RcsInboundUserAction type when a user has acted over a suggestion sent with an RCS outbound message.

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.

RCS inbound user action event.

type*string

Webhook type. Possible values:

TcrCampaignImported: Notifies that new campaign was imported from TCR. This webhook is configured at company level via webhook subscription.
PhoneNumberStatusChanged: Notifies that phone number changed its status. This webhook is configured at company level via webhook subscription.
PhoneNumberVoiceStatusChanged: Phone number voice status changed. This webhook is configured at company level via webhook subscription.
TrafficLimitAlert: Traffic limit alert. This webhook is configured at company level via webhook subscription.
InboundCallReceived: Inbound call received. This webhook is configured at company level via webhook subscription.
InboundCallReceivedFallback: Inbound call received fallback. This webhook is configured at company level via webhook subscription.
CallStatusChanged: Call status changed. This webhook is configured at company level via webhook subscription.
CallRecordingCompleted: Call recording completed and available for download. This webhook is configured at company level via webhook subscription.
OutboundMessageStatusChanged: Outbound message status is changed. This webhook is configured at messaging config level.
InboundMessageReceived: Inbound message is received. This webhook is configured at messaging config level.
OptInOutReceived: Opt-in or opt-out is received. This webhook is configured at messaging config level.
RcsOutboundMessageStatusChanged: RCS outbound message status changed. This webhook is configured at company level via webhook subscription.
RcsInboundMessageReceived: RCS inbound message received. This webhook is configured at company level via webhook subscription.
RcsInboundUserAction: User has acted over a suggestion sent with the RCS message. This webhook is configured at company level via webhook subscription.
RcsMessageSeen: The recipient device confirmed that an RCS outbound message was seen. This webhook is configured at company level via webhook subscription.
RcsTypingIndicator: End user started typing in an RCS conversation. This webhook is configured at company level via webhook subscription.

Value in

"TcrCampaignImported"
"PhoneNumberStatusChanged"
"PhoneNumberVoiceStatusChanged"
"TrafficLimitAlert"
"InboundCallReceived"
"InboundCallReceivedFallback"
"CallStatusChanged"
"CallRecordingCompleted"
"OutboundMessageStatusChanged"
"InboundMessageReceived"
"OptInOutReceived"
"RcsOutboundMessageStatusChanged"
"RcsInboundMessageReceived"
"RcsInboundUserAction"
"RcsMessageSeen"
"RcsTypingIndicator"

sid*string

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

Length1 <= length

Example"WH08dba8f78b5eabd733eba3812a614e8e8257628ef32c888b"

payload*

Webhook payload.

Response Body

curl -X POST "https://example.com/v1/Webhooks/RcsInboundUserActionWebhook" \  -H "Content-Type: application/json" \  -d '{    "type": "RcsInboundUserAction",    "sid": "WH08df051c8bb96203d0df5ed6c838161b2c501f5578f0af07",    "payload": {      "sid": "ROXXXXXXXX",      "from": "+19876543210",      "agentId": "MyAgent",      "eventDate": "2023-03-22T16:44:55.123Z",      "type": "Suggestion",      "text": "Reply suggestion text",      "postbackData": "PostbackData specified for the reply suggestion"    }  }'

Empty

RCS User Action

Authorization

Request Body

Response Body

200