대화방 목록 조회
Request
브랜드 내에 등록된 대화방(발신번호) 목록을 조회합니다.
계정 권한 : 마스터, 매니저, 대행사
브랜드 권한 : 브랜드 대표운영자, 운영자
maxLength: 13 - 브랜드 내 정보 접근시 사용되는 브랜드ID Path Parameter 입니다.
시작 offset 번호(default: 0) 입니다.
0minimum: 100, maximum: 1000 - 조회 최대 건수(default: 100) 입니다.'
100maxLength: 18 - RCS Biz Center에서 브랜드 등록 시 자동 생성되는 Key 입니다.
대행사가 해당 브랜드에 대한 권한 여부를 판단하는데 사용됩니다. 따라서, 대행사 계정으로 브랜드 내 정보를 조회/등록/수정 API 연동 시 Header에 설정되어야 합니다.
GET /api/1.1/brand/{brandId}/chatbot HTTP/1.1
Host: api-qa.rcsbizcenter.com
Authorization: Bearer JWT
Accept: */*
Response
code
string
5
O
20000000
status
integer
3
O
200
desc
string
O
result - array<object>
groupId
string
10
대화방이 대량등록된 경우 그룹ID 입니다.
chatbotId
string
15
O
대화방(발신번호)ID, A2P의 경우 발신번호(mdn)과 동일합니다.
brandId
string
13
O
브랜드ID
subNum
string
40
회신번호 A2P의 경우 발신번호, 즉 chatbotId와 동일합니다.
isMainNum
boolean
대표번호 개념은 더 이상 유효하지 않습니다. 브랜드에 등록된 대화방 중 유효한 첫번째 대화방이 표시됩니다.
subTitle
string
20
대화방명입니다.
service
string
a2p
대화방 유형입니다.
a2p : 발신번호를 이용한 대화방
chat : 양방향ID를 이용한 대화방
display
string
단말에서 대화방의 검색 및 RCS대화방 노출 여부를 설정합니다. 브랜드홈 전시로 설정되면 대화방은 RCS메시지 수신이 가능하게 되며, 반대로 브랜드홈 비전시 설정 시에는 RCS메시지 수신이 불가능합니다.
'11' : 브랜드채널 노출 및 브랜드검색 허용 & 브랜드홈 전시
'10' : 브랜드채널 노출 및 브랜드검색 허용 & 브랜드홈 비전시
'01' : 브랜드채널 노출 및 브랜드검색 불허 & 브랜드홈 전시
'00' : 브랜드채널 노출 및 브랜드검색 불허 & 브랜드홈 비전시
inputField
integer
1
단말 대화방에서 사용자 입력창을 활성화 또는 비활성화 합니다.
0 : 비활성화
1 : 활성화
subDescr
string
50
대화방 검색 시 노출되는 소개글을 입력할 수 있습니다.
botAgencyId
string
20
양방향 대화방 서비스 계약 관계에 있는 대행사ID(중계사)로 자동응답메시지 과금 및 챗봇 연동에 사용됩니다.
saftyStatusYn
string
Y
안심마크 지정된 기업에 한하여, 대화방의 안심마크 표시 여부를 지정합니다.
Y : 안심마크 표시
N : 안심마크 미표시
psMenuUse
boolean
false
대화방메뉴 사용 여부입니다.
true : 사용
false : 미사용
approvalResult
string
대화방의 승인 상태입니다.
저장 : RCS Biz Center 홈페이지에서 대화방 정보를 입력하고 승인요청 하지 않고 저장해 둔 상태입니다. 저장 상태의 브랜드는 승인요청을 해야 승인대기 상태로 변경됩니다.
승인대기 : 대화방 등록 직후 검수 이전 상태입니다.
검수시작 : 대화방 검수가 시작된 상태입니다.
승인 : 검수가 완료되어 이통3사에 대화방 정보 등록까지 최종 완료되어 RCS 메시지를 발송할 수 있는 상태입니다.
반려 : 검수 시 승인이 불가하여 반려된 상태입니다. 반려된 대화방은 수정 후 다시 승인요청 할 수 있습니다.
검수완료 : RCS Biz Center에서 검수 승인 하였으나 이통사 3사 등록이 완료되지 않은 상태로 RCS 메시지를 발송할 수 없습니다.
검수완료(수정) : 승인된 대화방의 이름을 변경하였으나 이통3사 정보 등록이 완료되지 않은 상태입니다. 현재 상태에서는 이통사에 따라 단말 표시 대화방 이름이 다를 수 있습니다.
registerDate
string
대화방 등록일시
approvalDate
string
대화방 승인일시
updateDate
string
대화방 수정일시
registerId
string
대화방 등록 계정 ID
updateId
string
대화방 수정 계정 ID
pagination - object
total
integer
O
전체건수
offset
integer
O
0
조회 기준 위치
limit
integer
O
100
페이지 당 조회 건수
links - object
prev
string
O
이전페이지URL
next
string
O
다음페이지URL
❖ response body sample
{
"code": "20000000",
"desc": null,
"result": [
{
"groupId": null,
"chatbotId": "07082245290",
"brandId": "BR.u720xwadx0",
"subNum": "07082245290",
"isMainNum": true,
"subTitle": "대화방",
"service": "a2p",
"display": "01",
"inputField": 1,
"subDescr": "",
"botAgencyId": null,
"saftyStatusYn": "N",
"psMenuUse": false,
"approvalResult": "승인",
"registerDate": "2024-06-18T09:42:21.000+09",
"approvalDate": "2024-06-18T09:48:37.000+09",
"updateDate": "2024-06-18T09:48:27.000+09",
"registerId": "hong",
"updateId": "hong"
}
],
"pagination": {
"offset": 0,
"limit": 100,
"total": 1
},
"links": {
"prev": null,
"next": null
},
"status": 200
}error code는 RCS Biz Center - Response body error code 참조
Last updated
Was this helpful?