POST
/
v1
/
create-outbound-call
Create Outbound Call
curl --request POST \
  --url https://client-api.tryvox.co/v1/create-outbound-call \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "call_from": "<string>",
  "call_to": "<string>",
  "agent_id": "<string>",
  "agent_version": "production",
  "metadata": {},
  "dynamic_variables": {},
  "presentation_number": "<string>"
}'
{
  "call_id": "<string>",
  "status": "queued",
  "call_from": "<string>",
  "call_to": "<string>",
  "metadata": {},
  "dynamic_variables": {}
}

Authorizations

​
Authorization
string
header
required

대시보드에서 발급받은 API 키를 인증 헤더에 포함시켜야 합니다. 형식은 "Bearer YOUR_API_KEY" 입니다.

Body

application/json
​
call_from
string
required

워크스페이스에 등록된 발신 전화번호입니다. 예시: 07012345678

​
call_to
string
required

전화를 걸고자 하는 수신 번호입니다. 예시: 01012345678

​
agent_id
string
required

통화에 사용할 에이전트의 고유 ID입니다. UUID v4 형식입니다. 예시: 123e4567-e89b-12d3-a456-426614174000

​
agent_version
string | null
default:production

사용할 에이전트의 버전입니다. 'production'은 배포된 버전, 'current'는 현재 편집 중인 버전, 'v1', 'v2'와 같이 'v+숫자' 형태는 특정 버전을 의미합니다. 기본값은 'production'입니다.

​
metadata
object

통화와 관련된 추가 정보를 담는 객체입니다. 자유롭게 구성 가능합니다.

​
dynamic_variables
object

에이전트 대화에서 사용할 동적 변수들을 담는 객체입니다. 에이전트 프롬프트에서 {{변수명}} 형태로 참조 가능합니다.

​
presentation_number
string | null

수신자에게 표시될 발신번호입니다. 사전 등록/검증된 번호만 허용됩니다. 미지정 시 call_from을 사용합니다. 예시: 07012345678

Response

Successful Response

​
call_id
string
required

생성된 통화의 고유 ID입니다. UUID v4 형식입니다.

​
status
enum<string>
required

통화 상태입니다. queued(대기 중), initiated(시작됨), failed(실패) 중 하나입니다.

Available options:
queued,
initiated,
failed
​
call_from
string
required

발신 전화번호입니다.

​
call_to
string
required

수신 전화번호입니다.

​
metadata
object

아웃바운드 콜 생성시 설정한 메타데이터입니다.

​
dynamic_variables
object

아웃바운드 콜 생성시 설정한 동적 변수입니다.