Skip to main content
PATCH
/
campaigns
/
{campaign_id}
캠페인 수정
curl --request PATCH \
  --url https://client-api.tryvox.co/v2/campaigns/{campaign_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "call_time_window": {
    "auto_resume": true,
    "timezone": "Asia/Seoul",
    "windows": [
      {
        "days": [
          "Monday",
          "Tuesday",
          "Wednesday",
          "Thursday",
          "Friday"
        ],
        "end_min": 1080,
        "start_min": 540
      }
    ]
  },
  "name": "수정된 캠페인 이름"
}
'
{
  "id": "<string>",
  "name": "<string>",
  "status": "draft",
  "agent_id": "<string>",
  "from_number": "<string>",
  "total_calls": 123,
  "created_at": "<string>",
  "organization_id": "<string>",
  "agent_version": 123,
  "presentation_number": "<string>",
  "completed_calls": 0,
  "failed_calls": 0,
  "scheduled_at": "<string>",
  "finished_at": "<string>",
  "paused_at": "<string>",
  "concurrency": 5,
  "active_concurrency": 0,
  "call_time_window": {},
  "paused_by": "user"
}

Authorizations

Authorization
string
header
required

API 키를 Authorization: Bearer <API_KEY> 헤더로 전달하세요. 대시보드 설정에서 발급받을 수 있습니다.

Path Parameters

campaign_id
string
required

Body

application/json

캠페인 수정 요청 모델 (draft, pending 상태에서만 가능)

name
string | null

캠페인 이름

call_time_window
CallTimeWindowConfig · object

통화 허용 시간대 설정

Response

Successful Response

캠페인 수정 응답 모델

id
string
required
name
string
required
status
enum<string>
required
Available options:
draft,
pending,
ongoing,
paused,
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
paused_at
string | null
concurrency
integer
default:5

최대 동시 발신 수

active_concurrency
integer
default:0

현재 진행 중인 동시 발신 수

call_time_window
Call Time Window · object

통화 허용 시간대 설정

paused_by
enum<string> | null

일시정지 원인 (user: 수동, system: 시간대)

Available options:
user,
system