Get Persistent Menus

    Gets a persistent menu.

    Note

    • A persistent menu is deleted if rich menus are added.

    API Type

    Server API

    Request URL

    https://apis.worksmobile.com/r/{API ID}/message/v1/bot/{botNo}/persistentmenu

    HTTP Method

    GET

    Path Parameters

    Parameter Required Description
    botNo Y Bot number for which you want to get persistent menus.

    Request Example

    
    GET https://apis.worksmobile.com/r/apiid/message/v1/bot/123/persistentmenu
    

    Response

    It returns HTTP status 200 with the persistent menu added to the message bot as a response if successful.

    Property Type Description
    content object Persistent menu
    content.actions array<Action Object> Buttons added to the persistent menu.

    Response Example

    
    {
        "code": 200,
        "message": "OK",
        "content": {
            "actions": [{
                "type": "uri",
                "label": "WorksMobile's Homepage",
                "uri": "https://line.worksmobile.com"
            }, {
                "type": "message",
                "label": "FAQ",
                "postback": "PersistentMenu_FAQ"
            }]
        }
    }
    

    Error Code

    If the API call fails, it returns an error code and message.
    For error codes, refer to Message Bot REST API Error Codes.