Skip to content

Latest commit

 

History

History
24 lines (21 loc) · 3.69 KB

File metadata and controls

24 lines (21 loc) · 3.69 KB

# SendInboxMessageRequest

Properties

Name Type Description Notes
account_id string Social account ID
message string Message text [optional]
attachment_url string URL of the attachment to send (image, video, audio, or file). The URL must be publicly accessible. For binary file uploads, use multipart/form-data instead. [optional]
attachment_type string Type of attachment. Defaults to file if not specified. [optional]
attachment_name string WhatsApp only. Display name for a document sent via attachmentUrl with attachmentType: file (e.g. "Report.pdf"). Maps to the recipient's file name; without it WhatsApp derives the name from the URL and shows "Untitled". Ignored for image/video/audio and for binary uploads (which use the uploaded file's name). [optional]
voice_note bool WhatsApp only. When `true` on an audio attachment, the message is sent as a voice message (PTT) — the recipient sees the waveform + voice-note UI instead of a basic audio attachment. The audio file MUST be `.ogg` encoded with the OPUS codec (mono) per Meta's voice-message contract; other formats are rejected by WhatsApp. Ignored for non-audio attachments. [optional]
quick_replies \Zernio\Model\SendInboxMessageRequestQuickRepliesInner[] Quick reply buttons. Mutually exclusive with buttons. Max 13 items. [optional]
buttons \Zernio\Model\SendInboxMessageRequestButtonsInner[] Action buttons. Mutually exclusive with quickReplies. Max 3 items. WhatsApp: buttons always render as interactive reply buttons. Only `title` and `payload` are used — `type`, `url`, and `phone` are ignored (WhatsApp has no URL/phone button in this field; use the `interactive` field with `type: cta_url` for a link button). `payload` becomes the button reply ID delivered on the `message.received` webhook when the user taps. To send a simple reply-button message, provide `title` + `payload` and set `type: postback`, e.g. `{ "type": "postback", "title": "Yes", "payload": "yes" }`. [optional]
template \Zernio\Model\SendInboxMessageRequestTemplate [optional]
interactive \Zernio\Model\SendInboxMessageRequestInteractive [optional]
reply_markup \Zernio\Model\SendInboxMessageRequestReplyMarkup [optional]
messaging_type string Facebook messaging type. Required when using messageTag. [optional]
message_tag string Facebook message tag for messaging outside 24h window. Requires messagingType MESSAGE_TAG. Instagram only supports HUMAN_AGENT. [optional]
reply_to string Platform message ID to quote-reply to. For WhatsApp, pass the wamid (available in message.platformMessageId from webhooks). For Telegram, pass the Telegram message ID. [optional]
location \Zernio\Model\SendInboxMessageRequestLocation [optional]
contacts \Zernio\Model\SendInboxMessageRequestContactsInner[] WhatsApp-only. Send one or more contact cards. [optional]

[Back to Model list] [Back to API list] [Back to README]