> ## 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 post /sms-batches/{batch_id}/resume
openapi: 3.1.0
info:
  title: vox.ai API
  description: >
    vox.ai API v3


    ### v3 공개 계약 규칙


    - 인증은 `Authorization: Bearer <token>` 헤더를 사용합니다. 워크스페이스 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-batches/{batch_id}/resume:
    post:
      tags:
        - SMS
      summary: 대량 문자 발신 재개
      description: 일시정지한 대량 문자 발신을 재개합니다. 일시정지 상태가 아니면 상태를 바꾸지 않고 그대로 돌려줍니다.
      operationId: resumeSmsBatch
      parameters:
        - name: batch_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            description: 대량 문자 발신의 UUID입니다.
            title: Batch Id
          description: 대량 문자 발신의 UUID입니다.
      responses:
        '200':
          description: 성공 응답
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SmsBatchResponse'
        '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 인증 주체(auth-principal) 리미터 윈도우가 초기화될 때까지 남은 시간입니다. 단위는
                초입니다. 개별 경로 자체 리미터가 만든 429 응답에는 이 헤더가 없을 수 있습니다.
              schema:
                type: integer
                minimum: 1
            X-RateLimit-Limit:
              description: >-
                초과한 공용 v3 인증 주체(auth-principal) 리미터 윈도우의 최대 요청 수입니다. 개별 경로 자체
                리미터가 만든 429 응답에는 이 헤더가 없을 수 있습니다.
              schema:
                type: integer
                minimum: 1
            X-RateLimit-Window:
              description: >-
                초과한 공용 v3 인증 주체(auth-principal) 리미터 윈도우의 길이입니다. 단위는 초입니다. 개별 경로
                자체 리미터가 만든 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:
    SmsBatchResponse:
      properties:
        id:
          type: string
          title: Id
          description: 대량 문자 발신의 고유 식별자입니다(UUID).
        name:
          anyOf:
            - type: string
            - type: 'null'
          title: Name
          description: 대량 문자 발신 이름입니다. 이름 없이 만든 이전 대량 문자 발신은 null입니다.
        status:
          type: string
          enum:
            - draft
            - pending
            - ongoing
            - paused
            - success
            - fail
            - canceled
          title: Status
          description: >-
            대량 문자 발신 상태입니다. canceled는 취소됨, paused는 일시정지 중, draft는 예약 시각 전의 대기
            상태입니다. 그 외에는 pending(발신 전), ongoing(발신 중이거나 발신이 끝난 뒤 통신사 결과를 기다리는
            중), success(모든 결과가 정해졌거나 마지막 발신 후 10분이 지나 끝남, 실패·차단 항목이 있을 수 있음),
            fail(접수된 항목 없이 끝남)입니다.
        from_number:
          type: string
          title: From Number
          description: 대량 문자 발신 전체가 공유하는 발신번호입니다.
        total_count:
          type: integer
          minimum: 0
          title: Total Count
          description: 이 대량 문자 발신에 담은 전체 문자 수입니다.
        success_count:
          type: integer
          minimum: 0
          title: Success Count
          description: 요금이 부과되는 성공(sent) 항목 수입니다.
        failure_count:
          type: integer
          minimum: 0
          title: Failure Count
          description: 발신에 실패한(failed) 항목 수입니다.
        pending_count:
          type: integer
          minimum: 0
          title: Pending Count
          description: >-
            아직 결과가 정해지지 않은 문자 수입니다. 발신하지 않은 pending 문자와 통신사의 최종 결과를 기다리는 queued
            문자를 합한 값이며, success_count + failure_count + pending_count +
            blocked_count + canceled_count가 total_count와 같습니다. 문자별 결과는 GET
            /v3/sms?batch_id= 로 조회합니다.
        blocked_count:
          type: integer
          minimum: 0
          title: Blocked Count
          description: 제한된 내용이 포함되어 발신하지 않은(blocked) 항목 수입니다.
        canceled_count:
          type: integer
          minimum: 0
          title: Canceled Count
          description: 대량 문자 발신 취소로 발신하지 않은(canceled) 항목 수입니다.
        send_time_window:
          anyOf:
            - $ref: '#/components/schemas/SMSBatchSendTimeWindow'
            - type: 'null'
          description: 발신 허용 시간대입니다. 시간대를 정하지 않고 만든 이전 대량 문자 발신은 null입니다.
        scheduled_at:
          anyOf:
            - type: integer
            - type: 'null'
          title: Scheduled At
          description: 예약 실행 시각입니다. unix milliseconds 형식입니다.
        paused_at:
          anyOf:
            - type: integer
            - type: 'null'
          title: Paused At
          description: 일시정지한 시각입니다(unix ms). 일시정지 중이 아니면 null입니다.
        canceled_at:
          anyOf:
            - type: integer
            - type: 'null'
          title: Canceled At
          description: 취소한 시각입니다(unix ms). 취소하지 않았으면 null입니다.
        created_at:
          type: integer
          title: Created At
          description: 리소스 생성 시각입니다. unix milliseconds 형식입니다.
        finished_at:
          anyOf:
            - type: integer
            - type: 'null'
          title: Finished At
          description: 대량 문자 발신이 끝난 시각입니다(unix ms). 끝나지 않았으면 null입니다.
        sheet_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Sheet Id
          description: 대량 문자 발신 생성에 사용한 시트 식별자입니다. 시트를 거치지 않았으면 null입니다.
      type: object
      required:
        - id
        - name
        - status
        - from_number
        - total_count
        - success_count
        - failure_count
        - pending_count
        - blocked_count
        - canceled_count
        - send_time_window
        - scheduled_at
        - paused_at
        - canceled_at
        - created_at
        - finished_at
        - sheet_id
      title: SmsBatchResponse
      description: 대량 문자 발신 한 건입니다. 문자별 결과는 GET /v3/sms?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입니다.
    SMSBatchSendTimeWindow:
      properties:
        windows:
          items:
            $ref: '#/components/schemas/SMSBatchTimeWindowItem'
          type: array
          minItems: 1
          title: Windows
          description: 허용 시간대 목록입니다(최소 1개).
        timezone:
          type: string
          title: Timezone
          description: 'IANA timezone 이름입니다. 예: `Asia/Seoul`.'
          default: Asia/Seoul
        auto_resume:
          type: boolean
          title: Auto Resume
          description: 허용 시간대에 다시 들어서면 자동으로 이어서 발신할지 여부입니다. 기본값은 true입니다.
          default: true
      additionalProperties: false
      type: object
      required:
        - windows
      title: SMSBatchSendTimeWindow
      description: 대량 문자 발신의 발신 허용 시간대 설정입니다.
    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`를 포함합니다.
    SMSBatchTimeWindowItem:
      properties:
        start_min:
          type: integer
          exclusiveMaximum: 1440
          minimum: 0
          title: Start Min
          description: 시작 시각입니다(자정 기준 분, 0~1439).
        end_min:
          type: integer
          maximum: 1440
          exclusiveMinimum: 0
          title: End Min
          description: 종료 시각입니다(자정 기준 분, 1~1440).
        days:
          items:
            type: string
            enum:
              - Monday
              - Tuesday
              - Wednesday
              - Thursday
              - Friday
              - Saturday
              - Sunday
          type: array
          minItems: 1
          title: Days
          description: 요일 이름입니다. Monday부터 Sunday까지의 영문 값을 사용합니다.
      additionalProperties: false
      type: object
      required:
        - start_min
        - end_min
        - days
      title: SMSBatchTimeWindowItem
      description: 대량 문자 발신의 발신 허용 시간대 한 구간입니다.
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Organization API key
      description: '워크스페이스 API 키를 `Authorization: Bearer <token>` 형식으로 보냅니다.'

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.