대화방 등록

Request

지정된 브랜드에 대화방(발신번호)을 등록합니다.

post

https://api-qa.rcsbizcenter.com/api/1.1https://api.rcsbizcenter.com/api/1.1

/brand/{brandId}/chatbot

지정된 브랜드에 대화방(발신번호)을 등록합니다. 대화방 등록 시 RBC 운영자 검수 승인 후 사용이 가능합니다.

• 계정 권한 : 마스터, 매니저, 대행사

• 브랜드 권한 : 브랜드 대표운영자, 운영자

Authorizations

jwtAuth

AuthorizationstringRequired

인증방식은 JWT인증을 사용합니다. 토큰의 갱신은 없으며 토큰 만료 시 항상 재발급 받아야 합니다.

Path parameters

brandIdstring · max: 13Required

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

Header parameters

X-RCS-Brandkeystring · max: 18Optional

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

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

Body

multipart/form-data

subNumCertificateobject · binaryOptional

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

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

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

Responses

200

페이지 내 Response 섹션 참조

No content

post

/brand/{brandId}/chatbot

HTTPcURLJavaScriptPython

POST /api/1.1/brand/{brandId}/chatbot HTTP/1.1
Host: api-qa.rcsbizcenter.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 182

{
  "subNumCertificate": {},
  "chatbots": {
    "chatbots": [
      {
        "mdn": "text",
        "subNum": "text",
        "subTitle": "text",
        "rcsReply": "1",
        "display": "01",
        "inputField": 1,
        "subDescr": "text",
        "saftyStatusYn": "Y"
      }
    ]
  }
}

200

페이지 내 Response 섹션 참조

No content

❖ request body form data sample

chatbots

'chatbots="{
  \"chatbots\": [
    {
      \"mdn\": \"15330000\",
      \"subNum\": \"15330000\",
      \"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

❖ response body sample

200

{
    "code": "20000000",
    "desc": null,
    "result": [
        {
            "groupId": null,
            "chatbotId": "15330000",
            "brandId": "BR.u720xwadx0",
            "subNum": "15330000",
            "isMainNum": false,
            "subTitle": "테스트대화방",
            "service": "a2p",
            "display": "01",
            "inputField": 1,
            "subDescr": "테스트용 대화방입니다.",
            "botAgencyId": null,
            "saftyStatusYn": "N",
            "psMenuUse": false,
            "approvalResult": "승인대기",
            "registerDate": "2024-06-24T14:09:21.000+09",
            "approvalDate": null,
            "updateDate": "2024-06-24T14:09:21.000+09",
            "registerId": "hong",
            "updateId": "hong"
        }
    ],
    "status": 200
}

400

401

403

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