Skip to main content
POST
/
v2
/
campaigns
/
list
캠페인 목록 조회
curl --request POST \
  --url https://client-api.tryvox.co/v2/campaigns/list \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "filter_criteria": {
    "status": [
      "<string>"
    ],
    "agent_id": [
      "<string>"
    ],
    "start_timestamp": {
      "upper_threshold": 123,
      "lower_threshold": 123
    }
  },
  "sort_order": "descending",
  "limit": 50,
  "pagination_key": "<string>"
}'
{
  "campaigns": [
    {
      "id": "123",
      "name": "고객 설문 캠페인",
      "status": "ongoing",
      "agent_id": "550e8400-e29b-41d4-a716-446655440000",
      "agent_version": "production",
      "from_number": "07070001234",
      "presentation_number": "15881508",
      "total_calls": 200,
      "completed_calls": 180,
      "failed_calls": 20,
      "created_at": "2024-01-15T10:00:00Z",
      "scheduled_at": "2024-01-16T09:00:00Z",
      "finished_at": null,
      "concurrency": 10,
      "active_concurrency": 8,
      "organization_id": "550e8400-e29b-41d4-a716-446655440001"
    }
  ],
  "next_cursor": "456",
  "total_count": 25
}

Authorizations

Authorization
string
header
required

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

Body

application/json

캠페인 목록 조회 요청 모델

filter_criteria
object

캠페인 목록 조회용 필터 조건

sort_order
string
default:descending

정렬 순서

limit
integer
default:50

최대 반환 개수

Required range: 1 <= x <= 500
pagination_key
string | null

커서 기반 페이징을 위한 캠페인 ID

Response

Successful Response

캠페인 목록 조회 응답 모델

campaigns
CampaignDataDto · object[]
required
next_cursor
string | null
total_count
integer
default:0
I