Skip to main content

Button Parameter Object

The object describing a either a quick reply or URL button parameter for a button type template message component.

Quick reply button​

Refers to a previously created quick reply button that allows for the customer to return a predefined message.

Example​

{
    "type": "payload",
    "payload": "PAYLOAD_STRING",
}

Properties​

  1. type : "payload" — type of parameter for the button.
  2. payload : string — developer-defined payload that is returned when the button is clicked in addition to the display text on the button.

URL button​

Refers to a previously created button that allows the customer to visit the URL generated by appending the text parameter to the predefined prefix URL in the template.

Example​

{
    "type": "text",
    "text": "TEXT_STRING",
}

Properties​

  1. formatted_name : "text" — type of parameter for the button.
  2. text : string — developer-provided suffix that is appended to the predefined prefix URL in the template.