대화방 수정

Request

지정된 대화방(발신번호)의 정보를 업데이트합니다.

지정된 대화방(발신번호)의 정보를 업데이트합니다.

저장, 반려, 승인 상태의 대화방(발신번호)만 수정이 가능하며, 대화방명이 변경되면 RBC 운영자의 검수를 받아야 합니다.

• 계정 권한 : 마스터, 매니저, 대행사
• 브랜드 권한 : 브랜드 대표운영자, 운영자
• 수정 가능 상태 : 저장, 반려, 승인

put

/brand/{brandId}/chatbot/{chatbotId}

Authorizations

Path parameters

brandIdstring · max: 13required

maxLength: 13 - 브랜드 내 정보 접근시 사용되는 브랜드ID Path Parameter 입니다.

chatbotIdstringrequired

브랜드 내 대화방 정보 접근시 사용되는 대화방ID Path Parameter 입니다.

Header parameters

X-RCS-Brandkeystring · max: 18

maxLength: 18 - RCS Biz Center에서 브랜드 등록 시 자동 생성되는 Key 입니다.

대행사가 해당 브랜드에 대한 권한 여부를 판단하는데 사용됩니다. 따라서, 대행사 계정으로 브랜드 내 정보를 조회/등록/수정 API 연동 시 Header에 설정되어야 합니다.

Body

subNumCertificateobject · binary

통신서비스 가입증명원 입니다.

입력한 발신번호와 통신서비스 가입증명원의 전화번호가 일치해야 발신번호 등록이 가능하며 최근 1개월 이내 발급된 서류로 제출해야 합니다.

파일형식 : jpg, png, pdf, tiff, zip (최대20MB)

chatbotobject

대화방(발신번호) 등록 정보 객체입니다.
Object 구성은 RegChatbotInfo를 참고하시기 바랍니다.

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://api-qa.rcsbizcenter.com/api/1.1/brand/{brandId}/chatbot/{chatbotId}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: multipart/form-data' \
  --form 'subNumCertificate=[object Object]' \
  --form 'chatbot=[object Object]'

❖ request body form data sample

chatbot

'chatbot="{
  \"mdn\": \"15330003\",
  \"subNum\": \"15330003\",
  \"subTitle\": \"테스트대화방수\",
  \"rcsReply\": \"0\",
  \"display\": \"01\",
  \"inputField\": \"1\",
  \"subDescr\": \"테스트용 대화방입니다.\",
  \"saftyStatusYn\": \"Y\"
}"' \

Response

필드명	타입	길이	필수여부	기본값	설명
result	array<object>		O		대화방(발신번호) 상세 정보 객체입니다.
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
mediaUrl	array<object>				이미지 파일ID와 URL 및 사용 유형 정보를 제공합니다.
rcsReply	string			1	service가 'chat' 이거나 양방향 대화방으로 설정하고자 한다면 반드시 '1'로 설정해야 합니다. 0 : SMS MO 수신 1 : RCS Postback 수신
approvalReason	string				승인 사유
status	string				대화방 상태를 나타내는 필드입니다. 현재는 단일 값인 "published" 만 존재하며, 대행사나 기업에서 API를 통한 등록/수정은 제공하지 않습니다.
searchWeight	string	10			검색 우선 순위로 사용자 단말에서 검색 시 검색 결과가 여러 개라면 이 값이 높은 순서로 보여집니다. 대행사나 기업에서 API를 통한 등록/수정은 제공하지 않습니다.
webhook	string	128			양방향 대화방 서비스 중계사 webhook URL 정보이며 botAgencyId 지정 시 자동으로 등록됩니다.
botTcPage	string	128			이용약관페이지 URL 입니다. 대행사나 기업에서 API를 통해 등록/수정은 제공하지 않습니다.
persistentMenu	array<object>				대화방메뉴 정보입니다.

mediaUrl - array<object>

필드명	타입	길이	필수여부	기본값	설명
fileId	string
url	string
typeName	string				이미지의 사용 유형을 구분합니다. icon - 템플릿 양식 아이콘 이미지 profile - 브랜드 프로필 이미 background - 브랜드 백그라운드 이미지
fileName	string	256			등록한 파일의 이름입니다.

persistentMenu - array<object>

필드명	타입	길이	필수여부	기본값	설명
postbackId	string	40			메뉴에 자동 부여되는 고유ID이며, RBC 자동할당하므로 별도 입력이 불가합니다.
upPostbackId	string	40			현재 메뉴가 속한 상위 메뉴 버튼의 Postback ID, RBC 자동할당하므로 별도 입력이 불가합니다.
type	string		O		대화방 메뉴를 구성하는 메뉴버튼의 유형입니다. RBC 개편 이후 하위메뉴(type menu)는 허용하지 않습니다. menu : 하위메뉴를 갖는 메뉴 버튼 (deprecated) reply : 응답 메뉴 버튼(챗봇응답 or 자동메시지) feed : 브랜드 소식 연결 버튼 action : RCS 액션 지정 버튼
title	string	25	O		메뉴버튼에 표시되는 메뉴명입니다.
ordNo	number		O		메뉴버튼 순서 값입니다.
autoReplyMsgId	string				type이 'reply' 인 경우, 자동응답메시지ID 지정 시 자동응답메시지가 할당됩니다. 자동응답메시지ID를 지정하지 않은 경우에는 챗봇응답으로 할당됩니다.
actionType	string				type이 'action'인 경우, 사용할 RCS 액션 유형을 지정합니다. 2022년 7월 28일 대화방 메뉴 정책 변경으로 dialerAction만 지정할 수 있습니다.
action	dialerAction

버튼 Action 목록 Link (2023.12.14)

❖ response body sample

200

{
    "code": "20000000",
    "desc": null,
    "result": [
        {
            "groupId": null,
            "chatbotId": "15330003",
            "brandId": "BR.u720xwadx0",
            "subNum": "15330003",
            "isMainNum": false,
            "subTitle": "테스트대화방수정",
            "service": "a2p",
            "display": "01",
            "inputField": 1,
            "subDescr": "테스트용 대화방입니다.",
            "botAgencyId": null,
            "saftyStatusYn": "N",
            "psMenuUse": false,
            "approvalResult": "승인대기(수정)",
            "registerDate": "2024-06-25T15:00:23.000+09",
            "approvalDate": "2024-06-25T14:58:02.000+09",
            "updateDate": "2024-06-25T15:00:23.000+09",
            "registerId": "swjeong75",
            "updateId": "swjeong75",
            "mediaUrl": [
                {
                    "fileId": "LT-common-Cni7oQ",
                    "fileName": "교육.png",
                    "url": "https://file-qa.rcsbizcenter.com/brand/common/LT-common-Cni7oQ_1.png",
                    "typeName": "profile"
                }
            ],
            "approvalReason": "승인완료",
            "status": "published",
            "rcsReply": "0",
            "searchWeight": "512",
            "webhook": null,
            "botTcPage": "http://www.rcsbizcenter.com"
        }
    ],
    "status": 200
}

400

{
    "error": {
        "code": "64002",
        "message": "Invalid Brand Key"
    },
    "status": 400
}

{
    "error": {
        "code": "64323",
        "message": "No changes"
    },
    "status": 400
}

{
    "error": {
        "code": "64307",
        "message": "Missing MDN"
    },
    "status": 400
}

401

{
    "error": {
        "code": "61003",
        "message": "Invalid token"
    },
    "status": 401
}

403

{
    "error": {
        "code": "63001",
        "message": "No Brand Permission"
    },
    "status": 403
}

error code는 RCS Biz Center - Response body error code 참조