固定メニューの登録

    トーク Bot の固定メニュー(persistent menu)を登録します。

    固定メニューはボタン形式で、callback type として message と uri を指定できます。

    各ボタンには postback パラメータを追加できます。受信メッセージ形式についてはメッセージ受信 - Callback形式を参照してください。

    固定メニューの構造は次の通りです。

    参考

    • ボタンは最大 4 個まで登録できます。
    • テキスト項目に改行文字を入力すると、空白に置き換えられます。

    注意

    • リッチメニューを登録した場合、登録済みの固定メニューは削除されます。
    • リッチメニューが登録済みのトーク Bot には、固定メニューの登録ができません。

    API の種類

    サーバー API

    Request URL

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

    HTTP Method

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

    Path Parameters

    パラメータ 必須 説明
    botNo Y 固定メニューを登録する Bot 番号

    Request

    パラメータ タイプ 必須 説明
    content object Y 固定メニュー(指定しない場合、固定メニュー解除)
    content.actions array<Action Object> N 固定メニューのボタンリスト

    Request Example

    
    POST https://apis.worksmobile.com/r/apiid/message/v1/bot/123/persistentmenu
    
    {
        "content": {
            "actions": [{
                "type": "uri",
                "label": "WorksMobile's Homepage",
                "uri": "https://line.worksmobile.com"
            }, {
                "type": "message",
                "label": "FAQ",
                "postback": "PersistentMenu_FAQ"
            }]
        }
    }
    

    Response

    呼び出しに成功すると HTTP 200 コードを返します。

    Error Code

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