Skip to navigation

번호 조회

View as Markdown

이 계정이 보유한 번호 하나의 설정을 반환합니다. 다른 계정의 번호는 없는 번호와 똑같이 404 를 반환합니다.

Authentication

AuthorizationBearer

API Key를 Bearer 토큰으로 전달

Path parameters

accountIdstringRequired

계정 ID

numberstringRequired

조회할 전화번호

Response

번호 설정

numberstringOptional

전화번호

sourcestringOptional

번호 출처 (pool 등)

webhookUrlstring or nullOptional
webhookMethodenumOptional
Allowed values:
callContextUrlstring or nullOptional

routingType=‘agent’에서 Managed Agent 시작 전에 통화별 CallContext를 조회하는 동기 endpoint.

routingTypeenumOptional

Agent 미연결/거부 시 fallback 라우팅. ‘webhook’ = webhookUrl 호출, ‘sip’ = sipEndpointId 의 OriginationRoute 로 외부 PBX 다이얼, ‘softphone’ = sipCredentialId 의 등록 단말로 착신(Kamailio usrloc fork), ‘forward’ = forwardTo(보유 번호)로 내부 착신전환, ‘callflow’ = callFlowId 의 콜 플로우(결정적 ARS)가 인입을 받음, ‘agent’ = agentId 의 매니지드 에이전트가 받음.

sipEndpointIdstring or nullOptional

routingType=‘sip’ 일 때 사용할 SipEndpoint id. 그 외 라우팅에서는 null.

sipCredentialIdstring or nullOptional

routingType=‘softphone’ 일 때 착신할 등록 SIP credential(단말) id. 그 외 라우팅에서는 null.

forwardTostring or nullOptional

routingType=‘forward’ 일 때 내부 착신전환 대상 번호(같은 계정 보유 번호). 대상이 여러 개면 첫 번째 대상. 그 외 라우팅에서는 null.

forwardTargetslist of stringsOptional

routingType=‘forward’ 일 때 전환 대상 전체(첫 번째가 forwardTo). 모두 동시에 울리고 먼저 받은 쪽으로 연결됩니다. 미설정이거나 그 외 라우팅이면 빈 배열.

callFlowIdstring or nullOptional

routingType=‘callflow’ 일 때 인입을 처리할 콜 플로우 id. 그 외 라우팅에서는 null.

agentIdstring or nullOptional

routingType=‘agent’ 일 때 인입을 처리할 매니지드 에이전트 id. 그 외 라우팅에서는 null.

webhookHeadersmap from strings to strings or nullOptional

Inbound webhook 호출 시 추가될 HTTP 헤더. 같은 통화의 후속 요청(action·<Redirect>·referUrl) 중 webhookUrl 과 origin(scheme·host·port)이 같은 요청에도 실립니다. 상태 콜백에는 실리지 않습니다. 키는 “X-” prefix 필수 (case-insensitive), reserved 헤더(X-Signature, X-Forwarded-*, X-Real-IP) 거절. 최대 10 entries, key ≤ 64 bytes, value ≤ 2048 bytes, ASCII printable. null 전송 시 헤더 제거, 미포함 시 변경 없음.

statusCallbackstring or nullOptional

수신(inbound) 통화 상태 webhook URL. 발신은 통화 생성 시 statusCallback 으로 별도 관리.

statusCallbackEventsstring or nullOptional

구독할 상태 이벤트(공백 구분). 미지정 시 initiated ringing answered completed 가 적용됩니다. transfer(호전환 진행 상황)는 기본에 포함되지 않으므로 받으려면 직접 나열하세요.

numberTypeenumOptional

번호 유형. did = 일반 번호, representative = 대표번호.

Allowed values:
dictionaryIdstring or nullOptional

부착된 받아쓰기 사전 id. null 이면 이 번호로 걸려온 통화 전사에 계정 기본 사전을 사용.

friendlyNamestring or nullOptional<=50 characters

번호마다 적어 두는 용도 메모(별칭). null 이면 별칭 없음. 발신 표시·라우팅에는 쓰이지 않습니다.

rejectCallerIdRestrictedbooleanOptional

번호 표시제한 수신 통화를 받지 않고 거절하는지 여부. 기본 false.

presentationNumberIdstring or nullOptional

발신 때 받는 화면에 보일 표시 번호 id. null 이면 이 번호가 그대로 표시됩니다.

createdAtdatetimeOptional

Errors

401
Unauthorized Error
404
Not Found Error