リッチメニューの登録

POST/bots/{botId}/richmenus

Botのリッチメニューを登録する。

  • 1つのBotに対し、最大1000個のリッチメニューを登録できる。
  • 各動作(action)のlabel項目は、PC版アプリで使用される。指定していない場合は、デフォルトの文章が表示される。

登録したリッチメニューを使用するためには、追加で以下の手順が必要。

  1. コンテンツアップロードでアップロードURLを取得
  2. アップロードURLにリッチメニュー画像をアップロード
  3. アップロードした画像のfileIdを指定してリッチメニュー画像を登録
  4. 既定リッチメニューに設定(下記参照)、またはユーザー別リッチメニューを設定

既定リッチメニューを設定するには「Botの更新」または「Botの部分更新」でdefaultRichMenuIdを設定する。

Authorization

oauth2

Authorization Code OAuth Flow

Authorization URL - https://auth.worksmobile.com/oauth2/v2.0/authorize
Token URL - https://auth.worksmobile.com/oauth2/v2.0/token
Refresh URL - https://auth.worksmobile.com/oauth2/v2.0/token

Scope

bot

HTTP Request

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

Path Parameters

ParameterTypeDescription
botIdinteger

Bot ID


required
example : 2000001
format : int64

Header Parameters

HeadertypeDescription
Authorizationstring

Bearer {token}


required
Content-Typestring

application/json


required
example : application/json

Request Body

PropertyTypeDescription
richmenuNamestring

リッチメニュー名


required
maxLength : 300
areasarray (RichmenuArea)

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


required
minItems : 1
maxItems : 20
sizeobject (size)

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


required

RichmenuArea

PropertyTypeDescription
actionobject (action)

エリアを押した時の動作


required
boundsobject (bounds)

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


required

action

PropertyTypeDescription
typestring

Actionの種類


required
Allowed values : postback, message, uri
labelstring

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

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

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


maxLength : 300
displayTextstring

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


maxLength : 300
postbackstring

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


maxLength : 1000
textstring

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


maxLength : 300
uristring

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


maxLength : 1000
i18nDisplayTextsarray (I18nDisplayTexts)

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


minItems : 0
i18nLabelsarray (I18nLabels)

多言語のラベルリスト


minItems : 0
i18nTextsarray (I18nTexts)

多言語のテキストリスト


minItems : 0

I18nDisplayTexts

PropertyTypeDescription
languagestring

多国語言語コード


required
Allowed values : ja_JP, ko_KR, en_US, zh_CN, zh_TW
displayTextstring

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


required
maxLength : 300

I18nLabels

PropertyTypeDescription
languagestring

多国語言語コード


required
Allowed values : ja_JP, ko_KR, en_US, zh_CN, zh_TW
labelstring

項目に表示されるラベル

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

required

I18nTexts

PropertyTypeDescription
languagestring

多国語言語コード


required
Allowed values : ja_JP, ko_KR, en_US, zh_CN, zh_TW
textstring

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


required
maxLength : 300

bounds

PropertyTypeDescription
xinteger

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


required
minimum : 0
maximum : 2500
format : int64
yinteger

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


required
minimum : 0
maximum : 1686
format : int64
widthinteger

領域の幅


required
minimum : 0
maximum : 2500
format : int64
heightinteger

領域の高さ


required
minimum : 0
maximum : 1686
format : int64

size

PropertyTypeDescription
widthinteger

リッチメニューの幅


required
Allowed values : 2500
format : int64
heightinteger

リッチメニューの高さ


required
Allowed values : 843, 1686
format : int64

Request Example

example

1{
2  "richmenuName": "Example Richmenu",
3  "areas": [
4    {
5      "action": {
6        "type": "postback",
7        "label": "Example label",
8        "data": "Example data",
9        "displayText": "Example displayText",
10        "i18nDisplayTexts": [
11          {
12            "language": "en_US",
13            "displayText": "Example display text"
14          }
15        ],
16        "i18nLabels": [
17          {
18            "language": "en_US",
19            "label": "Example label"
20          }
21        ]
22      },
23      "bounds": {
24        "x": 0,
25        "y": 0,
26        "width": 2500,
27        "height": 843
28      }
29    }
30  ],
31  "size": {
32    "width": 2500,
33    "height": 843
34  }
35}

Response

HTTP 201

OK

PropertyTypeDescription
richmenuIdstring

リッチメニューID


readOnly : true
richmenuNamestring

リッチメニュー名


required
maxLength : 300
areasarray (RichmenuArea)

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


required
minItems : 1
maxItems : 20
sizeobject (size)

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


required

RichmenuArea

PropertyTypeDescription
actionobject (action)

エリアを押した時の動作


required
boundsobject (bounds)

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


required

action

PropertyTypeDescription
typestring

Actionの種類


required
Allowed values : postback, message, uri
labelstring

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

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

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


maxLength : 300
displayTextstring

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


maxLength : 300
postbackstring

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


maxLength : 1000
textstring

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


maxLength : 300
uristring

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


maxLength : 1000
i18nDisplayTextsarray (I18nDisplayTexts)

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


minItems : 0
i18nLabelsarray (I18nLabels)

多言語のラベルリスト


minItems : 0
i18nTextsarray (I18nTexts)

多言語のテキストリスト


minItems : 0

I18nDisplayTexts

PropertyTypeDescription
languagestring

多国語言語コード


required
Allowed values : ja_JP, ko_KR, en_US, zh_CN, zh_TW
displayTextstring

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


required
maxLength : 300

I18nLabels

PropertyTypeDescription
languagestring

多国語言語コード


required
Allowed values : ja_JP, ko_KR, en_US, zh_CN, zh_TW
labelstring

項目に表示されるラベル

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

required

I18nTexts

PropertyTypeDescription
languagestring

多国語言語コード


required
Allowed values : ja_JP, ko_KR, en_US, zh_CN, zh_TW
textstring

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


required
maxLength : 300

bounds

PropertyTypeDescription
xinteger

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


required
minimum : 0
maximum : 2500
format : int64
yinteger

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


required
minimum : 0
maximum : 1686
format : int64
widthinteger

領域の幅


required
minimum : 0
maximum : 2500
format : int64
heightinteger

領域の高さ


required
minimum : 0
maximum : 1686
format : int64

size

PropertyTypeDescription
widthinteger

リッチメニューの幅


required
Allowed values : 2500
format : int64
heightinteger

リッチメニューの高さ


required
Allowed values : 843, 1686
format : int64

Response Example

example

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