Skip to navigation
RCSWebhooks

Suggestion click

Notification of a user interaction with a suggestion of the message (open URL, dial, calendar, location, or a generic click).

The root status is forced to DELIVERED; the real interaction type travels in data.action. data.element_type and data.element_value describe the element the user interacted with; data.message_index is only present when the event applies to a specific card.

Payload

The payload of this webhook request is an object.
originenumOptional

Origin of the message: direct API send (API) or bulk campaign send (CAMPAIGN).

Allowed values:
channelenumOptional

RCS channel of the send, according to the type of the agent/template used.

Allowed values:
message_idstringOptional

The same message_id returned by POST /v1/rcs/messages, except on inbound message events, where it identifies the inbound message itself.

statusenumOptional

Forced to DELIVERED; the real interaction type travels in data.action.

Allowed values:
occurred_atdatetimeOptional
Moment of the event.
timestampstringOptional

Moment of the event as epoch seconds (string). Redundant with occurred_at; use whichever you prefer.

campaign_idstringOptional

Optional. Only present when origin is CAMPAIGN and the message belongs to a campaign; omitted otherwise.

dataobjectOptional

Event-specific content; its shape depends on the event type.

Response

200
Event received by the client.