Type Alias ClientMessageRequest

Type Declaration

• Optionalbiz_opaque_callback_data?: string

  An arbitrary 512B string, useful for tracking.

  Any app subscribed to the messages webhook field on the WhatsApp Business Account can get this string, as it is included in statuses object within webhook payloads.

  Cloud API does not process this field, it just returns it as part of sent/delivered/read message webhooks.

• Optionalcontext?: { message_id: string }

  The message to reply to

  • message_id: string

    The message id to reply to

• messaging_product: "whatsapp"

  The messaging product

• Optionalrecipient?: string

  The user's BSUID

• Optionalrecipient_identity_key_hash?: string

  The recipient's identity key hash, used to detect profile changes by the user. If provided, the API will not deliver if the server hash doesn't match.

  See

  https://developers.facebook.com/documentation/business-messaging/whatsapp/business-phone-numbers/phone-numbers#identity-change-check

• Optionalrecipient_type?: "individual" | "group"

  Either an individual or a group message, defaults to "individual"

• Optionalto?: string

  The user's phone number (takes precedence over recipient)

• { text: Text; type: "text" }
• { audio: Audio; type: "audio" }
• { document: Document; type: "document" }
• { image: Image; type: "image" }
• { sticker: Sticker; type: "sticker" }
• { type: "video"; video: Video }
• { location: Location; type: "location" }
• { contacts: Contacts; type: "contacts" }
• { interactive: Interactive; type: "interactive" }
• { template: Template; type: "template" }
• { reaction: Reaction; type: "reaction" }