Skip to main content
POST
/
v2
/
campaigns
캠페인 생성
curl --request POST \
  --url https://client-api.tryvox.co/v2/campaigns \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "agent_id": "550e8400-e29b-41d4-a716-446655440000",
  "agent_version": "production",
  "call_from": "07070001234",
  "presentation_number": "15881508",
  "concurrency": 10,
  "name": "고객 설문 캠페인",
  "tasks": [
    {
      "call_to": "01023456789",
      "dynamic_variables": {
        "name": "홍길동"
      },
      "metadata": {
        "customer_id": "123"
      },
      "presentation_number": "15331532"
    },
    {
      "call_to": "01034567890",
      "dynamic_variables": {
        "name": "이몽룡"
      },
      "metadata": {
        "customer_id": "456"
      }
    }
  ]
}'
{
  "active_concurrency": 0,
  "agent_id": "550e8400-e29b-41d4-a716-446655440000",
  "completed_calls": 0,
  "concurrency": 5,
  "created_at": "2024-01-15T10:00:00Z",
  "failed_calls": 0,
  "from_number": "07070001234",
  "presentation_number": "15881508",
  "id": "123",
  "name": "고객 설문 캠페인",
  "organization_id": "550e8400-e29b-41d4-a716-446655440001",
  "status": "pending",
  "total_calls": 2
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json

새 캠페인 생성 요청 모델

​
name
string
required

캠페인 이름

​
call_from
string
required

발신 번호 (예: 07070001234)

​
agent_id
string
required

에이전트 ID

​
tasks
CampaignCallTask · object[]
required

실행할 발신 작업 목록

​
presentation_number
string | null

캠페인 기본 표시 발신번호. 통화 실행 시 우선순위는 tasks[].presentation_number > presentation_number > call_from 입니다.

​
agent_version
string | null
default:production

사용할 에이전트 버전

​
scheduled_at
string | null

예약 실행 시간 (ISO 타임스탬프)

​
concurrency
integer
default:5

최대 동시 발신 수

Required range: 1 <= x <= 100

Response

Successful Response

캠페인 생성 응답 모델 - 전체 캠페인 데이터 반환

​
id
string
required
​
name
string
required
​
status
enum<string>
required
Available options:
draft,
pending,
ongoing,
success,
fail,
canceled
​
agent_id
string
required
​
from_number
string
required
​
total_calls
integer
required
​
created_at
string
required
​
organization_id
string
required
​
agent_version
integer | null
​
presentation_number
string | null

캠페인 기본 표시 발신번호

​
completed_calls
integer
default:0
​
failed_calls
integer
default:0
​
scheduled_at
string | null
​
finished_at
string | null
​
concurrency
integer
default:5

최대 동시 발신 수

​
active_concurrency
integer
default:0

현재 진행 중인 동시 발신 수

⌘I