Skip to main content
PATCH
/
campaigns
/
{campaign_id}
캠페인 수정
curl --request PATCH \
  --url https://client-api.tryvox.co/v3/campaigns/{campaign_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>"
}
'
{
  "id": "<string>",
  "name": "<string>",
  "status": "draft",
  "agent": {
    "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "agent_version": "current"
  },
  "from_number": "<string>",
  "total_calls": 123,
  "completed_calls": 123,
  "failed_calls": 123,
  "concurrency": 123,
  "active_concurrency": 123,
  "created_at": 123,
  "presentation_number": "<string>",
  "scheduled_at": 123,
  "finished_at": 123,
  "paused_at": 123,
  "paused_by": "user",
  "call_time_window": {
    "windows": [
      {
        "start_min": 1,
        "end_min": 123,
        "days": [
          "Monday"
        ]
      }
    ],
    "timezone": "Asia/Seoul",
    "auto_resume": true
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.tryvox.co/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

조직 API 키를 Authorization: Bearer <token> 형식으로 보냅니다.

Path Parameters

campaign_id
string
required

캠페인 ID입니다.

Body

application/json

캠페인 수정 요청입니다. 수정 가능한 예약 관련 메타데이터만 변경할 수 있습니다.

v3 캠페인 수정 요청. draft/pending/paused 상태에서만 가능.

변경할 필드만 보내면 됩니다. name은 1~255자여야 하고, call_time_window를 보내면 전체 시간대 설정이 교체됩니다.

name
string

캠페인 이름입니다. 생략하면 변경하지 않습니다. null, 빈 문자열, 공백만 있는 문자열을 보내면 400을 반환합니다.

Required string length: 1 - 255
call_time_window
CallTimeWindowV3 · object

통화 허용 시간대 설정입니다. 생략하면 변경하지 않습니다. null로 보내면 400을 반환합니다.

Response

성공 응답

v3 캠페인 응답.

id
string
required

캠페인의 고유 식별자입니다.

name
string
required

캠페인 이름.

status
enum<string>
required

캠페인 상태 (7값): 'draft'(예약 대기), 'pending'(실행 대기), 'ongoing'(진행 중), 'paused'(일시정지), 'success'(완료), 'fail'(실패), 'canceled'(취소).

Available options:
draft,
pending,
ongoing,
paused,
success,
fail,
canceled
agent
AgentMapping · object
required

agent_idagent_version으로 구성된 에이전트 매핑 객체입니다.

from_number
string
required

발신 번호 (하이픈 없는 국내 번호).

total_calls
integer
required

전체 발신 수.

completed_calls
integer
required

성공 발신 수.

failed_calls
integer
required

실패+취소 발신 수.

concurrency
integer
required

최대 동시 발신 수.

active_concurrency
integer
required

현재 진행 중 동시 발신 수.

created_at
integer
required

리소스 생성 시각입니다. unix milliseconds 형식입니다.

presentation_number
string | null

표시 발신 번호. 미지정은 null.

scheduled_at
integer | null

예약 실행 시각입니다. unix milliseconds 형식입니다.

finished_at
integer | null

완료 시각입니다(unix ms). 완료 전에는 null입니다.

paused_at
integer | null

일시정지 시각 (unix ms). 일시정지 아니면 null.

paused_by
enum<string> | null

일시정지 주체 ('user': 수동, 'system': 시간대 기반 자동).

Available options:
user,
system
call_time_window
CallTimeWindowV3 · object

통화 허용 시간대 설정입니다. 설정하지 않으면 null입니다.