The button template allows you to send a structured message that includes text and buttons.
The Call Button can be used to initiate a phone call. This button can be used with the Button and Generic Templates.
Add an e-amil quick reply button after an Expression
Annotate all the children content with the message settings attributes and append quick replies after the content.
The log out button triggers the account unlinking flow.
The game play button launches an Instant Game that is associated with the bot page.
The item of the GenericTemplate.
The generic template allows you to send a structured message that includes an image, text and buttons. A generic template with multiple templates described in the elements array will send a horizontally scrollable carousel of items, each composed of an image, text and buttons.
The log out button triggers the account unlinking flow.
The receipt template allows you to send an order confirmation as a structured message.
The log in button triggers the account linking authentication flow.
The log out button triggers the account unlinking flow.
Display the confirmation icon.
The media template allows you to send a structured message that includes an image or video, and an optional button.
Pass thread control from your app to another app. The app that will receive thread ownership will receive a pass_thread_control webhook event.
Add an phone quick reply button after an Expression
When the postback button is tapped, the Messenger Platform sends an event to your postback webhook. This is useful when you want to invoke an action in your bot. This button can be used with the Button Template and Generic Template.
The item of ReceiptTemplate
The receipt template allows you to send an order confirmation as a structured message.
The Messenger Platform's One-Time Notification API (Beta) allows a page to request a user to send one follow-up message after 24-hour messaging window have ended. The user will be offered to receive a future notification. Once the user asks to be notified, the page will receive a token which is an equivalent to a permission to send a single message to the user. The token can only be used once and will expire within 1 year of creation.
Ask for control of a specific thread as a Secondary Receiver app. The Primary Receiver app will receive a messaging_handovers webhook event with the request_thread_control property when/request_thread_control` is called.
Take control of a specific thread from a Secondary Receiver app as the Primary Receiver app. The Secondary Receiver app will receive a take_thread_control webhook event when it loses thread control.
Add an text quick reply button with postback payload after an Expression.
Remove the typing bubble.
Display the typing bubble.
The URL Button opens a webpage in the Messenger webview. This button can be used with the Button and Generic Templates.
The log out button triggers the account unlinking flow.
1-3 button elements to append after the text.
Textual node with content up to 640 characters. Text will appear above the buttons.
Format must have "+" prefix followed by the country code, area code and local number.
Button title, 20 character limit.
Content nodes to be annotated.
The messaging type of the message being sent. For more information, see Sending Messages - Messaging Types. Default to 'RESPONSE'.
Custom string that is delivered as a message echo. 1000 character limit.
Push notification type. REGULAR: sound/vibration SILENT_PUSH: on-screen notification only NO_PUSH: no notification Defaults to 'REGULAR'.
The persona id to use.
QuickReply elements to be sent with messages.
The message tag to use when messagingType set to 'MESSAGE_TAG'. For more information, see Message Tags.
Context ID (Instant Game name-space) of the THREAD to play in.
This data will be sent to the game.
Player ID (Instant Game name-space) to play against.
Button title, 20 character limit.
At least one property must be set in addition to title.
Button elements to append to the template. A maximum of 3 buttons is supported.
One UrlButton element to act as the default action executed when the template is tapped.
The URL of the image to display in the template.
The subtitle to display in the template. 80 character limit.
The title to display in the template. 80 character limit.
GenericItem elements under the template. Specifying multiple elements will send a horizontally scrollable carousel of templates. A maximum of 10 elements is supported.
The aspect ratio used to render images specified by element.image_url. Defaults to horizontal.
Texual node to be wrapped in the LATEX block.
Authentication callback URL. Must use HTTPS protocol.
Set to true to make the saved asset sendable to other message recipients. Defaults to false.
Set to true to make the saved asset sendable to other message recipients. Defaults to false.
URL of the file to upload. Max file size is 25MB (after encoding). A Timeout is set to 75 sec for videos and 10 secs for every other file type.
The attachment ID of the image or video. Cannot be used if url is set.
One optional button element to be appended to the template
The type of media being sent
Set to true to enable the native share button in Messenger for the template message. Defaults to false.
The URL of the image. Cannot be used if attachment_id is set.
Metadata passed to the receiving app in the pass_thread_control webhook event.
The app ID to pass thread control to. Required if the Primary Receiver is passing thread control. If the Secondary Receiver is passing thread control, defaults to the app ID of the Primary Receiver. To pass thread control to the Page inbox, use app ID 263902037430900.
This data will be sent back to your webhook. 1000 character limit.
Button title. 20 character limit.
The currency of the item price.
The URL of an image to be displayed with the item.
The price of the item. For free items, '0' is allowed.
The quantity of the item purchased.
The subtitle for the item, usually a brief item description.
The name to display for the item.
The shipping address of the order.
Maximum of 100 {@line ReceiptItem} elements that describe items in the order. Sort order of the elements is not guaranteed.
The currency of the payment.
The merchant's name. If present this is shown as logo text.
The order number. Must be unique.
The payment method used. Providing enough information for the customer to decipher which payment method and account they used is recommended. This can be a custom string, such as, "Visa 1234".
The recipient's name.
Set to true to enable the native share button in Messenger for the template message. Defaults to false.
Optional. The shipping cost of the order.
Optional. The sub-total of the order.
The total cost of the order, including sub-total, shipping, and tax.
Optional. The tax of the order.
Timestamp of the order in seconds.
The data to be posted back with the one_time_notif_optin event.
The title to be displayed in the request message, limited to 65 characters.
Metadata passed back to the primary app in the request_thread_control webhook event.
Metadata passed back to the secondary app in the take_thread_control webhook event.
URL of image to display on the quick reply button for text quick replies. Image should be a minimum of 24px x 24px. Larger images will be automatically cropped and resized. Required if title is an empty string.
Custom data that will be sent back to you via the messaging_postbacks webhook event. 1000 character limit.
The text to display on the quick reply button. 20 character limit.
The URL to use on clients that don't support Messenger Extensions. If this is not defined, the url will be used as the fallback. It may only be specified if messenger_extensions is true.
Set to true to disable the share button in the Webview (for sensitive info)
Must be true if using Messenger Extensions.
Button title. 20 character limit.
This URL is opened in a mobile browser when the button is tapped. Must use HTTPS protocol if messenger_extensions is true.
Height of the Webview.
Generated using TypeDoc
The log out button triggers the account unlinking flow.
MediaProps
Check official send API doc and reference.