SignalWire Conference Logs API

openapi: 3.2.0
info:
  title: SignalWire REST Conference Logs API
  version: 1.0.0
  contact:
    name: SignalWire
    url: https://support.signalwire.com/portal/en/newticket?departmentId=1029313000000006907&layoutId=1029313000000074011
    email: support@signalwire.com
  license:
    name: MIT
    url: https://github.com/signalwire/docs/blob/main/LICENSE
  termsOfService: https://signalwire.com/legal/signalwire-cloud-agreement
  description: Manage and query conference log data.
servers:
- url: https://{space_name}.signalwire.com
  description: SignalWire API
  variables:
    space_name:
      default: '{Your_Space_Name}'
      description: Your SignalWire Space name
security:
- SignalWireBasicAuth: []
tags:
- name: Conference Logs
  description: Manage and query conference log data.
  externalDocs:
    url: https://signalwire.com/docs/apis
    description: Developer documentation on SignalWire REST APIs
paths:
  /api/logs/conferences:
    get:
      operationId: list_conferences
      summary: List conference logs
      description: 'A list of Conferences.


        #### Permissions


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


        [Learn more about API scopes](/docs/platform/your-signalwire-api-space).'
      parameters:
      - $ref: '#/components/parameters/Logs.ConferenceLogListRequest.include_deleted'
      - $ref: '#/components/parameters/Logs.ConferenceLogListRequest.created_on'
      - $ref: '#/components/parameters/Logs.ConferenceLogListRequest.created_before'
      - $ref: '#/components/parameters/Logs.ConferenceLogListRequest.created_after'
      - $ref: '#/components/parameters/Logs.ConferenceLogListRequest.page_number'
      - $ref: '#/components/parameters/Logs.ConferenceLogListRequest.page_size'
      - $ref: '#/components/parameters/Logs.ConferenceLogListRequest.page_token'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Logs.ConferencesResponse'
        '401':
          description: Access is unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode401'
        '422':
          description: The request contains invalid parameters. See errors for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Logs.ConferenceLogsStatusCode422'
        '500':
          description: An internal server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode500'
      tags:
      - Conference Logs
components:
  schemas:
    Logs.ConferencesResponse:
      type: object
      required:
      - links
      - data
      properties:
        links:
          allOf:
          - $ref: '#/components/schemas/Logs.ConferenceLogPaginationLinks'
          description: Pagination links.
        data:
          type: array
          items:
            anyOf:
            - $ref: '#/components/schemas/Logs.CxmlConference'
            - $ref: '#/components/schemas/Logs.RelayConference'
            - $ref: '#/components/schemas/Logs.VideoRoomSessionConference'
          description: A list of conference logs.
      unevaluatedProperties:
        not: {}
      description: Response containing a list of conferences.
    Logs.RelayConference:
      type: object
      required:
      - id
      - created_at
      - project_id
      - region
      - name
      - status
      - max_size
      - current_participants
      - updated_at
      - type
      - recording_url
      - recording_duration
      - recording_file_size
      properties:
        id:
          allOf:
          - $ref: '#/components/schemas/uuid'
          description: Unique identifier for the conference.
          examples:
          - b9028451-b1d3-4690-b5d3-37b19d25f573
        created_at:
          type: string
          format: date-time
          description: Creation timestamp.
          examples:
          - '2025-03-11T01:49:49.630Z'
        project_id:
          allOf:
          - $ref: '#/components/schemas/uuid'
          description: Project ID of the conference.
          examples:
          - a77ce7d0-6ae8-4b33-a7a6-0bf1750d1e19
        region:
          type: string
          description: Region of the conference.
          examples:
          - us1
        name:
          anyOf:
          - type: string
          - type: 'null'
          description: Name of the conference.
          examples:
          - conference
        status:
          anyOf:
          - type: string
          - type: 'null'
          description: Status of the conference.
          examples:
          - in-progress
        max_size:
          anyOf:
          - type: integer
          - type: 'null'
          description: Maximum size of the conference.
          examples:
          - 2
        current_participants:
          type: integer
          description: Current participants in the conference.
          examples:
          - 1
        updated_at:
          type: string
          format: date-time
          description: Updated timestamp.
          examples:
          - '2025-03-12T01:49:49.630Z'
        type:
          type: string
          enum:
          - relay_conference
          description: Type of the conference.
          examples:
          - relay_conference
        recording_url:
          anyOf:
          - type: string
          - type: 'null'
          description: Recording URL of the conference.
          examples:
          - http://record.com
        recording_duration:
          anyOf:
          - type: integer
          - type: 'null'
          description: Recording duration of the conference.
          examples:
          - 123
        recording_file_size:
          anyOf:
          - type: integer
          - type: 'null'
          description: Recording file size of the conference.
          examples:
          - 12345
      unevaluatedProperties:
        not: {}
      description: Core conference object.
      title: Relay Conference
    Types.StatusCodes.StatusCode401:
      type: object
      required:
      - error
      properties:
        error:
          type: string
          enum:
          - Unauthorized
      unevaluatedProperties:
        not: {}
      description: Access is unauthorized.
    uuid:
      type: string
      format: uuid
      description: Universal Unique Identifier.
    Logs.ChargeDetails:
      type: object
      required:
      - description
      - charge
      properties:
        description:
          type: string
          description: Description for this charge.
          examples:
          - Tax
        charge:
          type: string
          description: Charge amount in dollars.
          examples:
          - '0.50'
      unevaluatedProperties:
        not: {}
    Logs.CxmlConference:
      type: object
      required:
      - id
      - created_at
      - project_id
      - region
      - name
      - status
      - max_size
      - current_participants
      - updated_at
      - type
      properties:
        id:
          allOf:
          - $ref: '#/components/schemas/uuid'
          description: Unique identifier for the conference.
          examples:
          - b9028451-b1d3-4690-b5d3-37b19d25f573
        created_at:
          type: string
          format: date-time
          description: Creation timestamp.
          examples:
          - '2025-03-11T01:49:49.630Z'
        project_id:
          allOf:
          - $ref: '#/components/schemas/uuid'
          description: Project ID of the conference.
          examples:
          - a77ce7d0-6ae8-4b33-a7a6-0bf1750d1e19
        region:
          type: string
          description: Region of the conference.
          examples:
          - us1
        name:
          anyOf:
          - type: string
          - type: 'null'
          description: Name of the conference.
          examples:
          - conference
        status:
          anyOf:
          - type: string
          - type: 'null'
          description: Status of the conference.
          examples:
          - in-progress
        max_size:
          anyOf:
          - type: integer
          - type: 'null'
          description: Maximum size of the conference.
          examples:
          - 2
        current_participants:
          type: integer
          description: Current participants in the conference.
          examples:
          - 1
        updated_at:
          type: string
          format: date-time
          description: Updated timestamp.
          examples:
          - '2025-03-12T01:49:49.630Z'
        type:
          type: string
          enum:
          - cxml_conference
          description: Type of the conference.
          examples:
          - cxml_conference
      unevaluatedProperties:
        not: {}
      description: Core conference object.
      title: cXML Conference
    Types.StatusCodes.StatusCode500:
      type: object
      required:
      - error
      properties:
        error:
          type: string
          enum:
          - Internal Server Error
      unevaluatedProperties:
        not: {}
      description: An internal server error occurred.
    Logs.ConferenceLogsStatusCode422:
      type: object
      required:
      - errors
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Types.StatusCodes.RestApiErrorItem'
          description: List of validation errors.
      unevaluatedProperties:
        not: {}
      description: The request contains invalid parameters. See errors for details.
      examples:
      - statusCode: 422
        errors:
        - type: validation_error
          code: invalid_parameter
          message: created_on is not a valid date or timestamp
          attribute: created_on
          url: https://signalwire.com/docs/apis/error-codes
    Types.StatusCodes.RestApiErrorItem:
      type: object
      required:
      - type
      - code
      - message
      - url
      properties:
        type:
          type: string
          description: The category of error.
          examples:
          - validation_error
        code:
          type: string
          description: A specific error code.
          examples:
          - invalid_parameter
        message:
          type: string
          description: A description of what caused the error.
          examples:
          - Name must be present
        attribute:
          anyOf:
          - type: string
          - type: 'null'
          description: The request parameter that caused the error, if applicable.
          examples:
          - name
        url:
          type: string
          description: A link to documentation about this error.
          examples:
          - https://signalwire.com/docs/apis/error-codes
      unevaluatedProperties:
        not: {}
      description: Details about a specific error.
    Logs.VideoRoomSessionConference:
      type: object
      required:
      - id
      - created_at
      - source
      - type
      - url
      - room_name
      - status
      - locked
      - started_at
      - ended_at
      - charge
      - charge_details
      properties:
        id:
          allOf:
          - $ref: '#/components/schemas/uuid'
          description: Unique identifier for the conference.
          examples:
          - b9028451-b1d3-4690-b5d3-37b19d25f573
        created_at:
          type: string
          format: date-time
          description: Creation timestamp.
          examples:
          - '2025-03-11T01:49:49.630Z'
        source:
          type: string
          description: Source of the conference.
          examples:
          - realtime_api
        type:
          type: string
          enum:
          - video_conference_session
          - video_room_session
          description: Type of the conference.
          examples:
          - video_conference_session
        url:
          type: string
          description: URL of the conference room session.
          examples:
          - https://test.signalwire.com/api/video/room_sessions/b9028451-b1d3-4690-b5d3-37b19d25f573
        room_name:
          anyOf:
          - type: string
          - type: 'null'
          description: Name of the conference room.
          examples:
          - dmjjSRZphrx8Y1do2MwE
        status:
          anyOf:
          - type: string
          - type: 'null'
          description: Status of the conference.
          examples:
          - completed
        locked:
          type: boolean
          description: Whether the conference is locked.
          examples:
          - false
        started_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          description: Timestamp when the conference started.
          examples:
          - '2025-03-11T01:49:51.069Z'
        ended_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          description: Timestamp when the conference ended.
          examples:
          - '2025-03-11T01:50:55.752Z'
        charge:
          type: string
          description: Total charge amount of the conference in dollars.
          examples:
          - '0.0'
        charge_details:
          type: array
          items:
            $ref: '#/components/schemas/Logs.ChargeDetails'
          description: Details on charges associated with this conference.
      unevaluatedProperties:
        not: {}
      description: Core conference object.
      title: Video Room Session
    Logs.ConferenceLogPaginationLinks:
      type: object
      required:
      - self
      - first
      properties:
        self:
          type: string
          description: Link to the current page.
          examples:
          - https://example.signalwire.com/api/logs/conferences?page_number=0&page_size=50
        first:
          type: string
          description: Link to the first page.
          examples:
          - https://example.signalwire.com/api/logs/conferences?page_size=50
        next:
          type: string
          description: Link to the next page. Only present when there are more results.
          examples:
          - https://example.signalwire.com/api/logs/conferences?page_number=1&page_size=50&page_token=PAb9028451-b1d3-4690-b5d3-37b19d25f573
        prev:
          type: string
          description: Link to the previous page. Only present when not on the first page.
          examples:
          - https://example.signalwire.com/api/logs/conferences?page_number=0&page_size=50&page_token=PBb9028451-b1d3-4690-b5d3-37b19d25f573
      unevaluatedProperties:
        not: {}
      description: Pagination links for conference log list responses.
  parameters:
    Logs.ConferenceLogListRequest.created_on:
      name: created_on
      in: query
      required: false
      description: Return logs for activity on this date. Accepts a date (YYYY-MM-DD) or ISO 8601 timestamp.
      schema:
        type: string
      explode: false
    Logs.ConferenceLogListRequest.include_deleted:
      name: include_deleted
      in: query
      required: false
      description: Include logs for deleted activity.
      schema:
        type: boolean
      explode: false
    Logs.ConferenceLogListRequest.page_size:
      name: page_size
      in: query
      required: false
      description: Specify the number of results to return on a single page. The default page size is `50` and the maximum is `1000`.
      schema:
        type: integer
        format: int32
        minimum: 1
        maximum: 1000
        default: 50
      explode: false
    Logs.ConferenceLogListRequest.page_number:
      name: page_number
      in: query
      required: false
      description: The page number to retrieve (0-indexed).
      schema:
        type: integer
        format: int32
        minimum: 0
        default: 0
      explode: false
    Logs.ConferenceLogListRequest.created_after:
      name: created_after
      in: query
      required: false
      description: Return logs for activity after this date. Accepts a date (YYYY-MM-DD) or ISO 8601 timestamp.
      schema:
        type: string
      explode: false
    Logs.ConferenceLogListRequest.page_token:
      name: page_token
      in: query
      required: false
      description: Token for cursor-based pagination. Required when `page_number` > 0.
      schema:
        type: string
      explode: false
    Logs.ConferenceLogListRequest.created_before:
      name: created_before
      in: query
      required: false
      description: Return logs for activity prior to this date. Accepts a date (YYYY-MM-DD) or ISO 8601 timestamp.
      schema:
        type: string
      explode: false
  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
    SignalWireBearerAuth:
      type: http
      scheme: Bearer
      description: 'SignalWire Bearer Token Authentication for subscriber endpoints.

        The client sends HTTP requests with the Authorization header containing

        the word Bearer followed by a space and the subscriber token.


        Example:

        ```

        Authorization: Bearer <subscriber_token>

        ```'