Skip to content

SendInboxMessageRequest.md

Latest commit

 

History

History
48 lines (42 loc) · 3.27 KB

SendInboxMessageRequest.md

File metadata and controls

48 lines (42 loc) · 3.27 KB
Raw

Zernio::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 Boolean 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 Array<SendInboxMessageRequestQuickRepliesInner> Quick reply buttons. Mutually exclusive with buttons. Max 13 items. [optional]
buttons Array<SendInboxMessageRequestButtonsInner> Action buttons. Mutually exclusive with quickReplies. Max 3 items. [optional]
template SendInboxMessageRequestTemplate [optional]
interactive SendInboxMessageRequestInteractive [optional]
reply_markup 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 SendInboxMessageRequestLocation [optional]
contacts Array<SendInboxMessageRequestContactsInner> WhatsApp-only. Send one or more contact cards. [optional]

Example

require 'zernio-sdk'

instance = Zernio::SendInboxMessageRequest.new(
  account_id: null,
  message: null,
  attachment_url: null,
  attachment_type: null,
  attachment_name: null,
  voice_note: null,
  quick_replies: null,
  buttons: null,
  template: null,
  interactive: null,
  reply_markup: null,
  messaging_type: null,
  message_tag: null,
  reply_to: null,
  location: null,
  contacts: null
)