SignalWire

SignalWire Conferences API

Manage conference calls.

Documentation GitHub OpenAPI

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/signalwire-conferences-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Compatibility Conferences API
  version: 1.0.0
  description: Manage conference calls.
servers:
- url: https://{space_name}.signalwire.com/api/laml/2010-04-01
  description: SignalWire Compatibility API
  variables:
    space_name:
      default: YOUR_SPACE
      description: Your SignalWire Space name
security:
- SignalWireBasicAuth: []
tags:
- name: Conferences
  description: Manage conference calls.
  externalDocs:
    url: https://signalwire.com/docs/compatibility-api/rest
    description: Developer documentation on the Compatibility REST API
paths:
  /Accounts/{AccountSid}/Conferences:
    get:
      operationId: list_all_conferences
      summary: List All Conferences
      description: 'The ability to read all of the conferences that are associated with your Account. This will be returned as a list of conferences.


        #### Permissions


        The API token used to authenticate must have the following scope(s) enabled to make a successful request: _Voice_.


        [Learn more about API scopes](/docs/platform/your-signalwire-api-space).'
      parameters:
      - $ref: '#/components/parameters/ConferencesAccountSidPath'
      - name: DateCreated
        in: query
        required: false
        description: 'Shows conferences that were created on the date provided. Format: YYYY-MM-DD.'
        schema:
          type: string
        explode: false
      - name: DateCreated<
        in: query
        required: false
        description: 'Shows conferences that were created before the date provided. Format: YYYY-MM-DD.'
        schema:
          type: string
        explode: false
      - name: DateCreated>
        in: query
        required: false
        description: 'Shows conferences that were created after the date provided. Format: YYYY-MM-DD.'
        schema:
          type: string
        explode: false
      - name: DateUpdated
        in: query
        required: false
        description: 'Shows conferences that were updated on the date provided. Format: YYYY-MM-DD.'
        schema:
          type: string
        explode: false
      - name: DateUpdated<
        in: query
        required: false
        description: 'Shows conferences that were updated before the date provided. Format: YYYY-MM-DD.'
        schema:
          type: string
        explode: false
      - name: DateUpdated>
        in: query
        required: false
        description: 'Shows conferences that were updated after the date provided. Format: YYYY-MM-DD.'
        schema:
          type: string
        explode: false
      - name: FriendlyName
        in: query
        required: false
        description: A description, up to 64 characters, of the conference room.
        schema:
          type: string
          maxLength: 64
        explode: false
      - name: Status
        in: query
        required: false
        description: The status of this conference.
        schema:
          $ref: '#/components/schemas/ConferenceStatus'
        explode: false
      - name: Page
        in: query
        required: false
        description: The page number to retrieve. Page numbers are zero-indexed, so the first page is 0.
        schema:
          type: integer
          format: int32
          minimum: 0
          default: 0
        explode: false
      - name: PageSize
        in: query
        required: false
        description: The number of results to return per page. The default is 50, and the maximum is 1000.
        schema:
          type: integer
          format: int32
          minimum: 1
          maximum: 1000
          default: 50
        explode: false
      - name: PageToken
        in: query
        required: false
        description: A token used to retrieve a specific page of results. Must start with PA or PB.
        schema:
          type: string
        explode: false
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConferenceListResponse'
        '400':
          description: The request was invalid or cannot be processed. Check the error details for more information.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompatibilityErrorResponse'
        '401':
          description: Authentication failed. Please verify your credentials and try again.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompatibilityErrorResponse'
        '422':
          description: The request could not be processed due to validation errors. Check the error details for more information.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompatibilityErrorResponse'
      tags:
      - Conferences
  /Accounts/{AccountSid}/Conferences/{Sid}:
    get:
      operationId: retrieve_conference
      summary: Retrieve a Conference
      description: 'Retrieve a single conference.


        #### Permissions


        The API token used to authenticate must have the following scope(s) enabled to make a successful request: _Voice_.


        [Learn more about API scopes](/docs/platform/your-signalwire-api-space).'
      parameters:
      - $ref: '#/components/parameters/ConferencesAccountSidPath'
      - $ref: '#/components/parameters/ConferenceSidPath'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConferenceResponse'
        '400':
          description: The request was invalid or cannot be processed. Check the error details for more information.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompatibilityErrorResponse'
        '401':
          description: Authentication failed. Please verify your credentials and try again.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompatibilityErrorResponse'
        '404':
          description: The requested resource was not found. Please verify the resource identifier.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompatibilityErrorResponse'
      tags:
      - Conferences
    post:
      operationId: update_conference
      summary: Update Conference
      description: 'Allows you to modify the properties of a conference.


        #### Permissions


        The API token used to authenticate must have the following scope(s) enabled to make a successful request: _Voice_.


        [Learn more about API scopes](/docs/platform/your-signalwire-api-space).'
      parameters:
      - $ref: '#/components/parameters/ConferencesAccountSidPath'
      - $ref: '#/components/parameters/ConferenceSidPath'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConferenceResponse'
        '400':
          description: The request was invalid or cannot be processed. Check the error details for more information.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompatibilityErrorResponse'
        '401':
          description: Authentication failed. Please verify your credentials and try again.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompatibilityErrorResponse'
        '404':
          description: The requested resource was not found. Please verify the resource identifier.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompatibilityErrorResponse'
        '422':
          description: The request could not be processed due to validation errors. Check the error details for more information.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompatibilityErrorResponse'
        '503':
          description: The service is temporarily unavailable. Please try again later.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompatibilityErrorResponse'
      tags:
      - Conferences
      requestBody:
        required: false
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/UpdateConferenceRequest'
components:
  schemas:
    ConferenceStatus:
      type: string
      enum:
      - init
      - in-progress
      - completed
      description: Conference status.
    uuid:
      type: string
      format: uuid
      description: Universal Unique Identifier.
    ConferenceResponse:
      type: object
      required:
      - sid
      - account_sid
      - date_created
      - date_updated
      - friendly_name
      - status
      - api_version
      - region
      - uri
      - subresource_uris
      properties:
        sid:
          allOf:
          - $ref: '#/components/schemas/uuid'
          description: The unique identifier for this conference.
          examples:
          - b3877c40-da60-4998-90ad-b792e98472cf
        account_sid:
          allOf:
          - $ref: '#/components/schemas/uuid'
          description: The unique identifier for the account that created this conference.
          examples:
          - b3877c40-da60-4998-90ad-b792e98472af
        date_created:
          type: string
          description: The date, in RFC 2822 format, this conference was created.
          examples:
          - Mon, 24 Sept 2018 21:00:00 +0000
        date_updated:
          type: string
          description: The date, in RFC 2822 format, this conference was updated.
          examples:
          - Tue, 25 Sept 2018 20:00:00 +0000
        friendly_name:
          type: string
          description: A description, up to 64 characters, of the conference room.
          examples:
          - My Conference Room
        status:
          allOf:
          - $ref: '#/components/schemas/ConferenceStatus'
          description: The status of this conference.
        api_version:
          type: string
          description: The version of the SignalWire API.
          examples:
          - '2010-04-01'
        region:
          type: string
          description: The region where this conference audio was mixed.
          examples:
          - us1
        uri:
          type: string
          description: The URI for this conference.
          examples:
          - /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Conferences/b3877c40-da60-4998-90ad-b792e98472cf.json
        subresource_uris:
          allOf:
          - $ref: '#/components/schemas/ConferenceSubresourceUris'
          description: The links to associated subresources.
      unevaluatedProperties:
        not: {}
      description: Response containing a single conference.
    Conference:
      type: object
      required:
      - sid
      - account_sid
      - date_created
      - date_updated
      - friendly_name
      - status
      - api_version
      - region
      - uri
      - subresource_uris
      properties:
        sid:
          allOf:
          - $ref: '#/components/schemas/uuid'
          description: The unique identifier for this conference.
          examples:
          - b3877c40-da60-4998-90ad-b792e98472cf
        account_sid:
          allOf:
          - $ref: '#/components/schemas/uuid'
          description: The unique identifier for the account that created this conference.
          examples:
          - b3877c40-da60-4998-90ad-b792e98472af
        date_created:
          type: string
          description: The date, in RFC 2822 format, this conference was created.
          examples:
          - Mon, 24 Sept 2018 21:00:00 +0000
        date_updated:
          type: string
          description: The date, in RFC 2822 format, this conference was updated.
          examples:
          - Tue, 25 Sept 2018 20:00:00 +0000
        friendly_name:
          type: string
          description: A description, up to 64 characters, of the conference room.
          examples:
          - My Conference Room
        status:
          allOf:
          - $ref: '#/components/schemas/ConferenceStatus'
          description: The status of this conference.
        api_version:
          type: string
          description: The version of the SignalWire API.
          examples:
          - '2010-04-01'
        region:
          type: string
          description: The region where this conference audio was mixed.
          examples:
          - us1
        uri:
          type: string
          description: The URI for this conference.
          examples:
          - /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Conferences/b3877c40-da60-4998-90ad-b792e98472cf.json
        subresource_uris:
          allOf:
          - $ref: '#/components/schemas/ConferenceSubresourceUris'
          description: The links to associated subresources.
      unevaluatedProperties:
        not: {}
      description: Conference model.
    ConferenceSubresourceUris:
      type: object
      required:
      - participants
      - recordings
      properties:
        participants:
          type: string
          description: Links to the participants.
          examples:
          - /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Conferences/b3877c40-da60-4998-90ad-b792e98472cf/Participants.json
        recordings:
          type: string
          description: Links to the recordings.
          examples:
          - /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Conferences/b3877c40-da60-4998-90ad-b792e98472cf/Recordings.json
      unevaluatedProperties:
        not: {}
      description: Conference subresource URIs.
    UpdateConferenceRequest:
      type: object
      properties:
        Status:
          type: string
          enum:
          - completed
          description: The status of this conference. Only 'completed' is allowed to end the conference.
          examples:
          - completed
        AnnounceUrl:
          type: string
          format: uri
          description: The URL to send conference announcements to.
          examples:
          - https://your-api-endpoint.com/announce
        AnnounceMethod:
          type: string
          enum:
          - GET
          - POST
          description: Whether the request to `AnnounceUrl` is a `GET` or a `POST`. Default is `POST`.
          examples:
          - POST
          default: POST
      unevaluatedProperties:
        not: {}
      description: Request body for updating a conference.
    ConferenceListResponse:
      type: object
      required:
      - uri
      - first_page_uri
      - next_page_uri
      - previous_page_uri
      - page
      - page_size
      - conferences
      properties:
        uri:
          type: string
          description: The URI of the current page.
          examples:
          - /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Conferences?PageToken=PA1234
        first_page_uri:
          type: string
          description: The URI of the first page.
          examples:
          - /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Conferences
        next_page_uri:
          anyOf:
          - type: string
          - type: 'null'
          description: The URI of the next page.
          examples:
          - /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Conferences?Page=1&PageToken=PA5678
        previous_page_uri:
          anyOf:
          - type: string
          - type: 'null'
          description: The URI of the previous page.
          examples:
          - null
        page:
          type: integer
          format: int32
          description: The current page number.
          examples:
          - 0
        page_size:
          type: integer
          format: int32
          description: The number of items per page.
          examples:
          - 50
        conferences:
          type: array
          items:
            $ref: '#/components/schemas/Conference'
          description: List of conferences.
      unevaluatedProperties:
        not: {}
      description: Response containing a list of conferences.
    CompatibilityErrorResponse:
      type: object
      required:
      - code
      - message
      - more_info
      - status
      properties:
        code:
          type: integer
          format: int32
          description: Error code.
          examples:
          - 20003
        message:
          type: string
          description: Error message.
          examples:
          - Authentication failed
        more_info:
          type: string
          description: URL for more information about the error.
          examples:
          - https://signalwire.com/docs/compatibility-api/reference/errors
        status:
          type: integer
          format: int32
          description: HTTP status code.
          examples:
          - 401
      unevaluatedProperties:
        not: {}
      description: Error response model.
  parameters:
    ConferenceSidPath:
      name: Sid
      in: path
      required: true
      description: The unique identifier for this conference.
      schema:
        $ref: '#/components/schemas/uuid'
    ConferencesAccountSidPath:
      name: AccountSid
      in: path
      required: true
      description: The unique identifier for the account that created this conference.
      schema:
        $ref: '#/components/schemas/uuid'
  securitySchemes:
    SignalWireBasicAuth:
      type: http
      scheme: Basic
      description: 'SignalWire Basic Authentication using Project ID and API Token.


        The client sends HTTP requests with the Authorization header containing

        the word Basic followed by a space and a base64-encoded string of project_id:token.

        The project ID will be used as the username and the API token as the password.


        Example:

        ```

        Authorization: Basic base64(project_id:token)

        ```'
      x-fern-basic:
        username:
          name: project_id
          env: SIGNALWIRE_PROJECT_ID
        password:
          name: api_token
          env: SIGNALWIRE_API_TOKEN