대화방ID 등록 가능 여부 조회

Request

대화방ID 등록 가능 여부를 조회 합니다.

get

대화방ID 등록 가능 여부를 조회 합니다. 등록 가능한 경우 200 OK 응답으로 리턴되며, 대화방ID 형식 부적합, 이미 등록된 대화방ID 등 등록이 불가능한 경우 400 Error 리턴됩니다.

• 발신번호 조회 시에는 숫자만 입력해야 합니다.

  • 발신번호 조회 시 숫자 이외 '-'을 삽입할 경우 양방향 대화방ID로 인식될 수 있으므로 주의해 주세요.

• 양방향 대화방ID 조회 시에는 영문, 숫자, '-', '_' 사용이 가능합니다.

  • 양방향 대화방ID 영문 대문자는 소문자로 변환됩니다.

• 계정 권한: 대행사

Authorizations

Path parameters

chatbotIdstringRequired

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

get

HTTPcURLJavaScriptPython

GET /api/1.1/usableQuery/chatbotId/{chatbotId} HTTP/1.1
Host: api-qa.rcsbizcenter.com
Authorization: Bearer JWT
Accept: */*

Response

필드명	타입	길이	필수여부	기본값	설명
result	object		O		대화방Id(=chatbotId)
code	string	5	O	20000000
status	integer	3	O	200
desc	string		O

result - object

필드명	타입	길이	필수여부	기본값	설명
chatbotId	string				대화방Id(=chatbotId)

❖ response body sample

200

{
    "code": "20000000",
    "desc": "registration available",
    "result": {
        "chatbotId": "121251"
    },
    "status": 200
}

400

{
    "error": {
        "code": "64373",
        "message": "Invalid chatbotId format"
    },
    "status": 400
}

401

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

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