Skip to main content
PATCH
/
organization-telephone-numbers
/
{organization_telephone_number_id}
/
sip
보유 전화번호 SIP 설정
curl --request PATCH \
  --url https://client-api.tryvox.co/v3/organization-telephone-numbers/{organization_telephone_number_id}/sip \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "address": "<string>",
  "auth_username": "<string>",
  "auth_password": "<string>",
  "memo": "<string>"
}
'
{
  "id": "<string>",
  "number": "<string>",
  "provider": "vox",
  "status": "active",
  "start_at": 123,
  "created_at": 123,
  "updated_at": 123,
  "monthly_fee": 123,
  "address": "<string>",
  "inbound_trunk_id": "<string>",
  "outbound_trunk_id": "<string>",
  "inbound_agent": {
    "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "agent_version": "current"
  },
  "outbound_agent": {
    "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "agent_version": "current"
  },
  "memo": "<string>",
  "end_at": 123,
  "cancel_requested_at": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.tryvox.co/llms.txt

Use this file to discover all available pages before exploring further.

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

custom 번호의 SIP trunk 설정 수정 요청입니다.

SIP 설정 수정 요청입니다(custom 번호 전용).

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

  • 필드를 생략하면 기존 값을 유지합니다.
  • 필드에 null을 보내면 해당 값을 삭제합니다(nullable column).
  • 빈 body({})는 PatchRequest base에서 400으로 거부합니다.
​
address
string | null

SIP trunk 연동 주소. 필드를 생략하면 기존 값이 유지됩니다. null 전송 시 해제됩니다.

​
auth_username
string | null

SIP trunk 인증 사용자명. 필드를 생략하면 기존 값이 유지됩니다. null 전송 시 해제됩니다.

​
auth_password
string | null

SIP trunk 인증 비밀번호. address 또는 auth_username 변경 시 반드시 함께 전달해야 합니다. 필드를 생략하면 기존 값이 유지됩니다.

​
memo
string | null

전화번호에 대한 메모. 최대 200자. 필드를 생략하면 기존 값이 유지됩니다. null 전송 시 삭제됩니다.

Maximum string length: 200

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입니다.

​
outbound_agent
AgentMapping · object

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

​
memo
string | null

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

​
end_at
integer | null

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

​
cancel_requested_at
integer | null

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