> ## 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. # SMS 배치 상태 조회 > SMS 대량 발송 캠페인의 상태와 항목별 결과를 폴링합니다. ## OpenAPI ````yaml /api-reference/v3/openapi.json get /sms/batch/{batch_id} 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: /sms/batch/{batch_id}: get: tags: - SMS summary: SMS 배치 상태 조회 description: SMS 대량 발송 캠페인의 상태와 항목별 결과를 폴링합니다. operationId: getSmsBatch parameters: - name: batch_id in: path required: true schema: type: string title: Batch Id description: SMS 대량 발송 등록이 반환한 배치 ID입니다. responses: '200': description: 성공 응답 content: application/json: schema: $ref: '#/components/schemas/SMSBatchStatusResponse' '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: 요청 한도를 초과했습니다. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: rateLimited: summary: 요청 한도를 초과했습니다. value: error: code: RATE_LIMIT_EXCEEDED message: Too many requests. details: limit: 5 window_seconds: 1 '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: SMSBatchStatusResponse: properties: batch_id: type: string title: Batch Id description: 배치의 고유 식별자 (UUID). title: anyOf: - type: string - type: 'null' title: Title description: 배치 라벨. 없으면 null. status: type: string enum: - pending - ongoing - success - fail title: Status description: >- 배치 캠페인 상태 ('pending'/'ongoing'/'success'/'fail'). success는 대기 항목이 없고 최소 1건이 발송된 상태로, 실패·차단 항목이 포함될 수 있다. total_count: type: integer minimum: 0 title: Total Count description: 전체 항목 수. success_count: type: integer minimum: 0 title: Success Count description: 발송된 항목 수. failure_count: type: integer minimum: 0 title: Failure Count description: 실패한 항목 수. pending_count: type: integer minimum: 0 title: Pending Count description: 대기(미발송) 항목 수. blocked_count: type: integer minimum: 0 title: Blocked Count description: 차단된 항목 수. created_at: type: integer title: Created At description: 리소스 생성 시각입니다. unix milliseconds 형식입니다. finished_at: anyOf: - type: integer - type: 'null' title: Finished At description: 배치 완료 시각 (unix ms). 미완이면 null. items: items: $ref: '#/components/schemas/SMSBatchItemStatus' type: array title: Items description: 항목별 상태 목록. type: object required: - batch_id - status - total_count - success_count - failure_count - pending_count - blocked_count - created_at - items title: SMSBatchStatusResponse description: GET /v3/sms/batch/{batch_id} 응답. 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입니다. SMSBatchItemStatus: properties: index: type: integer minimum: 0 title: Index description: 0-기반 제출 인덱스. to_number: type: string title: To Number description: 수신 번호. status: type: string enum: - pending - sent - failed - blocked title: Status description: 현재 항목 상태 ('pending'/'sent'/'failed'/'blocked'). sms_message_id: anyOf: - type: string - type: 'null' title: Sms Message Id description: 연결된 SMS 메시지 식별자. 없으면 null. error: anyOf: - $ref: '#/components/schemas/SMSBatchItemError' - type: 'null' description: 실패 항목의 에러 페이로드. 없으면 null. metadata: anyOf: - additionalProperties: true type: object - type: 'null' title: Metadata description: 등록 시 전달된 클라이언트 메타데이터. 없으면 null. type: object required: - index - to_number - status title: SMSBatchItemStatus description: GET /v3/sms/batch/{id} 응답의 항목 상태. 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`를 포함합니다. SMSBatchItemError: properties: code: type: string title: Code description: 기계 판독용 에러 코드. message: type: string title: Message description: 사람이 읽는 에러 메시지. details: additionalProperties: true type: object title: Details description: 구조화된 에러 상세. type: object required: - code - message title: SMSBatchItemError description: 배치 항목 실패 페이로드. securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: Organization API key description: '조직 API 키를 `Authorization: Bearer ` 형식으로 보냅니다.' ````