대화방 메뉴 등록
Request
대화방에 대화방메뉴를 등록합니다.
대화방 메뉴 개편으로 상위 메뉴, 하위 메뉴 구분 없이 최대 5개까지 메뉴를 지정할 수 있습니다.
대화방 메뉴 등록 시 대화방메뉴 정보는 등록하지만 대화방에서의 사용여부를 미사용으로 설정할 수 있습니다.
※ 대표번호 문자서비스가 설정된 대화방에는 대화방메뉴를 등록할 수 없습니다. 즉, rcsReply 값이 1인 대화방에만 대화방메뉴를 설정할 수 있습니다.
- 계정 권한 : 마스터, 매니저, 대행사
- 브랜드 권한 : 브랜드 대표운영자, 운영자
maxLength: 13 - 브랜드 내 정보 접근시 사용되는 브랜드ID Path Parameter 입니다.
브랜드 내 대화방 정보 접근시 사용되는 대화방ID Path Parameter 입니다.
maxLength: 18 - RCS Biz Center에서 브랜드 등록 시 자동 생성되는 Key 입니다.
대행사가 해당 브랜드에 대한 권한 여부를 판단하는데 사용됩니다. 따라서, 대행사 계정으로 브랜드 내 정보를 조회/등록/수정 API 연동 시 Header에 설정되어야 합니다.
대화방메뉴 사용 여부입니다.
- true : 사용
- false : 미사용
truePOST /api/1.1/brand/{brandId}/bidirectional/chatbot/{chatbotId}/persistentmenu HTTP/1.1
Host: api-qa.rcsbizcenter.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 221
{
"psMenuUse": true,
"persistentMenu": {
"menu": [
{
"type": "reply",
"title": "text",
"ordNo": 1,
"autoReplyMsgId": "text",
"feedId": "text",
"actionType": "dialerAction",
"action": {
"urlAction": {
"openUrl": {
"url": "https://example.com"
}
}
}
}
]
}
}❖ request body sample
{
"psMenuUse": false,
"persistentMenu": {
"menu": [
{
"type": "action",
"title": "119연락",
"ordNo": 0,
"actionType": "dialerAction",
"action": {
"dialerAction": {
"dialPhoneNumber": {
"phoneNumber": "119"
}
}
}
},
{
"ordNo": "1",
"title": "API버튼1",
"type": "feed",
"feedId": "BR.vt0HGdJXG0.cUmR1s689n"
}
]
}
}Response
result - array<object>
result - array<object>type
string
O
대화방 메뉴를 구성하는 메뉴 버튼의 유형입니다.
reply : 응답 메뉴 버튼(챗봇응답 or 자동메시지)
feed : 브랜드 소식 연결 버튼
action : RCS 액션 지정 버튼
title
string
O
메뉴버튼에 표시되는 메뉴명입니다.
ordNo
number
O
메뉴버튼 순서 값입니다.
autoReplyMsgId
string
type이 'reply' 인 경우, 자동응답메시지 ID 지정 시 자동응답메시지가 할당됩니다. 자동응답메시지 ID를 지정하지 않은 경우에는 챗봇응답으로 할당됩니다.
feedId
string
type이 'feed' 인 경우, 브랜드 소식 ID 지정 시 해당 소식이 연결됩니다.
actionType
string
type이 'action'인 경우, 사용할 RCS 액션 유형을 지정합니다.
dialerAction : 전화연결
urlAction : 웹사이트 연결
action
object
❖ response body sample
{
"code": "20000000",
"desc": null,
"result": [
{
"postbackId": "P7r9Gr5W0XM6RyQ",
"upPostbackId": "",
"type": "action",
"title": "119연락",
"ordNo": "10",
"autoReplyMsgId": "",
"actionType": "dialerAction",
"action": {
"dialerAction": {
"dialPhoneNumber": {
"phoneNumber": "119"
}
}
},
"chatbotId": "07082245290",
"armIdName": null
},
{
"postbackId": "PObF8R4XtopwoW2",
"upPostbackId": "",
"type": "feed",
"title": "API버튼1",
"ordNo": "20",
"autoReplyMsgId": "",
"actionType": "urlAction",
"action": {
"urlAction": {
"openUrl": {
"url": "https://biz-qa.chatplus.co.kr/brand/BR.vt0HGdJXG0/feed/BR.vt0HGdJXG0.cUmR1s689n"
}
}
},
"chatbotId": "07082245290",
"armIdName": null
}
],
"status": 200
}error code는 RCS Biz Center - Response body error code 참조
Last updated