固定メニューの照会

    登録されている固定メニュー(persistent menu)を照会します。

    参考

    • リッチメニューを登録する場合、登録済みの固定メニューは削除されます。

    API の種類

    サーバー API

    Request URL

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

    HTTP Method

    GET

    Path Parameters

    パラメータ 必須 説明
    botNo Y Bot 番号

    Request Example

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

    Response

    API 呼び出しに成功すると HTTP 200 コードとトーク Bot に登録されている固定メニューの内容を返します。

    プロパティ タイプ 説明
    content object 固定メニューの内容
    content.actions array<Action Object> ボタンリスト

    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

    呼び出しに失敗するとエラーコードとエラーメッセージを返します。
    エラーコードはトーク Bot REST API エラーコードを参照してください。