GET/bots/{botId}/richmenus

등록된 모든 리치 메뉴의 목록을 조회한다.
등록된 리치 메뉴가 50개를 초과할 때는 이전 조회 결과에서 받은 cursor 파라미터를 입력하여 다음 리치 메뉴 목록을 계속해서 조회할 수 있다.

Authorization

oauth2

OAuth 2.0 인증.
자세한 인증 방식은 인가·인증을 참고한다.

Scope

bot.message
bot
bot.read

HTTP Request

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

Path Parameters

ParameterTypeDescription
botId integer 

봇 ID


required
example : 2000001
format : int64 

Query Parameters

ParameterTypeDescription
cursor string 

다음 목록 조회 시 사용하는 커서값


example : JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA== 
count integer 

목록 조회 개수


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) 

리치 메뉴 동작을 설정하는 영역 목록


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자
  • 고정 메뉴 최대 글자 수: 1000자
  • 위 항목 이외 최대 문자 수: 20자
 
data string 

postback.data 속성의 callback으로 반환되는 문자열


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 : ko_KR, ja_JP, en_US, zh_CN, zh_TW 
displayText string 

사용자가 보낸 메시지로 채팅에 표시되는 텍스트


required
maxLength : 300 

i18nLabels

PropertyTypeDescription
language string 

다국어 언어 코드


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

항목에 표시되는 레이블

  • 이미지 캐러셀 최대 글자 수: 12자
  • 고정 메뉴 최대 글자 수: 1000자
  • 위 항목 이외 최대 문자 수: 20자

required 

i18nTexts

PropertyTypeDescription
language string 

다국어 언어 코드


required
Allowed values : ko_KR, ja_JP, 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}