リッチメニューの登録

    リッチメニューを登録します。

    メンバーが実際にリッチメニューを利用するためには、追加で以下の手順が必要です。

    1. リッチメニュー画像をアップロード
    2. アップロードされた画像をリッチメニューに登録
    3. 基本またはメンバー個別のリッチメニューを設定

    参考

    • 1 つのトーク Bot につき、最大 1,000 個のリッチメニューを登録できます。
    • 各動作(action)の label 項目は、デスクトップ版アプリケーションで使用されます。指定しない場合はデフォルトの文章が表示されます。

    API の種類

    サーバー API

    Request URL

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

    HTTP Method

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

    Path Parameters

    パラメーター 必須 説明
    botNo Y リッチメニューを設定するBot番号

    Request Content

    パラメーター タイプ 必須 説明
    size object Y リッチメニューの幅と高さ
    size.width number Y リッチメニューの幅
    2500ピクセルで固定
    size.height number Y リッチメニューの高さ
    1686または843ピクセル
    name string Y リッチメニュー名。リッチメニューの管理だけで使用し、メンバーには表示されない。
    最大 300 文字
    areas array<object> Y 各動作(action) のエリアオブジェクト (座標/サイズ)
    最大 20 個
    areas[].bounds object Y エリア境界。ピクセル単位で定義
    areas[].bounds.x number Y エリア左端の位置 (メニュー左端を基準にした横方向の位置)。0以上を指定。
    areas[].bounds.y number Y エリア上端の位置 (メニュー上端を基準にした縦方向の位置)。0以上を指定。
    areas[].bounds.width number Y エリアの幅
    areas[].bounds.height number Y エリアの高さ
    areas[].action Action Object Y エリアを押した時の動作

    Request Example

    
    POST https://apis.worksmobile.com/r/apiid/message/v1/bot/123/richmenu
    {
      "size": {
        "width": 2500,
        "height": 1686
      },
      "name": "Nice richmenu",
      "areas": [
        {
          "bounds": {
            "x": 0,
            "y": 0,
            "width": 1250,
            "height": 843
          },
          "action": {
            "type": "message",
            "label": "Document",
            "text": "Document"
          }
        },
        {
          "bounds": {
            "x": 1250,
            "y": 0,
            "width": 1250,
            "height": 843
          },
          "action": {
            "type": "message",
            "label": "Schedule",
            "text": "Schedule"
          }
        },
        {
          "bounds": {
            "x": 0,
            "y": 843,
            "width": 1250,
            "height": 843
          },
          "action": {
            "type": "message",
            "label": "Bank",
            "text": "Bank"
          }
        },
        {
          "bounds": {
            "x": 1250,
            "y": 843,
            "width": 1250,
            "height": 843
          },
          "action": {
            "type": "message",
            "label": "Q&A",
            "text": "Q&A"
          }
        }
      ]
    }
    

    Response

    API 呼び出しに成功すると HTTP 200 コードと作成されたリッチメニューの ID を返します。

    プロパティ タイプ 説明
    richMenuId string 作成されたリッチメニューの ID

    Response Example

    
    {
        "richMenuId": "12345"
    }
    

    Error Code

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