Get PersistentMenu

    Gets a message PersistentMenu added.


    • PersistentMenu is available in the client version 2.2 or later.

    API Type

    Server API

    Request URL{API ID}/message/getPersistentMenu

    HTTP Method

    POST(Content-Type: application/json; charset=UTF-8)


    Parameter Type Required Description
    botNo number Y Message bot number for which you want to get a PersistentMenu

    Request Example

        "botNo": 123


    It returns code 200 when the API call is successful.

    Property Type Required Description
    code number Y ● 200: Success
    ● 4xx: Client request errors
    ● 5xx: Unexpected errors and server internal errors
    message string Y Description about the code
    content object Y Persistentmenu
    content.buttons array<object> Y Buttons added to the PersistentMenu
    content.buttons[].text string Y Text displayed on the button
    content.buttons[].i18nTexts[] array N Multilingual button text list
    content.buttons[].i18nTexts[].language string Y Language code
    content.buttons[].i18nTexts[].text string Y Button text in the language
    content.buttons[].link string N Link to go to when the button is clicked.
    content.buttons[].postback string N Postback to be passed as a callback when the button is clicked.

    Response Example

        "code": 200,
        "message": "OK",
        "content": {
            "buttons": [{
                "text": "WorksMobile's Homepage",
                "link": ""
            }, {
                "text": "FAQ",
                "postback": "PersistentMenu_FAQ"