Skip to main content
GET
/
campaigns
캠페인 목록 조회
curl --request GET \
  --url https://client-api.tryvox.co/v3/campaigns \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "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
      }
    }
  ],
  "total_count": 123,
  "next_cursor": "<string>"
}

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> 형식으로 보냅니다.

Query Parameters

status
enum<string>[] | null

상태 필터입니다. 여러 상태를 지원하는 endpoint에서는 query parameter를 반복해서 전달합니다.

Available options:
draft,
pending,
ongoing,
paused,
success,
fail,
canceled
agent_id
string<uuid>[] | null

에이전트 UUID 필터입니다. 여러 에이전트로 필터링하려면 query parameter를 반복해서 전달합니다.

created_at_after
integer | null

생성 시각 하한입니다(unix ms 포함). 10~11자리 unix 초 입력도 허용하며, 자동으로 ms로 정규화합니다.

created_at_before
integer | null

생성 시각 상한입니다(unix ms 포함). 10~11자리 unix 초 입력도 허용하며, 자동으로 ms로 정규화합니다.

sort_order
enum<string>
default:desc

정렬 방향입니다. 허용값은 asc, desc입니다.

Available options:
asc,
desc
cursor
string | null

이전 응답의 next_cursor 값입니다. 다음 페이지를 조회할 때 그대로 전달합니다.

limit
integer
default:50

반환할 최대 항목 수입니다. v3 목록 endpoint는 1~100을 허용합니다.

Required range: 1 <= x <= 100

Response

성공 응답

캠페인 목록 페이지 응답입니다.

items
CampaignResponse · object[]
required

페이지 항목입니다.

total_count
integer
required

조건에 맞는 전체 항목 수입니다.

next_cursor
string | null

다음 페이지 커서입니다. 조회할 항목이 더 없으면 null입니다.