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

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
name
string
required

배치 작업의 이름입니다. 대시보드에서 확인할 때 사용됩니다. 예시: 6월 프로모션 캠페인

​
call_from
string
required

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

​
agent_id
string
required

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

​
tasks
object[]
required

수행할 개별 통화 작업 목록입니다. 각 작업은 개별 전화 건을 나타냅니다.

​
agent_version
string | null
default:production

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

Response

Successful Response

​
batch_id
string
required

생성된 배치 작업의 고유 ID입니다. UUID v4 형식입니다.

​
status
enum<string>
required

배치 작업 상태입니다. queued(대기 중), processing(처리 중), failed(실패) 중 하나입니다.

Available options:
queued,
processing,
failed
​
total_tasks
integer
required

배치에 포함된 총 작업 수입니다.

​
message
string

요청 결과 메시지입니다.