Skip to main content
POST
채널 연결 해제

Authorizations

Authorization
string
header
required

워크스페이스 API 키를 Authorization: Bearer <token> 형식으로 보냅니다.

Path Parameters

chat_channel_id
string<uuid>
required

채널 ID입니다. GET /v3/chat-channels 응답의 id를 사용합니다.

Response

성공 응답

id
string<uuid>
required

채널 ID입니다. UUID이며 경로 파라미터 chat_channel_id에 사용합니다.

organization_id
string<uuid>
required

채널을 소유한 워크스페이스 ID입니다.

status
enum<string>
required

채널의 현재 상태입니다. active는 문의를 받아 응대하는 중, disabled는 채널을 비활성화한 상태, provider_pending은 공급자 쪽 처리를 기다리는 상태(끝나면 저절로 바뀜), failed는 이 API에 다시 요청해야 풀리는 상태, disconnected는 연결을 해제한 상태입니다.

Available options:
provider_pending,
active,
disabled,
failed,
disconnected
status_detail
enum<string> | null
required

다음에 할 일입니다. 없으면 null입니다. verify는 POST /v3/chat-channels/verification으로 인증을 신청합니다(채널별 단계는 그 응답의 next_action). reconnect는 POST /v3/chat-channels/{chat_channel_id}/reconnect를 호출합니다. retry_operation은 operation_enabled가 true이면 POST /v3/chat-channels/{chat_channel_id}/enable을, false이면 POST /v3/chat-channels/{chat_channel_id}/disable을 다시 호출합니다. check_provider는 공급자 쪽에서 해결할 일이 있다는 뜻이며 내용은 details에 있습니다.

Available options:
verify,
reconnect,
retry_operation,
check_provider
operation_enabled
boolean
required

채널을 활성화해 두었는지입니다. POST /v3/chat-channels/{chat_channel_id}/enable로 활성화하면 true, POST /v3/chat-channels/{chat_channel_id}/disable로 비활성화하면 false입니다. 실제로 운영 중인지는 status로 확인합니다. 연결을 해제한 채널은 false입니다.

name
string | null
required

대시보드에 표시할 채널 이름입니다. 오래된 채널은 null일 수 있습니다.

display_name
string | null
required
deprecated

지원 종료 예정입니다. name과 같은 값이므로 name을 쓰세요.

agent
AgentMapping · object
required

agent_id와 agent_version으로 구성된 에이전트 매핑 객체입니다.

initial_responder_type
enum<string>
required

새 채팅의 최초 응답 담당입니다. agent는 AI 에이전트, external은 고객사 시스템입니다. desk는 vox.ai 상담 화면용 값입니다.

Available options:
agent,
desk,
external
created_at
integer
required

리소스 생성 시각입니다. unix milliseconds 형식입니다.

updated_at
integer
required

리소스 마지막 수정 시각입니다. unix milliseconds 형식입니다.

allow_agent_response
boolean
required

현재 적용되는 AI 사용 허용 값입니다. false이면 새 채팅을 AI가 맡지 않고, AI가 맡고 있던 채팅도 이후 고객 입력에 AI가 답하지 않습니다. 고객 입력은 기록에 남고 사람은 답할 수 있습니다.

channel
string
required

채널 종류입니다. kakao, navertalk, instagram, line, wechat, channeltalk, sms 중 하나이며, 이 값에 따라 details 형식이 정해집니다.

Allowed value: "kakao"
details
KakaoDetails · object
required

채널별 연결 정보입니다.