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

Request

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

get
/usableQuery/chatbotId/{chatbotId}

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

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

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

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

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

  • 계정 권한: 대행사

Authorizations
Path parameters
chatbotIdstringRequired

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

Responses
200

페이지 내 Response 섹션 참조

No content

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

페이지 내 Response 섹션 참조

No content

Response

필드명
타입
길이
필수여부
기본값
설명

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

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

Last updated

Was this helpful?