リッチメニュー画像の照会

    リッチメニューに設定されている画像を照会します。

    取得したリソース ID の画像データは、コンテンツダウンロード API を利用して確認できます。

    API の種類

    サーバー API

    Request URL

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

    HTTP Method

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

    Path Parameters

    パラメーター 必須 説明
    botNo Y Bot 番号
    richMenuId Y リッチメニュー ID

    Request Example

    
    GET https://apis.worksmobile.com/r/apiid/message/v1/bot/123/richmenu/456/content
    

    Response

    API 呼び出しに成功すると HTTP 200 コード、リッチメニューに設定されているリソースIDと多言語情報を返します。

    パラメーター タイプ 説明
    resourceId string リッチメニュー画像のリソース ID
    i18nResourceIds[] array 多言語リッチメニューのリソースリスト
    i18nResourceIds[].language string 言語コード
    ●ja_JP
    ●ko_KR
    ●zh_CN
    ●zh_TW
    ●en_US
    i18nResourceIds[].resourceId string 各言語のリッチメニュー画像のリソース ID

    Response Example

    
    {
      "resourceId": "XAAAUD16j+TxtDcn/DIUuo",
      "i18nResourceIds": [{
        "language": "en_US",
        "resourceId": "XAAAUDAfqDdEhGzER19K"
      }]
    }
    

    Error Code

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