SendInboxMessageRequestInteractive.md

SendInboxMessageRequestInteractive

WhatsApp-only. Rich interactive payload for list messages, CTA URL buttons, Flow prompts, and location requests. When set, takes priority over buttons and quickReplies. The shape mirrors Meta's Cloud API interactive object verbatim, so any payload that works against Meta directly will also work here. Use buttons / quickReplies for simple button replies (WhatsApp's interactive.type: \"button\") — the abstraction caps at 3 buttons and handles the auto-conversion for you. Use this field only for list, cta_url, flow, location_request_message, or voice_call messages. For voice_call, the message renders WhatsApp's native call button; tapping it starts a voice call to your business number. Requires WhatsApp Business Calling to be enabled on the sending number. The optional parameters.payload string is echoed back on the calls webhook (as cta_payload) for attribution. For location_request_message, action may be omitted (we default it to { \"name\": \"send_location\" }). WhatsApp renders a localized "Send location" button; the user's reply arrives as a regular location message in the conversation. Tap events come back via the message.received webhook with metadata.interactiveType set to list_reply or nfm_reply.

Properties

Name	Type	Description	Notes
type	TypeEnum	Which interactive layout to render.
header	SendInboxMessageRequestInteractiveHeader		[optional]
body	SendInboxMessageRequestInteractiveBody
footer	SendInboxMessageRequestInteractiveFooter		[optional]
action	SendInboxMessageRequestInteractiveAction		[optional]

Enum: TypeEnum

Name	Value
LIST	"list"
CTA_URL	"cta_url"
FLOW	"flow"
LOCATION_REQUEST_MESSAGE	"location_request_message"
VOICE_CALL	"voice_call"