Skip to main content
PATCH
보유 전화번호 에이전트 설정

Authorizations

Authorization
string
header
required

조직 API 키를 Authorization: Bearer <token> 형식으로 보냅니다.

Path Parameters

organization_telephone_number_id
string<uuid>
required

조직 보유 전화번호 ID입니다. 전화번호 문자열이 아니라 GET /v3/organization-telephone-numbers 응답의 id를 사용합니다.

Body

application/json

음성 수신·발신 및 SMS 수신 에이전트 매핑 요청입니다. 매핑을 해제하려면 null을, 설정하려면 agent_id와 선택적인 agent_version을 보내세요.

에이전트 매핑 수정 요청입니다.

PATCH 동작 규칙(v3 convention, §2.3):

  • 필드를 생략하면 기존 매핑을 유지합니다.
  • 필드에 null을 보내면 매핑을 해제합니다(nullable column).
  • 빈 body({})는 PatchRequest base에서 400으로 거부합니다.
inbound_agent
AgentMapping · object | null

인바운드 에이전트 매핑. 필드를 생략하면 기존 값이 유지됩니다. null 전송 시 매핑이 해제됩니다.

outbound_agent
AgentMapping · object | null

아웃바운드 에이전트 매핑. 필드를 생략하면 기존 값이 유지됩니다. null 전송 시 매핑이 해제됩니다.

sms_inbound_agent
AgentMapping · object | null

문자 수신 담당입니다. 생략하면 유지, null이면 해제합니다. 기존 채팅의 담당은 변경하지 않습니다.

Response

성공 응답

조직 보유 전화번호 응답입니다.

id
string
required

전화번호 레코드의 고유 식별자입니다.

number
string
required

등록된 전화번호입니다. 하이픈 없는 숫자 문자열로 반환됩니다.

provider
enum<string>
required

번호 제공자 구분입니다. 'vox'(vox.ai 구매 번호) 또는 'custom'(자체 보유 번호) 중 하나입니다.

Available options:
vox,
custom
status
enum<string>
required

번호의 현재 상태를 나타냅니다. 'active'(사용 중), 'scheduled'(예약됨), 'cancel_requested'(해지 요청됨), 'expired'(만료됨) 중 하나입니다.

Available options:
active,
scheduled,
cancel_requested,
expired
start_at
integer
required

전화번호 서비스 시작일입니다. unix timestamp (ms).

created_at
integer
required

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

updated_at
integer
required

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

monthly_fee
integer | null

월 사용료입니다. 단위는 원(KRW)이며, provider가 'custom'인 경우 null일 수 있습니다.

address
string | null

SIP trunk 연동 주소입니다. SIP 설정이 없으면 null입니다.

inbound_trunk_id
string | null

인바운드 SIP trunk의 고유 식별자입니다. SIP 설정이 없으면 null입니다.

outbound_trunk_id
string | null

아웃바운드 SIP trunk의 고유 식별자입니다. SIP 설정이 없으면 null입니다.

inbound_agent
AgentMapping · object | null

이 번호에 매핑된 인바운드 에이전트 정보입니다. 매핑이 없으면 null입니다.

outbound_agent
AgentMapping · object | null

이 번호에 매핑된 아웃바운드 에이전트 정보입니다. 매핑이 없으면 null입니다.

sms_inbound_agent
AgentMapping · object | null

문자 수신 에이전트입니다. 미지정이면 null이며 새 AI 채팅을 시작하지 않습니다.

memo
string | null

전화번호에 대한 메모입니다. 설정되지 않았으면 null입니다.

end_at
integer | null

전화번호 서비스 종료일입니다. unix timestamp (ms). 해지 예약이 없으면 null입니다.

cancel_requested_at
integer | null

해지 요청이 접수된 일시입니다. unix timestamp (ms). 해지 요청이 없으면 null입니다.