openapi: 3.2.0
info:
  title: wazo-call-logd Voicemail Transcriptions API
  description: Consult call logs from a REST API
  version: 1.0.0
  contact:
    name: Wazo Dev Team
    url: https://wazo-platform.org/
    email: dev@wazo.community
  x-logo:
    url: https://wazo-platform.org/images/logo-black.svg
    backgroundColor: '#FAFAFA'
    altText: Wazo Logo
servers:
- url: /1.0
security:
- wazo_auth_token: []
tags:
- name: voicemail_transcriptions
paths:
  /voicemails/transcriptions:
    get:
      summary: List voicemail transcriptions
      description: '**Required ACL:** `call-logd.voicemails.transcriptions.read`'
      operationId: list_voicemail_transcriptions
      tags:
      - voicemail_transcriptions
      parameters:
      - $ref: '#/components/parameters/from'
      - $ref: '#/components/parameters/until'
      - $ref: '#/components/parameters/voicemail_id'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      - $ref: '#/components/parameters/order'
      - $ref: '#/components/parameters/direction'
      - $ref: '#/components/parameters/search_text'
      responses:
        '200':
          description: List of voicemail transcriptions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TranscriptionList'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    Transcription:
      type: object
      properties:
        message_id:
          type: string
          description: The voicemail message ID
        tenant_uuid:
          type: string
          format: uuid
        voicemail_id:
          type: integer
          description: The voicemail ID (mailbox number)
        transcription_text:
          type: string
          description: The transcription text
        provider_id:
          type: string
          description: Transcription provider/model identifier
        language:
          type: string
          description: Detected language code (ISO 639-1)
        duration:
          type: number
          format: float
          description: Voicemail duration in seconds
        created_at:
          type: string
          format: date-time
    TranscriptionList:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/Transcription'
        total:
          type: integer
        filtered:
          type: integer
  parameters:
    search_text:
      name: search_text
      in: query
      description: Full-text search in transcript content
      schema:
        type: string
    direction:
      required: false
      name: direction
      in: query
      description: Sort list of items in 'asc' (ascending) or 'desc' (descending) order
      schema:
        type: string
        enum:
        - asc
        - desc
    offset:
      required: false
      name: offset
      in: query
      description: Number of items to skip over in the list. Useful for pagination.
      schema:
        type: integer
    until:
      name: until
      description: Ignore CDR starting at or after the given date. Format is <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO-8601</a>.
      in: query
      required: false
      schema:
        type: string
        format: date-time
    limit:
      required: false
      name: limit
      in: query
      description: Maximum number of items to return in the list. Default to 1000 if not specified.
      schema:
        type: integer
    from:
      name: from
      description: Ignore CDR starting before the given date. Format is <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO-8601</a>.
      in: query
      required: false
      schema:
        type: string
        format: date-time
    voicemail_id:
      name: voicemail_id
      in: query
      description: The voicemail ID of the message
      style: form
      explode: false
      schema:
        type: array
        items:
          type: integer
    order:
      required: false
      name: order
      in: query
      description: 'Name of the field to use for sorting the list of items returned. Unsupported values: ``end``.'
      schema:
        type: string
        enum:
        - created_at
        - message_id
  responses:
    Unauthorized:
      description: Unauthorized
  securitySchemes:
    wazo_auth_token:
      type: apiKey
      name: X-Auth-Token
      in: header
x-xivo-port: 9298
x-xivo-name: call-logs
x-apievangelist-source:
  harvested_from: https://github.com/wazo-platform/wazo-call-logd
  assembly: base plugin api.yml deep-merged with all plugin api.yml fragments, reproducing what the running service serves at /api/call-logd/1.0/api/api.yml (see wazo_call_logd/plugins/api/http.py — xivo.chain_map.ChainMap)
  spec_version: Swagger 2.0 (as published by Wazo)
  harvested: '2026-08-17'