Skip to content

TwilioRichMessageParams

Defined in: lib/webhook/twilio-webhook.payloads.ts:137

Parameters Twilio adds for rich messaging: buttons, flows and channel-specific payloads.

InteractiveData, FlowData and ChannelMetadata arrive as stringified JSON; parse them before use.

Property Modifier Type Description Defined in
ButtonPayload? readonly string Postback payload identifying which button was pressed. lib/webhook/twilio-webhook.payloads.ts:139
ButtonText? readonly string Visible label of the pressed button, e.g. 'Cancel Appointment'. lib/webhook/twilio-webhook.payloads.ts:141
ButtonType? readonly string Button category: 'REPLY' or 'ACTION'. lib/webhook/twilio-webhook.payloads.ts:143
ChannelMetadata? readonly string Stringified JSON: the full response from the rich-messaging channel. lib/webhook/twilio-webhook.payloads.ts:149
FlowData? readonly string Stringified JSON payload returned after a WhatsApp flow completes. lib/webhook/twilio-webhook.payloads.ts:147
InteractiveData? readonly string Stringified JSON holding an omnichannel rich-feature response. lib/webhook/twilio-webhook.payloads.ts:145