Ringover Transcriptions API

openapi: 3.2.0
info:
  license:
    name: Proprietary – Contact us for usage terms
    url: https://www.ringover.com/contact
  description: '# Ringover Public API


    Welcome to the Ringover Public API. This RESTful API lets you integrate Ringover telephony, messaging, contacts, and AI analytics into your applications. ## Base URL


    | Region | Base URL |

    |--------|----------|

    | Europe | `https://public-api.ringover.com/v2` |

    | United States | `https://public-api-us.ringover.com/v2` |


    ## Authentication


    All requests must include your API key in the `Authorization` header:


    ```

    Authorization: your-api-key-here

    ```


    To create an API key:

    1. Open the Ringover Dashboard. 2. Navigate to **Developer > API Keys**. 3. Click **Create an API key**, select a user, and set a label. 4. Configure the permissions for this key (see Permissions below). ## Permissions


    Each API key is associated with **7 permission categories**, each configurable as **None**, **Read**, **Write**, or **Read+Write**:


    | Category | Controls access to |

    |----------|-------------------|

    | **Calls** | Call history, archives, live call controls, callbacks |

    | **Contacts** | Contact CRUD and phone number management |

    | **Users** | User listing, plannings, presences, groups, user blacklists |

    | **Numbers** | Phone number listing, team blacklist |

    | **IVRs** | IVR/scenario listing, tag management |

    | **Conversations** | SMS/Chat conversations, messages, SMS sending |

    | **Empower** | AI call analysis, summaries, moments, analytics |


    ### The Monitoring flag (Supervision)


    In addition to R/W permissions, each API key has a **Monitoring** toggle that controls the **scope** of data returned:


    | Monitoring | Effect |

    |------------|--------|

    | **OFF** | Your permissions give access to **your own data only** (your calls, your numbers, your conversations…) |

    | **ON** | Your permissions give access to **the entire team''s data** (all users, all calls, all conversations…) |


    Monitoring does **not** grant additional permissions — it widens the scope of existing ones. Some routes **require** Monitoring to be enabled and will return `401` without it. Conversely, some routes may ignore the Monitoring flag entirely or apply it differently — unless stated otherwise in the endpoint documentation, the default behavior described above applies. > Each endpoint in this documentation specifies its exact permission and monitoring requirements. ### Special cases


    - **Campaigns, Tasks, WhatsApp**: These routes do not require specific token permissions. A valid API key is sufficient. - **Empower**: Uses its own role system (Admin / Supervisor / User) in addition to the Empower R/W permission. - **Transcriptions**: Access is controlled by a team-level setting, not by the token permissions. - **Conferences**: All conference routes require Monitoring enabled. ## Rate Limiting


    A **2-request-per-second** rate limit is applied per API key. Exceeding this limit returns `429 Too Many Requests`. ## Pagination


    List endpoints support offset-based pagination with two parameters:

    - `limit_count`: Maximum number of items to return (default: 100, max varies by endpoint). - `limit_offset`: Number of items to skip (default: 0). Some call-related endpoints also support cursor-based pagination via `last_id_returned`. ## Error Responses


    | HTTP Code | Meaning |

    |-----------|---------|

    | `400` | Bad request — invalid parameters or body |

    | `401` | Unauthorized — invalid/expired API key, or access denied by permission/monitoring checks on most endpoints |

    | `403` | Forbidden — authenticated request refused by specific endpoint logic (notably some Empower routes) or upstream forwarded services |

    | `402` | Payment required — feature not available on your plan |

    | `404` | Resource not found |

    | `429` | Rate limit exceeded |

    | `500` | Internal server error |


    ## SCIM 2.0 Provisioning


    Ringover exposes a **SCIM 2.0** server (RFC 7643 / RFC 7644) for automated user and group provisioning from your identity provider (Okta, Microsoft Entra ID, …). It reuses the **same API key** as the REST API (`Authorization` header).'
  version: 2.1.0
  title: Ringover Public Transcriptions API
  x-logo:
    url: https://webcdn.ringover.com/app/img/misc/logo_app_redoc.png
    backgroundColor: '#FAFAFA'
    altText: Ringover Logo
  termsOfService: https://ringover.com/terms/
  contact:
    email: support@ringover.com
servers:
- url: https://public-api.ringover.com/v2
  description: Production server (Europe)
- url: https://public-api-us.ringover.com/v2
  description: Production server (United States)
security:
- Authorization: []
tags:
- name: transcriptions
  description: 'Retrieve call transcriptions. Access is controlled by a team-level setting — your team must have the transcription feature enabled.


    **Permissions required:** Transcription access is based on a team-level setting, not on the API key permissions.'
paths:
  /transcriptions:
    get:
      operationId: getTranscriptions
      tags:
      - transcriptions
      x-permissions:
        required: Team-level (transcription feature must be enabled)
        monitoring: none
      summary: List call transcriptions
      description: 'Retrieves your team''s call transcriptions with optional filters (date range, duration, pagination).


        **Permission:** This endpoint is not governed by API token permissions. Your team must have the **transcription feature enabled** in its plan.


        **Monitoring:** No impact.


        For each transcription, in the items of the array of the transcription_data.speeches field, the field channelId takes one of the following values:

        - 1 for the caller emitting the call

        - 0 for the callee receiving the call


        If the call is received by a Ringover user while the call is emitted by a call member that is not a registered contact, the contact field will be null.


        The maximum rows returned has to be set in the parameter limit_count (limited to 100 rows). All the parameters are optional. The full text of each transcription is fetched per row, so larger pages would time out: paginate through your transcriptions with `limit_offset` in pages of up to 100. A `limit_count` above 100 is rejected with a `422`.


        **Search mode:** When the `search` query parameter is provided, a semantic vector search is run on transcription content. In this mode the filters `audio_duration_from`, `audio_duration_to`, `created_from`, `created_to` and `limit_offset` are **ignored**, and only `limit_count` is honored (it caps the number of matches returned, up to 100).'
      parameters:
      - name: limit_count
        in: query
        description: 'Maximum number of results to return per page (max 100). Default: 100.'
        schema:
          type: integer
          format: int64
          default: 100
          maximum: 100
          example: 100
      - name: limit_offset
        in: query
        description: The amount of transcriptions ignored, not returned
        schema:
          type: integer
          format: int64
          example: 0
      - name: search
        in: query
        description: 'Free-text search query on transcription content. When provided (and the transcription feature is enabled for the team), results are returned by semantic relevance and the filters

          `audio_duration_from`, `audio_duration_to`, `created_from`, `created_to` and `limit_offset` are **ignored**. Only `limit_count` is honored (it caps the number of matches).

          '
        schema:
          type: string
          example: refund request
      - name: audio_duration_from
        in: query
        description: Used to filter out calls under a certain duration. The filter applies to the **total duration of the call**, not to the duration of the recording.
        schema:
          type: integer
          format: int64
          example: 0
      - name: audio_duration_to
        in: query
        description: Used to filter out calls over a certain duration. The filter applies to the **total duration of the call**, not to the duration of the recording.
        schema:
          type: integer
          format: int64
          example: 0
      - name: created_from
        in: query
        description: 'Return calls created **after or at** this date.   The value must be in **UTC** and follow **ISO 8601 / RFC 3339** format   (e.g. `YYYY-MM-DDTHH:MM:SSZ`).

          '
        schema:
          type: string
          format: date-time
          example: '2025-09-15T16:02:49Z'
      - name: created_to
        in: query
        description: 'Return calls created **before or at** this date.   The value must be in **UTC** and follow **ISO 8601 / RFC 3339** format   (e.g. `YYYY-MM-DDTHH:MM:SSZ`).

          '
        schema:
          type: string
          format: date-time
          example: '2025-09-18T23:59:59Z'
      responses:
        '200':
          description: Successful operation — returns the list of transcriptions matching your filters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/transcription_list'
        '204':
          description: No content — no transcriptions match the given filters.
        '400':
          description: Bad request — invalid query parameter value.
        '401':
          description: Unauthorized — missing or invalid token, or transcription feature not enabled for your team.
        '500':
          description: Internal server error.
  /transcriptions/{callId}:
    get:
      operationId: getTranscriptionsCallid
      tags:
      - transcriptions
      x-permissions:
        required: Team-level (transcription feature must be enabled)
        monitoring: none
      summary: Get a single transcription by call ID
      description: 'Retrieves a single transcription by its Call ID.


        **Permission:** This endpoint is not governed by API token permissions. Your team must have the **transcription feature enabled** in its plan.


        **Monitoring:** No impact.


        For the returned transcription, in the items of the array of the transcription_data.speeches field, the field channelId takes one of the following values:

        - 1 for the caller emitting the call

        - 0 for the callee receiving the call


        If the call is received by a Ringover user while the call is emitted by a call member that is not a registered contact, the contact field will be null.'
      parameters:
      - name: callId
        in: path
        description: The identifier of the call
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful operation — returns the transcription for the specified call.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/transcription_list'
        '400':
          description: Bad request — invalid call ID format.
        '401':
          description: Unauthorized — missing or invalid token, or transcription feature not enabled for your team.
        '404':
          description: Not found — no transcription exists for the specified call ID.
        '500':
          description: Internal server error.
components:
  schemas:
    transcriptions_object:
      type: object
      properties:
        id:
          type: integer
          format: int64
          example: 88
        team_id:
          type: integer
          format: int64
          example: 16804
        user_id:
          type: integer
          format: int64
          example: 50907
        standard_id:
          type:
          - integer
          - 'null'
          format: int64
          example: null
        cdr_id:
          type: integer
          format: int64
          example: 991367
        call_id:
          type: string
          example: '11322631031026875934'
        channel_id:
          type: string
          example: '17857850318647956376'
        provider:
          type: string
          example: SPEECH_CALLITY
        user:
          $ref: '#/components/schemas/user_light'
        contact:
          description: 'The non-user call member which can be <em>null</em> if not registered as a contact.

            '
          $ref: '#/components/schemas/contact'
        transcription_data:
          type: object
          properties:
            duration:
              type: string
            num_channels:
              type: integer
            speeches:
              type: array
              items:
                type: object
                properties:
                  channelId:
                    type: integer
                    description: 'The identifier for the call members: the caller has the Channel ID <em>1</em>, and the callee has the Channel ID <em>0</em>.

                      '
                  start:
                    type: number
                  end:
                    type: number
                  duration:
                    type: number
                  text:
                    type: string
                  words:
                    type: array
                    items:
                      type: object
                      properties:
                        text:
                          type: string
                        start:
                          type: number
                        end:
                          type: number
                  named_entities:
                    type: array
                    items:
                      type: object
                      properties:
                        label:
                          type: string
                        text:
                          type: string
                        score:
                          type: number
                        start:
                          type: integer
                        end:
                          type: integer
            text:
              type: string
            prediction_time:
              type: number
        transcription_status:
          type: string
          example: DONE
        creation_date:
          type: string
          format: date-time
          example: '2018-06-12T23:23:40.99Z'
    user_light:
      type: object
      properties:
        user_id:
          type: integer
          format: int64
          description: The user identifier
          example: 123456
        team_id:
          type: integer
          format: int64
          description: The team identifier of the user
          example: 123456
        initial:
          type: string
          description: The initials of the user
          example: PM
        color:
          type: string
          example: 3CC8C8
        firstname:
          type: string
          description: The firstname of the user
          example: Pauline
        lastname:
          type: string
          description: The lastname of the user
          example: Martin
        company:
          type: string
          description: The company of the user
          example: Ringover
        email:
          type: string
          description: The email of the user
          example: pauline.martin@ringover.com
        picture:
          type: string
          description: The picture of the user
          example: https://cdn77.ringover.com/img/users/default.jpg
        concat_name:
          type: string
          example: Pauline Martin
    transcription_list:
      type: array
      items:
        $ref: '#/components/schemas/transcriptions_object'
    contact:
      type: object
      properties:
        contact_id:
          type: integer
          format: int64
          example: 654321
        is_shared:
          type: boolean
          example: true
        im_owner:
          type: string
        social_service:
          type:
          - string
          - 'null'
          example: null
        social_service_id:
          type: string
          example: 00P7U000015Ei75YBX
        social_profile_url:
          type:
          - string
          - 'null'
          example: null
        social_data:
          type:
          - string
          - 'null'
          example: null
        firstname:
          type: string
          example: John
        lastname:
          type: string
          example: Do
        company:
          type: string
          example: DoeCompany
        concat_name:
          type: string
          example: John Doe
        color:
          type: string
          example: 3CC8C8
        initial:
          type: string
          example: JD
        profile_picture:
          type:
          - string
          - 'null'
          example: null
        creation_date:
          type: string
          format: date-time
          example: '2018-08-12T12:12:40.53Z'
        numbers:
          type:
          - array
          - 'null'
          items:
            type: integer
            format: uint64
            example: 331797500010
  securitySchemes:
    Authorization:
      description: "We use API keys for authentication to authorize API requests. First, you need to create a public access token (API key) and select the appropriate rights for each user. To do so:\n  1. Open the Ringover Dashboard.\n  2. Go to the **Developer** section.\n  3. Click the **Create an API key** button.\n  4. Select a user in the drop-down menu and enter a label for the key and click the **Create** button.\n  5. Click the **Edit** button corresponding to the API key and select the appropriate rights.\n\nOnce you've created a public access token, you can use it in the `Authorization` header to authenticate your HTTP request.\n\n```\nAuthorization: <your-public-token>\n```\n\nThis is the **recommended authentication method** and the only one supported by the REST and SCIM endpoints.\n"
      type: apiKey
      name: Authorization
      in: header
    AuthorizationQuery:
      description: '**Alternative authentication method, only available on the MCP endpoint (`/mcp`).**


        Pass your Public API token via the `token` query string parameter:


        ```

        POST /mcp?token=<your-public-token>

        ```


        Useful for clients (no-code platforms, browser tools, etc.) that cannot set custom HTTP headers.


        See the **mcp** tag for details on the three accepted authentication sources and their precedence.

        '
      type: apiKey
      name: token
      in: query
    AuthorizationPath:
      description: '**Alternative authentication method, only available on the MCP endpoint (`/mcp/{token}`).**


        Pass your Public API token directly inside the URL path:


        ```

        POST /mcp/<your-public-token>

        ```


        Most permissive variant — works with any HTTP client, including those that strip custom headers and query strings.


        > ⚠️ The token appears in URLs and is therefore likely to be logged by proxies, browsers and access logs. Prefer the `Authorization` header whenever your client supports it, and rotate any token that may have leaked.


        OpenAPI 3.0 does not support `apiKey` in `path`, so this scheme is declared in `query` for tooling compatibility — the actual transport is the URL path. See the **mcp** tag for details.

        '
      type: apiKey
      name: token
      in: query
x-tagGroups:
- name: Ringover Public API
  tags:
  - How to paginate?
  - teams
  - groups
  - users
  - numbers
  - ivrs
  - tags
  - conferences
  - calls
  - campaigns
  - channels
  - contacts
  - conversations
  - messages
  - sms
  - profiles
  - presences
  - blacklist
  - webhook
  - callbacks
  - surveys
  - snoozes
  - transcriptions
  - cdn
  - empower
  - whatsapp
  - task
  - mcp
- name: SCIM 2.0 Provisioning
  tags:
  - scim