Ringover Conferences 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 Conferences 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: Conferences
  description: 'Manage conference rooms. List conferences and update access PIN codes.


    **Permissions required:** No specific permission category, but **Monitoring must be ON** for all conference routes. Returns `401` if Monitoring is OFF.'
paths:
  /conferences:
    get:
      operationId: getConferences
      tags:
      - Conferences
      x-permissions:
        required: none
        monitoring: required
      summary: List all conference rooms
      description: 'Retrieves all conference rooms (audio bridges) configured for your team. A conference room allows multiple participants to join a shared audio call using a dedicated phone number and PIN code. Each conference includes its assigned number, participant PIN, admin PIN, and capacity settings. The total count is in the `list_count` field.


        **Permission:** No specific permission required. A valid API key is sufficient.


        **Monitoring:** **Required.** Conference management is a team-level supervisory feature. Returns `401 Unauthorized` if Monitoring is OFF on your API key.'
      responses:
        '200':
          description: Successful operation — returns the list of conferences.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/conference_list'
        '204':
          description: No conferences found.
        '401':
          description: Unauthorized — invalid or missing API token, or Monitoring is OFF.
        '500':
          description: Internal server error.
  /conferences/{conferenceId}:
    get:
      operationId: getConferencesConferenceid
      tags:
      - Conferences
      x-permissions:
        required: none
        monitoring: required
      summary: Get a conference room by ID
      description: 'Retrieves detailed information about a specific conference room by its identifier, including its assigned phone number, participant PIN code, admin PIN code, name, and configuration. Use `GET /conferences` to discover available conference IDs.


        **Permission:** No specific permission required. A valid API key is sufficient.


        **Monitoring:** **Required.** Conference details are a team-level supervisory feature. Returns `401 Unauthorized` if Monitoring is OFF on your API key.'
      parameters:
      - name: conferenceId
        in: path
        description: The identifier of the conference
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: Successful operation — returns the conference details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/conference'
        '400':
          description: Invalid conference identifier.
        '401':
          description: Unauthorized — invalid or missing API token, or Monitoring is OFF.
        '404':
          description: Conference not found.
        '500':
          description: Internal server error.
  /conferences/{conferenceId}/pincode/{pincodeId}:
    patch:
      operationId: patchConferencesConferenceidPincodePincodeid
      tags:
      - Conferences
      x-permissions:
        required: none
        monitoring: required
      summary: Update a conference participant PIN code
      description: 'Updates the participant PIN code for a specific conference room. The new PIN code value is passed directly in the URL path as `pincodeId`. Participants will need to use the new PIN to join the conference. If the new PIN is the same as the current one, the request returns `304 Not Modified`.


        **Permission:** No specific permission required. A valid API key is sufficient.


        **Monitoring:** **Required.** Conference configuration changes are team-level supervisory operations. Returns `401 Unauthorized` if Monitoring is OFF on your API key.'
      parameters:
      - name: conferenceId
        in: path
        description: The identifier of the conference
        required: true
        schema:
          type: integer
          format: int64
      - name: pincodeId
        in: path
        description: The identifier of the pincode
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: Successful operation — pincode updated.
        '304':
          description: Pincode value unchanged (same as current).
        '400':
          description: Invalid conference or pincode identifier.
        '401':
          description: Unauthorized — invalid or missing API token, or Monitoring is OFF.
        '404':
          description: Conference not found.
        '500':
          description: Internal server error.
components:
  schemas:
    conference_list:
      type: object
      properties:
        list_count:
          type: integer
          format: int64
          description: The size of the list
          example: 1
        list:
          type: array
          items:
            $ref: '#/components/schemas/conference'
    number:
      type: object
      properties:
        number:
          type: integer
          description: Phone number in E.164 format without the `+` prefix (e.g., `33612345678`).
          example: 33184800000
        label:
          type: string
          description: The label of the number
          example: myfavoritenumber
        type:
          type: string
          description: The type of the number
          example: PHONE
        user_id:
          type: integer
          format: int64
          description: The user identifier
          example: 60907
        ivr_id:
          type: integer
          format: int64
          description: The unique identifier of the IVR. Use `GET /ivrs` to discover available IVR IDs.
          example: 60908
        conference_id:
          type: integer
          format: int64
          description: The conference identifier
          example: 60908
        is_sms:
          type: boolean
          example: false
        is_sms_write:
          type: boolean
          example: false
        is_callable:
          type: boolean
          example: false
        format:
          $ref: '#/components/schemas/format_number'
    conference:
      type: object
      properties:
        conference_id:
          type: integer
          format: int64
          description: The conference identifier
          example: 60908
        name:
          type: string
          description: The name of the conference
          example: SoConference
        numbers:
          type: array
          items:
            $ref: '#/components/schemas/number'
          description: The numbers of the conference
    format_number:
      type: object
      properties:
        raw:
          type: integer
          format: int64
          example: 184800000
        country_code:
          type: string
          example: '33'
        country:
          type: string
          example: FR
        e164:
          type: string
          example: '+33184800000'
        international:
          type: string
          example: +33 1 84 80 00 00
        international_alt:
          type: string
          example: '33184800000'
        national:
          type: string
          example: 01 84 80 00 00
        national_alt:
          type: string
          example: 0184800000
        rfc3966:
          type: string
          example: tel:+33-1-84-80-00-00
        is_short_code:
          type: boolean
          example: false
  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