Note that the Inline Menu data type falls under the Message data type.
Each menu consists of a set of rows. At least one row should be defined.
| Field | Type | Required | Description |
|---|---|---|---|
menu_ref |
String | Yes | Unique identifier of this menu as defined by bot. |
rows |
Array of Row | Yes | Row: an array of buttons. (Rows belong to this menu). |
Each row belongs to a keypad menu (1 keypad menu) that consists of a set of buttons. At least one button should be defined.
| Field | Type | Required | Description |
|---|---|---|---|
buttons |
Array of Button | Yes | Buttons belong to the row. |
row_order |
Integer | Yes | Row order in the menu. |
This object represents the button for replying. The button must have a button_callback, which is the unique identifier defined by the bot.
| Field | Type | Required | Description |
|---|---|---|---|
button_callback |
String | Yes | Unique identifier as defined by Bot. The button_callback returns in inlineMessageCallback and chatMenuCallback when the button is pressed. |
next_menu |
Menu | Optional | Menu unique identifier: references the next menu to navigate to when the button is pressed. |
button_span |
Integer | Optional | Button span. |
button_order |
Integer | Optional | The number of buttons is ordered in ascending order. |
button_text_color |
String | Optional | Text color for the button title. The color should be in hexadecimal format (Hex triplet) or its common English name. Example: You can set red as either 'RED' or '#FF0000'. |
button_bgColor |
String | Optional | Button background color. The color should be in hexadecimal format (Hex triplet) or its common English name. Example: You can set red as either 'RED' or '#FF0000'. |
button_label |
String | Optional | Button label or title. |
button_url |
String | Optional | Button URL: when the button is pressed, an external URL link will be opened. |
button_query |
String | Optional | The app's query field accepts one of two values: |
Location: to ask the user to share a location or map point.
Contact: to ask the user to share their contact number. |
| chat | Chat | Optional | Chat unique identifier that references the specific Channel or Group to be opened when the button is pressed. The user must be a member of the specified Channel or Group. If button_url and chat are both defined, they will be executed. |
| nav_type | String | Optional | null (default) shows the navigation button for Channel, Group, or Contact. Use 'admin' to show the admin navigation button in the chat setting. |
This object represents an incoming button query result from a callback button.
| Field | Type | Required | Description |
|---|---|---|---|
latitude |
String | Optional | Only sent if buttonQuery is Location. |
longitude |
String | Optional | Only sent if buttonQuery is Location. |
contact |
String | Optional | Only sent if buttonQuery is Phone_number. |
Read more about the inline menu topic here.