> ## 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. # 채팅 목록 조회 > 인증한 워크스페이스의 채팅 목록을 조회합니다. 에이전트, 고객, 채널, 상태, 시작 시각으로 필터링합니다. 목록에는 대화록이 포함되지 않습니다. ## OpenAPI ````yaml /api-reference/v3/openapi.json get /chats openapi: 3.1.0 info: title: vox.ai API description: > vox.ai API v3 ### v3 공개 계약 규칙 - 인증은 `Authorization: Bearer ` 헤더를 사용합니다. 워크스페이스 API 키를 Bearer 토큰으로 전달합니다. - 요청과 응답 필드는 기본적으로 `snake_case`를 사용합니다. - `agent.data`는 에이전트 레지스트리와 호환되어야 하므로 `callSettings`, `toolIds`, `builtInTools`, `presetDynamicVariables` 같은 camelCase 필드를 유지합니다. - `_at`으로 끝나는 타임스탬프는 unix milliseconds입니다. 일부 입력값은 호환성을 위해 10~11자리 unix seconds도 허용하고 milliseconds로 정규화합니다. - 대량 발신 통화 가능 시간은 분 단위 정수(`start_min` / `end_min`)를 사용합니다. 알림 스케줄은 `HH:MM` 문자열(`start_time` / `end_time`)을 사용합니다. - 응답 객체 자신의 식별자는 `id`입니다. 다른 리소스를 참조하는 필드와 path parameter는 `agent_id`, `call_id`, `telephone_line_id`처럼 명시적인 이름을 사용합니다. - 실패 응답은 `{ "error": { "code", "message", "details" } }` 형태입니다. 가능한 경우 `details.field`, `details.reason`, `details.allowed_values`를 함께 제공합니다. version: 3.0.0 servers: - url: https://client-api.tryvox.co/v3 description: 운영 security: [] paths: /chats: get: tags: - Chats summary: 채팅 목록 조회 description: >- 인증한 워크스페이스의 채팅 목록을 조회합니다. 에이전트, 고객, 채널, 상태, 시작 시각으로 필터링합니다. 목록에는 대화록이 포함되지 않습니다. operationId: listChats parameters: - name: agent_id in: query required: false schema: anyOf: - type: array items: type: string format: uuid - type: 'null' description: 에이전트 UUID 필터입니다. 여러 에이전트를 조회하려면 쿼리 매개변수를 반복해서 전달합니다. title: Agent Id description: 에이전트 UUID 필터입니다. 여러 에이전트를 조회하려면 쿼리 매개변수를 반복해서 전달합니다. style: form explode: true - name: customer_id in: query required: false schema: anyOf: - type: string format: uuid - type: 'null' description: 귀속 고객 UUID 필터입니다. title: Customer Id description: 귀속 고객 UUID 필터입니다. - name: channel in: query required: false schema: anyOf: - items: type: string type: array - type: 'null' description: 등록된 채팅 channel 필터 (반복 가능)입니다. title: Channel description: 등록된 채팅 channel 필터 (반복 가능)입니다. style: form explode: true - name: status in: query required: false schema: anyOf: - type: array items: $ref: '#/components/schemas/ChatStatusEnum' - type: 'null' description: 상태 필터입니다. 여러 상태를 지원하는 endpoint에서는 query parameter를 반복해서 전달합니다. title: Status description: 상태 필터입니다. 여러 상태를 지원하는 endpoint에서는 query parameter를 반복해서 전달합니다. style: form explode: true - name: start_at_after in: query required: false schema: anyOf: - type: integer - type: 'null' description: 채팅 session 시작 시각 하한 (unix ms, inclusive)입니다. title: Start At After description: 채팅 session 시작 시각 하한 (unix ms, inclusive)입니다. - name: start_at_before in: query required: false schema: anyOf: - type: integer - type: 'null' description: >- 채팅 session 시작 시각 상한 (unix ms, 지정한 시각 이하)입니다. 같은 millisecond 안에서 이 시각보다 늦게 시작한 session은 제외됩니다. title: Start At Before description: >- 채팅 session 시작 시각 상한 (unix ms, 지정한 시각 이하)입니다. 같은 millisecond 안에서 이 시각보다 늦게 시작한 session은 제외됩니다. - name: sort_order in: query required: false schema: type: string description: 정렬 방향입니다. 허용값은 `asc`, `desc`입니다. default: desc title: Sort Order enum: - asc - desc description: 정렬 방향입니다. 허용값은 `asc`, `desc`입니다. - name: cursor in: query required: false schema: anyOf: - type: string - type: 'null' title: Cursor description: 이전 응답의 `next_cursor` 값입니다. 다음 페이지를 조회할 때 그대로 전달합니다. description: 이전 응답의 `next_cursor` 값입니다. 다음 페이지를 조회할 때 그대로 전달합니다. - name: limit in: query required: false schema: type: integer maximum: 100 minimum: 1 default: 50 title: Limit description: 반환할 최대 항목 수입니다. v3 목록 endpoint는 1~100을 허용합니다. description: 반환할 최대 항목 수입니다. v3 목록 endpoint는 1~100을 허용합니다. responses: '200': description: 성공 응답 content: application/json: schema: $ref: '#/components/schemas/PaginatedResponse_ChatListItemResponse_' '400': description: 요청 검증에 실패했습니다. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: validationError: summary: 요청 검증에 실패했습니다. value: error: code: VALIDATION_ERROR message: Request validation failed. details: field: name reason: must not be blank '401': description: 인증이 필요합니다. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: unauthorized: summary: Bearer 토큰 누락 또는 오류 value: error: code: UNAUTHORIZED message: Authentication is required. details: {} '403': description: 권한이 없습니다. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: forbidden: summary: 권한이 없습니다. value: error: code: FORBIDDEN message: Permission denied. details: {} '404': description: 리소스를 찾을 수 없습니다. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: notFound: summary: 리소스를 찾을 수 없습니다. value: error: code: RESOURCE_NOT_FOUND message: Resource not found. details: resource: agent '409': description: 충돌이 발생했습니다. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: conflict: summary: 상태 충돌 value: error: code: CONFLICT message: The requested operation conflicts with current state. details: current_status: draft '429': description: >- 요청 한도를 초과했습니다. API 키 트래픽의 기본 한도는 워크스페이스당 초당 5건과 분당 120건입니다. Supabase JWT 트래픽의 기본 한도는 사용자당 초당 10건과 분당 240건이며, 워크스페이스 대시보드에는 분당 2,400건의 기본 보조 한도가 적용됩니다. 운영자가 한도를 변경할 수 있습니다. 초과한 버킷에 적용된 한도와 기간은 429 응답의 `X-RateLimit-Limit` 및 `X-RateLimit-Window` 헤더로 알립니다. 개별 경로의 자체 제한기가 생성한 429 응답에는 이 헤더가 없을 수 있습니다. headers: Retry-After: description: >- 초과한 공용 v3 인증 주체 제한기의 기간이 초기화될 때까지 남은 초입니다. 개별 경로의 자체 제한기가 생성한 429 응답에는 이 헤더가 없을 수 있습니다. schema: type: integer minimum: 1 X-RateLimit-Limit: description: >- 초과한 공용 v3 인증 주체 제한기 기간의 최대 요청 수입니다. 개별 경로의 자체 제한기가 생성한 429 응답에는 이 헤더가 없을 수 있습니다. schema: type: integer minimum: 1 X-RateLimit-Window: description: >- 초과한 공용 v3 인증 주체 제한기 기간의 길이입니다. 단위는 초입니다. 개별 경로의 자체 제한기가 생성한 429 응답에는 이 헤더가 없을 수 있습니다. schema: type: integer minimum: 1 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: rateLimited: summary: 요청 한도 초과 value: error: code: RATE_LIMIT_EXCEEDED message: Too many requests. details: limit: 10 window_seconds: 1 scope: user '500': description: 서버 내부 오류가 발생했습니다. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: internalError: summary: 서버 내부 오류가 발생했습니다. value: error: code: INTERNAL_ERROR message: Internal server error. details: {} '503': description: 서비스를 일시적으로 사용할 수 없습니다. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: serviceUnavailable: summary: 서비스를 일시적으로 사용할 수 없습니다. value: error: code: SERVICE_UNAVAILABLE message: Service temporarily unavailable. details: {} security: - BearerAuth: [] components: schemas: ChatStatusEnum: type: string enum: - active - ended title: ChatStatusEnum PaginatedResponse_ChatListItemResponse_: properties: items: items: $ref: '#/components/schemas/ChatListItemResponse' type: array title: Items description: 페이지 항목입니다. next_cursor: anyOf: - type: string - type: 'null' title: Next Cursor description: 다음 페이지 커서입니다. 조회할 항목이 더 없으면 null입니다. total_count: type: integer title: Total Count description: 조건에 맞는 전체 항목 수입니다. type: object required: - items - total_count title: PaginatedResponse[ChatListItemResponse] ErrorResponse: type: object required: - error title: ErrorResponse description: 모든 실패 응답에서 사용하는 v3 error envelope입니다. examples: - error: code: VALIDATION_ERROR message: Request validation failed. details: field: name reason: must not be blank properties: error: $ref: '#/components/schemas/ErrorDetail' description: 오류 payload입니다. ChatListItemResponse: properties: provider_responder: anyOf: - type: string enum: - ai - external - unknown - type: 'null' title: Provider Responder description: 외부 채널 응대권의 조회 시점 상태입니다. 채널 원장에서 계산하며 별도로 저장하지 않습니다. id: type: string format: uuid title: Id description: 채팅 ID입니다. customer_id: anyOf: - type: string format: uuid - type: 'null' title: Customer Id description: 연결된 고객의 UUID입니다. 고객 식별자를 생략해도 익명 고객을 생성합니다. 고객 연결이 없으면 null일 수 있습니다. agent: $ref: '#/components/schemas/AgentMapping' description: '`agent_id`와 `agent_version`으로 구성된 에이전트 매핑 객체입니다.' channel: type: string pattern: ^[a-z][a-z0-9_]{0,31}$ title: Channel description: 채팅 채널입니다. 현재 api, widget, sms, kakao를 지원하며 등록된 채널 이름을 그대로 반환합니다. status: $ref: '#/components/schemas/ChatStatusEnum' description: 채팅 상태입니다. responder: $ref: '#/components/schemas/ChatResponderResponse' description: 현재 응답 주체입니다. AI, 상담사, 외부 채널 가운데 어느 쪽이 응답 중인지 확인합니다. metadata: additionalProperties: true type: object title: Metadata description: 생성 시 전달한 저장용 메타데이터입니다. dynamic_variables: additionalProperties: true type: object title: Dynamic Variables description: 생성 시 전달한 동적 변수입니다. start_at: type: integer title: Start At description: 채팅 시작 시각입니다. 밀리초 단위 Unix 타임스탬프입니다. end_at: anyOf: - type: integer - type: 'null' title: End At description: 채팅 종료 시각입니다. 밀리초 단위 Unix 타임스탬프이며 진행 중에는 null입니다. chat_analysis: anyOf: - $ref: '#/components/schemas/ChatAnalysisResponse' - type: 'null' description: 대화 종료 후 분석 결과입니다. 분석 완료 전에는 null 입니다. chat_cost: anyOf: - $ref: '#/components/schemas/ChatCostResponse' - type: 'null' description: 확정된 Chat AI 사용료입니다. active 상태이거나 전체 비용을 확정할 수 없으면 null입니다. type: object required: - id - customer_id - agent - channel - status - responder - metadata - dynamic_variables - start_at - end_at - chat_analysis - chat_cost title: ChatListItemResponse ErrorDetail: type: object required: - code - message - details title: ErrorDetail description: 기계가 읽을 수 있는 v3 오류 상세 정보입니다. examples: - code: VALIDATION_ERROR message: Request validation failed. details: field: name reason: must not be blank properties: code: type: string title: Code description: 기계가 읽을 수 있는 오류 code입니다. message parsing 대신 이 값을 사용합니다. examples: - VALIDATION_ERROR message: type: string title: Message description: 사용자에게 표시할 수 있는 오류 메시지입니다. 프로그램 처리는 `code`를 사용합니다. examples: - Request validation failed. details: type: object title: Details additionalProperties: true description: 구조화된 context입니다. 주로 `field`, `reason`, `allowed_values`를 포함합니다. AgentMapping: additionalProperties: false description: >- `agent_id`와 `agent_version` 매핑입니다. 요청·응답 모두에서 에이전트 매핑이 필요한 경우 이 타입을 사용합니다. version 지정이 필요 없는 엔드포인트는 flat `agent_id: UUID`를 직접 받고 `AgentMapping`을 사용하지 않습니다. properties: agent_id: description: 에이전트 UUID입니다. format: uuid title: Agent Id type: string agent_version: default: current description: >- 에이전트 버전입니다. 허용값은 "current", "production", "v{n}"(n≥1)입니다. 보내지 않으면 "current"로 처리합니다. null 전송은 거부합니다. title: Agent Version type: string pattern: ^(current|production|v[1-9][0-9]*)$ examples: - current - production - v1 required: - agent_id title: AgentMapping type: object ChatResponderResponse: properties: type: type: string enum: - ai - operator - external title: Type description: 현재 Chat 응답 주체입니다. external은 외부 채널에서 관리합니다. operator: anyOf: - $ref: '#/components/schemas/ChatResponderOperatorResponse' - type: 'null' description: 상담사 응답 중일 때의 공개 상담사 식별 정보입니다. since: type: integer title: Since description: 현재 응답 주체로 전환된 시각 (unix ms)입니다. type: object required: - type - operator - since title: ChatResponderResponse ChatAnalysisResponse: properties: summary: anyOf: - type: string - type: 'null' title: Summary description: 대화 내용의 자동 생성 요약입니다. user_sentiment: anyOf: - $ref: '#/components/schemas/UserSentimentDto' - type: 'null' description: 사용자의 감정 분석 결과입니다. 분석 완료 전에는 null입니다. custom_analysis_data: items: additionalProperties: true type: object type: array title: Custom Analysis Data description: 대화에서 수집된 사용자 정의 분석 데이터입니다. type: object required: - summary - user_sentiment - custom_analysis_data title: ChatAnalysisResponse description: 채팅 종료 후 생성된 분석 결과입니다. ChatCostResponse: properties: total_cost: type: string title: Total Cost description: 채팅 AI 사용료 합계(KRW 원 단위, Decimal 문자열)입니다. type: object required: - total_cost title: ChatCostResponse description: 확정된 채팅 AI 사용료입니다. ChatResponderOperatorResponse: properties: member_id: anyOf: - type: string format: uuid - type: 'null' title: Member Id description: 현재 응답 중인 상담사의 워크스페이스 멤버 ID입니다. type: object required: - member_id title: ChatResponderOperatorResponse UserSentimentDto: type: string enum: - positive - negative - neutral - unknown title: UserSentimentDto description: 사용자 감정 enum입니다. securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: Organization API key description: '워크스페이스 API 키를 `Authorization: Bearer ` 형식으로 보냅니다.' ````