통화 목록 조회

POST

calls

list

통화 목록 조회

curl --request POST \
  --url https://client-api.tryvox.co/v2/calls/list \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "filter_criteria": {
    "agent_id": [
      "<string>"
    ],
    "disconnection_reason": [
      "user_hangup"
    ],
    "call_type": [
      "web"
    ],
    "user_sentiment": [
      "positive"
    ],
    "call_from": [
      "<string>"
    ],
    "call_to": [
      "<string>"
    ],
    "duration": {
      "upper_threshold": 123,
      "lower_threshold": 123
    },
    "start_timestamp": {
      "upper_threshold": 123,
      "lower_threshold": 123
    }
  },
  "sort_order": "descending",
  "limit": 50,
  "pagination_key": "<string>"
}
'

{
  "calls": [
    {
      "agent_id": "<string>",
      "call_id": "<string>",
      "call_type": "web",
      "call_from": "<string>",
      "call_to": "<string>",
      "dynamic_variables": {},
      "metadata": {},
      "disconnection_reason": "user_hangup",
      "start_timestamp": 123,
      "end_timestamp": 123,
      "duration_ms": 123,
      "transcript": [
        {
          "role": "agent",
          "content": "<string>",
          "start_at": 123,
          "end_at": 123
        }
      ],
      "transcript_with_tool_calls": [
        {
          "role": "agent",
          "content": "<string>",
          "start_at": 123,
          "end_at": 123
        }
      ],
      "recording_url": "<string>",
      "call_cost": {
        "total_credits_used": 123,
        "duration_seconds": 123
      },
      "call_analysis": {
        "summary": "<string>",
        "user_sentiment": "positive",
        "custom_analysis_data": [
          {}
        ]
      },
      "opt_out_sensitive_data_storage": false
    }
  ],
  "next_cursor": "<string>",
  "total_count": 0
}

Authorizations

Authorization

string

header

required

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

Body

application/json

통화 목록 조회를 위한 필터 및 페이징 옵션

filter_criteria

CallFilterCriteria · object

반환할 통화에 적용할 필터 조건

Show child attributes

filter_criteria.agent_id

string[] | null

에이전트 ID 목록으로 필터링

filter_criteria.disconnection_reason

enum<string>[] | null

통화 종료 사유로 필터링

통화 종료 사유 Enum

Available options:

user_hangup,

agent_hangup,

dial_no_answer,

dial_failed,

voicemail_reached,

concurrency_limit_reached,

insufficient_balance,

error_voxai,

max_duration_reached,

inactivity,

flow_error,

call_transfer

filter_criteria.call_type

enum<string>[] | null

통화 유형으로 필터링: 'web', 'phone', 'inbound', 'outbound', 'api', 'unknown'

통화 유형 Enum

Available options:

web,

phone,

inbound,

outbound,

api,

unknown

filter_criteria.user_sentiment

enum<string>[] | null

감정 분석 결과 라벨로 필터링

사용자 감정 Enum

Available options:

positive,

negative,

neutral,

unknown

filter_criteria.call_from

string[] | null

발신 번호로 필터링 (예: 01012345678)

filter_criteria.call_to

string[] | null

수신 번호로 필터링 (예: 01098765432)

filter_criteria.duration

TimestampFilter · object

통화 지속시간(초) 필터

Show child attributes

filter_criteria.duration.upper_threshold

integer | null

필터 범위의 상한값 (UNIX 타임스탬프, 초)

filter_criteria.duration.lower_threshold

integer | null

필터 범위의 하한값 (UNIX 타임스탬프, 초)

filter_criteria.start_timestamp

TimestampFilter · object

통화 시작 시간 (UNIX 타임스탬프, 초) 필터

Show child attributes

filter_criteria.start_timestamp.upper_threshold

integer | null

필터 범위의 상한값 (UNIX 타임스탬프, 초)

filter_criteria.start_timestamp.lower_threshold

integer | null

필터 범위의 하한값 (UNIX 타임스탬프, 초)

sort_order

string

default:descending

정렬 순서: 'ascending' 또는 'descending'

limit

integer

default:50

최대 반환 개수

Required range: 1 <= x <= 500

pagination_key

string | null

다음 페이지 조회를 위한 커서(통화 ID)

Response

Successful Response

통화 목록 조회 응답 모델

calls

CallDataDto · object[]

required

필터 조건에 부합하는 통화 목록

Show child attributes

calls.agent_id

string

required

calls.call_id

string

required

calls.call_type

enum<string>

required

통화 유형 Enum

Available options:

web,

phone,

inbound,

outbound,

api,

unknown

calls.call_from

string | null

calls.call_to

string | null

calls.dynamic_variables

Dynamic Variables · object

에이전트 컨텍스트에 사용되는 동적 변수

calls.metadata

Metadata · object

분석/추적을 위한 임의의 메타데이터

calls.disconnection_reason

enum<string> | null

통화 종료 사유 Enum

Available options:

user_hangup,

agent_hangup,

dial_no_answer,

dial_failed,

voicemail_reached,

concurrency_limit_reached,

insufficient_balance,

error_voxai,

max_duration_reached,

inactivity,

flow_error,

call_transfer

calls.start_timestamp

integer | null

calls.end_timestamp

integer | null

calls.duration_ms

integer | null

calls.transcript

TranscriptMessageDto · object[] | null

Show child attributes

calls.transcript.role

enum<string>

required

통화 대화록에서 사용되는 메시지 역할 정의

Available options:

agent,

user,

tool_call_invocation,

tool_call_result

calls.transcript.content

string

required

calls.transcript.start_at

integer | null

calls.transcript.end_at

integer | null

calls.transcript_with_tool_calls

(TranscriptMessageDto · object | ToolCallMessageDto · object | ToolCallResultMessageDto · object)[] | null

통화 대화록의 기본 메시지 모델

TranscriptMessageDto
ToolCallMessageDto
ToolCallResultMessageDto

Show child attributes

calls.transcript_with_tool_calls.role

enum<string>

required

통화 대화록에서 사용되는 메시지 역할 정의

Available options:

agent,

user,

tool_call_invocation,

tool_call_result

calls.transcript_with_tool_calls.content

string

required

calls.transcript_with_tool_calls.start_at

integer | null

calls.transcript_with_tool_calls.end_at

integer | null

calls.recording_url

string | null

calls.call_cost

CallCostDto · object

통화 비용 관련 지표 모델

Show child attributes

calls.call_cost.total_credits_used

integer

required

calls.call_cost.duration_seconds

integer

required

calls.call_analysis

CallAnalysisDto · object

통화 분석 결과 모델

Show child attributes

calls.call_analysis.summary

string

required

calls.call_analysis.user_sentiment

enum<string>

required

사용자 감정 Enum

Available options:

positive,

negative,

neutral,

unknown

calls.call_analysis.custom_analysis_data

Custom Analysis Data · object[] | null

통화에서 수집된 사용자 정의 분석 데이터

calls.opt_out_sensitive_data_storage

boolean

default:false

next_cursor

string | null

다음 페이지 조회에 사용할 커서 값

total_count

integer

default:0

필터에 부합하는 전체 통화 수

캠페인 조회캠페인 ID로 캠페인 상세 정보를 조회합니다. Bearer 토큰 인증이 필요합니다.

⌘I

통화 목록 조회

curl --request POST \
  --url https://client-api.tryvox.co/v2/calls/list \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "filter_criteria": {
    "agent_id": [
      "<string>"
    ],
    "disconnection_reason": [
      "user_hangup"
    ],
    "call_type": [
      "web"
    ],
    "user_sentiment": [
      "positive"
    ],
    "call_from": [
      "<string>"
    ],
    "call_to": [
      "<string>"
    ],
    "duration": {
      "upper_threshold": 123,
      "lower_threshold": 123
    },
    "start_timestamp": {
      "upper_threshold": 123,
      "lower_threshold": 123
    }
  },
  "sort_order": "descending",
  "limit": 50,
  "pagination_key": "<string>"
}
'

{
  "calls": [
    {
      "agent_id": "<string>",
      "call_id": "<string>",
      "call_type": "web",
      "call_from": "<string>",
      "call_to": "<string>",
      "dynamic_variables": {},
      "metadata": {},
      "disconnection_reason": "user_hangup",
      "start_timestamp": 123,
      "end_timestamp": 123,
      "duration_ms": 123,
      "transcript": [
        {
          "role": "agent",
          "content": "<string>",
          "start_at": 123,
          "end_at": 123
        }
      ],
      "transcript_with_tool_calls": [
        {
          "role": "agent",
          "content": "<string>",
          "start_at": 123,
          "end_at": 123
        }
      ],
      "recording_url": "<string>",
      "call_cost": {
        "total_credits_used": 123,
        "duration_seconds": 123
      },
      "call_analysis": {
        "summary": "<string>",
        "user_sentiment": "positive",
        "custom_analysis_data": [
          {}
        ]
      },
      "opt_out_sensitive_data_storage": false
    }
  ],
  "next_cursor": "<string>",
  "total_count": 0
}

통화

캠페인

지식 베이스

워크스페이스

테스트 엔드포인트

Legacy

Authorizations

Body

Response