GET/bots/{botId}/richmenus

Bot のリッチメニューリストを取得する。

Authorization

oauth2

Access Token を指定します。
指定の方法や Access Token の取得方法は 共通仕様 を参照してください。

Scope

bot.message
bot
bot.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/bots/{botId}/richmenus

Path Parameters

ParameterTypeDescription
botId integer 

Bot ID


required
example : 2000001
format : int64 

Query Parameters

ParameterTypeDescription
cursor string 

リストのカーソル値 (URL エンコードする)


example : JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA== 
count integer 

取得数


required
default : 50
minimum : 1
maximum : 100
example : 60
format : int64 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
richmenus array (Richmenu) 

リッチメニューリスト

 
responseMetaData object (responseMetaData) 

レスポンスのメタデータ

 

Richmenu

PropertyTypeDescription
richmenuId string 

リッチメニュー ID


readOnly : true 
richmenuName string 

リッチメニュー名


required
maxLength : 300 
areas array (RichmenuArea) 

リッチメニューの各動作 (action) のエリア (座標/サイズ)


required
minItems : 1
maxItems : 20 
size object (size) 

リッチメニューの幅と高さ


required 

RichmenuArea

PropertyTypeDescription
action object (action) 

エリアを押した時の動作


required 
bounds object (bounds) 

リッチメニューボタンの範囲モデル


required 

action

PropertyTypeDescription
type string 

Action の種類


required
Allowed values : postback, message, uri, copy 
label string 

項目に表示されるラベル
リッチメニューとカルーセルの defaultAction 項目を除き必須。リッチメニューは、値を指定しない場合、デスクトップ環境でデフォルトメッセージが表示される。

  • 画像カルーセルの最大文字数: 12 字
  • 固定メニューの最大文字数: 1,000 字
  • 上記以外の最大文字数: 20 字
 
data string 

"postback.data" プロパティとして返す文字列


maxLength : 300 
displayText string 

トーク画面に表示されるテキスト
入力しない場合、テキストが表示されない。クイックリプライでは必須。


maxLength : 300 
postback string 

"message.postback" として返される文字列


maxLength : 1000 
text string 

項目を押すと送信されるテキスト
カルーセル、画像カルーセル、リッチメニュー、クイックリプライでは必須値であり、ボタンテンプレート、リストテンプレート、固定メニューでは label に置き換えられる。


maxLength : 300 
uri string 

項目を押すと開く URI
http、https スキーマに対応する。


maxLength : 1000 
copyText string 

項目をクリックするとクリップボードにコピーされる文字列


maxLength : 1000 
i18nDisplayTexts array (i18nDisplayTexts) 

多言語の表示テキストリスト


minItems : 0 
i18nLabels array (i18nLabels) 

多言語のラベルリスト


minItems : 0 
i18nTexts array (i18nTexts) 

多言語のテキストリスト


minItems : 0 

i18nDisplayTexts

PropertyTypeDescription
language string 

多国語言語コード


required
Allowed values : ja_JP, ko_KR, en_US, zh_CN, zh_TW 
displayText string 

ユーザーが送信したメッセージで、トーク画面に表示されるテキスト


required
maxLength : 300 

i18nLabels

PropertyTypeDescription
language string 

多国語言語コード


required
Allowed values : ja_JP, ko_KR, en_US, zh_CN, zh_TW 
label string 

項目に表示されるラベル

  • 画像カルーセルの最大文字数: 12 字
  • 固定メニューの最大文字数: 1,000 字
  • 上記以外の最大文字数: 20 字

required 

i18nTexts

PropertyTypeDescription
language string 

多国語言語コード


required
Allowed values : ja_JP, ko_KR, en_US, zh_CN, zh_TW 
text string 

項目を押すと送信されるテキスト
カルーセル、画像カルーセル、リッチメニュー、クイックリプライでは必須値として使用され、ボタンテンプレート、リストテンプレート、固定メニューでは label に置き換えられる。


required
maxLength : 300 

bounds

PropertyTypeDescription
x integer 

領域の左側からの水平位置


required
minimum : 0
maximum : 2500
format : int64 
y integer 

領域の上部からの垂直位置


required
minimum : 0
maximum : 1686
format : int64 
width integer 

領域の幅


required
minimum : 0
maximum : 2500
format : int64 
height integer 

領域の高さ


required
minimum : 0
maximum : 1686
format : int64 

size

PropertyTypeDescription
width integer 

リッチメニューの幅


required
Allowed values : 2500
format : int64 
height integer 

リッチメニューの高さ


required
Allowed values : 843, 1686
format : int64 

responseMetaData

PropertyTypeDescription
nextCursor string 

次のリストが存在する場合のカーソル値


required 

Response Example

example

1{2  "richmenus": [3    {4      "richmenuId": "40001",5      "richmenuName": "Example Richmenu",6      "areas": [7        {8          "action": {9            "type": "postback",10            "label": "Example label",11            "data": "Example data",12            "displayText": "Example displayText",13            "i18nDisplayTexts": [14              {15                "language": "en_US",16                "displayText": "Example display text"17              }18            ],19            "i18nLabels": [20              {21                "language": "en_US",22                "label": "Example label"23              }24            ]25          },26          "bounds": {27            "x": 0,28            "y": 0,29            "width": 2500,30            "height": 84331          }32        }33      ],34      "size": {35        "width": 2500,36        "height": 84337      }38    }39  ],40  "responseMetaData": {41    "nextCursor": "JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA=="42  }43}