openapi: 3.0.0
info:
  title: Compatibility API
  version: 1.0.0
tags:
  - name: Accounts
  - name: Applications
  - name: Available Phone Numbers
  - name: Calls
  - name: Recordings
  - name: Streams
  - name: Conferences
  - name: Conference Participants
  - name: Conference Recordings
  - name: Conference Streams
  - name: Faxes
  - name: Fax Media
  - name: Incoming Phone Numbers
  - name: Imported Phone Numbers
  - name: Messages
  - name: Media
  - name: Recording Transcriptions
  - name: Queues
  - name: Queue Members
  - name: Tokens
  - name: cXML Scripts
    description: Manage cXML scripts for storing XML instructions.
    x-displayName: cXML Scripts
paths:
  /Accounts:
    get:
      operationId: list_accounts
      summary: List Accounts
      description: |-
        This endpoint will return a list that contains Project you are connecting as and any subprojects.

        #### Permissions
        The API token must include the following scopes: _Management_.
      parameters:
        - name: FriendlyName
          in: query
          required: false
          description: 'A named unique identifier for the resource. Allowed characters: `A-Za-z0-9_-`. Maximum of 100 characters.'
          schema:
            type: string
          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. The token is returned in the response of a previous request.
          schema:
            type: string
          explode: false
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountListResponse'
        '401':
          description: Authentication failed. Please verify your credentials and try again.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompatibilityErrorResponse'
      tags:
        - Accounts
    post:
      operationId: create_subprojects
      summary: Create Subprojects
      description: |-
        This endpoint creates a subproject on the Project you are connecting as.

        #### Permissions
        The API token must include the following scopes: _Management_.
      parameters: []
      responses:
        '201':
          description: Response containing a newly created subproject account.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Account'
        '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'
      tags:
        - Accounts
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CreateSubprojectRequest'
  /Accounts/{AccountSid}/Applications:
    get:
      operationId: list_applications
      summary: List Applications
      description: |-
        The ability to read all of the applications that are associated with your Account. This will be returned as a list of applications.

        #### Permissions
        The API token must include one of the following scopes: _Voice_ or _Messaging_ or _Fax_.
      parameters:
        - $ref: '#/components/parameters/AccountSidPath'
        - name: FriendlyName
          in: query
          required: false
          description: Filter by a named unique identifier for the resource.
          schema:
            type: string
          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.
          schema:
            type: string
          explode: false
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationListResponse'
        '401':
          description: Authentication failed. Please verify your credentials and try again.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompatibilityErrorResponse'
      tags:
        - Applications
    post:
      operationId: create_application
      summary: Create an Application
      description: |-
        Create an Application.

        #### Permissions
        The API token must include one of the following scopes: _Voice_ or _Messaging_ or _Fax_.
      parameters:
        - $ref: '#/components/parameters/AccountSidPath'
      responses:
        '201':
          description: Response containing a newly created application.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Application'
        '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'
      tags:
        - Applications
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CreateApplicationRequest'
  /Accounts/{AccountSid}/Applications/{Sid}:
    get:
      operationId: get_application
      summary: Find an Application by ID
      description: |-
        Find an Application by ID.

        #### Permissions
        The API token must include one of the following scopes: _Voice_ or _Messaging_ or _Fax_.
      parameters:
        - $ref: '#/components/parameters/AccountSidPath'
        - $ref: '#/components/parameters/ApplicationPathSid'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationResponse'
        '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:
        - Applications
    post:
      operationId: update_application
      summary: Update an Application
      description: |-
        Update an Application.

        #### Permissions
        The API token must include one of the following scopes: _Voice_ or _Messaging_ or _Fax_.
      parameters:
        - $ref: '#/components/parameters/AccountSidPath'
        - $ref: '#/components/parameters/ApplicationPathSid'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationResponse'
        '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:
        - Applications
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/UpdateApplicationRequest'
    delete:
      operationId: delete_application
      summary: Delete an Application
      description: |-
        Delete an Application.

        #### Permissions
        The API token must include one of the following scopes: _Voice_ or _Messaging_ or _Fax_.
      parameters:
        - $ref: '#/components/parameters/AccountSidPath'
        - $ref: '#/components/parameters/ApplicationPathSid'
      responses:
        '204':
          description: 204 No Content response.
        '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:
        - Applications
  /Accounts/{AccountSid}/AvailablePhoneNumbers:
    get:
      operationId: list_available_phone_number_resources
      summary: List of AvailablePhoneNumber resources
      description: |-
        Returns a list of URIs to phone number resources available to the account, categorized by type (Local, Toll-Free, Mobile, etc) and ISO country.

        #### Permissions
        The API token must include the following scopes: _Numbers_.
      parameters:
        - $ref: '#/components/parameters/AvailablePhoneNumbersAccountSidPath'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AvailablePhoneNumberResourcesResponse'
        '401':
          description: Authentication failed. Please verify your credentials and try again.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompatibilityErrorResponse'
      tags:
        - Available Phone Numbers
  /Accounts/{AccountSid}/AvailablePhoneNumbers/{IsoCountry}:
    get:
      operationId: list_available_phone_number_resources_by_country
      summary: List of AvailablePhoneNumber resources by country
      description: |-
        Returns a list of URIs to phone number resources available to the account in the specified ISO country, categorized by type (Local, Toll-Free, Mobile, etc).

        #### Permissions
        The API token must include the following scopes: _Numbers_.
      parameters:
        - $ref: '#/components/parameters/AvailablePhoneNumbersAccountSidPath'
        - $ref: '#/components/parameters/IsoCountryPath'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AvailablePhoneNumberByCountryResponse'
        '401':
          description: Authentication failed. Please verify your credentials and try again.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompatibilityErrorResponse'
      tags:
        - Available Phone Numbers
  /Accounts/{AccountSid}/AvailablePhoneNumbers/{IsoCountry}/Local:
    get:
      operationId: search_local_available_phone_numbers
      summary: Search for available phone numbers that match your criteria.
      description: |-
        Search for Local AvailablePhoneNumbers.

        #### Permissions
        The API token must include the following scopes: _Numbers_.
      parameters:
        - $ref: '#/components/parameters/AvailablePhoneNumbersAccountSidPath'
        - $ref: '#/components/parameters/IsoCountryPath'
        - name: AreaCode
          in: query
          required: false
          description: Find numbers in the provided area code. Only available for numbers in US and Canada.
          schema:
            type: string
          explode: false
        - name: Beta
          in: query
          required: false
          description: New numbers on SignalWire are marked as `beta`.
          schema:
            type: boolean
          explode: false
        - name: Contains
          in: query
          required: false
          description: Find numbers based off of a pattern. Valid characters are `[0-9a-zA-Z]`.
          schema:
            type: string
          explode: false
        - name: ExcludeAllAddressRequired
          in: query
          required: false
          description: Whether or not to exclude numbers that require an address anywhere in the world.
          schema:
            type: boolean
          explode: false
        - name: ExcludeForeignAddressRequired
          in: query
          required: false
          description: Whether or not to exclude numbers that require a foreign address.
          schema:
            type: boolean
          explode: false
        - name: ExcludeLocalAddressRequired
          in: query
          required: false
          description: Whether or not to exclude numbers that require a local address.
          schema:
            type: boolean
          explode: false
        - name: FaxEnabled
          in: query
          required: false
          description: Whether or not a number can receive faxes.
          schema:
            type: boolean
          explode: false
        - name: InLocality
          in: query
          required: false
          description: Limits search to a city/locality. Requires InRegion to also be set.
          schema:
            type: string
          explode: false
        - name: InRegion
          in: query
          required: false
          description: Limits search to same region as number. Must be a two-letter state/province code.
          schema:
            type: string
          explode: false
        - name: MmsEnabled
          in: query
          required: false
          description: Whether or not a number can receive MMS messages.
          schema:
            type: boolean
          explode: false
        - name: SmsEnabled
          in: query
          required: false
          description: Whether or not a number can receive SMS messages.
          schema:
            type: boolean
          explode: false
        - name: VoiceEnabled
          in: query
          required: false
          description: Whether or not a number can receive calls.
          schema:
            type: boolean
          explode: false
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AvailablePhoneNumberListResponse'
        '401':
          description: Authentication failed. Please verify your credentials and try again.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompatibilityErrorResponse'
      tags:
        - Available Phone Numbers
  /Accounts/{AccountSid}/AvailablePhoneNumbers/{IsoCountry}/TollFree:
    get:
      operationId: search_toll_free_available_phone_numbers
      summary: Find toll-free numbers.
      description: |-
        Search for toll-free AvailablePhoneNumbers.

        #### Permissions
        The API token must include the following scopes: _Numbers_.
      parameters:
        - $ref: '#/components/parameters/AvailablePhoneNumbersAccountSidPath'
        - $ref: '#/components/parameters/IsoCountryPath'
        - name: AreaCode
          in: query
          required: false
          description: Find numbers in the provided area code. Only available for numbers in US and Canada.
          schema:
            type: string
          explode: false
        - name: Beta
          in: query
          required: false
          description: New numbers on SignalWire are marked as `beta`.
          schema:
            type: boolean
          explode: false
        - name: Contains
          in: query
          required: false
          description: Find numbers based off of a pattern. Valid characters are `[0-9a-zA-Z]`.
          schema:
            type: string
          explode: false
        - name: ExcludeAllAddressRequired
          in: query
          required: false
          description: Whether or not to exclude numbers that require an address anywhere in the world.
          schema:
            type: boolean
          explode: false
        - name: ExcludeForeignAddressRequired
          in: query
          required: false
          description: Whether or not to exclude numbers that require a foreign address.
          schema:
            type: boolean
          explode: false
        - name: ExcludeLocalAddressRequired
          in: query
          required: false
          description: Whether or not to exclude numbers that require a local address.
          schema:
            type: boolean
          explode: false
        - name: FaxEnabled
          in: query
          required: false
          description: Whether or not a number can receive faxes.
          schema:
            type: boolean
          explode: false
        - name: InLocality
          in: query
          required: false
          description: Limits search to a city/locality. Requires InRegion to also be set.
          schema:
            type: string
          explode: false
        - name: InRegion
          in: query
          required: false
          description: Limits search to same region as number. Must be a two-letter state/province code.
          schema:
            type: string
          explode: false
        - name: MmsEnabled
          in: query
          required: false
          description: Whether or not a number can receive MMS messages.
          schema:
            type: boolean
          explode: false
        - name: SmsEnabled
          in: query
          required: false
          description: Whether or not a number can receive SMS messages.
          schema:
            type: boolean
          explode: false
        - name: VoiceEnabled
          in: query
          required: false
          description: Whether or not a number can receive calls.
          schema:
            type: boolean
          explode: false
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AvailablePhoneNumberListResponse'
        '401':
          description: Authentication failed. Please verify your credentials and try again.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompatibilityErrorResponse'
      tags:
        - Available Phone Numbers
  /Accounts/{AccountSid}/Calls:
    get:
      operationId: list_all_calls
      summary: List all Calls
      description: |-
        List all calls.

        #### Permissions
        The API token must include the following scopes: _Voice_.
      parameters:
        - $ref: '#/components/parameters/CallsAccountSidPath'
        - name: EndTime
          in: query
          required: false
          description: The time, in RFC 2822 GMT format, on which the call was terminated.
          schema:
            type: string
          explode: false
        - name: EndTime<
          in: query
          required: false
          description: The time before which the call was terminated.
          schema:
            type: string
          explode: false
        - name: EndTime>
          in: query
          required: false
          description: The time after which the call was terminated.
          schema:
            type: string
          explode: false
        - name: From
          in: query
          required: false
          description: The address that initiated the call.
          schema:
            type: string
          explode: false
        - name: ParentCallSid
          in: query
          required: false
          description: The unique identifier for the call that created this call.
          schema:
            type: string
            format: uuid
          explode: false
        - name: StartTime
          in: query
          required: false
          description: The time, in RFC 2822 GMT format, on which the call began.
          schema:
            type: string
          explode: false
        - name: StartTime<
          in: query
          required: false
          description: The time before which the call began.
          schema:
            type: string
          explode: false
        - name: StartTime>
          in: query
          required: false
          description: The time after which the call began.
          schema:
            type: string
          explode: false
        - name: Status
          in: query
          required: false
          description: The status of the call.
          schema:
            type: string
            enum:
              - queued
              - ringing
              - in-progress
              - canceled
              - completed
              - busy
              - failed
              - no-answer
          explode: false
        - name: To
          in: query
          required: false
          description: The address that received the call.
          schema:
            type: string
          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/CallListResponse'
        '401':
          description: Authentication failed. Please verify your credentials and try again.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompatibilityErrorResponse'
      tags:
        - Calls
    post:
      operationId: create_a_call
      summary: Create a Call
      description: |-
        Create a call.

        #### Permissions
        The API token must include the following scopes: _Voice_.
      parameters:
        - $ref: '#/components/parameters/CallsAccountSidPath'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CallResponse'
        '400':
          description: The request was invalid. Review the errors array for specific issues with your request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompatibilityErrorArrayResponse'
        '401':
          description: Authentication failed. Please verify your credentials and try again.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompatibilityErrorResponse'
      tags:
        - Calls
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CreateCallRequest'
  /Accounts/{AccountSid}/Calls/{CallSid}/Recordings:
    post:
      operationId: create_recording
      summary: Create a Recording.
      description: |-
        Create a recording.

        #### Permissions
        The API token must include the following scopes: _Voice_.
      parameters:
        - $ref: '#/components/parameters/CallsAccountSidPath'
        - $ref: '#/components/parameters/CallSidPathForRecording'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CallRecordingResponse'
        '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:
        - Recordings
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CreateCallRecordingRequest'
  /Accounts/{AccountSid}/Calls/{CallSid}/Recordings/{Sid}:
    post:
      operationId: update_recording
      summary: Update a Recording
      description: |-
        Pause, resume or stop a Recording. You can control what happens while recording is paused (replace pause with silence or skip it).

        #### Permissions
        The API token must include the following scopes: _Voice_.
      parameters:
        - $ref: '#/components/parameters/CallsAccountSidPath'
        - $ref: '#/components/parameters/CallSidPathForRecording'
        - $ref: '#/components/parameters/CallSidPath'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CallRecordingResponse'
        '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'
      tags:
        - Recordings
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/UpdateCallRecordingRequest'
  /Accounts/{AccountSid}/Calls/{CallSid}/Streams:
    post:
      operationId: create_stream
      summary: Create a Stream.
      description: |-
        Create a stream.

        #### Permissions
        The API token must include the following scopes: _Voice_.
      parameters:
        - $ref: '#/components/parameters/CallsAccountSidPath'
        - $ref: '#/components/parameters/CallSidPathForRecording'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CallStreamResponse'
        '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'
      tags:
        - Streams
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CreateCallStreamRequest'
  /Accounts/{AccountSid}/Calls/{CallSid}/Streams/{Sid}:
    post:
      operationId: update_stream
      summary: Stop a Stream
      description: |-
        Stop a Stream.

        #### Permissions
        The API token must include the following scopes: _Voice_.
      parameters:
        - $ref: '#/components/parameters/CallsAccountSidPath'
        - $ref: '#/components/parameters/CallSidPathForRecording'
        - $ref: '#/components/parameters/CallSidPath'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CallStreamResponse'
        '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:
        - Streams
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/UpdateCallStreamRequest'
  /Accounts/{AccountSid}/Calls/{Sid}:
    get:
      operationId: retrieve_a_call
      summary: Retrieve a Call
      description: |-
        Retrieve a call.

        #### Permissions
        The API token must include the following scopes: _Voice_.
      parameters:
        - $ref: '#/components/parameters/CallsAccountSidPath'
        - $ref: '#/components/parameters/CallSidPath'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CallResponse'
        '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:
        - Calls
    post:
      operationId: update_a_call
      summary: Update a Call
      description: |-
        Update a call.

        #### Permissions
        The API token must include the following scopes: _Voice_.
      parameters:
        - $ref: '#/components/parameters/CallsAccountSidPath'
        - $ref: '#/components/parameters/CallSidPath'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CallResponse'
        '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'
      tags:
        - Calls
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/UpdateCallRequest'
    delete:
      operationId: delete_a_call
      summary: Delete a Call
      description: |-
        Delete a call record from your account. If the delete is successful, a 204 response, with no body, will be returned.

        #### Permissions
        The API token must include the following scopes: _Voice_.
      parameters:
        - $ref: '#/components/parameters/CallsAccountSidPath'
        - $ref: '#/components/parameters/CallSidPath'
      responses:
        '204':
          description: 204 No Content response.
        '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'
      tags:
        - Calls
  /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 must include the following scopes: _Voice_.
      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/{ConferenceSid}/Participants:
    get:
      operationId: list_all_participants
      summary: List all active Participants
      description: |-
        The ability to read all of the active participants that are associated with this conference call. This will be returned as a list of participants.

        #### Permissions
        The API token must include the following scopes: _Voice_.
      parameters:
        - $ref: '#/components/parameters/ConferencesAccountSidPath'
        - $ref: '#/components/parameters/ConferenceSidPathForParticipant'
        - name: Muted
          in: query
          required: false
          description: Whether or not a participant is muted.
          schema:
            type: boolean
          explode: false
        - name: Hold
          in: query
          required: false
          description: Whether or not a participant is on hold.
          schema:
            type: boolean
          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/ConferenceParticipantListResponse'
        '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'
      tags:
        - Conference Participants
  /Accounts/{AccountSid}/Conferences/{ConferenceSid}/Participants/{CallSid}:
    get:
      operationId: retrieve_participant
      summary: Retrieve a Participant
      description: |-
        Retrieve a single participant.

        #### Permissions
        The API token must include the following scopes: _Voice_.
      parameters:
        - $ref: '#/components/parameters/ConferencesAccountSidPath'
        - $ref: '#/components/parameters/ConferenceSidPathForParticipant'
        - $ref: '#/components/parameters/ParticipantCallSidPath'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConferenceParticipantResponse'
        '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:
        - Conference Participants
    post:
      operationId: update_participant
      summary: Update a Participant
      description: |-
        Update a participant.

        #### Permissions
        The API token must include the following scopes: _Voice_.
      parameters:
        - $ref: '#/components/parameters/ConferencesAccountSidPath'
        - $ref: '#/components/parameters/ConferenceSidPathForParticipant'
        - $ref: '#/components/parameters/ParticipantCallSidPath'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConferenceParticipantResponse'
        '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'
      tags:
        - Conference Participants
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/UpdateConferenceParticipantRequest'
    delete:
      operationId: delete_participant
      summary: Delete a Participant
      description: |-
        Deleting a participant will take them out of a conference call.

        #### Permissions
        The API token must include the following scopes: _Voice_.
      parameters:
        - $ref: '#/components/parameters/ConferencesAccountSidPath'
        - $ref: '#/components/parameters/ConferenceSidPathForParticipant'
        - $ref: '#/components/parameters/ParticipantCallSidPath'
      responses:
        '204':
          description: 204 No Content response.
        '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'
      tags:
        - Conference Participants
  /Accounts/{AccountSid}/Conferences/{ConferenceSid}/Recordings:
    get:
      operationId: list_conference_recordings
      summary: List Conference Recordings
      description: |-
        List all recordings for a conference.

        #### Permissions
        The API token must include the following scopes: _Voice_.
      parameters:
        - $ref: '#/components/parameters/ConferencesAccountSidPath'
        - $ref: '#/components/parameters/ConferenceSidPathForParticipant'
        - name: DateCreated
          in: query
          required: false
          description: 'Shows recordings that were created on the date provided. Format: YYYY-MM-DD.'
          schema:
            type: string
          explode: false
        - name: DateCreated<
          in: query
          required: false
          description: 'Shows recordings that were created before the date provided. Format: YYYY-MM-DD.'
          schema:
            type: string
          explode: false
        - name: DateCreated>
          in: query
          required: false
          description: 'Shows recordings that were created after the date provided. Format: YYYY-MM-DD.'
          schema:
            type: string
          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/ConferenceRecordingListResponse'
        '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'
      tags:
        - Conference Recordings
  /Accounts/{AccountSid}/Conferences/{ConferenceSid}/Recordings/{Sid}:
    get:
      operationId: get_conference_recording
      summary: Get a Conference Recording
      description: |-
        Get details for a specific conference recording.

        #### Permissions
        The API token must include the following scopes: _Voice_.
      parameters:
        - $ref: '#/components/parameters/ConferencesAccountSidPath'
        - $ref: '#/components/parameters/ConferenceSidPathForParticipant'
        - $ref: '#/components/parameters/ConferenceRecordingSidPath'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConferenceRecordingResponse'
        '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:
        - Conference Recordings
    post:
      operationId: update_conference_recording
      summary: Update a Conference Recording
      description: |-
        Pause, resume or stop a conference recording. You can control what happens while recording is paused (replace pause with silence or skip it).

        #### Permissions
        The API token must include the following scopes: _Voice_.
      parameters:
        - $ref: '#/components/parameters/ConferencesAccountSidPath'
        - $ref: '#/components/parameters/ConferenceSidPathForParticipant'
        - $ref: '#/components/parameters/ConferenceRecordingSidPath'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConferenceRecordingResponse'
        '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. Review the errors array for specific issues.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompatibilityErrorStringArrayResponse'
        '503':
          description: The service is temporarily unavailable. Please try again later.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompatibilityErrorResponse'
      tags:
        - Conference Recordings
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/UpdateConferenceRecordingRequest'
    delete:
      operationId: delete_conference_recording
      summary: Delete a Conference Recording
      description: |-
        Delete a conference recording. If successful, a 204 response with no body will be returned.

        #### Permissions
        The API token must include the following scopes: _Voice_.
      parameters:
        - $ref: '#/components/parameters/ConferencesAccountSidPath'
        - $ref: '#/components/parameters/ConferenceSidPathForParticipant'
        - $ref: '#/components/parameters/ConferenceRecordingSidPath'
      responses:
        '204':
          description: 204 No Content response.
        '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:
        - Conference Recordings
  /Accounts/{AccountSid}/Conferences/{ConferenceSid}/Streams:
    post:
      operationId: create_conference_stream
      summary: Create a Conference Stream.
      description: |-
        Create a stream for an existing conference.

        #### Permissions
        The API token must include the following scopes: _Voice_.
      parameters:
        - $ref: '#/components/parameters/ConferencesAccountSidPath'
        - $ref: '#/components/parameters/ConferenceSidPathForParticipant'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConferenceStreamResponse'
        '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. Review the errors array for specific issues.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompatibilityErrorStringArrayResponse'
      tags:
        - Conference Streams
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CreateConferenceStreamRequest'
  /Accounts/{AccountSid}/Conferences/{ConferenceSid}/Streams/{Sid}:
    post:
      operationId: update_conference_stream
      summary: Update Conference Stream
      description: |-
        Update an existing conference stream. Commonly used to stop/start streams or modify stream properties.

        #### Permissions
        The API token must include the following scopes: _Voice_.
      parameters:
        - $ref: '#/components/parameters/ConferencesAccountSidPath'
        - $ref: '#/components/parameters/ConferenceSidPathForParticipant'
        - $ref: '#/components/parameters/ConferenceSidPath'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConferenceStreamResponse'
        '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. Review the errors array for specific issues.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompatibilityErrorStringArrayResponse'
      tags:
        - Conference Streams
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/UpdateConferenceStreamRequest'
  /Accounts/{AccountSid}/Conferences/{Sid}:
    get:
      operationId: retrieve_conference
      summary: Retrieve a Conference
      description: |-
        Retrieve a single conference.

        #### Permissions
        The API token must include the following scopes: _Voice_.
      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 must include the following scopes: _Voice_.
      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'
  /Accounts/{AccountSid}/Faxes:
    get:
      operationId: list_all_faxes
      summary: List all Faxes
      description: |-
        List all faxes.

        #### Permissions
        The API token must include the following scopes: _Fax_.
      parameters:
        - $ref: '#/components/parameters/FaxesAccountSidPath'
        - name: Page
          in: query
          required: false
          description: The page index to retrieve. Zero-indexed.
          schema:
            type: integer
            format: int32
            minimum: 0
            default: 0
          explode: false
        - name: PageSize
          in: query
          required: false
          description: The number of results per page. Default is 50, maximum is 1000.
          schema:
            type: integer
            format: int32
            minimum: 1
            maximum: 1000
            default: 50
          explode: false
        - name: PageToken
          in: query
          required: false
          description: Token for cursor-based pagination. Required when Page > 0.
          schema:
            type: string
          explode: false
        - name: DateCreatedAfter
          in: query
          required: false
          description: The date, in ISO 8601 format, after which the fax was sent.
          schema:
            type: string
          explode: false
        - name: DateCreatedOnOrBefore
          in: query
          required: false
          description: The date, in ISO 8601 format, on or before which the fax was sent.
          schema:
            type: string
          explode: false
        - name: From
          in: query
          required: false
          description: The phone number, in E.164 format, the fax was sent from.
          schema:
            type: string
          explode: false
        - name: To
          in: query
          required: false
          description: The phone number, in E.164 format, the fax was sent to.
          schema:
            type: string
          explode: false
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FaxListResponse'
        '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:
        - Faxes
    post:
      operationId: send_fax
      summary: Send a Fax
      description: |-
        Send a fax.

        #### Permissions
        The API token must include the following scopes: _Fax_.
      parameters:
        - $ref: '#/components/parameters/FaxesAccountSidPath'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FaxResponse'
        '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:
        - Faxes
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/SendFaxRequest'
  /Accounts/{AccountSid}/Faxes/{FaxSid}/Media:
    get:
      operationId: list_all_fax_media
      summary: List Fax Media
      description: |-
        List all media for a fax.

        #### Permissions
        The API token must include the following scopes: _Fax_.
      parameters:
        - $ref: '#/components/parameters/FaxesAccountSidPath'
        - $ref: '#/components/parameters/FaxSidPathForMedia'
        - name: Page
          in: query
          required: false
          description: The page index to retrieve. Zero-indexed.
          schema:
            type: integer
            format: int32
            minimum: 0
            default: 0
          explode: false
        - name: PageSize
          in: query
          required: false
          description: The number of results per page. Default is 50, maximum is 1000.
          schema:
            type: integer
            format: int32
            minimum: 1
            maximum: 1000
            default: 50
          explode: false
        - name: PageToken
          in: query
          required: false
          description: Token for cursor-based pagination. Required when Page > 0.
          schema:
            type: string
          explode: false
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FaxMediaListResponse'
        '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'
      tags:
        - Fax Media
  /Accounts/{AccountSid}/Faxes/{FaxSid}/Media/{Sid}:
    get:
      operationId: retrieve_medias
      summary: Retrieve Fax Media
      description: |-
        Retrieve media for a fax.

        #### Permissions
        The API token must include the following scopes: _Fax_.
      parameters:
        - $ref: '#/components/parameters/FaxesAccountSidPath'
        - $ref: '#/components/parameters/FaxSidPathForMedia'
        - $ref: '#/components/parameters/FaxSidPath'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FaxMediaResponse'
        '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:
        - Fax Media
    delete:
      operationId: delete_fax_media
      summary: Delete Fax Media
      description: |-
        Delete media for a fax. Cannot delete media for a fax that is in progress (queued, processing, sending, or receiving).

        #### Permissions
        The API token must include the following scopes: _Fax_.
      parameters:
        - $ref: '#/components/parameters/FaxesAccountSidPath'
        - $ref: '#/components/parameters/FaxSidPathForMedia'
        - $ref: '#/components/parameters/FaxSidPath'
      responses:
        '204':
          description: 204 No Content response.
        '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'
      tags:
        - Fax Media
  /Accounts/{AccountSid}/Faxes/{Sid}:
    get:
      operationId: retrieve_fax
      summary: Retrieve a fax.
      description: |-
        Retrieve a fax.

        #### Permissions
        The API token must include the following scopes: _Fax_.
      parameters:
        - $ref: '#/components/parameters/FaxesAccountSidPath'
        - $ref: '#/components/parameters/FaxSidPath'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FaxResponse'
        '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:
        - Faxes
    post:
      operationId: update_fax
      summary: Update a fax
      description: |-
        Allows you to cancel a queued fax. Only faxes in 'queued' status can be canceled.

        #### Permissions
        The API token must include the following scopes: _Fax_.
      parameters:
        - $ref: '#/components/parameters/FaxesAccountSidPath'
        - $ref: '#/components/parameters/FaxSidPath'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FaxResponse'
        '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'
      tags:
        - Faxes
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/UpdateFaxRequest'
    delete:
      operationId: delete_fax
      summary: Delete a Fax
      description: |-
        Delete a fax. Cannot delete a fax that is currently in progress (processing, sending, or receiving).

        #### Permissions
        The API token must include the following scopes: _Fax_.
      parameters:
        - $ref: '#/components/parameters/FaxesAccountSidPath'
        - $ref: '#/components/parameters/FaxSidPath'
      responses:
        '204':
          description: 204 No Content response.
        '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'
      tags:
        - Faxes
  /Accounts/{AccountSid}/ImportedPhoneNumbers:
    post:
      operationId: create_imported_phone_number
      summary: Import a Phone Number
      description: |-
        Import a phone number hosted elsewhere into your SignalWire Space.

        **Note:** This is a **Partner API**. To enable it on your SignalWire Space, contact 
        [Sales](https://signalwire.com/company/contact?utm_campaign=devex_sent_em).

        #### Permissions
        The API token must include the following scopes: _Numbers_.
      parameters:
        - $ref: '#/components/parameters/ImportedPhoneNumbersAccountSidPath'
      responses:
        '201':
          description: The request has succeeded and a new resource has been created as a result.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IncomingPhoneNumber'
        '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 phone number import request could not be processed due to validation errors. Check the error details for more information.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompatibilityImportedPhoneNumberError'
      tags:
        - Imported Phone Numbers
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ImportPhoneNumberRequest'
  /Accounts/{AccountSid}/IncomingPhoneNumbers:
    get:
      operationId: list_incoming_phone_numbers
      summary: List all Incoming Phone Numbers
      description: |-
        List all incoming phone numbers.

        #### Permissions
        The API token must include the following scopes: _Numbers_.
      parameters:
        - $ref: '#/components/parameters/IncomingPhoneNumbersAccountSidPath'
        - name: Page
          in: query
          required: false
          description: The page index to retrieve. Zero-indexed.
          schema:
            type: integer
            format: int32
            minimum: 0
            default: 0
          explode: false
        - name: PageSize
          in: query
          required: false
          description: The number of results per page. Default is 50, maximum is 1000.
          schema:
            type: integer
            format: int32
            minimum: 1
            maximum: 1000
            default: 50
          explode: false
        - name: PageToken
          in: query
          required: false
          description: Token for cursor-based pagination. Required when Page > 0.
          schema:
            type: string
          explode: false
        - name: PhoneNumber
          in: query
          required: false
          description: Only show numbers that match this pattern.
          schema:
            type: string
          explode: false
        - name: FriendlyName
          in: query
          required: false
          description: Only show numbers with this friendly name.
          schema:
            type: string
          explode: false
        - name: Beta
          in: query
          required: false
          description: Only show numbers that are marked as beta.
          schema:
            type: boolean
          explode: false
        - name: Origin
          in: query
          required: false
          description: Only show numbers that match this origin.
          schema:
            type: string
          explode: false
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IncomingPhoneNumberListResponse'
        '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:
        - Incoming Phone Numbers
    post:
      operationId: create_incoming_phone_number
      summary: Create an Incoming Phone Number
      description: |-
        Purchase and provision a new incoming phone number.

        #### Permissions
        The API token must include the following scopes: _Numbers_.
      parameters:
        - $ref: '#/components/parameters/IncomingPhoneNumbersAccountSidPath'
      responses:
        '201':
          description: Response returned when an incoming phone number is created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IncomingPhoneNumber'
        '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:
        - Incoming Phone Numbers
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CreateIncomingPhoneNumberRequest'
  /Accounts/{AccountSid}/IncomingPhoneNumbers/{Sid}:
    get:
      operationId: retrieve_incoming_phone_number
      summary: Retrieve an incoming phone number
      description: |-
        Retrieve an incoming phone number.

        #### Permissions
        The API token must include the following scopes: _Numbers_.
      parameters:
        - $ref: '#/components/parameters/IncomingPhoneNumbersAccountSidPath'
        - $ref: '#/components/parameters/IncomingPhoneNumberSidPath'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IncomingPhoneNumberResponse'
        '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:
        - Incoming Phone Numbers
    post:
      operationId: update_incoming_phone_number
      summary: Update an incoming phone number
      description: |-
        Update an incoming phone number.

        #### Permissions
        The API token must include the following scopes: _Numbers_.
      parameters:
        - $ref: '#/components/parameters/IncomingPhoneNumbersAccountSidPath'
        - $ref: '#/components/parameters/IncomingPhoneNumberSidPath'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IncomingPhoneNumberResponse'
        '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'
      tags:
        - Incoming Phone Numbers
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/UpdateIncomingPhoneNumberRequest'
    delete:
      operationId: delete_incoming_phone_number
      summary: Delete an incoming phone number
      description: |-
        Release an incoming phone number. The number will be removed from your account.

        Note: Numbers cannot be released within a cooldown period after purchase.

        #### Permissions
        The API token must include the following scopes: _Numbers_.
      parameters:
        - $ref: '#/components/parameters/IncomingPhoneNumbersAccountSidPath'
        - $ref: '#/components/parameters/IncomingPhoneNumberSidPath'
      responses:
        '204':
          description: 204 No Content response.
        '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'
        '409':
          description: The request conflicts with the current state of the resource. The operation cannot be completed.
          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:
        - Incoming Phone Numbers
  /Accounts/{AccountSid}/LamlBins:
    get:
      operationId: list_cxml_applications
      summary: List All cXML Scripts
      description: |-
        Returns a list of your cXML scripts. The scripts are returned sorted by creation date, with the most recent appearing first.

        #### Permissions
        The API token must include one of the following scopes: _Voice_ or _Messaging_ or _Fax_.
      parameters:
        - $ref: '#/components/parameters/CxmlScriptsAccountSidPath'
        - name: Name
          in: query
          required: false
          description: A friendly name given to the cXML script.
          schema:
            type: string
          explode: false
        - name: Page
          in: query
          required: false
          description: The page number to retrieve. Default is 0.
          schema:
            type: integer
            format: int32
            default: 0
          explode: false
        - name: PageSize
          in: query
          required: false
          description: The number of items per page. Default is 50, maximum is 1000.
          schema:
            type: integer
            format: int32
            minimum: 1
            maximum: 1000
            default: 50
          explode: false
        - name: PageToken
          in: query
          required: false
          description: The token for cursor-based pagination. 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/CxmlScriptListResponse'
        '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:
        - cXML Scripts
    post:
      operationId: create_cxml_application
      summary: Create a cXML Script
      description: |-
        Create a cXML script.

        #### Permissions
        The API token must include one of the following scopes: _Voice_ or _Messaging_ or _Fax_.
      parameters:
        - $ref: '#/components/parameters/CxmlScriptsAccountSidPath'
      responses:
        '201':
          description: Response returned when a cXML script is created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CxmlScript'
        '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:
        - cXML Scripts
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CreateCxmlScriptRequest'
  /Accounts/{AccountSid}/LamlBins/{Sid}:
    get:
      operationId: retrieve_cxml_application
      summary: Retrieve a cXML Script
      description: |-
        Retrieve a cXML script.

        #### Permissions
        The API token must include one of the following scopes: _Voice_ or _Messaging_ or _Fax_.
      parameters:
        - $ref: '#/components/parameters/CxmlScriptsAccountSidPath'
        - $ref: '#/components/parameters/CxmlScriptSidPath'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CxmlScriptResponse'
        '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:
        - cXML Scripts
    post:
      operationId: update_cxml_application
      summary: Update a cXML Script
      description: |-
        Update a cXML script.

        #### Permissions
        The API token must include one of the following scopes: _Voice_ or _Messaging_ or _Fax_.
      parameters:
        - $ref: '#/components/parameters/CxmlScriptsAccountSidPath'
        - $ref: '#/components/parameters/CxmlScriptSidPath'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CxmlScriptResponse'
        '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'
      tags:
        - cXML Scripts
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/UpdateCxmlScriptRequest'
    delete:
      operationId: delete_cxml_application
      summary: Delete a cXML Script
      description: |-
        Delete a cXML script.

        #### Permissions
        The API token must include one of the following scopes: _Voice_ or _Messaging_ or _Fax_.
      parameters:
        - $ref: '#/components/parameters/CxmlScriptsAccountSidPath'
        - $ref: '#/components/parameters/CxmlScriptSidPath'
      responses:
        '204':
          description: 204 No Content response.
        '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'
      tags:
        - cXML Scripts
  /Accounts/{AccountSid}/Messages:
    get:
      operationId: list_messages
      summary: List all Messages
      description: |-
        List all messages.

        #### Permissions
        The API token must include the following scopes: _Messaging_.
      parameters:
        - $ref: '#/components/parameters/MessagesAccountSidPath'
        - name: DateSent
          in: query
          required: false
          description: Only return messages sent on this particular date, formatted as YYYY-MM-DD in UTC.
          schema:
            type: string
          explode: false
        - name: DateSent<
          in: query
          required: false
          description: Only return messages sent before this date, formatted as YYYY-MM-DD in UTC.
          schema:
            type: string
          explode: false
        - name: DateSent>
          in: query
          required: false
          description: Only return messages sent after this date, formatted as YYYY-MM-DD in UTC.
          schema:
            type: string
          explode: false
        - name: From
          in: query
          required: false
          description: The phone number in E.164 format. For inbound messages, this will be the remote phone number who sent the message. For outbound messages, this will be one of your SignalWire phone numbers.
          schema:
            type: string
          explode: false
        - name: To
          in: query
          required: false
          description: The phone number in E.164 format that received the message. For inbound messages, this is one of your SignalWire phone numbers; for outbound messages, this is the remote phone number that received the message.
          schema:
            type: string
          explode: false
        - name: Status
          in: query
          required: false
          description: Current status of the message.
          schema:
            $ref: '#/components/schemas/MessageStatus'
          explode: false
        - name: Page
          in: query
          required: false
          description: The page number to retrieve. Default is 0.
          schema:
            type: integer
            format: int32
            minimum: 0
            default: 0
          explode: false
        - name: PageSize
          in: query
          required: false
          description: The number of items per page. Default is 50, maximum is 1000.
          schema:
            type: integer
            format: int32
            minimum: 1
            maximum: 1000
            default: 50
          explode: false
        - name: PageToken
          in: query
          required: false
          description: The token for cursor-based pagination. 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/MessageListResponse'
        '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:
        - Messages
    post:
      operationId: create_message
      summary: Create a Message
      description: |-
        Create and send a message.

        #### Permissions
        The API token must include the following scopes: _Messaging_.
      parameters:
        - $ref: '#/components/parameters/MessagesAccountSidPath'
      responses:
        '201':
          description: Response returned when a message is created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Message'
        '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:
        - Messages
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CreateMessageRequest'
  /Accounts/{AccountSid}/Messages/{MessageSid}/Media:
    get:
      operationId: list_media
      summary: List Message Media
      description: |-
        List all media for a message.

        #### Permissions
        The API token must include the following scopes: _Messaging_.
      parameters:
        - $ref: '#/components/parameters/MessagesAccountSidPath'
        - $ref: '#/components/parameters/MessageSidPathForMedia'
        - name: DateCreated
          in: query
          required: false
          description: Only return media created on this particular date, formatted as YYYY-MM-DD in UTC.
          schema:
            type: string
          explode: false
        - name: DateCreated<
          in: query
          required: false
          description: Only return media created before this date, formatted as YYYY-MM-DD in UTC.
          schema:
            type: string
          explode: false
        - name: DateCreated>
          in: query
          required: false
          description: Only return media created after this date, formatted as YYYY-MM-DD in UTC.
          schema:
            type: string
          explode: false
        - name: Page
          in: query
          required: false
          description: The page number to retrieve. Default is 0.
          schema:
            type: integer
            format: int32
            minimum: 0
            default: 0
          explode: false
        - name: PageSize
          in: query
          required: false
          description: The number of items per page. Default is 50, maximum is 1000.
          schema:
            type: integer
            format: int32
            minimum: 1
            maximum: 1000
            default: 50
          explode: false
        - name: PageToken
          in: query
          required: false
          description: The token for cursor-based pagination. 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/MessageMediaListResponse'
        '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:
        - Media
  /Accounts/{AccountSid}/Messages/{MessageSid}/Media/{Sid}:
    get:
      operationId: retrieve_media
      summary: Retrieve Message Media
      description: |-
        Retrieve media for a message.

        #### Permissions
        The API token must include the following scopes: _Messaging_.
      parameters:
        - $ref: '#/components/parameters/MessagesAccountSidPath'
        - $ref: '#/components/parameters/MessageSidPathForMedia'
        - $ref: '#/components/parameters/MessageSidPath'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageMediaResponse'
        '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:
        - Media
    delete:
      operationId: delete_message_media
      summary: Delete Message Media
      description: |-
        Delete media for a message. Media cannot be deleted if the parent message is still in progress (initiated or queued status).

        #### Permissions
        The API token must include the following scopes: _Messaging_.
      parameters:
        - $ref: '#/components/parameters/MessagesAccountSidPath'
        - $ref: '#/components/parameters/MessageSidPathForMedia'
        - $ref: '#/components/parameters/MessageSidPath'
      responses:
        '204':
          description: 204 No Content response.
        '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'
      tags:
        - Media
  /Accounts/{AccountSid}/Messages/{Sid}:
    get:
      operationId: retrieve_message
      summary: Retrieve a Message
      description: |-
        Retrieve a single message.

        #### Permissions
        The API token must include the following scopes: _Messaging_.
      parameters:
        - $ref: '#/components/parameters/MessagesAccountSidPath'
        - $ref: '#/components/parameters/MessageSidPath'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageResponse'
        '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:
        - Messages
    post:
      operationId: update_message
      summary: Update a Message
      description: |-
        Update a message body after it has been sent. Currently, the only supported update is redacting the message by setting the body to an empty string. Messages that are still in progress (queued or initiated status) cannot be updated.

        #### Permissions
        The API token must include the following scopes: _Messaging_.
      parameters:
        - $ref: '#/components/parameters/MessagesAccountSidPath'
        - $ref: '#/components/parameters/MessageSidPath'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageResponse'
        '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'
      tags:
        - Messages
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/UpdateMessageRequest'
    delete:
      operationId: delete_message
      summary: Delete a Message
      description: |-
        Delete a message. Messages that are still in progress (queued status) cannot be deleted.

        #### Permissions
        The API token must include the following scopes: _Messaging_.
      parameters:
        - $ref: '#/components/parameters/MessagesAccountSidPath'
        - $ref: '#/components/parameters/MessageSidPath'
      responses:
        '204':
          description: 204 No Content response.
        '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'
      tags:
        - Messages
  /Accounts/{AccountSid}/Queues:
    get:
      operationId: list_queues
      summary: List All Queues
      description: |-
        Retrieve all queues associated with your account. Results are returned as a paginated list.

        #### Permissions
        The API token must include the following scopes: _Voice_.
      parameters:
        - $ref: '#/components/parameters/QueuesAccountSidPath'
        - name: Page
          in: query
          required: false
          description: The page number to retrieve (zero-indexed).
          schema:
            type: integer
            format: int32
            minimum: 0
            default: 0
          explode: false
        - name: PageSize
          in: query
          required: false
          description: The number of results per page. Default is 50, maximum is 1000.
          schema:
            type: integer
            format: int32
            minimum: 1
            maximum: 1000
            default: 50
          explode: false
        - name: PageToken
          in: query
          required: false
          description: Token for cursor-based pagination. Required when navigating to pages beyond the first.
          schema:
            type: string
          explode: false
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueueListResponse'
        '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:
        - Queues
    post:
      operationId: create_queue
      summary: Create a Queue
      description: |-
        Create a call queue. Queue names must be unique within an account and can only contain alphanumeric characters and underscores.

        #### Permissions
        The API token must include the following scopes: _Voice_.
      parameters:
        - $ref: '#/components/parameters/QueuesAccountSidPath'
      responses:
        '201':
          description: Response returned when a queue is successfully created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Queue'
        '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:
        - Queues
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CreateQueueRequest'
  /Accounts/{AccountSid}/Queues/{QueueSid}/Members:
    get:
      operationId: list_all_queue_members
      summary: List All Queue Members
      description: |-
        Retrieve all members currently waiting in a queue. Results are returned as a paginated list ordered by enqueue time.

        #### Permissions
        The API token must include the following scopes: _Voice_.
      parameters:
        - $ref: '#/components/parameters/QueuesAccountSidPath'
        - $ref: '#/components/parameters/QueueSidPathForMembers'
        - name: Page
          in: query
          required: false
          description: The page number to retrieve (zero-indexed).
          schema:
            type: integer
            format: int32
            minimum: 0
            default: 0
          explode: false
        - name: PageSize
          in: query
          required: false
          description: The number of results per page. Default is 50, maximum is 1000.
          schema:
            type: integer
            format: int32
            minimum: 1
            maximum: 1000
            default: 50
          explode: false
        - name: PageToken
          in: query
          required: false
          description: Token for cursor-based pagination. Required when navigating to pages beyond the first.
          schema:
            type: string
          explode: false
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueueMemberListResponse'
        '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'
      tags:
        - Queue Members
  /Accounts/{AccountSid}/Queues/{QueueSid}/Members/{CallSid}:
    get:
      operationId: retrieve_queue_member
      summary: Retrieve a Queue Member
      description: |-
        Retrieve a single queue member by call SID. Use the special value `Front` to retrieve the member at the front of the queue.

        #### Permissions
        The API token must include the following scopes: _Voice_.
      parameters:
        - $ref: '#/components/parameters/QueuesAccountSidPath'
        - $ref: '#/components/parameters/QueueSidPathForMembers'
        - $ref: '#/components/parameters/QueueMemberCallSidPath'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueueMemberResponse'
        '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:
        - Queue Members
    post:
      operationId: update_queue_member
      summary: Update a Queue Member
      description: |-
        Dequeue a member from a queue and redirect them to a new URL. Use the special value `Front` for the CallSid to dequeue the member at the front of the queue.

        #### Permissions
        The API token must include the following scopes: _Voice_.
      parameters:
        - $ref: '#/components/parameters/QueuesAccountSidPath'
        - $ref: '#/components/parameters/QueueSidPathForMembers'
        - $ref: '#/components/parameters/QueueMemberCallSidPath'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueueMemberResponse'
        '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:
        - Queue Members
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/UpdateQueueMemberRequest'
  /Accounts/{AccountSid}/Queues/{Sid}:
    get:
      operationId: retrieve_queue
      summary: Retrieve a Queue
      description: |-
        Retrieve a single queue by its unique identifier.

        #### Permissions
        The API token must include the following scopes: _Voice_.
      parameters:
        - $ref: '#/components/parameters/QueuesAccountSidPath'
        - $ref: '#/components/parameters/QueueSidPath'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueueResponse'
        '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:
        - Queues
    post:
      operationId: update_queue
      summary: Update a Queue
      description: |-
        Modify the properties of a call queue. Queue names must be unique within an account.

        #### Permissions
        The API token must include the following scopes: _Voice_.
      parameters:
        - $ref: '#/components/parameters/QueuesAccountSidPath'
        - $ref: '#/components/parameters/QueueSidPath'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueueResponse'
        '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'
      tags:
        - Queues
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/UpdateQueueRequest'
    delete:
      operationId: delete_queue
      summary: Delete a Queue
      description: |-
        Delete a call queue. Only empty queues can be deleted - attempting to delete a queue with members will return a 422 error.

        #### Permissions
        The API token must include the following scopes: _Voice_.
      parameters:
        - $ref: '#/components/parameters/QueuesAccountSidPath'
        - $ref: '#/components/parameters/QueueSidPath'
      responses:
        '204':
          description: 204 No Content response.
        '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'
      tags:
        - Queues
  /Accounts/{AccountSid}/Recordings:
    get:
      operationId: list_recordings
      summary: List all Recordings
      description: |-
        List all recordings. Results are returned as a paginated list ordered by creation date (newest first).

        #### Permissions
        The API token must include the following scopes: _Voice_.
      parameters:
        - $ref: '#/components/parameters/RecordingsAccountSidPath'
        - name: DateCreated
          in: query
          required: false
          description: Filter by recordings created on this exact date (RFC 2822 format).
          schema:
            type: string
          explode: false
        - name: DateCreated<
          in: query
          required: false
          description: Filter by recordings created before this date (RFC 2822 format).
          schema:
            type: string
          explode: false
        - name: DateCreated>
          in: query
          required: false
          description: Filter by recordings created after this date (RFC 2822 format).
          schema:
            type: string
          explode: false
        - name: CallSid
          in: query
          required: false
          description: Filter by recordings associated with a specific call.
          schema:
            type: string
            format: uuid
          explode: false
        - name: ConferenceSid
          in: query
          required: false
          description: Filter by recordings associated with a specific conference.
          schema:
            type: string
            format: uuid
          explode: false
        - name: Page
          in: query
          required: false
          description: The page number to retrieve (zero-indexed).
          schema:
            type: integer
            format: int32
            minimum: 0
            default: 0
          explode: false
        - name: PageSize
          in: query
          required: false
          description: The number of results per page. Default is 50, maximum is 1000.
          schema:
            type: integer
            format: int32
            minimum: 1
            maximum: 1000
            default: 50
          explode: false
        - name: PageToken
          in: query
          required: false
          description: Token for cursor-based pagination. Required when navigating to pages beyond the first.
          schema:
            type: string
          explode: false
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecordingListResponse'
        '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:
        - Recordings
  /Accounts/{AccountSid}/Recordings/{Sid}:
    get:
      operationId: retrieve_recording
      summary: Retrieve a Recording.
      description: |-
        Retrieve a single recording media or its metadata.

        This endpoint supports two different access methods with different authentication requirements:

        ## Public Access (No Authentication Required)

        Recording audio files can be accessed directly without authentication. This is useful for external applications
        to embed recording URLs without exposing SignalWire API credentials. SignalWire recording URLs are long
        and random, making them difficult to guess or exploit unless you reveal the URL.

        **Retrieve WAV file**

        When a recording URI has no extension or a `.wav` extension, the request
        will return a binary WAV version of the recording file.

        `GET https://example.signalwire.com/api/laml/2010-04-01/Accounts/{AccountSid}/Recordings/{Sid}`

        `GET https://example.signalwire.com/api/laml/2010-04-01/Accounts/{AccountSid}/Recordings/{Sid}.wav`

        **Retrieve MP3 file**

        Setting an extension of ".mp3" on the URI returns a binary MP3 version
        of the recording. For example:

        `GET https://example.signalwire.com/api/laml/2010-04-01/Accounts/{AccountSid}/Recordings/{Sid}.mp3`

        ## Authenticated Access (Voice Scope Required)

        **Retrieve Metadata**

        A recording's metadata, such as duration, cost, time, can be returned by
        setting the Recording URI's extension to `.json`. This requires authentication
        with a Voice-scoped API token.

        `GET https://example.signalwire.com/api/laml/2010-04-01/Accounts/{AccountSid}/Recordings/{Sid}.json`

        #### Permissions
        The API token must include the following scopes: _Voice_. This permission is only required for authenticated requests to retrieve recording metadata (.json extension).
      parameters:
        - $ref: '#/components/parameters/RecordingsAccountSidPath'
        - $ref: '#/components/parameters/RecordingSidPath'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecordingResponse'
        '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:
        - Recordings
    delete:
      operationId: delete_recording
      summary: Delete a Recording.
      description: |-
        Delete recording. If the delete is successful, a 204 response, with no body, will be returned.

        #### Permissions
        The API token must include the following scopes: _Voice_.
      parameters:
        - $ref: '#/components/parameters/RecordingsAccountSidPath'
        - $ref: '#/components/parameters/RecordingSidPath'
      responses:
        '204':
          description: 204 No Content response.
        '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'
      tags:
        - Recordings
  /Accounts/{AccountSid}/Transcriptions:
    get:
      operationId: list_transcriptions
      summary: List all Transcriptions
      description: |-
        List all transcriptions. Results are returned as a paginated list ordered by creation date (newest first).

        #### Permissions
        The API token must include the following scopes: _Voice_.
      parameters:
        - $ref: '#/components/parameters/TranscriptionsAccountSidPath'
        - name: DateCreated
          in: query
          required: false
          description: Filter by transcriptions created on this exact date (RFC 2822 format).
          schema:
            type: string
          explode: false
        - name: DateCreated<
          in: query
          required: false
          description: Filter by transcriptions created before this date (RFC 2822 format).
          schema:
            type: string
          explode: false
        - name: DateCreated>
          in: query
          required: false
          description: Filter by transcriptions created after this date (RFC 2822 format).
          schema:
            type: string
          explode: false
        - name: Page
          in: query
          required: false
          description: The page number to retrieve (zero-indexed).
          schema:
            type: integer
            format: int32
            minimum: 0
            default: 0
          explode: false
        - name: PageSize
          in: query
          required: false
          description: The number of results per page. Default is 50, maximum is 1000.
          schema:
            type: integer
            format: int32
            minimum: 1
            maximum: 1000
            default: 50
          explode: false
        - name: PageToken
          in: query
          required: false
          description: Token for cursor-based pagination. Required when navigating to pages beyond the first.
          schema:
            type: string
          explode: false
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TranscriptionListResponse'
        '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:
        - Recording Transcriptions
  /Accounts/{AccountSid}/Transcriptions/{Sid}:
    get:
      operationId: retrieve_transcription
      summary: Retrieve a Transcription.
      description: |-
        Retrieve a single recording transcription.

        #### Permissions
        The API token must include the following scopes: _Voice_.
      parameters:
        - $ref: '#/components/parameters/TranscriptionsAccountSidPath'
        - $ref: '#/components/parameters/TranscriptionSidPath'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TranscriptionResponse'
        '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:
        - Recording Transcriptions
    delete:
      operationId: delete_transcription
      summary: Delete a Recording Transcription.
      description: |-
        Delete a recording transcription from your account. If the delete is successful, a 204 response, with no body, will be returned.

        #### Permissions
        The API token must include the following scopes: _Voice_.
      parameters:
        - $ref: '#/components/parameters/TranscriptionsAccountSidPath'
        - $ref: '#/components/parameters/TranscriptionSidPath'
      responses:
        '204':
          description: 204 No Content response.
        '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'
      tags:
        - Recording Transcriptions
  /Accounts/{AccountSid}/tokens:
    post:
      operationId: create_token
      summary: Generate a new API Token
      description: |-
        Generate an API Token for a project to be used to authenticate requests within the project.

        #### Permissions
        The API token must include the following scopes: _Management_.
      parameters:
        - $ref: '#/components/parameters/TokensAccountSidPath'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TokenResponse'
        '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 token request could not be processed due to validation errors. Check the error details for the specific issue.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompatibilityTokenValidationError'
      tags:
        - Tokens
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CreateTokenRequest'
  /Accounts/{AccountSid}/tokens/{token_id}:
    patch:
      operationId: update_token
      summary: Update an API Token
      description: |-
        Update an API Token's name or permissions.

        #### Permissions
        The API token must include the following scopes: _Management_.
      parameters:
        - $ref: '#/components/parameters/TokensAccountSidPath'
        - $ref: '#/components/parameters/TokenIdPath'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TokenResponse'
        '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 token request could not be processed due to validation errors. Check the error details for the specific issue.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompatibilityTokenValidationError'
      tags:
        - Tokens
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateTokenRequest'
    delete:
      operationId: delete_token
      summary: Delete an API Token
      description: |-
        Delete an API Token. This action cannot be undone.

        #### Permissions
        The API token must include the following scopes: _Management_.
      parameters:
        - $ref: '#/components/parameters/TokensAccountSidPath'
        - $ref: '#/components/parameters/TokenIdPath'
      responses:
        '204':
          description: 204 No Content response.
        '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:
        - Tokens
  /Accounts/{Sid}:
    get:
      operationId: get_account
      summary: Find an Account by ID
      description: |-
        Find a Project (also referred to as _Account_) by ID.

        #### Permissions
        The API token must include the following scopes: _Management_.
      parameters:
        - $ref: '#/components/parameters/AccountPathSid'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountResponse'
        '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:
        - Accounts
    post:
      operationId: update_account
      summary: Update an Account
      description: |-
        Update a Project (also referred to as _Account_).

        #### Permissions
        The API token must include the following scopes: _Management_.
      parameters:
        - $ref: '#/components/parameters/AccountPathSid'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountResponse'
        '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:
        - Accounts
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/UpdateAccountRequest'
components:
  parameters:
    AccountPathSid:
      name: Sid
      in: path
      required: true
      description: The Project ID that uniquely identifies the Project to retrieve.
      schema:
        type: string
        format: uuid
    AccountSidPath:
      name: AccountSid
      in: path
      required: true
      description: The Account ID that has the Application.
      schema:
        type: string
        format: uuid
    ApplicationPathSid:
      name: Sid
      in: path
      required: true
      description: The Application ID that uniquely identifies the Application.
      schema:
        type: string
        format: uuid
    AvailablePhoneNumbersAccountSidPath:
      name: AccountSid
      in: path
      required: true
      description: The Project ID that uniquely identifies the Account to retrieve.
      schema:
        type: string
        format: uuid
    CallSidPath:
      name: Sid
      in: path
      required: true
      description: The unique identifier for the call.
      schema:
        type: string
        format: uuid
    CallSidPathForRecording:
      name: CallSid
      in: path
      required: true
      description: The unique identifier for the call.
      schema:
        type: string
        format: uuid
    CallsAccountSidPath:
      name: AccountSid
      in: path
      required: true
      description: The Project ID that uniquely identifies the Account.
      schema:
        type: string
        format: uuid
    ConferenceRecordingSidPath:
      name: Sid
      in: path
      required: true
      description: The unique identifier for the recording.
      schema:
        type: string
        format: uuid
    ConferenceSidPath:
      name: Sid
      in: path
      required: true
      description: The unique identifier for this conference.
      schema:
        type: string
        format: uuid
    ConferenceSidPathForParticipant:
      name: ConferenceSid
      in: path
      required: true
      description: The unique identifier for the conference this participant is in.
      schema:
        type: string
        format: uuid
    ConferencesAccountSidPath:
      name: AccountSid
      in: path
      required: true
      description: The unique identifier for the account that created this conference.
      schema:
        type: string
        format: uuid
    CxmlScriptSidPath:
      name: Sid
      in: path
      required: true
      description: The unique identifier of the cXML script.
      schema:
        type: string
        format: uuid
    CxmlScriptsAccountSidPath:
      name: AccountSid
      in: path
      required: true
      description: The unique identifier for the account this script is associated with.
      schema:
        type: string
        format: uuid
    FaxSidPath:
      name: Sid
      in: path
      required: true
      description: The Fax ID that uniquely identifies the Fax.
      schema:
        type: string
        format: uuid
    FaxSidPathForMedia:
      name: FaxSid
      in: path
      required: true
      description: The Fax ID that uniquely identifies the Fax.
      schema:
        type: string
        format: uuid
    FaxesAccountSidPath:
      name: AccountSid
      in: path
      required: true
      description: The Project ID that uniquely identifies the Account.
      schema:
        type: string
        format: uuid
    ImportedPhoneNumbersAccountSidPath:
      name: AccountSid
      in: path
      required: true
      description: The unique identifier for the account that is associated with this phone number.
      schema:
        type: string
        format: uuid
    IncomingPhoneNumberSidPath:
      name: Sid
      in: path
      required: true
      description: The unique identifier of the phone number.
      schema:
        type: string
        format: uuid
    IncomingPhoneNumbersAccountSidPath:
      name: AccountSid
      in: path
      required: true
      description: The unique identifier for the account that is associated with this phone number.
      schema:
        type: string
        format: uuid
    IsoCountryPath:
      name: IsoCountry
      in: path
      required: true
      description: The ISO country code of the number.
      schema:
        type: string
    MessageSidPath:
      name: Sid
      in: path
      required: true
      description: A unique ID that identifies this specific message.
      schema:
        type: string
        format: uuid
    MessageSidPathForMedia:
      name: MessageSid
      in: path
      required: true
      description: A unique ID that identifies this specific message.
      schema:
        type: string
        format: uuid
    MessagesAccountSidPath:
      name: AccountSid
      in: path
      required: true
      description: The unique identifier of the project that sent or received this message.
      schema:
        type: string
        format: uuid
    ParticipantCallSidPath:
      name: CallSid
      in: path
      required: true
      description: The unique identifier for the Participant call connected to this conference.
      schema:
        type: string
        format: uuid
    QueueMemberCallSidPath:
      name: CallSid
      in: path
      required: true
      description: The unique identifier for the call, or the special value 'Front' to reference the member at the front of the queue.
      schema:
        type: string
    QueueSidPath:
      name: Sid
      in: path
      required: true
      description: The unique identifier for the queue.
      schema:
        type: string
        format: uuid
    QueueSidPathForMembers:
      name: QueueSid
      in: path
      required: true
      description: The unique identifier for the queue.
      schema:
        type: string
        format: uuid
    QueuesAccountSidPath:
      name: AccountSid
      in: path
      required: true
      description: The unique identifier for the account this Queue is associated with.
      schema:
        type: string
        format: uuid
    RecordingSidPath:
      name: Sid
      in: path
      required: true
      description: The unique identifier for the recording.
      schema:
        type: string
        format: uuid
    RecordingsAccountSidPath:
      name: AccountSid
      in: path
      required: true
      description: The unique identifier for the account that is associated with this recording.
      schema:
        type: string
        format: uuid
    TokenIdPath:
      name: token_id
      in: path
      required: true
      description: The unique identifier of the project API token.
      schema:
        type: string
        format: uuid
    TokensAccountSidPath:
      name: AccountSid
      in: path
      required: true
      description: The unique identifier for the project you want to use to authenticate this request.
      schema:
        type: string
        format: uuid
    TranscriptionSidPath:
      name: Sid
      in: path
      required: true
      description: The unique identifier for the transcription.
      schema:
        type: string
        format: uuid
    TranscriptionsAccountSidPath:
      name: AccountSid
      in: path
      required: true
      description: The unique identifier for the account that created this transcription.
      schema:
        type: string
        format: uuid
  schemas:
    Account:
      type: object
      required:
        - sid
        - friendly_name
        - status
        - auth_token
        - date_created
        - date_updated
        - type
        - owner_account_sid
        - region_preference
        - uri
        - subproject
        - signing_key
        - subresource_uris
      properties:
        sid:
          type: string
          format: uuid
          description: The unique identifier for this Project.
          example: b3877c40-da60-4998-90ad-b792e98472af
        friendly_name:
          type: string
          description: The name of the Project.
          example: My Project
        status:
          allOf:
            - $ref: '#/components/schemas/AccountStatus'
          description: The status of the Project. Always 'active'.
        auth_token:
          type: string
          description: The authorization token for this Project. Always returns 'redacted' for security.
          example: redacted
        date_created:
          type: string
          description: The date and time this Project was created, in RFC 2822 format.
          example: Sat, 15 Sep 2018 10:00:00 +0000
        date_updated:
          type: string
          description: The date and time this Project was last updated, in RFC 2822 format.
          example: Sat, 16 Sep 2018 10:00:00 +0000
        type:
          allOf:
            - $ref: '#/components/schemas/AccountType'
          description: The type of the Project. Always 'Full'.
        owner_account_sid:
          type: string
          format: uuid
          description: The Project ID of the parent project. For parent projects, this is the same as sid.
          example: b3877c40-da60-4998-90ad-b792e98472af
        region_preference:
          type: string
          description: The preferred region for the Project.
          example: us-east
        uri:
          type: string
          description: The URI for the Project.
          example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af
        subproject:
          type: boolean
          description: Whether this project is a sub-project of another project.
          example: false
        signing_key:
          type: string
          nullable: true
          description: The signing key for the Project. Currently not supported and always null.
        subresource_uris:
          allOf:
            - $ref: '#/components/schemas/SubresourceUris'
          description: A map of URIs for sub-resources linked to this Project.
      description: Account/Project model representing a SignalWire project.
    AccountListResponse:
      type: object
      required:
        - uri
        - first_page_uri
        - next_page_uri
        - previous_page_uri
        - page
        - page_size
        - accounts
      properties:
        uri:
          type: string
          description: The URI of the current page.
          example: /api/laml/2010-04-01/Accounts?Page=0&PageSize=50
        first_page_uri:
          type: string
          description: The URI of the first page.
          example: /api/laml/2010-04-01/Accounts?Page=0&PageSize=50
        next_page_uri:
          type: string
          nullable: true
          description: The URI of the next page. Null if there are no more results.
          example: /api/laml/2010-04-01/Accounts?Page=1&PageSize=50
        previous_page_uri:
          type: string
          nullable: true
          description: The URI of the previous page. Null if this is the first page.
        page:
          type: integer
          format: int32
          description: The current page number (zero-indexed).
          example: 0
        page_size:
          type: integer
          format: int32
          description: The number of results per page.
          example: 50
        accounts:
          type: array
          items:
            $ref: '#/components/schemas/Account'
          description: List of accounts.
      description: Response containing a list of accounts.
    AccountResponse:
      type: object
      required:
        - sid
        - friendly_name
        - status
        - auth_token
        - date_created
        - date_updated
        - type
        - owner_account_sid
        - region_preference
        - uri
        - subproject
        - signing_key
        - subresource_uris
      properties:
        sid:
          type: string
          format: uuid
          description: The unique identifier for this Project.
          example: b3877c40-da60-4998-90ad-b792e98472af
        friendly_name:
          type: string
          description: The name of the Project.
          example: My Project
        status:
          allOf:
            - $ref: '#/components/schemas/AccountStatus'
          description: The status of the Project. Always 'active'.
        auth_token:
          type: string
          description: The authorization token for this Project. Always returns 'redacted' for security.
          example: redacted
        date_created:
          type: string
          description: The date and time this Project was created, in RFC 2822 format.
          example: Sat, 15 Sep 2018 10:00:00 +0000
        date_updated:
          type: string
          description: The date and time this Project was last updated, in RFC 2822 format.
          example: Sat, 16 Sep 2018 10:00:00 +0000
        type:
          allOf:
            - $ref: '#/components/schemas/AccountType'
          description: The type of the Project. Always 'Full'.
        owner_account_sid:
          type: string
          format: uuid
          description: The Project ID of the parent project. For parent projects, this is the same as sid.
          example: b3877c40-da60-4998-90ad-b792e98472af
        region_preference:
          type: string
          description: The preferred region for the Project.
          example: us-east
        uri:
          type: string
          description: The URI for the Project.
          example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af
        subproject:
          type: boolean
          description: Whether this project is a sub-project of another project.
          example: false
        signing_key:
          type: string
          nullable: true
          description: The signing key for the Project. Currently not supported and always null.
        subresource_uris:
          allOf:
            - $ref: '#/components/schemas/SubresourceUris'
          description: A map of URIs for sub-resources linked to this Project.
      description: Response containing a single account.
    AccountStatus:
      type: string
      enum:
        - active
        - suspended
        - closed
      description: The status of the Project.
    AccountType:
      type: string
      enum:
        - Trial
        - Full
      description: The type of the Project.
    AddressRequirements:
      type: string
      enum:
        - none
        - any
        - local
        - foreign
      description: Address requirements.
    AnsweredBy:
      type: string
      enum:
        - human
        - machine
      description: Who/what answered the call.
    Application:
      type: object
      required:
        - sid
        - account_sid
        - api_version
        - date_created
        - date_updated
        - friendly_name
        - uri
        - voice_url
        - voice_method
        - voice_fallback_url
        - voice_fallback_method
        - status_callback
        - status_callback_method
        - voice_caller_id_lookup
        - sms_url
        - sms_method
        - sms_fallback_url
        - sms_fallback_method
        - sms_status_callback
        - sms_status_callback_method
        - message_status_callback
      properties:
        sid:
          type: string
          format: uuid
          description: The unique identifier for the Application.
          example: b3877c40-da60-4998-90ad-b792e98472af
        account_sid:
          type: string
          format: uuid
          description: The unique identifier for the Account that created this Application.
          example: b3877c40-da60-4998-90ad-b792e98472af
        api_version:
          type: string
          description: The version of the SignalWire API.
          example: '2010-04-01'
        date_created:
          type: string
          description: The date, in RFC 2822 GMT format, this Application was created.
          example: Sat, 15 Sept 2018 10:00:00 +0000
        date_updated:
          type: string
          description: The date, in RFC 2822 GMT format, this Application was updated.
          example: Sat, 16 Sept 2018 10:00:00 +0000
        friendly_name:
          type: string
          description: A named unique identifier for the resource.
          example: My Friendly Name
        uri:
          type: string
          description: The URI for this Application.
          example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Applications/b3877c40-da60-4998-90ad-b792e98472af.json
        voice_url:
          type: string
          nullable: true
          description: The URL to request when a phone number receives a call or fax.
          example: http://example.com
        voice_method:
          type: string
          nullable: true
          description: Whether the request to `VoiceUrl` is a `GET` or a `POST`. Default is `POST`.
          example: POST
        voice_fallback_url:
          type: string
          nullable: true
          description: The URL SignalWire will request if errors occur when fetching the `VoiceUrl`.
          example: http://example.com
        voice_fallback_method:
          type: string
          nullable: true
          description: Whether the request to `VoiceFallbackUrl` is a `GET` or a `POST`. Default is `POST`.
          example: POST
        status_callback:
          type: string
          nullable: true
          description: The URL to pass status updates to the Application.
          example: http://example.com
        status_callback_method:
          type: string
          nullable: true
          description: Whether the request to the `StatusCallback` URL is a `GET` or a `POST`. Default is `POST`.
          example: POST
        voice_caller_id_lookup:
          type: boolean
          nullable: true
          description: Whether or not to look up a caller's ID from the database. Always null.
          example: null
        sms_url:
          type: string
          nullable: true
          description: The URL to request when an SMS is received.
          example: http://example.com
        sms_method:
          type: string
          nullable: true
          description: Whether the request to `SmsUrl` is a `GET` or a `POST`. Default is `POST`.
          example: POST
        sms_fallback_url:
          type: string
          nullable: true
          description: The URL SignalWire will request if errors occur when fetching the `SmsUrl`.
          example: http://www.example.com/sms-fallback
        sms_fallback_method:
          type: string
          nullable: true
          description: Whether the request to `SmsFallbackUrl` is a `GET` or a `POST`. Default is `POST`.
          example: POST
        sms_status_callback:
          type: string
          nullable: true
          description: The URL to receive status updates for messages sent via this Application.
          example: http://www.example.com/sms-status-callback
        sms_status_callback_method:
          type: string
          nullable: true
          description: Whether the request to `SmsStatusCallback` is a `GET` or a `POST`. Default is `POST`.
          example: POST
        message_status_callback:
          type: string
          nullable: true
          description: The URL to receive status updates for messages sent via this Application.
          example: http://www.example.com/sms-status-callback
      description: Application model representing a cXML application.
    ApplicationListResponse:
      type: object
      required:
        - uri
        - first_page_uri
        - next_page_uri
        - previous_page_uri
        - page
        - page_size
        - applications
      properties:
        uri:
          type: string
          description: The URI for this resource.
          example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Applications?Page=0&PageSize=50
        first_page_uri:
          type: string
          description: The URI for the first page of results.
          example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Applications?Page=0&PageSize=50
        next_page_uri:
          type: string
          nullable: true
          description: The URI for the next page of results. Null if there are no more pages.
          example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Applications?Page=1&PageSize=50
        previous_page_uri:
          type: string
          nullable: true
          description: The URI for the previous page of results. Null if this is the first page.
          example: null
        page:
          type: integer
          format: int32
          description: The current page number. Zero-indexed.
          example: 0
        page_size:
          type: integer
          format: int32
          description: The number of results per page.
          example: 50
        applications:
          type: array
          items:
            $ref: '#/components/schemas/Application'
          description: List of applications.
      description: Response containing a list of applications.
    ApplicationResponse:
      type: object
      required:
        - sid
        - account_sid
        - api_version
        - date_created
        - date_updated
        - friendly_name
        - uri
        - voice_url
        - voice_method
        - voice_fallback_url
        - voice_fallback_method
        - status_callback
        - status_callback_method
        - voice_caller_id_lookup
        - sms_url
        - sms_method
        - sms_fallback_url
        - sms_fallback_method
        - sms_status_callback
        - sms_status_callback_method
        - message_status_callback
      properties:
        sid:
          type: string
          format: uuid
          description: The unique identifier for the Application.
          example: b3877c40-da60-4998-90ad-b792e98472af
        account_sid:
          type: string
          format: uuid
          description: The unique identifier for the Account that created this Application.
          example: b3877c40-da60-4998-90ad-b792e98472af
        api_version:
          type: string
          description: The version of the SignalWire API.
          example: '2010-04-01'
        date_created:
          type: string
          description: The date, in RFC 2822 GMT format, this Application was created.
          example: Sat, 15 Sept 2018 10:00:00 +0000
        date_updated:
          type: string
          description: The date, in RFC 2822 GMT format, this Application was updated.
          example: Sat, 16 Sept 2018 10:00:00 +0000
        friendly_name:
          type: string
          description: A named unique identifier for the resource.
          example: My Friendly Name
        uri:
          type: string
          description: The URI for this Application.
          example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Applications/b3877c40-da60-4998-90ad-b792e98472af.json
        voice_url:
          type: string
          nullable: true
          description: The URL to request when a phone number receives a call or fax.
          example: http://example.com
        voice_method:
          type: string
          nullable: true
          description: Whether the request to `VoiceUrl` is a `GET` or a `POST`. Default is `POST`.
          example: POST
        voice_fallback_url:
          type: string
          nullable: true
          description: The URL SignalWire will request if errors occur when fetching the `VoiceUrl`.
          example: http://example.com
        voice_fallback_method:
          type: string
          nullable: true
          description: Whether the request to `VoiceFallbackUrl` is a `GET` or a `POST`. Default is `POST`.
          example: POST
        status_callback:
          type: string
          nullable: true
          description: The URL to pass status updates to the Application.
          example: http://example.com
        status_callback_method:
          type: string
          nullable: true
          description: Whether the request to the `StatusCallback` URL is a `GET` or a `POST`. Default is `POST`.
          example: POST
        voice_caller_id_lookup:
          type: boolean
          nullable: true
          description: Whether or not to look up a caller's ID from the database. Always null.
          example: null
        sms_url:
          type: string
          nullable: true
          description: The URL to request when an SMS is received.
          example: http://example.com
        sms_method:
          type: string
          nullable: true
          description: Whether the request to `SmsUrl` is a `GET` or a `POST`. Default is `POST`.
          example: POST
        sms_fallback_url:
          type: string
          nullable: true
          description: The URL SignalWire will request if errors occur when fetching the `SmsUrl`.
          example: http://www.example.com/sms-fallback
        sms_fallback_method:
          type: string
          nullable: true
          description: Whether the request to `SmsFallbackUrl` is a `GET` or a `POST`. Default is `POST`.
          example: POST
        sms_status_callback:
          type: string
          nullable: true
          description: The URL to receive status updates for messages sent via this Application.
          example: http://www.example.com/sms-status-callback
        sms_status_callback_method:
          type: string
          nullable: true
          description: Whether the request to `SmsStatusCallback` is a `GET` or a `POST`. Default is `POST`.
          example: POST
        message_status_callback:
          type: string
          nullable: true
          description: The URL to receive status updates for messages sent via this Application.
          example: http://www.example.com/sms-status-callback
      description: Response containing a single application.
    AvailablePhoneNumber:
      type: object
      required:
        - friendly_name
        - phone_number
        - lata
        - locality
        - rate_center
        - latitude
        - longitude
        - region
        - postal_code
        - iso_country
        - capabilities
        - beta
      properties:
        friendly_name:
          type: string
          description: A formatted version of the number.
          example: (253) 218-6751
        phone_number:
          type: string
          description: The number in E.164 format.
          example: '+12532186751'
        lata:
          type: string
          nullable: true
          description: The LATA of the number. Always null.
          example: null
        locality:
          type: string
          nullable: true
          description: The locality/city of the number. Always null.
          example: null
        rate_center:
          type: string
          nullable: true
          description: The rate center of the number. Only available for numbers in US and Canada.
          example: AUBURN
        latitude:
          type: string
          nullable: true
          description: The latitude of the number. Always null.
          example: null
        longitude:
          type: string
          nullable: true
          description: The longitude of the number. Always null.
          example: null
        region:
          type: string
          nullable: true
          description: The state or province abbreviation of the number. Only available for numbers in US and Canada.
          example: WA
        postal_code:
          type: string
          nullable: true
          description: The postal/zip code of the number. Always null.
          example: null
        iso_country:
          type: string
          description: The ISO country code of the number.
          example: US
        capabilities:
          allOf:
            - $ref: '#/components/schemas/PhoneNumberCapabilities'
          description: Whether or not a number can receive calls and messages.
        beta:
          type: boolean
          description: New numbers on SignalWire are marked as `beta`.
          example: false
      description: Available phone number model.
    AvailablePhoneNumberByCountryResponse:
      type: object
      required:
        - country_code
        - country
        - uri
        - beta
        - subresource_uris
      properties:
        country_code:
          type: string
          description: The ISO country code of the number.
          example: US
        country:
          type: string
          description: The country the number is from.
          example: United States
        uri:
          type: string
          description: The URI for the API call.
          example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/AvailablePhoneNumbers/US
        beta:
          type: boolean
          description: New numbers on SignalWire are marked as `beta`.
          example: false
        subresource_uris:
          allOf:
            - $ref: '#/components/schemas/CountrySubresourceUris'
          description: URIs for subresources.
      description: Response containing available phone number resources for a specific country.
    AvailablePhoneNumberListResponse:
      type: object
      required:
        - uri
        - available_phone_numbers
      properties:
        uri:
          type: string
          description: The URI for the API call.
          example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/AvailablePhoneNumbers/US/Local
        available_phone_numbers:
          type: array
          items:
            $ref: '#/components/schemas/AvailablePhoneNumber'
          description: List of available phone numbers.
      description: Response containing a list of available phone numbers.
    AvailablePhoneNumberResourcesResponse:
      type: object
      required:
        - uri
        - countries
      properties:
        uri:
          type: string
          description: The URI for the API call.
          example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/AvailablePhoneNumbers
        countries:
          type: array
          items:
            $ref: '#/components/schemas/CountryResource'
          description: List of available countries.
      description: Response containing a list of available phone number resources (countries).
    Call:
      type: object
      required:
        - sid
        - account_sid
        - date_created
        - date_updated
        - parent_call_sid
        - to
        - formatted_to
        - to_formatted
        - from
        - formatted_from
        - from_formatted
        - phone_number_sid
        - status
        - start_time
        - end_time
        - duration
        - price
        - price_unit
        - direction
        - answered_by
        - api_version
        - forwarded_from
        - caller_name
        - uri
        - subresource_uris
        - annotation
        - group_sid
        - audio_in_mos
        - sip_result_code
        - audio_rtt_avg
        - audio_rtt_min
        - audio_rtt_max
        - audio_out_jitter_min
        - audio_out_jitter_max
        - audio_out_jitter_avg
        - audio_out_lost
      properties:
        sid:
          type: string
          format: uuid
          description: The unique identifier for the call.
          example: b3877c40-da60-4998-90ad-b792e98472ca
        account_sid:
          type: string
          format: uuid
          description: The unique identifier for the account that created this call.
          example: b3877c40-da60-4998-90ad-b792e98472af
        date_created:
          type: string
          description: The date, in RFC 2822 GMT format, this call was created.
          example: Wed, 19 Sep 2018 20:00:00 +0000
        date_updated:
          type: string
          description: The date, in RFC 2822 GMT format, this call was updated.
          example: Wed, 19 Sep 2018 21:00:00 +0000
        parent_call_sid:
          type: string
          nullable: true
          format: uuid
          description: The unique identifier for the call that created this call.
          example: b3877c40-da60-4998-90ad-b792e98472af
        to:
          type: string
          description: The address that received the call.
          example: '+13105678901'
        formatted_to:
          type: string
          description: The formatted number that received the call.
          example: (310) 567-8901
        to_formatted:
          type: string
          description: The formatted number that received the call. Alias for formatted_to.
          example: (310) 567-8901
        from:
          type: string
          description: The address that initiated the call.
          example: '+13103384645'
        formatted_from:
          type: string
          description: The formatted number that initiated the call.
          example: (310) 338-4645
        from_formatted:
          type: string
          description: The formatted number that initiated the call. Alias for formatted_from.
          example: (310) 338-4645
        phone_number_sid:
          type: string
          nullable: true
          format: uuid
          description: The unique identifier for the phone number.
          example: b3877c40-da60-4998-90ad-b792e98472pn
        status:
          allOf:
            - $ref: '#/components/schemas/CallStatus'
          description: The status of the call.
        start_time:
          type: string
          nullable: true
          description: The time, in RFC 2822 GMT format, on which the call began.
          example: Wed, 19 Sep 2018 20:00:01 +0000
        end_time:
          type: string
          nullable: true
          description: The time, in RFC 2822 GMT format, on which the call was terminated.
          example: Fri, 21 Sep 2018 10:00:00 +0000
        duration:
          type: integer
          format: int32
          description: The duration, in seconds, of the call.
          example: 20
        price:
          type: number
          format: float
          nullable: true
          description: The charge for the call.
          example: 0.003
        price_unit:
          type: string
          description: The currency, in ISO 4127 format, for the price of the call.
          example: USD
        direction:
          allOf:
            - $ref: '#/components/schemas/CallDirection'
          description: The direction of the call.
        answered_by:
          allOf:
            - $ref: '#/components/schemas/AnsweredBy'
          nullable: true
          description: Who/what the call was answered by.
        api_version:
          type: string
          description: The version of the SignalWire API.
          example: '2010-04-01'
        forwarded_from:
          type: string
          nullable: true
          description: The number this call was forwarded from. Always null.
          example: null
        caller_name:
          type: string
          nullable: true
          description: The caller name. Always null.
          example: null
        uri:
          type: string
          description: The URI for the call.
          example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Calls/b3877c40-da60-4998-90ad-b792e98472ca.json
        subresource_uris:
          allOf:
            - $ref: '#/components/schemas/CallSubresourceUris'
          description: A Map of available sub-resources.
        annotation:
          type: string
          nullable: true
          description: The annotation for the call. Always null.
          example: null
        group_sid:
          type: string
          nullable: true
          description: The group SID for the call. Always null.
          example: null
        audio_in_mos:
          type: number
          format: float
          nullable: true
          description: The Mean Opinion Score for audio quality (1.0-5.0).
          example: 4.5
        sip_result_code:
          type: string
          nullable: true
          description: The SIP result code for the call.
          example: '200'
        audio_rtt_avg:
          type: integer
          format: int32
          nullable: true
          description: The average round-trip time for audio in milliseconds.
          example: 50
        audio_rtt_min:
          type: integer
          format: int32
          nullable: true
          description: The minimum round-trip time for audio in milliseconds.
          example: 20
        audio_rtt_max:
          type: integer
          format: int32
          nullable: true
          description: The maximum round-trip time for audio in milliseconds.
          example: 100
        audio_out_jitter_min:
          type: integer
          format: int32
          nullable: true
          description: The minimum outbound audio jitter in milliseconds.
          example: 1
        audio_out_jitter_max:
          type: integer
          format: int32
          nullable: true
          description: The maximum outbound audio jitter in milliseconds.
          example: 10
        audio_out_jitter_avg:
          type: integer
          format: int32
          nullable: true
          description: The average outbound audio jitter in milliseconds.
          example: 5
        audio_out_lost:
          type: integer
          format: int32
          nullable: true
          description: The number of outbound audio packets lost.
          example: 0
      description: Call model representing a voice call.
    CallDirection:
      type: string
      enum:
        - inbound
        - outbound
      description: Call direction.
    CallListResponse:
      type: object
      required:
        - uri
        - first_page_uri
        - next_page_uri
        - previous_page_uri
        - page
        - page_size
        - calls
      properties:
        uri:
          type: string
          description: The URI of the current page.
          example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Calls?Page=0&PageSize=50
        first_page_uri:
          type: string
          description: The URI of the first page.
          example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Calls?Page=0&PageSize=50
        next_page_uri:
          type: string
          nullable: true
          description: The URI of the next page.
          example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Calls?Page=1&PageSize=50&PageToken=PAxxxxxxxxxx
        previous_page_uri:
          type: string
          nullable: true
          description: The URI of the previous page.
          example: null
        page:
          type: integer
          format: int32
          description: The current page number.
          example: 0
        page_size:
          type: integer
          format: int32
          description: The number of items per page.
          example: 50
        calls:
          type: array
          items:
            $ref: '#/components/schemas/Call'
          description: List of calls.
      description: Response containing a list of calls.
    CallRecordingResponse:
      type: object
      required:
        - sid
        - account_sid
        - api_version
        - call_sid
        - conference_sid
        - channel
        - channels
        - date_created
        - date_updated
        - start_time
        - end_time
        - duration
        - price
        - price_unit
        - source
        - status
        - error_code
        - uri
        - subresource_uris
        - encryption_details
        - trim
      properties:
        sid:
          type: string
          format: uuid
          description: The unique identifier for the recording.
          example: 19e436af-5688-4307-b03b-bdb2b42b8142
        account_sid:
          type: string
          format: uuid
          description: The unique identifier for the account that is associated with this recording.
          example: 720796a0-8ee9-4350-83bd-2d07a3121f1e
        api_version:
          type: string
          description: The version of the SignalWire API.
          example: '2010-04-01'
        call_sid:
          type: string
          nullable: true
          format: uuid
          description: The unique identifier for the call that is associated with this recording. Null if this is a conference recording.
          example: 43bb71ee-553f-4074-bb20-8e2747647cce
        conference_sid:
          type: string
          nullable: true
          format: uuid
          description: The unique identifier for the conference that is associated with this recording. Null if this is a call recording.
          example: null
        channel:
          type: string
          enum:
            - '1'
            - '2'
          description: The number of channels in a recording (singular key). Returns '1' for mono or '2' for stereo.
          example: '1'
        channels:
          type: string
          enum:
            - '1'
            - '2'
          description: The number of channels in a recording. Returns '1' for mono or '2' for stereo.
          example: '1'
        date_created:
          type: string
          description: The date, in RFC 2822 format, this recording was created.
          example: Tue, 25 Sep 2018 23:00:00 +0000
        date_updated:
          type: string
          description: The date, in RFC 2822 format, this recording was updated.
          example: Wed, 26 Sep 2018 23:00:04 +0000
        start_time:
          type: string
          nullable: true
          description: The time, in RFC 2822 format, this recording started.
          example: Tue, 25 Sep 2018 23:00:00 +0000
        end_time:
          type: string
          nullable: true
          description: The time, in RFC 2822 format, this recording ended.
          example: Wed, 26 Sep 2018 23:00:04 +0000
        duration:
          type: integer
          format: int32
          description: The length, in seconds, of the recording.
          example: 4
        price:
          type: string
          nullable: true
          description: The cost for the recording.
          example: '-0.0025'
        price_unit:
          type: string
          description: The currency of the price of the recording.
          example: USD
        source:
          allOf:
            - $ref: '#/components/schemas/RecordingSource'
          description: How the recording was made.
        status:
          allOf:
            - $ref: '#/components/schemas/RecordingStatus'
          description: The status of the recording.
        error_code:
          type: string
          nullable: true
          description: Further details about a failed recording.
          example: null
        uri:
          type: string
          description: The URI of the recording.
          example: /api/laml/2010-04-01/Accounts/720796a0-8ee9-4350-83bd-2d07a3121f1e/Recordings/19e436af-5688-4307-b03b-bdb2b42b8142.json
        subresource_uris:
          allOf:
            - $ref: '#/components/schemas/RecordingSubresourceUris'
          description: Subresource URIs.
        encryption_details:
          type: string
          nullable: true
          description: Encryption details. Always null.
          example: null
        trim:
          type: string
          description: Whether leading and trailing silence is trimmed from a recording.
          example: do-not-trim
      description: Response containing a single call recording.
    CallResponse:
      type: object
      required:
        - sid
        - account_sid
        - date_created
        - date_updated
        - parent_call_sid
        - to
        - formatted_to
        - to_formatted
        - from
        - formatted_from
        - from_formatted
        - phone_number_sid
        - status
        - start_time
        - end_time
        - duration
        - price
        - price_unit
        - direction
        - answered_by
        - api_version
        - forwarded_from
        - caller_name
        - uri
        - subresource_uris
        - annotation
        - group_sid
        - audio_in_mos
        - sip_result_code
        - audio_rtt_avg
        - audio_rtt_min
        - audio_rtt_max
        - audio_out_jitter_min
        - audio_out_jitter_max
        - audio_out_jitter_avg
        - audio_out_lost
      properties:
        sid:
          type: string
          format: uuid
          description: The unique identifier for the call.
          example: b3877c40-da60-4998-90ad-b792e98472ca
        account_sid:
          type: string
          format: uuid
          description: The unique identifier for the account that created this call.
          example: b3877c40-da60-4998-90ad-b792e98472af
        date_created:
          type: string
          description: The date, in RFC 2822 GMT format, this call was created.
          example: Wed, 19 Sep 2018 20:00:00 +0000
        date_updated:
          type: string
          description: The date, in RFC 2822 GMT format, this call was updated.
          example: Wed, 19 Sep 2018 21:00:00 +0000
        parent_call_sid:
          type: string
          nullable: true
          format: uuid
          description: The unique identifier for the call that created this call.
          example: b3877c40-da60-4998-90ad-b792e98472af
        to:
          type: string
          description: The address that received the call.
          example: '+13105678901'
        formatted_to:
          type: string
          description: The formatted number that received the call.
          example: (310) 567-8901
        to_formatted:
          type: string
          description: The formatted number that received the call. Alias for formatted_to.
          example: (310) 567-8901
        from:
          type: string
          description: The address that initiated the call.
          example: '+13103384645'
        formatted_from:
          type: string
          description: The formatted number that initiated the call.
          example: (310) 338-4645
        from_formatted:
          type: string
          description: The formatted number that initiated the call. Alias for formatted_from.
          example: (310) 338-4645
        phone_number_sid:
          type: string
          nullable: true
          format: uuid
          description: The unique identifier for the phone number.
          example: b3877c40-da60-4998-90ad-b792e98472pn
        status:
          allOf:
            - $ref: '#/components/schemas/CallStatus'
          description: The status of the call.
        start_time:
          type: string
          nullable: true
          description: The time, in RFC 2822 GMT format, on which the call began.
          example: Wed, 19 Sep 2018 20:00:01 +0000
        end_time:
          type: string
          nullable: true
          description: The time, in RFC 2822 GMT format, on which the call was terminated.
          example: Fri, 21 Sep 2018 10:00:00 +0000
        duration:
          type: integer
          format: int32
          description: The duration, in seconds, of the call.
          example: 20
        price:
          type: number
          format: float
          nullable: true
          description: The charge for the call.
          example: 0.003
        price_unit:
          type: string
          description: The currency, in ISO 4127 format, for the price of the call.
          example: USD
        direction:
          allOf:
            - $ref: '#/components/schemas/CallDirection'
          description: The direction of the call.
        answered_by:
          allOf:
            - $ref: '#/components/schemas/AnsweredBy'
          nullable: true
          description: Who/what the call was answered by.
        api_version:
          type: string
          description: The version of the SignalWire API.
          example: '2010-04-01'
        forwarded_from:
          type: string
          nullable: true
          description: The number this call was forwarded from. Always null.
          example: null
        caller_name:
          type: string
          nullable: true
          description: The caller name. Always null.
          example: null
        uri:
          type: string
          description: The URI for the call.
          example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Calls/b3877c40-da60-4998-90ad-b792e98472ca.json
        subresource_uris:
          allOf:
            - $ref: '#/components/schemas/CallSubresourceUris'
          description: A Map of available sub-resources.
        annotation:
          type: string
          nullable: true
          description: The annotation for the call. Always null.
          example: null
        group_sid:
          type: string
          nullable: true
          description: The group SID for the call. Always null.
          example: null
        audio_in_mos:
          type: number
          format: float
          nullable: true
          description: The Mean Opinion Score for audio quality (1.0-5.0).
          example: 4.5
        sip_result_code:
          type: string
          nullable: true
          description: The SIP result code for the call.
          example: '200'
        audio_rtt_avg:
          type: integer
          format: int32
          nullable: true
          description: The average round-trip time for audio in milliseconds.
          example: 50
        audio_rtt_min:
          type: integer
          format: int32
          nullable: true
          description: The minimum round-trip time for audio in milliseconds.
          example: 20
        audio_rtt_max:
          type: integer
          format: int32
          nullable: true
          description: The maximum round-trip time for audio in milliseconds.
          example: 100
        audio_out_jitter_min:
          type: integer
          format: int32
          nullable: true
          description: The minimum outbound audio jitter in milliseconds.
          example: 1
        audio_out_jitter_max:
          type: integer
          format: int32
          nullable: true
          description: The maximum outbound audio jitter in milliseconds.
          example: 10
        audio_out_jitter_avg:
          type: integer
          format: int32
          nullable: true
          description: The average outbound audio jitter in milliseconds.
          example: 5
        audio_out_lost:
          type: integer
          format: int32
          nullable: true
          description: The number of outbound audio packets lost.
          example: 0
      description: Response containing a single call.
    CallStatus:
      type: string
      enum:
        - queued
        - ringing
        - in-progress
        - canceled
        - completed
        - busy
        - failed
        - no-answer
      description: Call status.
    CallStreamResponse:
      type: object
      required:
        - sid
        - account_sid
        - call_sid
        - name
        - status
        - date_updated
        - uri
      properties:
        sid:
          type: string
          format: uuid
          description: The unique identifier for the stream.
          example: b3877c40-da60-4998-90ad-b792e98472st
        account_sid:
          type: string
          format: uuid
          description: The unique identifier for the account.
          example: b3877c40-da60-4998-90ad-b792e98472af
        call_sid:
          type: string
          format: uuid
          description: The unique identifier for the call.
          example: b3877c40-da60-4998-90ad-b792e98472ca
        name:
          type: string
          description: The name of the stream.
          example: my_first_stream
        status:
          allOf:
            - $ref: '#/components/schemas/StreamStatus'
          description: The status of the stream.
        date_updated:
          type: string
          description: The date, in RFC 2822 GMT format, this stream was updated.
          example: Wed, 19 Sep 2018 21:00:00 +0000
        uri:
          type: string
          description: The URI for the stream.
          example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Calls/b3877c40-da60-4998-90ad-b792e98472ca/Streams/b3877c40-da60-4998-90ad-b792e98472st.json
      description: Response containing a single call stream.
    CallSubresourceUris:
      type: object
      required:
        - notifications
        - recordings
      properties:
        notifications:
          type: string
          nullable: true
          description: The URI for notifications. Always null.
          example: null
        recordings:
          type: string
          description: The URI for recordings.
          example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Calls/b3877c40-da60-4998-90ad-b792e98472ca/Recordings.json
      description: Call subresource URIs.
    CompatibilityErrorArrayItem:
      type: object
      properties:
        code:
          type: string
          description: The numeric string identifying the API error code
          example: '30010'
        message:
          type: string
          description: Error text
          example: Maxpriceperminute was exceeded. This call's cost is 0.008 per minute.
        more_info:
          type: string
          description: Url for more information on error code
          example: https://developer.signalwire.com/rest/compatibility-api/error-codes
      description: Error item in the errors array format.
    CompatibilityErrorArrayResponse:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/CompatibilityErrorArrayItem'
          description: A list of errors
      description: Error response with errors array format.
    CompatibilityErrorResponse:
      type: object
      required:
        - code
        - message
        - more_info
        - status
      properties:
        code:
          type: integer
          format: int32
          description: Error code.
          example: 20003
        message:
          type: string
          description: Error message.
          example: Authentication failed
        more_info:
          type: string
          description: URL for more information about the error.
          example: https://developer.signalwire.com/compatibility-api/reference/errors
        status:
          type: integer
          format: int32
          description: HTTP status code.
          example: 401
      description: Error response model.
    CompatibilityErrorStringArrayResponse:
      type: object
      required:
        - errors
      properties:
        errors:
          type: array
          items:
            type: string
          description: List of validation error messages.
          example:
            - Validation error message
      description: Error response with errors array of strings format.
    CompatibilityImportedPhoneNumberError:
      type: object
      properties:
        code:
          type: string
          description: The error code.
          example: '10000'
        message:
          type: string
          description: A human-readable error message.
          example: Number type can't be blank
        more_info:
          type: string
          description: A URL to more information about the error.
          example: https://developer.signalwire.com/rest/compatibility-api/overview/error-codes
        status:
          type: integer
          format: int32
          description: The HTTP status code.
          example: 400
      description: Error response model with string code for ImportedPhoneNumbers.
    CompatibilityTokenValidationError:
      type: object
      properties:
        type:
          type: string
          description: Error type.
        code:
          type: string
          description: Error code.
        message:
          type: string
          description: Error message.
        attribute:
          type: string
          description: Request parameter associated with this error.
        url:
          type: string
          format: uri
          description: Link to developer resource for this error.
      description: Token validation error response model.
    Conference:
      type: object
      required:
        - sid
        - account_sid
        - date_created
        - date_updated
        - friendly_name
        - status
        - api_version
        - region
        - uri
        - subresource_uris
      properties:
        sid:
          type: string
          format: uuid
          description: The unique identifier for this conference.
          example: b3877c40-da60-4998-90ad-b792e98472cf
        account_sid:
          type: string
          format: uuid
          description: The unique identifier for the account that created this conference.
          example: b3877c40-da60-4998-90ad-b792e98472af
        date_created:
          type: string
          description: The date, in RFC 2822 format, this conference was created.
          example: Mon, 24 Sept 2018 21:00:00 +0000
        date_updated:
          type: string
          description: The date, in RFC 2822 format, this conference was updated.
          example: Tue, 25 Sept 2018 20:00:00 +0000
        friendly_name:
          type: string
          description: A description, up to 64 characters, of the conference room.
          example: 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.
          example: '2010-04-01'
        region:
          type: string
          description: The region where this conference audio was mixed.
          example: us1
        uri:
          type: string
          description: The URI for this conference.
          example: /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.
      description: Conference model.
    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.
          example: /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.
          example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Conferences
        next_page_uri:
          type: string
          nullable: true
          description: The URI of the next page.
          example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Conferences?Page=1&PageToken=PA5678
        previous_page_uri:
          type: string
          nullable: true
          description: The URI of the previous page.
          example: null
        page:
          type: integer
          format: int32
          description: The current page number.
          example: 0
        page_size:
          type: integer
          format: int32
          description: The number of items per page.
          example: 50
        conferences:
          type: array
          items:
            $ref: '#/components/schemas/Conference'
          description: List of conferences.
      description: Response containing a list of conferences.
    ConferenceParticipant:
      type: object
      required:
        - account_sid
        - call_sid
        - call_sid_to_coach
        - coaching
        - conference_sid
        - date_created
        - status
        - date_updated
        - end_conference_on_exit
        - muted
        - hold
        - start_conference_on_enter
        - uri
      properties:
        account_sid:
          type: string
          format: uuid
          description: The unique identifier for the account that created this conference.
          example: b3877c40-da60-4998-90ad-b792e98472af
        call_sid:
          type: string
          format: uuid
          description: The unique identifier for the Participant call connected to this conference.
          example: b3877c40-da60-4998-90ad-b792e98472ca
        call_sid_to_coach:
          type: string
          nullable: true
          format: uuid
          description: The unique identifier of the participant who is being coached.
          example: b3877c40-da60-4998-90ad-b792e98472co
        coaching:
          type: boolean
          description: Whether the participant is coaching another call.
          example: false
        conference_sid:
          type: string
          format: uuid
          description: The unique identifier for the conference this participant is in.
          example: b3877c40-da60-4998-90ad-b792e98472cf
        date_created:
          type: string
          description: The date, in RFC 2822 format, this conference participant was created.
          example: Mon, 24 Sept 2018 21:00:00 +0000
        status:
          allOf:
            - $ref: '#/components/schemas/ParticipantStatus'
          description: The status of the conference call.
        date_updated:
          type: string
          description: The date, in RFC 2822 format, this conference participant was updated.
          example: Tue, 25 Sept 2018 20:00:00 +0000
        end_conference_on_exit:
          type: boolean
          description: Whether or not a conference ends when a participant leaves the conference call.
          example: false
        muted:
          type: boolean
          description: Whether or not a participant is muted.
          example: false
        hold:
          type: boolean
          description: Whether or not a participant is on hold.
          example: false
        start_conference_on_enter:
          type: boolean
          description: Whether or not a conference will begin when this participant enters the conference call.
          example: true
        uri:
          type: string
          description: The URI for this conference participant.
          example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Conferences/b3877c40-da60-4998-90ad-b792e98472cf/Participants/b3877c40-da60-4998-90ad-b792e98472ca.json
      description: Conference participant model.
    ConferenceParticipantListResponse:
      type: object
      required:
        - uri
        - first_page_uri
        - next_page_uri
        - previous_page_uri
        - page
        - page_size
        - participants
      properties:
        uri:
          type: string
          description: The URI of the current page.
          example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Conferences/b3877c40-da60-4998-90ad-b792e98472cf/Participants?PageToken=PA1234
        first_page_uri:
          type: string
          description: The URI of the first page.
          example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Conferences/b3877c40-da60-4998-90ad-b792e98472cf/Participants
        next_page_uri:
          type: string
          nullable: true
          description: The URI of the next page.
          example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Conferences/b3877c40-da60-4998-90ad-b792e98472cf/Participants?Page=1&PageToken=PA5678
        previous_page_uri:
          type: string
          nullable: true
          description: The URI of the previous page.
          example: null
        page:
          type: integer
          format: int32
          description: The current page number.
          example: 0
        page_size:
          type: integer
          format: int32
          description: The number of items per page.
          example: 50
        participants:
          type: array
          items:
            $ref: '#/components/schemas/ConferenceParticipant'
          description: List of participants.
      description: Response containing a list of conference participants.
    ConferenceParticipantResponse:
      type: object
      required:
        - account_sid
        - call_sid
        - call_sid_to_coach
        - coaching
        - conference_sid
        - date_created
        - status
        - date_updated
        - end_conference_on_exit
        - muted
        - hold
        - start_conference_on_enter
        - uri
      properties:
        account_sid:
          type: string
          format: uuid
          description: The unique identifier for the account that created this conference.
          example: b3877c40-da60-4998-90ad-b792e98472af
        call_sid:
          type: string
          format: uuid
          description: The unique identifier for the Participant call connected to this conference.
          example: b3877c40-da60-4998-90ad-b792e98472ca
        call_sid_to_coach:
          type: string
          nullable: true
          format: uuid
          description: The unique identifier of the participant who is being coached.
          example: b3877c40-da60-4998-90ad-b792e98472co
        coaching:
          type: boolean
          description: Whether the participant is coaching another call.
          example: false
        conference_sid:
          type: string
          format: uuid
          description: The unique identifier for the conference this participant is in.
          example: b3877c40-da60-4998-90ad-b792e98472cf
        date_created:
          type: string
          description: The date, in RFC 2822 format, this conference participant was created.
          example: Mon, 24 Sept 2018 21:00:00 +0000
        status:
          allOf:
            - $ref: '#/components/schemas/ParticipantStatus'
          description: The status of the conference call.
        date_updated:
          type: string
          description: The date, in RFC 2822 format, this conference participant was updated.
          example: Tue, 25 Sept 2018 20:00:00 +0000
        end_conference_on_exit:
          type: boolean
          description: Whether or not a conference ends when a participant leaves the conference call.
          example: false
        muted:
          type: boolean
          description: Whether or not a participant is muted.
          example: false
        hold:
          type: boolean
          description: Whether or not a participant is on hold.
          example: false
        start_conference_on_enter:
          type: boolean
          description: Whether or not a conference will begin when this participant enters the conference call.
          example: true
        uri:
          type: string
          description: The URI for this conference participant.
          example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Conferences/b3877c40-da60-4998-90ad-b792e98472cf/Participants/b3877c40-da60-4998-90ad-b792e98472ca.json
      description: Response containing a single conference participant.
    ConferenceRecording:
      type: object
      required:
        - sid
        - account_sid
        - api_version
        - call_sid
        - conference_sid
        - channel
        - channels
        - date_created
        - date_updated
        - start_time
        - end_time
        - duration
        - price
        - price_unit
        - source
        - status
        - error_code
        - uri
        - subresource_uris
        - encryption_details
        - trim
      properties:
        sid:
          type: string
          format: uuid
          description: The unique identifier for the recording.
          example: 19e436af-5688-4307-b03b-bdb2b42b8142
        account_sid:
          type: string
          format: uuid
          description: The unique identifier for the account that is associated with this recording.
          example: 720796a0-8ee9-4350-83bd-2d07a3121f1e
        api_version:
          type: string
          description: The version of the SignalWire API.
          example: '2010-04-01'
        call_sid:
          type: string
          nullable: true
          description: The unique identifier for the call. Always null for conference recordings.
          example: null
        conference_sid:
          type: string
          nullable: true
          format: uuid
          description: The unique identifier for the conference that is associated with this recording.
          example: 43bb71ee-553f-4074-bb20-8e2747647cce
        channel:
          type: string
          enum:
            - '1'
            - '2'
          description: The number of channels in a recording (singular key). Returns '1' for mono or '2' for stereo.
          example: '1'
        channels:
          type: string
          enum:
            - '1'
            - '2'
          description: The number of channels in a recording. Returns '1' for mono or '2' for stereo.
          example: '1'
        date_created:
          type: string
          description: The date, in RFC 2822 format, this recording was created.
          example: Tue, 25 Sep 2018 23:00:00 +0000
        date_updated:
          type: string
          description: The date, in RFC 2822 format, this recording was updated.
          example: Wed, 26 Sep 2018 23:00:04 +0000
        start_time:
          type: string
          nullable: true
          description: The time, in RFC 2822 format, this recording started.
          example: Tue, 25 Sep 2018 23:00:00 +0000
        end_time:
          type: string
          nullable: true
          description: The time, in RFC 2822 format, this recording ended.
          example: Wed, 26 Sep 2018 23:00:04 +0000
        duration:
          type: integer
          format: int32
          description: The length, in seconds, of the recording.
          example: 4
        price:
          type: string
          nullable: true
          description: The cost for the recording.
          example: '-0.0025'
        price_unit:
          type: string
          description: The currency of the price of the recording.
          example: USD
        source:
          allOf:
            - $ref: '#/components/schemas/ConferenceRecordingSource'
          description: How the recording was made.
        status:
          allOf:
            - $ref: '#/components/schemas/ConferenceRecordingStatus'
          description: The status of the recording.
        error_code:
          type: string
          nullable: true
          description: Further details about a failed recording.
          example: null
        uri:
          type: string
          description: The URI of the recording.
          example: /api/laml/2010-04-01/Accounts/720796a0-8ee9-4350-83bd-2d07a3121f1e/Conferences/43bb71ee-553f-4074-bb20-8e2747647cce/Recordings/19e436af-5688-4307-b03b-bdb2b42b8142.json
        subresource_uris:
          allOf:
            - $ref: '#/components/schemas/ConferenceRecordingSubresourceUris'
          description: Subresource URIs.
        encryption_details:
          type: string
          nullable: true
          description: Encryption details. Always null.
          example: null
        trim:
          type: string
          description: Whether leading and trailing silence is trimmed from a recording.
          example: do-not-trim
      description: Conference recording model.
    ConferenceRecordingListResponse:
      type: object
      required:
        - uri
        - first_page_uri
        - next_page_uri
        - previous_page_uri
        - page
        - page_size
        - recordings
      properties:
        uri:
          type: string
          description: The URI of the current page.
          example: /api/laml/2010-04-01/Accounts/720796a0-8ee9-4350-83bd-2d07a3121f1e/Conferences/43bb71ee-553f-4074-bb20-8e2747647cce/Recordings?PageToken=PA1234
        first_page_uri:
          type: string
          description: The URI of the first page.
          example: /api/laml/2010-04-01/Accounts/720796a0-8ee9-4350-83bd-2d07a3121f1e/Conferences/43bb71ee-553f-4074-bb20-8e2747647cce/Recordings
        next_page_uri:
          type: string
          nullable: true
          description: The URI of the next page.
          example: /api/laml/2010-04-01/Accounts/720796a0-8ee9-4350-83bd-2d07a3121f1e/Conferences/43bb71ee-553f-4074-bb20-8e2747647cce/Recordings?Page=1&PageToken=PA5678
        previous_page_uri:
          type: string
          nullable: true
          description: The URI of the previous page.
          example: null
        page:
          type: integer
          format: int32
          description: The current page number.
          example: 0
        page_size:
          type: integer
          format: int32
          description: The number of items per page.
          example: 50
        recordings:
          type: array
          items:
            $ref: '#/components/schemas/ConferenceRecording'
          description: List of recordings.
      description: Response containing a list of conference recordings.
    ConferenceRecordingResponse:
      type: object
      required:
        - sid
        - account_sid
        - api_version
        - call_sid
        - conference_sid
        - channel
        - channels
        - date_created
        - date_updated
        - start_time
        - end_time
        - duration
        - price
        - price_unit
        - source
        - status
        - error_code
        - uri
        - subresource_uris
        - encryption_details
        - trim
      properties:
        sid:
          type: string
          format: uuid
          description: The unique identifier for the recording.
          example: 19e436af-5688-4307-b03b-bdb2b42b8142
        account_sid:
          type: string
          format: uuid
          description: The unique identifier for the account that is associated with this recording.
          example: 720796a0-8ee9-4350-83bd-2d07a3121f1e
        api_version:
          type: string
          description: The version of the SignalWire API.
          example: '2010-04-01'
        call_sid:
          type: string
          nullable: true
          description: The unique identifier for the call. Always null for conference recordings.
          example: null
        conference_sid:
          type: string
          nullable: true
          format: uuid
          description: The unique identifier for the conference that is associated with this recording.
          example: 43bb71ee-553f-4074-bb20-8e2747647cce
        channel:
          type: string
          enum:
            - '1'
            - '2'
          description: The number of channels in a recording (singular key). Returns '1' for mono or '2' for stereo.
          example: '1'
        channels:
          type: string
          enum:
            - '1'
            - '2'
          description: The number of channels in a recording. Returns '1' for mono or '2' for stereo.
          example: '1'
        date_created:
          type: string
          description: The date, in RFC 2822 format, this recording was created.
          example: Tue, 25 Sep 2018 23:00:00 +0000
        date_updated:
          type: string
          description: The date, in RFC 2822 format, this recording was updated.
          example: Wed, 26 Sep 2018 23:00:04 +0000
        start_time:
          type: string
          nullable: true
          description: The time, in RFC 2822 format, this recording started.
          example: Tue, 25 Sep 2018 23:00:00 +0000
        end_time:
          type: string
          nullable: true
          description: The time, in RFC 2822 format, this recording ended.
          example: Wed, 26 Sep 2018 23:00:04 +0000
        duration:
          type: integer
          format: int32
          description: The length, in seconds, of the recording.
          example: 4
        price:
          type: string
          nullable: true
          description: The cost for the recording.
          example: '-0.0025'
        price_unit:
          type: string
          description: The currency of the price of the recording.
          example: USD
        source:
          allOf:
            - $ref: '#/components/schemas/ConferenceRecordingSource'
          description: How the recording was made.
        status:
          allOf:
            - $ref: '#/components/schemas/ConferenceRecordingStatus'
          description: The status of the recording.
        error_code:
          type: string
          nullable: true
          description: Further details about a failed recording.
          example: null
        uri:
          type: string
          description: The URI of the recording.
          example: /api/laml/2010-04-01/Accounts/720796a0-8ee9-4350-83bd-2d07a3121f1e/Conferences/43bb71ee-553f-4074-bb20-8e2747647cce/Recordings/19e436af-5688-4307-b03b-bdb2b42b8142.json
        subresource_uris:
          allOf:
            - $ref: '#/components/schemas/ConferenceRecordingSubresourceUris'
          description: Subresource URIs.
        encryption_details:
          type: string
          nullable: true
          description: Encryption details. Always null.
          example: null
        trim:
          type: string
          description: Whether leading and trailing silence is trimmed from a recording.
          example: do-not-trim
      description: Response containing a single conference recording.
    ConferenceRecordingSource:
      type: string
      enum:
        - Conference
        - StartConferenceRecording
      description: Recording source for conference recordings.
    ConferenceRecordingStatus:
      type: string
      enum:
        - queued
        - in-progress
        - paused
        - resumed
        - completed
        - absent
        - stopped
      description: Recording status.
    ConferenceRecordingSubresourceUris:
      type: object
      required:
        - transcriptions
      properties:
        transcriptions:
          type: string
          description: The URI for transcriptions.
          example: /api/laml/2010-04-01/Accounts/720796a0-8ee9-4350-83bd-2d07a3121f1e/Recordings/19e436af-5688-4307-b03b-bdb2b42b8142/Transcriptions.json
      description: Recording subresource URIs.
    ConferenceResponse:
      type: object
      required:
        - sid
        - account_sid
        - date_created
        - date_updated
        - friendly_name
        - status
        - api_version
        - region
        - uri
        - subresource_uris
      properties:
        sid:
          type: string
          format: uuid
          description: The unique identifier for this conference.
          example: b3877c40-da60-4998-90ad-b792e98472cf
        account_sid:
          type: string
          format: uuid
          description: The unique identifier for the account that created this conference.
          example: b3877c40-da60-4998-90ad-b792e98472af
        date_created:
          type: string
          description: The date, in RFC 2822 format, this conference was created.
          example: Mon, 24 Sept 2018 21:00:00 +0000
        date_updated:
          type: string
          description: The date, in RFC 2822 format, this conference was updated.
          example: Tue, 25 Sept 2018 20:00:00 +0000
        friendly_name:
          type: string
          description: A description, up to 64 characters, of the conference room.
          example: 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.
          example: '2010-04-01'
        region:
          type: string
          description: The region where this conference audio was mixed.
          example: us1
        uri:
          type: string
          description: The URI for this conference.
          example: /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.
      description: Response containing a single conference.
    ConferenceStatus:
      type: string
      enum:
        - init
        - in-progress
        - completed
      description: Conference status.
    ConferenceStreamResponse:
      type: object
      required:
        - account_sid
        - conference_sid
        - date_updated
        - name
        - sid
        - status
        - uri
      properties:
        account_sid:
          type: string
          format: uuid
          description: The unique identifier for the account.
          example: b3877c40-da60-4998-90ad-b792e98472af
        conference_sid:
          type: string
          format: uuid
          description: The unique identifier for the conference.
          example: b3877c40-da60-4998-90ad-b792e98472cf
        date_updated:
          type: string
          description: The date, in RFC 2822 GMT format, this stream was updated.
          example: Tue, 25 Sept 2018 20:00:00 +0000
        name:
          type: string
          nullable: true
          description: The name of the stream. May be null if not specified when creating the stream.
          example: my_conference_stream
        sid:
          type: string
          format: uuid
          description: The unique identifier for the stream.
          example: b3877c40-da60-4998-90ad-b792e98472st
        status:
          allOf:
            - $ref: '#/components/schemas/ConferenceStreamStatus'
          description: The status of the stream.
        uri:
          type: string
          description: The URI for the stream.
          example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Conferences/b3877c40-da60-4998-90ad-b792e98472cf/Streams/b3877c40-da60-4998-90ad-b792e98472st.json
      description: Response containing a single conference stream.
    ConferenceStreamStatus:
      type: string
      enum:
        - queued
        - in-progress
        - stopped
      description: Conference stream status.
    ConferenceSubresourceUris:
      type: object
      required:
        - participants
        - recordings
      properties:
        participants:
          type: string
          description: Links to the participants.
          example: /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.
          example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Conferences/b3877c40-da60-4998-90ad-b792e98472cf/Recordings.json
      description: Conference subresource URIs.
    CountryResource:
      type: object
      required:
        - country_code
        - country
        - uri
        - beta
        - subresource_uris
      properties:
        country_code:
          type: string
          description: The ISO country code of the number.
          example: US
        country:
          type: string
          description: The country the number is from.
          example: United States
        uri:
          type: string
          description: The URI for the API call.
          example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/AvailablePhoneNumbers/US
        beta:
          type: boolean
          description: New numbers on SignalWire are marked as `beta`.
          example: false
        subresource_uris:
          allOf:
            - $ref: '#/components/schemas/CountrySubresourceUris'
          description: URIs for subresources.
      description: Country resource for available phone numbers.
    CountrySubresourceUris:
      type: object
      required:
        - local
        - toll_free
      properties:
        local:
          type: string
          description: The URI for local numbers.
          example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/AvailablePhoneNumbers/US/Local
        toll_free:
          type: string
          description: The URI for toll-free numbers.
          example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/AvailablePhoneNumbers/US/TollFree
      description: Country subresource URIs.
    CreateApplicationRequest:
      type: object
      required:
        - FriendlyName
      properties:
        FriendlyName:
          type: string
          maxLength: 64
          description: A named unique identifier for the resource.
          example: My Friendly Name
        VoiceUrl:
          type: string
          format: uri
          description: The URL to request when a phone number receives a call or fax.
          example: http://example.com
        VoiceMethod:
          type: string
          enum:
            - GET
            - POST
          description: Whether the request to `VoiceUrl` is a `GET` or a `POST`. Default is `POST`.
          example: POST
          default: POST
        VoiceFallbackUrl:
          type: string
          format: uri
          description: The URL SignalWire will request if errors occur when fetching the `VoiceUrl`.
          example: http://example.com
        VoiceFallbackMethod:
          type: string
          enum:
            - GET
            - POST
          description: Whether the request to `VoiceFallbackUrl` is a `GET` or a `POST`. Default is `POST`.
          example: POST
          default: POST
        StatusCallback:
          type: string
          format: uri
          description: The URL to pass status updates to the Application.
          example: http://example.com
        StatusCallbackMethod:
          type: string
          enum:
            - GET
            - POST
          description: Whether the request to the `StatusCallback` URL is a `GET` or a `POST`. Default is `POST`.
          example: POST
          default: POST
        SmsUrl:
          type: string
          format: uri
          description: The URL to request when an SMS is received.
          example: http://example.com
        SmsMethod:
          type: string
          enum:
            - GET
            - POST
          description: Whether the request to `SmsUrl` is a `GET` or a `POST`. Default is `POST`.
          example: POST
          default: POST
        SmsFallbackUrl:
          type: string
          format: uri
          description: The URL SignalWire will request if errors occur when fetching the `SmsUrl`.
          example: http://www.example.com/sms-fallback
        SmsFallbackMethod:
          type: string
          enum:
            - GET
            - POST
          description: Whether the request to `SmsFallbackUrl` is a `GET` or a `POST`. Default is `POST`.
          example: POST
          default: POST
        SmsStatusCallback:
          type: string
          format: uri
          description: The URL to receive status updates for messages sent via this Application.
          example: http://www.example.com/sms-status-callback
        SmsStatusCallbackMethod:
          type: string
          enum:
            - GET
            - POST
          description: Whether the request to `SmsStatusCallback` is a `GET` or a `POST`. Default is `POST`.
          example: POST
          default: POST
      description: Request body for creating an application.
    CreateCallRecordingRequest:
      type: object
      properties:
        RecordingChannels:
          type: string
          enum:
            - mono
            - dual
          description: The number of channels in the recording. Can be `mono` (both legs of call recorded under one channel into one recording file) or `dual` (each leg of call recorded in separate channels into one recording file). Default is `mono`.
          example: mono
          default: mono
        RecordingStatusCallback:
          type: string
          format: uri
          description: The URL to request to when recording is available.
          example: https://your-api-endpoint.com/recording-status
        RecordingStatusCallbackEvent:
          type: string
          description: 'The different recording statuses. To specify multiple events, separate with a space. Valid values: completed, in-progress, absent. Default is `completed`.'
          example: completed
          default: completed
        RecordingStatusCallbackMethod:
          type: string
          enum:
            - GET
            - POST
          description: Whether the request to `RecordingStatusCallback` URL is a `GET` or a `POST`. Default is `POST`.
          example: POST
          default: POST
        RecordingTrack:
          type: string
          enum:
            - inbound
            - outbound
            - both
          description: Specifies whether to record the `inbound` audio to SignalWire from the called party or the `outbound` audio from SignalWire to the called party or `both` the inbound and outbound audio. Default is `both`.
          example: both
          default: both
        Trim:
          type: string
          enum:
            - trim-silence
            - do-not-trim
          description: Whether leading and trailing silence is trimmed from a recording. Default is `do-not-trim`.
          example: do-not-trim
          default: do-not-trim
      description: Request body for creating a call recording.
    CreateCallRequest:
      type: object
      required:
        - To
        - From
      properties:
        To:
          type: string
          description: The address that received the call. Can be a phone number in E.164 format, a SIP URI, or a client identifier.
          example: '+13105678901'
        From:
          type: string
          description: The address that initiated the call. Must be a phone number in E.164 format for PSTN calls.
          example: '+13103384645'
        Url:
          type: string
          format: uri
          description: The URL to handle the call. Required if `ApplicationSid` and `Laml`/`Twiml` are not used.
          example: http://your-application.com/docs/voice.xml
        ApplicationSid:
          type: string
          format: uuid
          description: The unique identifier of the application used to handle the call. Required if `Url` and `Laml`/`Twiml` are not used.
          example: b3877c40-da60-4998-90ad-b792e98472ap
        Laml:
          type: string
          minLength: 11
          maxLength: 4000
          description: Inline cXML/LAML document to execute. Required if `Url` and `ApplicationSid` are not used.
          example: <Response><Say>Hello World</Say></Response>
        Twiml:
          type: string
          minLength: 11
          maxLength: 4000
          description: Inline TwiML document to execute. Alias for `Laml`. Required if `Url` and `ApplicationSid` are not used.
          example: <Response><Say>Hello World</Say></Response>
        Method:
          type: string
          enum:
            - GET
            - POST
          description: Whether the request to `Url` is a `GET` or a `POST`. Default is `POST`.
          example: POST
          default: POST
        FallbackUrl:
          type: string
          format: uri
          description: The URL SignalWire will request if errors occur when fetching the `Url`.
          example: https://your-api-endpoint.com/path
        FallbackMethod:
          type: string
          enum:
            - GET
            - POST
          description: Whether the request to `FallbackUrl` is a `GET` or a `POST`. Default is `POST`.
          example: POST
          default: POST
        StatusCallback:
          type: string
          format: uri
          description: The URL SignalWire will send webhooks to on every requested `StatusCallbackEvent` event.
          example: https://your-api-endpoint.com/path
        StatusCallbackMethod:
          type: string
          enum:
            - GET
            - POST
          description: Whether the request to `StatusCallback` URL is a `GET` or a `POST`. Default is `POST`.
          example: POST
          default: POST
        StatusCallbackEvent:
          type: array
          items:
            type: string
          description: 'The status events that trigger a SignalWire webhook. Valid values: initiated, ringing, answered, completed, ringing_forwarded, ringing_queued. Defaults to `completed`.'
          example:
            - initiated
            - ringing
            - answered
            - completed
          default:
            - completed
        CallerId:
          type: string
          description: The number, in E.164 format, or identifier of the caller. Used to override the From for caller ID purposes.
          example: '+13102259067'
        SendDigits:
          type: string
          maxLength: 32
          pattern: ^[\d#*wW]{1,32}$
          description: 'The digits to press after a call is connected. Valid characters are 0-9, #, *, w (wait 0.5s), and W (wait 1s).'
          example: 1ww2
        Timeout:
          type: integer
          format: int32
          minimum: 1
          maximum: 600
          description: The time in seconds SignalWire will wait before assuming the call has no answer. Default is `60` seconds.
          example: 60
          default: 60
        MachineDetection:
          type: string
          enum:
            - Enable
            - DetectMessageEnd
            - none
          description: Whether a human or machine picked up the call. Default is `none`.
          example: Enable
          default: none
        MachineDetectionTimeout:
          type: integer
          format: int32
          minimum: 1
          maximum: 120
          description: The time in seconds SignalWire will wait for machine detection before timing out. Default is `30` seconds.
          example: 30
          default: 30
        MachineDetectionSpeechThreshold:
          type: integer
          format: int32
          minimum: 1000
          maximum: 6000
          description: How many milliseconds of voice to decide it is a machine. Default is `2400` milliseconds.
          example: 2400
          default: 2400
        MachineDetectionSpeechEndThreshold:
          type: integer
          format: int32
          minimum: 500
          maximum: 5000
          description: Number of milliseconds to wait for voice to finish. Default is `1200` milliseconds.
          example: 1200
          default: 1200
        MachineDetectionSilenceTimeout:
          type: integer
          format: int32
          minimum: 2000
          maximum: 10000
          description: Number of milliseconds to wait for initial voice before giving up. Default is `5000` milliseconds.
          example: 5000
          default: 5000
        MachineWordsThreshold:
          type: integer
          format: int32
          minimum: 1
          maximum: 100
          description: How many words to count to decide it is a machine. Default is `6`.
          example: 6
          default: 6
        AsyncAmd:
          type: boolean
          description: Whether or not to execute machine detection asynchronously. Default is `false`.
          example: false
          default: false
        AsyncAmdStatusCallbackMethod:
          type: string
          enum:
            - GET
            - POST
          description: Whether the request to `AsyncAmdStatusCallback` is a `GET` or a `POST`. Default is `POST`.
          example: POST
          default: POST
        AsyncAmdStatusCallback:
          type: string
          format: uri
          description: The URL to request when the machine detection is completed.
          example: https://your-api-endpoint.com/path
        AsyncAmdPartialResults:
          type: boolean
          description: Whether or not to report partial (interim) results to the callback url. Default is `false`.
          example: false
          default: false
        Record:
          type: boolean
          description: Whether or not to record a call. Default is `false`.
          example: false
          default: false
        RecordingChannels:
          type: string
          enum:
            - mono
            - dual
          description: The number of channels in the recording. Default is `mono`.
          example: mono
          default: mono
        RecordingTrack:
          type: string
          enum:
            - inbound
            - outbound
            - both
          description: Specifies whether to record the `inbound`, `outbound`, or `both` audio. Default is `both`.
          example: both
          default: both
        RecordingStatusCallback:
          type: string
          format: uri
          description: The URL to request when recording is available.
          example: https://your-api-endpoint.com/path
        RecordingStatusCallbackMethod:
          type: string
          enum:
            - GET
            - POST
          description: Whether the request to `RecordingStatusCallback` URL is a `GET` or a `POST`. Default is `POST`.
          example: POST
          default: POST
        RecordingStatusCallbackEvent:
          type: string
          description: 'The recording status events that trigger a webhook. Space-separated list. Valid values: completed, in-progress, absent. Default is `completed`.'
          example: completed
          default: completed
        Trim:
          type: string
          enum:
            - trim-silence
            - do-not-trim
          description: Whether leading and trailing silence is trimmed from a recording. Default is `trim-silence`.
          example: trim-silence
          default: trim-silence
        SipAuthUsername:
          type: string
          description: The username to authenticate the caller when making an outbound SIP call.
          example: sipuser
        SipAuthPassword:
          type: string
          description: The password to authenticate the caller when making an outbound SIP call.
          example: sippassword
        MaxPricePerMinute:
          type: string
          pattern: ^\d+\.?\d{0,4}$
          description: 'The maximum price in USD acceptable for the call to be created. Format: up to 4 decimal places.'
          example: '0.0075'
      description: Request body for creating a call.
    CreateCallStreamRequest:
      type: object
      required:
        - Url
      properties:
        Name:
          type: string
          description: Unique name for the Stream, per Call. It is used to stop a Stream by name.
          example: my_first_stream
        Track:
          type: string
          enum:
            - inbound_track
            - outbound_track
            - both_tracks
          description: This attribute can be one of inbound_track, outbound_track, both_tracks. Default is `both_tracks`.
          example: both_tracks
          default: both_tracks
        StatusCallbackMethod:
          type: string
          enum:
            - GET
            - POST
          description: Whether the request to `StatusCallback` URL is a `GET` or a `POST`. Default is `POST`.
          example: GET
          default: POST
        StatusCallback:
          type: string
          format: uri
          description: The URL to request to when stream is available.
          example: https://your-api-endpoint.com/stream-status
        Url:
          type: string
          format: uri
          description: Absolute or relative URL. A WebSocket connection to the url will be established and audio will start flowing towards the Websocket server. The only supported protocol is wss. For security reasons ws is NOT supported.
          example: wss://your-application.com/audiostream
        Parameter1.Name:
          type: string
          description: Custom parameter name to pass towards the WebSocket server. You can pass up to 99 custom parameters using `Parameter1.Name` through `Parameter99.Name`.
          example: FirstName
        Parameter1.Value:
          type: string
          description: Custom parameter value to pass towards the WebSocket server. You can pass up to 99 custom parameters using `Parameter1.Value` through `Parameter99.Value`.
          example: Jane
        Parameter2.Name:
          type: string
          description: Custom parameter name to pass towards the WebSocket server.
          example: LastName
        Parameter2.Value:
          type: string
          description: Custom parameter value to pass towards the WebSocket server.
          example: Doe
        AuthorizationBearerToken:
          type: string
          description: Bearer token for authorization with the WebSocket server.
          example: your-bearer-token
      description: Request body for creating a call stream.
    CreateConferenceStreamRequest:
      type: object
      required:
        - Url
      properties:
        Name:
          type: string
          description: Unique name for the Stream, per Conference. It is used to stop a Stream by name.
          example: my_conference_stream
        Track:
          type: string
          enum:
            - inbound_track
            - outbound_track
            - both_tracks
          description: This attribute can be one of inbound_track, outbound_track, both_tracks. Default is `both_tracks`.
          example: both_tracks
          default: both_tracks
        StatusCallbackMethod:
          type: string
          enum:
            - GET
            - POST
          description: Whether the request to `StatusCallback` URL is a `GET` or a `POST`. Default is `POST`.
          example: GET
          default: POST
        StatusCallback:
          type: string
          format: uri
          description: The URL to request to when stream is available.
          example: https://your-api-endpoint.com/stream-status
        Url:
          type: string
          format: uri
          description: Absolute or relative URL. A WebSocket connection to the url will be established and audio will start flowing towards the Websocket server. The only supported protocol is wss. For security reasons ws is NOT supported.
          example: wss://your-application.com/audiostream
        StreamCodec:
          type: string
          enum:
            - PCMU
            - PCMA
            - L16
            - L16@16000h
            - L16@24000h
          description: The audio codec to use for the stream.
          example: PCMU
        StreamRealTime:
          type: boolean
          description: Enable real-time streaming for the conference stream.
          example: true
        Parameter1.Name:
          type: string
          description: Custom parameter name to pass towards the WebSocket server. You can pass up to 99 custom parameters using `Parameter1.Name` through `Parameter99.Name`.
          example: FirstName
        Parameter1.Value:
          type: string
          description: Custom parameter value to pass towards the WebSocket server. You can pass up to 99 custom parameters using `Parameter1.Value` through `Parameter99.Value`.
          example: Jane
        Parameter2.Name:
          type: string
          description: Custom parameter name to pass towards the WebSocket server.
          example: LastName
        Parameter2.Value:
          type: string
          description: Custom parameter value to pass towards the WebSocket server.
          example: Doe
        AuthorizationBearerToken:
          type: string
          description: Bearer token for authorization with the WebSocket server.
          example: your-bearer-token
      description: Request body for creating a conference stream.
    CreateCxmlScriptRequest:
      type: object
      required:
        - Name
      properties:
        Name:
          type: string
          minLength: 1
          description: A friendly name given to the cXML script. Required.
          example: Death Star IVR
        Contents:
          type: string
          description: The cXML contents of the script. Must be valid XML with proper Mustache syntax if templates are used. Defaults to an empty Response element.
          example: <Response><Say>Hello!</Say></Response>
      description: Request body for creating a cXML script.
    CreateIncomingPhoneNumberRequest:
      type: object
      required:
        - PhoneNumber
      properties:
        PhoneNumber:
          type: string
          minLength: 6
          maxLength: 18
          pattern: ^\+\d{5,17}$
          description: The phone number to purchase in E.164 format. Must start with `+` followed by 5-17 digits.
          example: '+13103386745'
        FriendlyName:
          type: string
          description: A friendly name for the phone number. If not provided, the formatted phone number will be used.
          example: My Business Line
        SmsApplicationSid:
          type: string
          format: uuid
          description: The unique identifier for the application associated with SMS handling on this phone number.
          example: b3877c40-da60-4998-90ad-b792e98472sa
        SmsFallbackMethod:
          type: string
          enum:
            - GET
            - POST
          description: Whether the request to `SmsFallbackUrl` is a `GET` or a `POST`. Default is `POST`.
          example: POST
          default: POST
        SmsFallbackUrl:
          type: string
          format: uri
          description: The URL to request if errors occur when fetching SmsUrl.
          example: https://example.com/sms-fallback
        SmsMethod:
          type: string
          enum:
            - GET
            - POST
          description: Whether the request to SmsUrl is a `GET` or a `POST`. Default is `POST`.
          example: POST
          default: POST
        SmsUrl:
          type: string
          format: uri
          description: The URL to request when an incoming SMS is received.
          example: https://example.com/sms
        StatusCallback:
          type: string
          format: uri
          description: The URL to request to pass status updates to.
          example: https://example.com/status
        StatusCallbackMethod:
          type: string
          enum:
            - GET
            - POST
          description: Whether the request to StatusCallback is a `GET` or a `POST`. Default is `POST`.
          example: POST
          default: POST
        VoiceApplicationSid:
          type: string
          format: uuid
          description: The unique identifier for the application associated with call handling on this phone number.
          example: b3877c40-da60-4998-90ad-b792e98472va
        VoiceFallbackMethod:
          type: string
          enum:
            - GET
            - POST
          description: Whether the request to VoiceFallbackUrl is a `GET` or a `POST`. Default is `POST`.
          example: POST
          default: POST
        VoiceFallbackUrl:
          type: string
          format: uri
          description: The URL to request if errors occur when fetching VoiceUrl.
          example: https://example.com/voice-fallback
        VoiceMethod:
          type: string
          enum:
            - GET
            - POST
          description: Whether the request to VoiceUrl is a `GET` or a `POST`. Default is `POST`.
          example: POST
          default: POST
        VoiceReceiveMode:
          type: string
          enum:
            - voice
            - fax
            - none
          description: Whether this number can receive voice calls, faxes, or neither. Default is `voice`.
          example: voice
          default: voice
        VoiceUrl:
          type: string
          format: uri
          description: The URL to request when an incoming call is received.
          example: https://example.com/voice
      description: Request body for creating an incoming phone number.
    CreateMessageRequest:
      type: object
      required:
        - To
      properties:
        To:
          type: string
          description: The phone number in E.164 format that will receive the message.
          example: '+15557654321'
        From:
          type: string
          description: The phone number in E.164 format that will send the message. Either `From` or `MessagingServiceSid` must be provided.
          example: '+15551234567'
        Body:
          type: string
          description: The text of the message. Either `Body` or `MediaUrl` must be provided.
          example: Hello World!
        MediaUrl:
          anyOf:
            - type: string
            - type: array
              items:
                type: string
          format: uri
          description: URL(s) of media you wish to attach and send with the message. Can be specified multiple times for up to 8 media items.
          example: https://example.com/image.jpg
        SendAsMms:
          type: boolean
          description: When set to true, forces the message to be sent as an MMS.
          example: false
        ApplicationSid:
          type: string
          format: uuid
          description: The SID of a SignalWire cXML Application used to configure the message's status callback.
          example: b3877c40-da60-4998-90ad-b792e98472ap
        MaxPrice:
          type: string
          pattern: ^\d+\.?\d{0,4}$
          description: 'The maximum price in USD acceptable for the message to be sent. Format: decimal with up to 4 decimal places.'
          example: '0.0075'
        StatusCallback:
          type: string
          format: uri
          description: A URL endpoint to receive callbacks each time the status of the message changes.
          example: https://example.com/status-callback
        ValidityPeriod:
          type: integer
          format: int32
          minimum: 1
          maximum: 172800
          description: The number of seconds a message will allow being queued before canceling. Must be between 1 and 172800 (48 hours). Default is 14400 (4 hours).
          example: 14400
          default: 14400
        MessagingServiceSid:
          type: string
          format: uuid
          description: The ID of a number group to use when sending the message. Either `From` or `MessagingServiceSid` must be provided.
          example: b3877c40-da60-4998-90ad-b792e98472ms
      description: Request body for creating a message.
    CreateQueueRequest:
      type: object
      required:
        - FriendlyName
      properties:
        FriendlyName:
          type: string
          minLength: 1
          pattern: ^\w+$
          description: A unique name for the queue. Must contain only alphanumeric characters and underscores.
          example: Queue1
        MaxSize:
          type: integer
          format: int32
          description: The maximum number of calls that are allowed to wait in a queue. Must be a positive integer.
          minimum: 0
          exclusiveMinimum: true
          example: 100
      description: Request body for creating a queue.
    CreateSubprojectRequest:
      type: object
      required:
        - FriendlyName
      properties:
        FriendlyName:
          type: string
          maxLength: 250
          description: The name of the Project, up to 250 characters long.
          example: My Project
      description: Request body for creating a subproject.
    CreateTokenRequest:
      type: object
      required:
        - name
        - permissions
      properties:
        name:
          type: string
          minLength: 1
          description: The name representing the project API token.
          example: John Doe's Token
        permissions:
          type: array
          items:
            type: string
          minItems: 1
          description: 'The permissions you would like to enable for this project API token. Valid permissions are: calling, chat, datasphere, fax, management, messaging, numbers, pubsub, storage, tasking, and video.'
          example:
            - calling
            - fax
            - messaging
        subproject_id:
          type: string
          format: uuid
          description: The unique identifier of the subproject you would like to create a token for. Must belong to the parent project.
          example: 9a7fc048-984f-11ee-b9d1-0242ac120002
      description: Request body for creating an API token.
    CxmlScript:
      type: object
      required:
        - sid
        - date_created
        - date_updated
        - date_last_accessed
        - account_sid
        - name
        - contents
        - request_url
        - num_requests
        - api_version
        - uri
      properties:
        sid:
          type: string
          format: uuid
          description: The unique identifier of the cXML script on SignalWire.
          example: 5184b831-184f-4209-872d-ccdccc80f2f1
        date_created:
          type: string
          description: The date and time, in ISO 8601 format, the script was created.
          example: '2019-11-26T20:00:00Z'
        date_updated:
          type: string
          description: The date and time, in ISO 8601 format, the script was updated.
          example: '2019-11-26T20:00:00Z'
        date_last_accessed:
          type: string
          nullable: true
          description: The date and time, in ISO 8601 format, the script was last accessed, or null if never accessed.
          example: '2020-06-05T20:00:00Z'
        account_sid:
          type: string
          format: uuid
          description: The unique identifier for the account this script is associated with.
          example: b3877c40-da60-4998-90ad-b792e98472af
        name:
          type: string
          description: A friendly name given to the cXML script.
          example: Death Star IVR
        contents:
          type: string
          description: The contents of the cXML script.
          example: <Response><Say>Hello!</Say></Response>
        request_url:
          type: string
          format: uri
          description: The unique URL to the raw contents of the cXML script.
          example: https://example.signalwire.com/laml-bins/5184b831-184f-4209-872d-ccdccc80f2f1
        num_requests:
          type: integer
          format: int32
          description: The number of times this cXML script has been accessed.
          example: 42
        api_version:
          type: string
          description: The version of the SignalWire API.
          example: '2010-04-01'
        uri:
          type: string
          description: The URL of this resource.
          example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/LamlBins/5184b831-184f-4209-872d-ccdccc80f2f1
      description: cXML Script model.
    CxmlScriptListResponse:
      type: object
      required:
        - uri
        - first_page_uri
        - next_page_uri
        - previous_page_uri
        - page
        - page_size
        - laml_bins
      properties:
        uri:
          type: string
          description: The URI of the current page.
          example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/LamlBins?Page=0&PageSize=50
        first_page_uri:
          type: string
          description: The URI of the first page.
          example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/LamlBins?Page=0&PageSize=50
        next_page_uri:
          type: string
          nullable: true
          description: The URI of the next page, or null if there are no more pages.
          example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/LamlBins?Page=1&PageSize=50&PageToken=PAb3877c40da604998
        previous_page_uri:
          type: string
          nullable: true
          description: The URI of the previous page, or null if this is the first page.
          example: null
        page:
          type: integer
          format: int32
          description: The current page number.
          example: 0
        page_size:
          type: integer
          format: int32
          description: The number of items per page.
          example: 50
        laml_bins:
          type: array
          items:
            $ref: '#/components/schemas/CxmlScript'
          description: List of cXML scripts.
      description: Response containing a list of cXML scripts.
    CxmlScriptResponse:
      type: object
      required:
        - sid
        - date_created
        - date_updated
        - date_last_accessed
        - account_sid
        - name
        - contents
        - request_url
        - num_requests
        - api_version
        - uri
      properties:
        sid:
          type: string
          format: uuid
          description: The unique identifier of the cXML script on SignalWire.
          example: 5184b831-184f-4209-872d-ccdccc80f2f1
        date_created:
          type: string
          description: The date and time, in ISO 8601 format, the script was created.
          example: '2019-11-26T20:00:00Z'
        date_updated:
          type: string
          description: The date and time, in ISO 8601 format, the script was updated.
          example: '2019-11-26T20:00:00Z'
        date_last_accessed:
          type: string
          nullable: true
          description: The date and time, in ISO 8601 format, the script was last accessed, or null if never accessed.
          example: '2020-06-05T20:00:00Z'
        account_sid:
          type: string
          format: uuid
          description: The unique identifier for the account this script is associated with.
          example: b3877c40-da60-4998-90ad-b792e98472af
        name:
          type: string
          description: A friendly name given to the cXML script.
          example: Death Star IVR
        contents:
          type: string
          description: The contents of the cXML script.
          example: <Response><Say>Hello!</Say></Response>
        request_url:
          type: string
          format: uri
          description: The unique URL to the raw contents of the cXML script.
          example: https://example.signalwire.com/laml-bins/5184b831-184f-4209-872d-ccdccc80f2f1
        num_requests:
          type: integer
          format: int32
          description: The number of times this cXML script has been accessed.
          example: 42
        api_version:
          type: string
          description: The version of the SignalWire API.
          example: '2010-04-01'
        uri:
          type: string
          description: The URL of this resource.
          example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/LamlBins/5184b831-184f-4209-872d-ccdccc80f2f1
      description: Response containing a single cXML script.
    Fax:
      type: object
      required:
        - account_sid
        - api_version
        - date_created
        - date_updated
        - direction
        - from
        - media_url
        - media_sid
        - num_pages
        - price
        - price_unit
        - quality
        - sid
        - status
        - to
        - duration
        - links
        - url
        - error_code
        - error_message
      properties:
        account_sid:
          type: string
          description: The unique identifier for the account this fax is associated with.
          example: b3877c40-da60-4998-90ad-b792e98472ac
        api_version:
          type: string
          description: The version of the SignalWire API.
          example: v1
        date_created:
          type: string
          description: The date and time, in ISO 8601 format, the fax was created.
          example: '2018-11-26T20:00:00Z'
        date_updated:
          type: string
          description: The date and time, in ISO 8601 format, the fax was updated.
          example: '2018-11-27T20:00:00Z'
        direction:
          allOf:
            - $ref: '#/components/schemas/FaxDirection'
          description: The direction of the fax.
        from:
          type: string
          description: The phone number, in E.164 format, the fax was sent from.
          example: '+13103383454'
        media_url:
          type: string
          nullable: true
          description: The URL hosting the received media, or null if not available.
          example: https://example.com/fax.pdf
        media_sid:
          type: string
          description: The unique identifier for the media instance associated with the fax instance.
          example: b3877c40-da60-4998-90ad-b792e98472me
        num_pages:
          type: string
          nullable: true
          description: The number of pages in the fax document, or null if not yet determined.
          example: '3'
        price:
          type: string
          nullable: true
          description: The cost of the fax, or null if not yet calculated.
          example: '-0.005'
        price_unit:
          type: string
          description: The currency, in ISO 4217 format, of the price.
          example: USD
        quality:
          allOf:
            - $ref: '#/components/schemas/FaxQuality'
          description: The quality of the fax.
        sid:
          type: string
          description: The unique identifier of the fax.
          example: b3877c40-da60-4998-90ad-b792e98472fx
        status:
          allOf:
            - $ref: '#/components/schemas/FaxStatus'
          description: The status of the fax.
        to:
          type: string
          description: The phone number, in E.164 format, the fax was sent to.
          example: '+13104456789'
        duration:
          type: integer
          format: int32
          description: The time, in seconds, it took to deliver a fax.
          example: 5000
        links:
          allOf:
            - $ref: '#/components/schemas/FaxLinks'
          description: The URL links for resources associated with the fax.
        url:
          type: string
          description: The URL of this resource.
          example: /fax/v1/Faxes/b3877c40-da60-4998-90ad-b792e98472fx
        error_code:
          type: string
          nullable: true
          description: Error code for this resource, or null if no error.
          example: null
        error_message:
          type: string
          nullable: true
          description: The description of this error, or null if no error.
          example: null
      description: Fax model.
    FaxDirection:
      type: string
      enum:
        - inbound
        - outbound
      description: Fax direction.
    FaxLinks:
      type: object
      required:
        - media
      properties:
        media:
          type: string
          description: Media associated with this fax.
          example: /fax/v1/Faxes/b3877c40-da60-4998-90ad-b792e98472fx/Media
      description: Fax links.
    FaxListResponse:
      type: object
      required:
        - uri
        - first_page_uri
        - next_page_uri
        - previous_page_uri
        - page
        - page_size
        - faxes
      properties:
        uri:
          type: string
          description: The URI of the current page.
          example: /fax/v1/Faxes?Page=0&PageSize=50
        first_page_uri:
          type: string
          description: The URI of the first page.
          example: /fax/v1/Faxes?PageSize=50
        next_page_uri:
          type: string
          nullable: true
          description: The URI of the next page, or null if there are no more pages.
          example: /fax/v1/Faxes?Page=1&PageSize=50&PageToken=PAb3877c40da604998
        previous_page_uri:
          type: string
          nullable: true
          description: The URI of the previous page, or null if this is the first page.
          example: null
        page:
          type: integer
          format: int32
          description: The current page number.
          example: 0
        page_size:
          type: integer
          format: int32
          description: The number of items per page.
          example: 50
        faxes:
          type: array
          items:
            $ref: '#/components/schemas/Fax'
          description: List of faxes.
      description: Response containing a list of faxes.
    FaxMedia:
      type: object
      required:
        - account_sid
        - content_type
        - date_created
        - date_updated
        - fax_sid
        - sid
        - uri
        - url
      properties:
        account_sid:
          type: string
          description: The unique identifier for the account.
          example: b3877c40-da60-4998-90ad-b792e98472ac
        content_type:
          type: string
          description: The content type of the media.
          example: application/pdf
        date_created:
          type: string
          description: The date, in ISO 8601 format, this media was created.
          example: '2018-11-26T20:00:00Z'
        date_updated:
          type: string
          description: The date, in ISO 8601 format, this media was updated.
          example: '2018-11-27T20:00:00Z'
        fax_sid:
          type: string
          description: The unique identifier for the fax.
          example: b3877c40-da60-4998-90ad-b792e98472fx
        sid:
          type: string
          description: The unique identifier for the media.
          example: b3877c40-da60-4998-90ad-b792e98472me
        uri:
          type: string
          description: The URI for the media.
          example: /fax/v1/Faxes/b3877c40-da60-4998-90ad-b792e98472fx/Media/b3877c40-da60-4998-90ad-b792e98472me.json
        url:
          type: string
          description: The URL for the media.
          example: /fax/v1/Faxes/b3877c40-da60-4998-90ad-b792e98472fx/Media/b3877c40-da60-4998-90ad-b792e98472me.json
      description: Fax media model.
    FaxMediaListResponse:
      type: object
      required:
        - uri
        - first_page_uri
        - next_page_uri
        - previous_page_uri
        - page
        - page_size
        - media
        - fax_media
      properties:
        uri:
          type: string
          description: The URI of the current page.
          example: /fax/v1/Faxes/b3877c40-da60-4998-90ad-b792e98472fx/Media?Page=0&PageSize=50
        first_page_uri:
          type: string
          description: The URI of the first page.
          example: /fax/v1/Faxes/b3877c40-da60-4998-90ad-b792e98472fx/Media?PageSize=50
        next_page_uri:
          type: string
          nullable: true
          description: The URI of the next page, or null if there are no more pages.
          example: null
        previous_page_uri:
          type: string
          nullable: true
          description: The URI of the previous page, or null if this is the first page.
          example: null
        page:
          type: integer
          format: int32
          description: The current page number.
          example: 0
        page_size:
          type: integer
          format: int32
          description: The number of items per page.
          example: 50
        media:
          type: array
          items:
            $ref: '#/components/schemas/FaxMedia'
          description: List of media.
        fax_media:
          type: array
          items:
            $ref: '#/components/schemas/FaxMedia'
          description: List of fax media (alias for media).
      description: Response containing a list of fax media.
    FaxMediaResponse:
      type: object
      required:
        - account_sid
        - content_type
        - date_created
        - date_updated
        - fax_sid
        - sid
        - uri
        - url
      properties:
        account_sid:
          type: string
          description: The unique identifier for the account.
          example: b3877c40-da60-4998-90ad-b792e98472ac
        content_type:
          type: string
          description: The content type of the media.
          example: application/pdf
        date_created:
          type: string
          description: The date, in ISO 8601 format, this media was created.
          example: '2018-11-26T20:00:00Z'
        date_updated:
          type: string
          description: The date, in ISO 8601 format, this media was updated.
          example: '2018-11-27T20:00:00Z'
        fax_sid:
          type: string
          description: The unique identifier for the fax.
          example: b3877c40-da60-4998-90ad-b792e98472fx
        sid:
          type: string
          description: The unique identifier for the media.
          example: b3877c40-da60-4998-90ad-b792e98472me
        uri:
          type: string
          description: The URI for the media.
          example: /fax/v1/Faxes/b3877c40-da60-4998-90ad-b792e98472fx/Media/b3877c40-da60-4998-90ad-b792e98472me.json
        url:
          type: string
          description: The URL for the media.
          example: /fax/v1/Faxes/b3877c40-da60-4998-90ad-b792e98472fx/Media/b3877c40-da60-4998-90ad-b792e98472me.json
      description: Response containing a single fax media.
    FaxQuality:
      type: string
      enum:
        - standard
        - fine
        - superfine
      description: Fax quality.
    FaxResponse:
      type: object
      required:
        - account_sid
        - api_version
        - date_created
        - date_updated
        - direction
        - from
        - media_url
        - media_sid
        - num_pages
        - price
        - price_unit
        - quality
        - sid
        - status
        - to
        - duration
        - links
        - url
        - error_code
        - error_message
      properties:
        account_sid:
          type: string
          description: The unique identifier for the account this fax is associated with.
          example: b3877c40-da60-4998-90ad-b792e98472ac
        api_version:
          type: string
          description: The version of the SignalWire API.
          example: v1
        date_created:
          type: string
          description: The date and time, in ISO 8601 format, the fax was created.
          example: '2018-11-26T20:00:00Z'
        date_updated:
          type: string
          description: The date and time, in ISO 8601 format, the fax was updated.
          example: '2018-11-27T20:00:00Z'
        direction:
          allOf:
            - $ref: '#/components/schemas/FaxDirection'
          description: The direction of the fax.
        from:
          type: string
          description: The phone number, in E.164 format, the fax was sent from.
          example: '+13103383454'
        media_url:
          type: string
          nullable: true
          description: The URL hosting the received media, or null if not available.
          example: https://example.com/fax.pdf
        media_sid:
          type: string
          description: The unique identifier for the media instance associated with the fax instance.
          example: b3877c40-da60-4998-90ad-b792e98472me
        num_pages:
          type: string
          nullable: true
          description: The number of pages in the fax document, or null if not yet determined.
          example: '3'
        price:
          type: string
          nullable: true
          description: The cost of the fax, or null if not yet calculated.
          example: '-0.005'
        price_unit:
          type: string
          description: The currency, in ISO 4217 format, of the price.
          example: USD
        quality:
          allOf:
            - $ref: '#/components/schemas/FaxQuality'
          description: The quality of the fax.
        sid:
          type: string
          description: The unique identifier of the fax.
          example: b3877c40-da60-4998-90ad-b792e98472fx
        status:
          allOf:
            - $ref: '#/components/schemas/FaxStatus'
          description: The status of the fax.
        to:
          type: string
          description: The phone number, in E.164 format, the fax was sent to.
          example: '+13104456789'
        duration:
          type: integer
          format: int32
          description: The time, in seconds, it took to deliver a fax.
          example: 5000
        links:
          allOf:
            - $ref: '#/components/schemas/FaxLinks'
          description: The URL links for resources associated with the fax.
        url:
          type: string
          description: The URL of this resource.
          example: /fax/v1/Faxes/b3877c40-da60-4998-90ad-b792e98472fx
        error_code:
          type: string
          nullable: true
          description: Error code for this resource, or null if no error.
          example: null
        error_message:
          type: string
          nullable: true
          description: The description of this error, or null if no error.
          example: null
      description: Response containing a single fax.
    FaxStatus:
      type: string
      enum:
        - queued
        - processing
        - sending
        - delivered
        - receiving
        - received
        - no-answer
        - busy
        - failed
        - canceled
      description: Fax status.
    ImportPhoneNumberRequest:
      type: object
      required:
        - number
        - number_type
        - capabilities
      properties:
        number:
          type: string
          minLength: 6
          maxLength: 31
          pattern: ^\+\d{5,30}$
          description: The phone number to import. Must start with `+` followed by 5-30 digits.
          example: '+49152234333323'
        number_type:
          allOf:
            - $ref: '#/components/schemas/NumberType'
          description: The type of phone number being imported.
          example: longcode
        capabilities:
          type: array
          items:
            $ref: '#/components/schemas/PhoneNumberCapability'
          minItems: 1
          description: 'The capabilities to enable for this phone number. Must include at least one capability. Can include any combination of: `sms`, `voice`, `fax`, `mms`.'
          example:
            - sms
            - voice
      description: Request body for importing a phone number.
    IncomingPhoneNumber:
      type: object
      required:
        - account_id
        - account_sid
        - address_requirements
        - address_sid
        - api_version
        - beta
        - capabilities
        - country_code
        - date_created
        - date_updated
        - emergency_address_sid
        - emergency_status
        - friendly_name
        - identity_sid
        - origin
        - phone_number
        - sid
        - sms_application_sid
        - sms_fallback_method
        - sms_fallback_url
        - sms_method
        - sms_url
        - status_callback
        - status_callback_method
        - trunk_sid
        - uri
        - voice_application_sid
        - voice_caller_id_lookup
        - voice_fallback_method
        - voice_fallback_url
        - voice_method
        - voice_url
      properties:
        account_id:
          type: string
          format: uuid
          description: The unique identifier for the account that is associated with this phone number.
          example: b3877c40-da60-4998-90ad-b792e98472ac
        account_sid:
          type: string
          format: uuid
          description: The unique identifier for the account that is associated with this phone number.
          example: b3877c40-da60-4998-90ad-b792e98472ac
        address_requirements:
          allOf:
            - $ref: '#/components/schemas/AddressRequirements'
          description: Whether or not a registered address with SignalWire is required. Always 'none'.
        address_sid:
          type: string
          nullable: true
          description: The unique identifier for the address associated with this phone number. Always null.
          example: null
        api_version:
          type: string
          description: The version of the SignalWire API.
          example: '2010-04-01'
        beta:
          type: boolean
          description: New numbers on SignalWire are marked as beta. Always false.
          example: false
        capabilities:
          allOf:
            - $ref: '#/components/schemas/IncomingPhoneNumberCapabilities'
          description: Whether or not a number can receive calls and messages.
        country_code:
          type: string
          description: The ISO 3166-1 alpha-2 country code for this phone number.
          example: US
        date_created:
          type: string
          description: The date, in RFC 2822 format, this phone number was created.
          example: Tue, 25 Sept 2018 23:00:00 +0000
        date_updated:
          type: string
          description: The date, in RFC 2822 format, this phone number was updated.
          example: Wed, 26 Sept 2018 22:00:00 +0000
        emergency_address_sid:
          type: string
          nullable: true
          description: The unique identifier of the address associated with E911 for this phone number, or null if not set.
          example: null
        emergency_status:
          type: string
          description: Whether the phone route has an active E911 address associated. 'Active' or 'Inactive'.
          example: Inactive
        friendly_name:
          type: string
          description: A formatted version of the number.
          example: (310) 338-6745
        identity_sid:
          type: string
          nullable: true
          description: The unique identifier for the identity associated with this phone number. Always null.
          example: null
        origin:
          allOf:
            - $ref: '#/components/schemas/PhoneNumberOrigin'
          description: The origin of the phone number.
        phone_number:
          type: string
          description: The incoming number in E.164 format.
          example: '+13103386745'
        sid:
          type: string
          description: The unique identifier for this phone number.
          example: b3877c40-da60-4998-90ad-b792e98472pn
        sms_application_sid:
          type: string
          nullable: true
          description: The unique identifier for the application associated with SMS handling on this phone number, or null if not set.
          example: null
        sms_fallback_method:
          type: string
          description: Whether the request to `SmsFallbackUrl` is a `GET` or a `POST`.
          example: POST
        sms_fallback_url:
          type: string
          nullable: true
          description: The URL to request if errors occur when fetching SmsUrl, or null if not set.
          example: null
        sms_method:
          type: string
          description: Whether the request to SmsUrl is a `GET` or a `POST`.
          example: POST
        sms_url:
          type: string
          nullable: true
          description: The URL to request when an incoming SMS is received, or null if not set.
          example: null
        status_callback:
          type: string
          nullable: true
          description: The URL to request to pass status updates to, or null if not set.
          example: null
        status_callback_method:
          type: string
          description: Whether the request to StatusCallback is a `GET` or a `POST`.
          example: POST
        trunk_sid:
          type: string
          nullable: true
          description: The unique identifier for the Trunk associated with this phone number. Always null.
          example: null
        uri:
          type: string
          description: The URI for this number.
          example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472ac/IncomingPhoneNumbers/b3877c40-da60-4998-90ad-b792e98472pn.json
        verification_status:
          type: string
          description: The verification status for toll-free numbers. Only present for toll-free numbers.
          example: Unverified
        voice_application_sid:
          type: string
          nullable: true
          description: The unique identifier for the application associated with call handling on this phone number, or null if not set.
          example: null
        voice_caller_id_lookup:
          type: boolean
          nullable: true
          description: Whether or not to look up a caller's name in the database. Always null.
          example: null
        voice_fallback_method:
          type: string
          description: Whether the request to VoiceFallbackUrl is a `GET` or a `POST`.
          example: POST
        voice_fallback_url:
          type: string
          nullable: true
          description: The URL to request if errors occur when fetching `Url`, or null if not set.
          example: null
        voice_method:
          type: string
          description: Whether the request to Url is a `GET` or a `POST`.
          example: POST
        voice_url:
          type: string
          nullable: true
          description: The URL to request when an incoming call is received, or null if not set.
          example: null
      description: Incoming phone number model.
    IncomingPhoneNumberCapabilities:
      type: object
      required:
        - voice
        - sms
        - mms
        - fax
      properties:
        voice:
          type: boolean
          description: Whether or not voice is enabled.
          example: true
        sms:
          type: boolean
          description: Whether or not SMS is enabled.
          example: true
        mms:
          type: boolean
          description: Whether or not MMS is enabled.
          example: true
        fax:
          type: boolean
          description: Whether or not fax is enabled.
          example: true
      description: Phone number capabilities.
    IncomingPhoneNumberListResponse:
      type: object
      required:
        - uri
        - first_page_uri
        - next_page_uri
        - previous_page_uri
        - page
        - page_size
        - incoming_phone_numbers
      properties:
        uri:
          type: string
          description: The URI of the current page.
          example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/IncomingPhoneNumbers?Page=0&PageSize=50
        first_page_uri:
          type: string
          description: The URI of the first page.
          example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/IncomingPhoneNumbers?Page=0&PageSize=50
        next_page_uri:
          type: string
          nullable: true
          description: The URI of the next page, or null if there are no more pages.
          example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/IncomingPhoneNumbers?Page=1&PageSize=50&PageToken=PAb3877c40da604998
        previous_page_uri:
          type: string
          nullable: true
          description: The URI of the previous page, or null if this is the first page.
          example: null
        page:
          type: integer
          format: int32
          description: The current page number.
          example: 0
        page_size:
          type: integer
          format: int32
          description: The number of items per page.
          example: 50
        incoming_phone_numbers:
          type: array
          items:
            $ref: '#/components/schemas/IncomingPhoneNumber'
          description: List of incoming phone numbers.
      description: Response containing a list of incoming phone numbers.
    IncomingPhoneNumberResponse:
      type: object
      required:
        - account_id
        - account_sid
        - address_requirements
        - address_sid
        - api_version
        - beta
        - capabilities
        - country_code
        - date_created
        - date_updated
        - emergency_address_sid
        - emergency_status
        - friendly_name
        - identity_sid
        - origin
        - phone_number
        - sid
        - sms_application_sid
        - sms_fallback_method
        - sms_fallback_url
        - sms_method
        - sms_url
        - status_callback
        - status_callback_method
        - trunk_sid
        - uri
        - voice_application_sid
        - voice_caller_id_lookup
        - voice_fallback_method
        - voice_fallback_url
        - voice_method
        - voice_url
      properties:
        account_id:
          type: string
          format: uuid
          description: The unique identifier for the account that is associated with this phone number.
          example: b3877c40-da60-4998-90ad-b792e98472ac
        account_sid:
          type: string
          format: uuid
          description: The unique identifier for the account that is associated with this phone number.
          example: b3877c40-da60-4998-90ad-b792e98472ac
        address_requirements:
          allOf:
            - $ref: '#/components/schemas/AddressRequirements'
          description: Whether or not a registered address with SignalWire is required. Always 'none'.
        address_sid:
          type: string
          nullable: true
          description: The unique identifier for the address associated with this phone number. Always null.
          example: null
        api_version:
          type: string
          description: The version of the SignalWire API.
          example: '2010-04-01'
        beta:
          type: boolean
          description: New numbers on SignalWire are marked as beta. Always false.
          example: false
        capabilities:
          allOf:
            - $ref: '#/components/schemas/IncomingPhoneNumberCapabilities'
          description: Whether or not a number can receive calls and messages.
        country_code:
          type: string
          description: The ISO 3166-1 alpha-2 country code for this phone number.
          example: US
        date_created:
          type: string
          description: The date, in RFC 2822 format, this phone number was created.
          example: Tue, 25 Sept 2018 23:00:00 +0000
        date_updated:
          type: string
          description: The date, in RFC 2822 format, this phone number was updated.
          example: Wed, 26 Sept 2018 22:00:00 +0000
        emergency_address_sid:
          type: string
          nullable: true
          description: The unique identifier of the address associated with E911 for this phone number, or null if not set.
          example: null
        emergency_status:
          type: string
          description: Whether the phone route has an active E911 address associated. 'Active' or 'Inactive'.
          example: Inactive
        friendly_name:
          type: string
          description: A formatted version of the number.
          example: (310) 338-6745
        identity_sid:
          type: string
          nullable: true
          description: The unique identifier for the identity associated with this phone number. Always null.
          example: null
        origin:
          allOf:
            - $ref: '#/components/schemas/PhoneNumberOrigin'
          description: The origin of the phone number.
        phone_number:
          type: string
          description: The incoming number in E.164 format.
          example: '+13103386745'
        sid:
          type: string
          description: The unique identifier for this phone number.
          example: b3877c40-da60-4998-90ad-b792e98472pn
        sms_application_sid:
          type: string
          nullable: true
          description: The unique identifier for the application associated with SMS handling on this phone number, or null if not set.
          example: null
        sms_fallback_method:
          type: string
          description: Whether the request to `SmsFallbackUrl` is a `GET` or a `POST`.
          example: POST
        sms_fallback_url:
          type: string
          nullable: true
          description: The URL to request if errors occur when fetching SmsUrl, or null if not set.
          example: null
        sms_method:
          type: string
          description: Whether the request to SmsUrl is a `GET` or a `POST`.
          example: POST
        sms_url:
          type: string
          nullable: true
          description: The URL to request when an incoming SMS is received, or null if not set.
          example: null
        status_callback:
          type: string
          nullable: true
          description: The URL to request to pass status updates to, or null if not set.
          example: null
        status_callback_method:
          type: string
          description: Whether the request to StatusCallback is a `GET` or a `POST`.
          example: POST
        trunk_sid:
          type: string
          nullable: true
          description: The unique identifier for the Trunk associated with this phone number. Always null.
          example: null
        uri:
          type: string
          description: The URI for this number.
          example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472ac/IncomingPhoneNumbers/b3877c40-da60-4998-90ad-b792e98472pn.json
        verification_status:
          type: string
          description: The verification status for toll-free numbers. Only present for toll-free numbers.
          example: Unverified
        voice_application_sid:
          type: string
          nullable: true
          description: The unique identifier for the application associated with call handling on this phone number, or null if not set.
          example: null
        voice_caller_id_lookup:
          type: boolean
          nullable: true
          description: Whether or not to look up a caller's name in the database. Always null.
          example: null
        voice_fallback_method:
          type: string
          description: Whether the request to VoiceFallbackUrl is a `GET` or a `POST`.
          example: POST
        voice_fallback_url:
          type: string
          nullable: true
          description: The URL to request if errors occur when fetching `Url`, or null if not set.
          example: null
        voice_method:
          type: string
          description: Whether the request to Url is a `GET` or a `POST`.
          example: POST
        voice_url:
          type: string
          nullable: true
          description: The URL to request when an incoming call is received, or null if not set.
          example: null
      description: Response containing a single incoming phone number.
    Message:
      type: object
      required:
        - account_sid
        - api_version
        - body
        - num_segments
        - num_media
        - date_created
        - date_sent
        - date_updated
        - direction
        - error_code
        - error_message
        - from
        - price
        - price_unit
        - sid
        - status
        - to
        - messaging_service_sid
        - uri
        - subresource_uris
      properties:
        account_sid:
          type: string
          format: uuid
          description: The unique identifier of the project that sent or received this message.
          example: ea108133-d6b3-407c-9536-9fad8a929a6a
        api_version:
          type: string
          description: The version number of the SignalWire cXML REST API used to handle this message.
          example: '2010-04-01'
        body:
          type: string
          nullable: true
          description: The text of the message. Up to 1600 characters long. May be null if filtered for spam.
          example: Hello World!
        num_segments:
          type: integer
          format: int32
          description: The number of segments that make up the entire message.
          example: 1
        num_media:
          type: integer
          format: int32
          description: The number of media files that were included with the message.
          example: 1
        date_created:
          type: string
          description: The date and time the message was created in RFC 2822 format.
          example: Mon, 13 Aug 2018 21:38:46 +0000
        date_sent:
          type: string
          nullable: true
          description: The date and time the message was sent in RFC 2822 format, or null if not yet sent.
          example: Mon, 13 Aug 2018 21:38:46 +0000
        date_updated:
          type: string
          description: The date and time the message was last updated in RFC 2822 format.
          example: Mon, 13 Aug 2018 21:38:46 +0000
        direction:
          allOf:
            - $ref: '#/components/schemas/MessageDirection'
          description: The direction of the message.
        error_code:
          type: string
          nullable: true
          description: If an error has occurred on the message, the error code will give you a specific code, or null if no error.
          example: '30001'
        error_message:
          type: string
          nullable: true
          description: A human readable description of the error that occurred, or null if no error.
          example: Queue overflow
        from:
          type: string
          description: The phone number in E.164 format that sent the message.
          example: '+15551234567'
        price:
          type: number
          format: float
          nullable: true
          description: The cost of the individual message billed to your project, or null if not yet calculated.
          example: 0.005
        price_unit:
          type: string
          description: The currency in which `price` is charged as.
          example: USD
        sid:
          type: string
          format: uuid
          description: A unique ID that identifies this specific message.
          example: 0a059168-ead0-41af-9d1f-343dae832527
        status:
          allOf:
            - $ref: '#/components/schemas/MessageStatus'
          description: Current status of the message.
        to:
          type: string
          description: The phone number in E.164 format that received the message.
          example: '+15557654321'
        messaging_service_sid:
          type: string
          nullable: true
          format: uuid
          description: If a number group was used when sending an outbound message, the number group's ID will be present, or null otherwise.
          example: b3877c40-da60-4998-90ad-b792e98472ms
        uri:
          type: string
          description: The URI of this particular message.
          example: /api/laml/2010-04-01/Accounts/ea108133-d6b3-407c-9536-9fad8a929a6a/Messages/0a059168-ead0-41af-9d1f-343dae832527.json
        subresource_uris:
          allOf:
            - $ref: '#/components/schemas/MessageSubresourceUris'
          description: The URIs for any subresources associated with this message.
      description: Message model.
    MessageDirection:
      type: string
      enum:
        - inbound
        - outbound-api
        - outbound-call
        - outbound-reply
      description: Message direction.
    MessageListResponse:
      type: object
      required:
        - uri
        - first_page_uri
        - next_page_uri
        - previous_page_uri
        - page
        - page_size
        - messages
      properties:
        uri:
          type: string
          description: The URI of the current page.
          example: /api/laml/2010-04-01/Accounts/ea108133-d6b3-407c-9536-9fad8a929a6a/Messages?Page=0&PageSize=50
        first_page_uri:
          type: string
          description: The URI of the first page.
          example: /api/laml/2010-04-01/Accounts/ea108133-d6b3-407c-9536-9fad8a929a6a/Messages?Page=0&PageSize=50
        next_page_uri:
          type: string
          nullable: true
          description: The URI of the next page, or null if there are no more pages.
          example: /api/laml/2010-04-01/Accounts/ea108133-d6b3-407c-9536-9fad8a929a6a/Messages?Page=1&PageSize=50&PageToken=PA0a059168ead041af
        previous_page_uri:
          type: string
          nullable: true
          description: The URI of the previous page, or null if this is the first page.
          example: null
        page:
          type: integer
          format: int32
          description: The current page number.
          example: 0
        page_size:
          type: integer
          format: int32
          description: The number of items per page.
          example: 50
        messages:
          type: array
          items:
            $ref: '#/components/schemas/Message'
          description: List of messages.
      description: Response containing a list of messages.
    MessageMedia:
      type: object
      required:
        - account_sid
        - content_type
        - date_created
        - date_updated
        - parent_sid
        - sid
        - uri
      properties:
        account_sid:
          type: string
          format: uuid
          description: The unique identifier for the account.
          example: ea108133-d6b3-407c-9536-9fad8a929a6a
        content_type:
          type: string
          description: The content type of the media.
          example: image/jpeg
        date_created:
          type: string
          description: The date, in RFC 2822 GMT format, this media was created.
          example: Mon, 13 Aug 2018 21:38:46 +0000
        date_updated:
          type: string
          description: The date, in RFC 2822 GMT format, this media was updated.
          example: Mon, 13 Aug 2018 21:38:46 +0000
        parent_sid:
          type: string
          format: uuid
          description: The unique identifier for the message.
          example: 0a059168-ead0-41af-9d1f-343dae832527
        sid:
          type: string
          format: uuid
          description: The unique identifier for the media.
          example: b3877c40-da60-4998-90ad-b792e98472me
        uri:
          type: string
          description: The URI for the media.
          example: /api/laml/2010-04-01/Accounts/ea108133-d6b3-407c-9536-9fad8a929a6a/Messages/0a059168-ead0-41af-9d1f-343dae832527/Media/b3877c40-da60-4998-90ad-b792e98472me.json
      description: Message media model.
    MessageMediaListResponse:
      type: object
      required:
        - uri
        - first_page_uri
        - next_page_uri
        - previous_page_uri
        - page
        - page_size
        - media_list
      properties:
        uri:
          type: string
          description: The URI of the current page.
          example: /api/laml/2010-04-01/Accounts/ea108133-d6b3-407c-9536-9fad8a929a6a/Messages/0a059168-ead0-41af-9d1f-343dae832527/Media?Page=0&PageSize=50
        first_page_uri:
          type: string
          description: The URI of the first page.
          example: /api/laml/2010-04-01/Accounts/ea108133-d6b3-407c-9536-9fad8a929a6a/Messages/0a059168-ead0-41af-9d1f-343dae832527/Media?Page=0&PageSize=50
        next_page_uri:
          type: string
          nullable: true
          description: The URI of the next page, or null if there are no more pages.
          example: null
        previous_page_uri:
          type: string
          nullable: true
          description: The URI of the previous page, or null if this is the first page.
          example: null
        page:
          type: integer
          format: int32
          description: The current page number.
          example: 0
        page_size:
          type: integer
          format: int32
          description: The number of items per page.
          example: 50
        media_list:
          type: array
          items:
            $ref: '#/components/schemas/MessageMedia'
          description: List of media.
      description: Response containing a list of message media.
    MessageMediaResponse:
      type: object
      required:
        - account_sid
        - content_type
        - date_created
        - date_updated
        - parent_sid
        - sid
        - uri
      properties:
        account_sid:
          type: string
          format: uuid
          description: The unique identifier for the account.
          example: ea108133-d6b3-407c-9536-9fad8a929a6a
        content_type:
          type: string
          description: The content type of the media.
          example: image/jpeg
        date_created:
          type: string
          description: The date, in RFC 2822 GMT format, this media was created.
          example: Mon, 13 Aug 2018 21:38:46 +0000
        date_updated:
          type: string
          description: The date, in RFC 2822 GMT format, this media was updated.
          example: Mon, 13 Aug 2018 21:38:46 +0000
        parent_sid:
          type: string
          format: uuid
          description: The unique identifier for the message.
          example: 0a059168-ead0-41af-9d1f-343dae832527
        sid:
          type: string
          format: uuid
          description: The unique identifier for the media.
          example: b3877c40-da60-4998-90ad-b792e98472me
        uri:
          type: string
          description: The URI for the media.
          example: /api/laml/2010-04-01/Accounts/ea108133-d6b3-407c-9536-9fad8a929a6a/Messages/0a059168-ead0-41af-9d1f-343dae832527/Media/b3877c40-da60-4998-90ad-b792e98472me.json
      description: Response containing a single message media.
    MessageResponse:
      type: object
      required:
        - account_sid
        - api_version
        - body
        - num_segments
        - num_media
        - date_created
        - date_sent
        - date_updated
        - direction
        - error_code
        - error_message
        - from
        - price
        - price_unit
        - sid
        - status
        - to
        - messaging_service_sid
        - uri
        - subresource_uris
      properties:
        account_sid:
          type: string
          format: uuid
          description: The unique identifier of the project that sent or received this message.
          example: ea108133-d6b3-407c-9536-9fad8a929a6a
        api_version:
          type: string
          description: The version number of the SignalWire cXML REST API used to handle this message.
          example: '2010-04-01'
        body:
          type: string
          nullable: true
          description: The text of the message. Up to 1600 characters long. May be null if filtered for spam.
          example: Hello World!
        num_segments:
          type: integer
          format: int32
          description: The number of segments that make up the entire message.
          example: 1
        num_media:
          type: integer
          format: int32
          description: The number of media files that were included with the message.
          example: 1
        date_created:
          type: string
          description: The date and time the message was created in RFC 2822 format.
          example: Mon, 13 Aug 2018 21:38:46 +0000
        date_sent:
          type: string
          nullable: true
          description: The date and time the message was sent in RFC 2822 format, or null if not yet sent.
          example: Mon, 13 Aug 2018 21:38:46 +0000
        date_updated:
          type: string
          description: The date and time the message was last updated in RFC 2822 format.
          example: Mon, 13 Aug 2018 21:38:46 +0000
        direction:
          allOf:
            - $ref: '#/components/schemas/MessageDirection'
          description: The direction of the message.
        error_code:
          type: string
          nullable: true
          description: If an error has occurred on the message, the error code will give you a specific code, or null if no error.
          example: '30001'
        error_message:
          type: string
          nullable: true
          description: A human readable description of the error that occurred, or null if no error.
          example: Queue overflow
        from:
          type: string
          description: The phone number in E.164 format that sent the message.
          example: '+15551234567'
        price:
          type: number
          format: float
          nullable: true
          description: The cost of the individual message billed to your project, or null if not yet calculated.
          example: 0.005
        price_unit:
          type: string
          description: The currency in which `price` is charged as.
          example: USD
        sid:
          type: string
          format: uuid
          description: A unique ID that identifies this specific message.
          example: 0a059168-ead0-41af-9d1f-343dae832527
        status:
          allOf:
            - $ref: '#/components/schemas/MessageStatus'
          description: Current status of the message.
        to:
          type: string
          description: The phone number in E.164 format that received the message.
          example: '+15557654321'
        messaging_service_sid:
          type: string
          nullable: true
          format: uuid
          description: If a number group was used when sending an outbound message, the number group's ID will be present, or null otherwise.
          example: b3877c40-da60-4998-90ad-b792e98472ms
        uri:
          type: string
          description: The URI of this particular message.
          example: /api/laml/2010-04-01/Accounts/ea108133-d6b3-407c-9536-9fad8a929a6a/Messages/0a059168-ead0-41af-9d1f-343dae832527.json
        subresource_uris:
          allOf:
            - $ref: '#/components/schemas/MessageSubresourceUris'
          description: The URIs for any subresources associated with this message.
      description: Response containing a single message.
    MessageStatus:
      type: string
      enum:
        - queued
        - initiated
        - sent
        - failed
        - delivered
        - undelivered
        - received
      description: Message status.
    MessageSubresourceUris:
      type: object
      required:
        - media
      properties:
        media:
          type: string
          description: The URI for media.
          example: /api/laml/2010-04-01/Accounts/ea108133-d6b3-407c-9536-9fad8a929a6a/Messages/0a059168-ead0-41af-9d1f-343dae832527/Media.json
      description: Message subresource URIs.
    NumberType:
      type: string
      enum:
        - longcode
        - tollfree
      description: The type of phone number being imported.
    ParticipantStatus:
      type: string
      enum:
        - completed
        - in-progress
      description: Conference participant status.
    PhoneNumberCapabilities:
      type: object
      required:
        - voice
        - SMS
        - MMS
      properties:
        voice:
          type: boolean
          description: Whether or not voice is enabled on the number.
          example: true
        SMS:
          type: boolean
          description: Whether or not SMS is enabled on the number.
          example: true
        MMS:
          type: boolean
          description: Whether or not MMS is enabled on the number.
          example: true
      description: Phone number capabilities.
    PhoneNumberCapability:
      type: string
      enum:
        - sms
        - voice
        - fax
        - mms
      description: Phone number capabilities.
    PhoneNumberOrigin:
      type: string
      enum:
        - signalwire
        - hosted
      description: Phone number origin.
    Queue:
      type: object
      required:
        - sid
        - account_sid
        - friendly_name
        - max_size
        - current_size
        - average_wait_time
        - date_created
        - date_updated
        - api_version
        - uri
      properties:
        sid:
          type: string
          format: uuid
          description: The unique identifier for the queue.
          example: b3877c40-da60-4998-90ad-b792e98472qu
        account_sid:
          type: string
          format: uuid
          description: The unique identifier for the account this Queue is associated with.
          example: b3877c40-da60-4998-90ad-b792e98472af
        friendly_name:
          type: string
          description: A description that distinguishes a queue.
          example: Queue1
        max_size:
          type: integer
          format: int32
          nullable: true
          description: The maximum number of calls that are allowed to wait in a queue. Null if no limit is set.
          example: 100
        current_size:
          type: integer
          format: int32
          minimum: 0
          description: The number of calls currently waiting in the queue.
          example: 0
        average_wait_time:
          type: integer
          format: int32
          minimum: 0
          description: The average wait time, in seconds, of callers in a queue.
          example: 0
        date_created:
          type: string
          description: The date and time, in RFC 2822 format, the Queue was created.
          example: Wed, 26 Sep 2018 18:00:00 +0000
        date_updated:
          type: string
          description: The date and time, in RFC 2822 format, the Queue was updated.
          example: Thu, 27 Sep 2018 19:00:00 +0000
        api_version:
          type: string
          description: The version of the SignalWire API.
          example: '2010-04-01'
        uri:
          type: string
          description: The URI of this resource, relative to the API base URL.
          example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Queues/b3877c40-da60-4998-90ad-b792e98472qu.json
      description: Queue model.
    QueueListResponse:
      type: object
      required:
        - uri
        - first_page_uri
        - next_page_uri
        - previous_page_uri
        - page
        - page_size
        - queues
      properties:
        uri:
          type: string
          description: The URI of the current page.
          example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Queues?Page=0&PageSize=50
        first_page_uri:
          type: string
          description: The URI of the first page.
          example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Queues
        next_page_uri:
          type: string
          nullable: true
          description: The URI of the next page. Null if there are no more pages.
          example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Queues?Page=1&PageSize=50&PageToken=PAb3877c40-da60-4998-90ad-b792e98472qu
        previous_page_uri:
          type: string
          nullable: true
          description: The URI of the previous page. Null if this is the first page.
          example: null
        page:
          type: integer
          format: int32
          description: The current page number (zero-indexed).
          example: 0
        page_size:
          type: integer
          format: int32
          description: The number of items per page.
          example: 50
        queues:
          type: array
          items:
            $ref: '#/components/schemas/Queue'
          description: List of queues.
      description: Response containing a list of queues.
    QueueMember:
      type: object
      required:
        - call_sid
        - account_sid
        - queue_sid
        - date_enqueued
        - position
        - wait_time
        - member_type
        - uri
      properties:
        call_sid:
          type: string
          format: uuid
          description: The unique identifier for the call.
          example: b3877c40-da60-4998-90ad-b792e98472ca
        account_sid:
          type: string
          format: uuid
          description: The unique identifier for the account.
          example: b3877c40-da60-4998-90ad-b792e98472af
        queue_sid:
          type: string
          format: uuid
          description: The unique identifier for the queue.
          example: b3877c40-da60-4998-90ad-b792e98472qu
        date_enqueued:
          type: string
          description: The date and time, in RFC 2822 format, when the member was enqueued.
          example: Wed, 26 Sep 2018 18:00:00 +0000
        position:
          type: integer
          format: int32
          minimum: 1
          description: The position of the member in the queue (1-indexed).
          example: 1
        wait_time:
          type: integer
          format: int32
          minimum: 0
          description: The wait time, in seconds, since the member was enqueued.
          example: 30
        member_type:
          type: string
          description: The type of the queue member.
          example: laml_call
        uri:
          type: string
          description: The URI of this resource, relative to the API base URL.
          example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Queues/b3877c40-da60-4998-90ad-b792e98472qu/Members/b3877c40-da60-4998-90ad-b792e98472ca.json
      description: Queue member model representing a call waiting in a queue.
    QueueMemberListResponse:
      type: object
      required:
        - uri
        - first_page_uri
        - next_page_uri
        - previous_page_uri
        - page
        - page_size
        - queue_members
      properties:
        uri:
          type: string
          description: The URI of the current page.
          example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Queues/b3877c40-da60-4998-90ad-b792e98472qu/Members?Page=0&PageSize=50
        first_page_uri:
          type: string
          description: The URI of the first page.
          example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Queues/b3877c40-da60-4998-90ad-b792e98472qu/Members
        next_page_uri:
          type: string
          nullable: true
          description: The URI of the next page. Null if there are no more pages.
          example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Queues/b3877c40-da60-4998-90ad-b792e98472qu/Members?Page=1&PageSize=50&PageToken=PAb3877c40-da60-4998-90ad-b792e98472me
        previous_page_uri:
          type: string
          nullable: true
          description: The URI of the previous page. Null if this is the first page.
          example: null
        page:
          type: integer
          format: int32
          description: The current page number (zero-indexed).
          example: 0
        page_size:
          type: integer
          format: int32
          description: The number of items per page.
          example: 50
        queue_members:
          type: array
          items:
            $ref: '#/components/schemas/QueueMember'
          description: List of queue members.
      description: Response containing a list of queue members.
    QueueMemberResponse:
      type: object
      required:
        - call_sid
        - account_sid
        - queue_sid
        - date_enqueued
        - position
        - wait_time
        - member_type
        - uri
      properties:
        call_sid:
          type: string
          format: uuid
          description: The unique identifier for the call.
          example: b3877c40-da60-4998-90ad-b792e98472ca
        account_sid:
          type: string
          format: uuid
          description: The unique identifier for the account.
          example: b3877c40-da60-4998-90ad-b792e98472af
        queue_sid:
          type: string
          format: uuid
          description: The unique identifier for the queue.
          example: b3877c40-da60-4998-90ad-b792e98472qu
        date_enqueued:
          type: string
          description: The date and time, in RFC 2822 format, when the member was enqueued.
          example: Wed, 26 Sep 2018 18:00:00 +0000
        position:
          type: integer
          format: int32
          minimum: 1
          description: The position of the member in the queue (1-indexed).
          example: 1
        wait_time:
          type: integer
          format: int32
          minimum: 0
          description: The wait time, in seconds, since the member was enqueued.
          example: 30
        member_type:
          type: string
          description: The type of the queue member.
          example: laml_call
        uri:
          type: string
          description: The URI of this resource, relative to the API base URL.
          example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Queues/b3877c40-da60-4998-90ad-b792e98472qu/Members/b3877c40-da60-4998-90ad-b792e98472ca.json
      description: Response containing a single queue member.
    QueueResponse:
      type: object
      required:
        - sid
        - account_sid
        - friendly_name
        - max_size
        - current_size
        - average_wait_time
        - date_created
        - date_updated
        - api_version
        - uri
      properties:
        sid:
          type: string
          format: uuid
          description: The unique identifier for the queue.
          example: b3877c40-da60-4998-90ad-b792e98472qu
        account_sid:
          type: string
          format: uuid
          description: The unique identifier for the account this Queue is associated with.
          example: b3877c40-da60-4998-90ad-b792e98472af
        friendly_name:
          type: string
          description: A description that distinguishes a queue.
          example: Queue1
        max_size:
          type: integer
          format: int32
          nullable: true
          description: The maximum number of calls that are allowed to wait in a queue. Null if no limit is set.
          example: 100
        current_size:
          type: integer
          format: int32
          minimum: 0
          description: The number of calls currently waiting in the queue.
          example: 0
        average_wait_time:
          type: integer
          format: int32
          minimum: 0
          description: The average wait time, in seconds, of callers in a queue.
          example: 0
        date_created:
          type: string
          description: The date and time, in RFC 2822 format, the Queue was created.
          example: Wed, 26 Sep 2018 18:00:00 +0000
        date_updated:
          type: string
          description: The date and time, in RFC 2822 format, the Queue was updated.
          example: Thu, 27 Sep 2018 19:00:00 +0000
        api_version:
          type: string
          description: The version of the SignalWire API.
          example: '2010-04-01'
        uri:
          type: string
          description: The URI of this resource, relative to the API base URL.
          example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Queues/b3877c40-da60-4998-90ad-b792e98472qu.json
      description: Response containing a single queue.
    Recording:
      type: object
      required:
        - sid
        - account_sid
        - api_version
        - call_sid
        - conference_sid
        - channel
        - channels
        - date_created
        - date_updated
        - start_time
        - end_time
        - duration
        - price
        - price_unit
        - source
        - status
        - error_code
        - uri
        - subresource_uris
        - encryption_details
        - trim
      properties:
        sid:
          type: string
          format: uuid
          description: The unique identifier for the recording.
          example: 19e436af-5688-4307-b03b-bdb2b42b8142
        account_sid:
          type: string
          format: uuid
          description: The unique identifier for the account that is associated with this recording.
          example: 720796a0-8ee9-4350-83bd-2d07a3121f1e
        api_version:
          type: string
          description: The version of the SignalWire API.
          example: '2010-04-01'
        call_sid:
          type: string
          nullable: true
          format: uuid
          description: The unique identifier for the call that is associated with this recording. Null if this is a conference recording.
          example: 43bb71ee-553f-4074-bb20-8e2747647cce
        conference_sid:
          type: string
          nullable: true
          format: uuid
          description: The unique identifier for the conference that is associated with this recording. Null if this is a call recording.
          example: null
        channel:
          type: string
          enum:
            - '1'
            - '2'
          description: The number of channels in a recording (singular key). Returns '1' for mono or '2' for stereo.
          example: '1'
        channels:
          type: string
          enum:
            - '1'
            - '2'
          description: The number of channels in a recording. Returns '1' for mono or '2' for stereo.
          example: '1'
        date_created:
          type: string
          description: The date, in RFC 2822 format, this recording was created.
          example: Tue, 25 Sep 2018 23:00:00 +0000
        date_updated:
          type: string
          description: The date, in RFC 2822 format, this recording was updated.
          example: Wed, 26 Sep 2018 23:00:04 +0000
        start_time:
          type: string
          nullable: true
          description: The time, in RFC 2822 format, this recording started.
          example: Tue, 25 Sep 2018 23:00:00 +0000
        end_time:
          type: string
          nullable: true
          description: The time, in RFC 2822 format, this recording ended.
          example: Wed, 26 Sep 2018 23:00:04 +0000
        duration:
          type: integer
          format: int32
          minimum: 0
          description: The length, in seconds, of the recording.
          example: 4
        price:
          type: string
          nullable: true
          description: The cost for the recording.
          example: '-0.0025'
        price_unit:
          type: string
          description: The currency of the price of the recording.
          example: USD
        source:
          allOf:
            - $ref: '#/components/schemas/RecordingSource'
          description: How the recording was made.
        status:
          allOf:
            - $ref: '#/components/schemas/RecordingStatus'
          description: The status of the recording.
        error_code:
          type: string
          nullable: true
          description: Further details about a failed recording.
          example: null
        uri:
          type: string
          description: The URI of the recording.
          example: /api/laml/2010-04-01/Accounts/720796a0-8ee9-4350-83bd-2d07a3121f1e/Recordings/19e436af-5688-4307-b03b-bdb2b42b8142.json
        subresource_uris:
          allOf:
            - $ref: '#/components/schemas/RecordingSubresourceUris'
          description: Subresource URIs.
        encryption_details:
          type: string
          nullable: true
          description: Encryption details. Always null.
          example: null
        trim:
          type: string
          description: Whether leading and trailing silence is trimmed from a recording.
          example: do-not-trim
      description: Recording model.
    RecordingListResponse:
      type: object
      required:
        - uri
        - first_page_uri
        - next_page_uri
        - previous_page_uri
        - page
        - page_size
        - recordings
      properties:
        uri:
          type: string
          description: The URI of the current page.
          example: /api/laml/2010-04-01/Accounts/720796a0-8ee9-4350-83bd-2d07a3121f1e/Recordings?Page=0&PageSize=50
        first_page_uri:
          type: string
          description: The URI of the first page.
          example: /api/laml/2010-04-01/Accounts/720796a0-8ee9-4350-83bd-2d07a3121f1e/Recordings
        next_page_uri:
          type: string
          nullable: true
          description: The URI of the next page. Null if there are no more pages.
          example: /api/laml/2010-04-01/Accounts/720796a0-8ee9-4350-83bd-2d07a3121f1e/Recordings?Page=1&PageSize=50&PageToken=PA19e436af-5688-4307-b03b-bdb2b42b8142
        previous_page_uri:
          type: string
          nullable: true
          description: The URI of the previous page. Null if this is the first page.
          example: null
        page:
          type: integer
          format: int32
          description: The current page number (zero-indexed).
          example: 0
        page_size:
          type: integer
          format: int32
          description: The number of items per page.
          example: 50
        recordings:
          type: array
          items:
            $ref: '#/components/schemas/Recording'
          description: List of recordings.
      description: Response containing a list of recordings.
    RecordingResponse:
      type: object
      required:
        - sid
        - account_sid
        - api_version
        - call_sid
        - conference_sid
        - channel
        - channels
        - date_created
        - date_updated
        - start_time
        - end_time
        - duration
        - price
        - price_unit
        - source
        - status
        - error_code
        - uri
        - subresource_uris
        - encryption_details
        - trim
      properties:
        sid:
          type: string
          format: uuid
          description: The unique identifier for the recording.
          example: 19e436af-5688-4307-b03b-bdb2b42b8142
        account_sid:
          type: string
          format: uuid
          description: The unique identifier for the account that is associated with this recording.
          example: 720796a0-8ee9-4350-83bd-2d07a3121f1e
        api_version:
          type: string
          description: The version of the SignalWire API.
          example: '2010-04-01'
        call_sid:
          type: string
          nullable: true
          format: uuid
          description: The unique identifier for the call that is associated with this recording. Null if this is a conference recording.
          example: 43bb71ee-553f-4074-bb20-8e2747647cce
        conference_sid:
          type: string
          nullable: true
          format: uuid
          description: The unique identifier for the conference that is associated with this recording. Null if this is a call recording.
          example: null
        channel:
          type: string
          enum:
            - '1'
            - '2'
          description: The number of channels in a recording (singular key). Returns '1' for mono or '2' for stereo.
          example: '1'
        channels:
          type: string
          enum:
            - '1'
            - '2'
          description: The number of channels in a recording. Returns '1' for mono or '2' for stereo.
          example: '1'
        date_created:
          type: string
          description: The date, in RFC 2822 format, this recording was created.
          example: Tue, 25 Sep 2018 23:00:00 +0000
        date_updated:
          type: string
          description: The date, in RFC 2822 format, this recording was updated.
          example: Wed, 26 Sep 2018 23:00:04 +0000
        start_time:
          type: string
          nullable: true
          description: The time, in RFC 2822 format, this recording started.
          example: Tue, 25 Sep 2018 23:00:00 +0000
        end_time:
          type: string
          nullable: true
          description: The time, in RFC 2822 format, this recording ended.
          example: Wed, 26 Sep 2018 23:00:04 +0000
        duration:
          type: integer
          format: int32
          minimum: 0
          description: The length, in seconds, of the recording.
          example: 4
        price:
          type: string
          nullable: true
          description: The cost for the recording.
          example: '-0.0025'
        price_unit:
          type: string
          description: The currency of the price of the recording.
          example: USD
        source:
          allOf:
            - $ref: '#/components/schemas/RecordingSource'
          description: How the recording was made.
        status:
          allOf:
            - $ref: '#/components/schemas/RecordingStatus'
          description: The status of the recording.
        error_code:
          type: string
          nullable: true
          description: Further details about a failed recording.
          example: null
        uri:
          type: string
          description: The URI of the recording.
          example: /api/laml/2010-04-01/Accounts/720796a0-8ee9-4350-83bd-2d07a3121f1e/Recordings/19e436af-5688-4307-b03b-bdb2b42b8142.json
        subresource_uris:
          allOf:
            - $ref: '#/components/schemas/RecordingSubresourceUris'
          description: Subresource URIs.
        encryption_details:
          type: string
          nullable: true
          description: Encryption details. Always null.
          example: null
        trim:
          type: string
          description: Whether leading and trailing silence is trimmed from a recording.
          example: do-not-trim
      description: Response containing a single recording.
    RecordingSource:
      type: string
      enum:
        - DialVerb
        - Conference
        - OutBoundApi
        - Trunking
        - RecordVerb
        - StartCallRecordingApi
        - StartConferenceRecording
      description: Recording source.
    RecordingStatus:
      type: string
      enum:
        - queued
        - in-progress
        - paused
        - resumed
        - completed
        - absent
        - stopped
      description: Recording status.
    RecordingSubresourceUris:
      type: object
      required:
        - transcriptions
      properties:
        transcriptions:
          type: string
          description: The URI for transcriptions.
          example: /api/laml/2010-04-01/Accounts/720796a0-8ee9-4350-83bd-2d07a3121f1e/Recordings/19e436af-5688-4307-b03b-bdb2b42b8142/Transcriptions.json
      description: Recording subresource URIs.
    SendFaxRequest:
      type: object
      required:
        - MediaUrl
        - To
        - From
      properties:
        MediaUrl:
          type: string
          description: The URL hosting the fax media to send.
          example: https://example.com/fax.pdf
        To:
          type: string
          description: The phone number, in E.164 format, or SIP URI the fax will be sent to.
          example: '+13104456789'
        From:
          type: string
          description: The phone number, in E.164 format, or client identifier the fax will be sent from.
          example: '+13103383454'
        Quality:
          type: string
          enum:
            - standard
            - fine
            - superfine
          description: The quality of the fax. Default is 'fine'.
          example: fine
          default: fine
        StatusCallback:
          type: string
          description: The URL to send status callback requests to when the fax status changes.
          example: https://your-api-endpoint.com/fax-status
        StatusCallbackMethod:
          type: string
          enum:
            - GET
            - POST
          description: The HTTP method to use for status callback requests. Default is 'POST'.
          example: POST
          default: POST
        StatusCallbackEvent:
          type: array
          items:
            type: string
          description: "The events that trigger status callback requests. Valid values: 'initiated', 'ringing', 'answered', 'completed', 'ringing_forwarded', 'ringing_queued'. Default is ['completed']."
          example:
            - completed
        StoreMedia:
          type: string
          enum:
            - 'true'
            - 'false'
          description: Whether to store the fax media. Default is 'true'.
          example: 'true'
          default: 'true'
        Ttl:
          type: integer
          format: int32
          minimum: 5
          maximum: 300
          description: Time to live in minutes for the fax. Must be between 5 and 300. Default is 60.
          example: 60
          default: 60
        SipAuthUsername:
          type: string
          description: The username for SIP authentication.
          example: user123
        SipAuthPassword:
          type: string
          description: The password for SIP authentication.
          example: password123
      description: Request body for sending a fax.
    StreamStatus:
      type: string
      enum:
        - queued
        - in-progress
        - stopped
      description: Stream status.
    SubresourceUris:
      type: object
      required:
        - addresses
        - available_phone_numbers
        - applications
        - authorized_connect_apps
        - calls
        - conferences
        - connect_apps
        - incoming_phone_numbers
        - keys
        - notifications
        - outgoing_caller_ids
        - queues
        - recordings
        - sandbox
        - sip
        - short_codes
        - messages
        - transcriptions
        - usage
      properties:
        addresses:
          type: string
          nullable: true
          description: URI for addresses. Currently not supported and always null.
        available_phone_numbers:
          type: string
          description: URI for available phone numbers.
          example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/AvailablePhoneNumbers
        applications:
          type: string
          description: URI for applications.
          example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Applications
        authorized_connect_apps:
          type: string
          nullable: true
          description: URI for authorized connect apps. Currently not supported and always null.
        calls:
          type: string
          description: URI for calls.
          example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Calls
        conferences:
          type: string
          description: URI for conferences.
          example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Conferences
        connect_apps:
          type: string
          nullable: true
          description: URI for connect apps. Currently not supported and always null.
        incoming_phone_numbers:
          type: string
          description: URI for incoming phone numbers.
          example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/IncomingPhoneNumbers
        keys:
          type: string
          nullable: true
          description: URI for keys. Currently not supported and always null.
        notifications:
          type: string
          nullable: true
          description: URI for notifications. Currently not supported and always null.
        outgoing_caller_ids:
          type: string
          nullable: true
          description: URI for outgoing caller IDs. Currently not supported and always null.
        queues:
          type: string
          description: URI for queues.
          example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Queues
        recordings:
          type: string
          description: URI for recordings.
          example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Recordings
        sandbox:
          type: string
          nullable: true
          description: URI for sandbox. Currently not supported and always null.
        sip:
          type: string
          nullable: true
          description: URI for SIP. Currently not supported and always null.
        short_codes:
          type: string
          nullable: true
          description: URI for short codes. Currently not supported and always null.
        messages:
          type: string
          description: URI for messages.
          example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Messages
        transcriptions:
          type: string
          description: URI for transcriptions.
          example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Transcriptions
        usage:
          type: string
          nullable: true
          description: URI for usage. Currently not supported and always null.
      description: A Map of sub-resources that are linked to the given Project.
    TokenResponse:
      type: object
      required:
        - id
        - name
        - permissions
        - token
      properties:
        id:
          type: string
          format: uuid
          description: The unique identifier of the created API Token.
          example: ea14556a-984f-11ee-b9d1-0242ac120002
        name:
          type: string
          minLength: 1
          description: The name of the created API Token.
          example: John Doe's Token
        permissions:
          type: array
          items:
            type: string
          description: The permissions enabled for this token.
          example:
            - calling
            - fax
            - messaging
        token:
          type: string
          description: The API token that can be used along with the project ID for basic authentication.
          example: PT037258e533e87ac63174ee136ed0798dc85d4f4f9e6d7191
      description: Response containing a single token.
    Transcription:
      type: object
      required:
        - sid
        - account_sid
        - api_version
        - recording_sid
        - date_created
        - date_updated
        - duration
        - price
        - price_unit
        - status
        - transcription_text
        - type
        - uri
      properties:
        sid:
          type: string
          format: uuid
          description: The unique identifier for the transcription.
          example: b3877c40-da60-4998-90ad-b792e98472tr
        account_sid:
          type: string
          format: uuid
          description: The unique identifier for the account that created this transcription.
          example: b3877c40-da60-4998-90ad-b792e98472ac
        api_version:
          type: string
          description: The version of the SignalWire API.
          example: '2010-04-01'
        recording_sid:
          type: string
          format: uuid
          description: The unique identifier for the recording that this transcription was created from.
          example: b3877c40-da60-4998-90ad-b792e98472re
        date_created:
          type: string
          description: The date, in RFC 2822 format, this transcription was created.
          example: Thu, 27 Sep 2018 02:00:00 +0000
        date_updated:
          type: string
          description: The date, in RFC 2822 format, this transcription was updated.
          example: Fri, 28 Sep 2018 03:00:00 +0000
        duration:
          type: integer
          format: int32
          minimum: 0
          description: The duration, in seconds, of the transcribed audio.
          example: 60
        price:
          type: string
          nullable: true
          description: The charge for the transcription. Null if cost has not been calculated.
          example: '-0.00025'
        price_unit:
          type: string
          description: The currency, in ISO 4217 format, for the price of the transcription.
          example: USD
        status:
          type: string
          description: The status of the transcription. Always 'completed' for transcriptions returned by the API.
          example: completed
        transcription_text:
          type: string
          nullable: true
          description: The text content of the transcription. Null if transcription text is not available.
          example: Hello, this is a test transcription.
        type:
          type: string
          description: The type of the transcription. Currently always an empty string.
          example: ''
        uri:
          type: string
          description: The URI of this resource, relative to the API base URL.
          example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472ac/Transcriptions/b3877c40-da60-4998-90ad-b792e98472tr.json
      description: Transcription model.
    TranscriptionListResponse:
      type: object
      required:
        - uri
        - first_page_uri
        - next_page_uri
        - previous_page_uri
        - page
        - page_size
        - transcriptions
      properties:
        uri:
          type: string
          description: The URI of the current page.
          example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472ac/Transcriptions?Page=0&PageSize=50
        first_page_uri:
          type: string
          description: The URI of the first page.
          example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472ac/Transcriptions
        next_page_uri:
          type: string
          nullable: true
          description: The URI of the next page. Null if there are no more pages.
          example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472ac/Transcriptions?Page=1&PageSize=50&PageToken=PAb3877c40-da60-4998-90ad-b792e98472tr
        previous_page_uri:
          type: string
          nullable: true
          description: The URI of the previous page. Null if this is the first page.
          example: null
        page:
          type: integer
          format: int32
          description: The current page number (zero-indexed).
          example: 0
        page_size:
          type: integer
          format: int32
          description: The number of items per page.
          example: 50
        transcriptions:
          type: array
          items:
            $ref: '#/components/schemas/Transcription'
          description: List of transcriptions.
      description: Response containing a list of transcriptions.
    TranscriptionResponse:
      type: object
      required:
        - sid
        - account_sid
        - api_version
        - recording_sid
        - date_created
        - date_updated
        - duration
        - price
        - price_unit
        - status
        - transcription_text
        - type
        - uri
      properties:
        sid:
          type: string
          format: uuid
          description: The unique identifier for the transcription.
          example: b3877c40-da60-4998-90ad-b792e98472tr
        account_sid:
          type: string
          format: uuid
          description: The unique identifier for the account that created this transcription.
          example: b3877c40-da60-4998-90ad-b792e98472ac
        api_version:
          type: string
          description: The version of the SignalWire API.
          example: '2010-04-01'
        recording_sid:
          type: string
          format: uuid
          description: The unique identifier for the recording that this transcription was created from.
          example: b3877c40-da60-4998-90ad-b792e98472re
        date_created:
          type: string
          description: The date, in RFC 2822 format, this transcription was created.
          example: Thu, 27 Sep 2018 02:00:00 +0000
        date_updated:
          type: string
          description: The date, in RFC 2822 format, this transcription was updated.
          example: Fri, 28 Sep 2018 03:00:00 +0000
        duration:
          type: integer
          format: int32
          minimum: 0
          description: The duration, in seconds, of the transcribed audio.
          example: 60
        price:
          type: string
          nullable: true
          description: The charge for the transcription. Null if cost has not been calculated.
          example: '-0.00025'
        price_unit:
          type: string
          description: The currency, in ISO 4217 format, for the price of the transcription.
          example: USD
        status:
          type: string
          description: The status of the transcription. Always 'completed' for transcriptions returned by the API.
          example: completed
        transcription_text:
          type: string
          nullable: true
          description: The text content of the transcription. Null if transcription text is not available.
          example: Hello, this is a test transcription.
        type:
          type: string
          description: The type of the transcription. Currently always an empty string.
          example: ''
        uri:
          type: string
          description: The URI of this resource, relative to the API base URL.
          example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472ac/Transcriptions/b3877c40-da60-4998-90ad-b792e98472tr.json
      description: Response containing a single transcription.
    UpdateAccountRequest:
      type: object
      required:
        - FriendlyName
      properties:
        FriendlyName:
          type: string
          maxLength: 250
          description: The new name for the Project.
          example: My Project
      description: Request body for updating an account.
    UpdateApplicationRequest:
      type: object
      required:
        - FriendlyName
      properties:
        FriendlyName:
          type: string
          maxLength: 64
          description: A named unique identifier for the resource.
          example: My Friendly Name
        VoiceUrl:
          type: string
          format: uri
          description: The URL to request when a phone number receives a call or fax.
          example: http://example.com
        VoiceMethod:
          type: string
          enum:
            - GET
            - POST
          description: Whether the request to `VoiceUrl` is a `GET` or a `POST`. Default is `POST`.
          example: POST
          default: POST
        VoiceFallbackUrl:
          type: string
          format: uri
          description: The URL SignalWire will request if errors occur when fetching the `VoiceUrl`.
          example: http://example.com
        VoiceFallbackMethod:
          type: string
          enum:
            - GET
            - POST
          description: Whether the request to `VoiceFallbackUrl` is a `GET` or a `POST`. Default is `POST`.
          example: POST
          default: POST
        StatusCallback:
          type: string
          format: uri
          description: The URL to pass status updates to the Application.
          example: http://example.com
        StatusCallbackMethod:
          type: string
          enum:
            - GET
            - POST
          description: Whether the request to the `StatusCallback` URL is a `GET` or a `POST`. Default is `POST`.
          example: POST
          default: POST
        SmsUrl:
          type: string
          format: uri
          description: The URL to request when an SMS is received.
          example: http://example.com
        SmsMethod:
          type: string
          enum:
            - GET
            - POST
          description: Whether the request to `SmsUrl` is a `GET` or a `POST`. Default is `POST`.
          example: POST
          default: POST
        SmsFallbackUrl:
          type: string
          format: uri
          description: The URL SignalWire will request if errors occur when fetching the `SmsUrl`.
          example: http://www.example.com/sms-fallback
        SmsFallbackMethod:
          type: string
          enum:
            - GET
            - POST
          description: Whether the request to `SmsFallbackUrl` is a `GET` or a `POST`. Default is `POST`.
          example: POST
          default: POST
        SmsStatusCallback:
          type: string
          format: uri
          description: The URL to receive status updates for messages sent via this Application.
          example: http://www.example.com/sms-status-callback
        SmsStatusCallbackMethod:
          type: string
          enum:
            - GET
            - POST
          description: Whether the request to `SmsStatusCallback` is a `GET` or a `POST`. Default is `POST`.
          example: POST
          default: POST
      description: Request body for updating an application.
    UpdateCallRecordingRequest:
      type: object
      required:
        - Status
      properties:
        Status:
          type: string
          enum:
            - paused
            - in-progress
            - stopped
          description: The status of the recording.
          example: paused
        PauseBehavior:
          type: string
          enum:
            - skip
            - silence
          description: What to do while recording is paused. Default is `silence`.
          example: silence
          default: silence
      description: Request body for updating a call recording.
    UpdateCallRequest:
      type: object
      properties:
        Url:
          type: string
          format: uri
          description: The URL to handle the call.
          example: http://your-application.com/docs/voice.xml
        Method:
          type: string
          enum:
            - GET
            - POST
          description: Whether the request to `Url` is a `GET` or a `POST`.
          example: POST
        Status:
          type: string
          enum:
            - canceled
            - completed
          description: The status to update the call to.
          example: completed
        FallbackUrl:
          type: string
          format: uri
          description: The URL SignalWire will request if errors occur.
          example: https://your-api-endpoint.com/fallback
        FallbackMethod:
          type: string
          enum:
            - GET
            - POST
          description: Whether the request to `FallbackUrl` is a `GET` or a `POST`.
          example: POST
        StatusCallback:
          type: string
          format: uri
          description: The URL SignalWire will send webhooks to.
          example: https://your-api-endpoint.com/status
        StatusCallbackMethod:
          type: string
          enum:
            - GET
            - POST
          description: Whether the request to `StatusCallback` is a `GET` or a `POST`.
          example: POST
        Laml:
          type: string
          minLength: 11
          maxLength: 4000
          description: Inline cXML/LAML document to execute for redirecting the call.
          example: <Response><Say>Hello World</Say></Response>
        Twiml:
          type: string
          minLength: 11
          maxLength: 4000
          description: Inline TwiML document to execute for redirecting the call. Alias for `Laml`.
          example: <Response><Say>Hello World</Say></Response>
      description: Request body for updating a call.
    UpdateCallStreamRequest:
      type: object
      required:
        - Status
      properties:
        Status:
          type: string
          enum:
            - stopped
          description: The status of the stream. Only 'stopped' is allowed.
          example: stopped
      description: Request body for updating a call stream.
    UpdateConferenceParticipantRequest:
      type: object
      properties:
        AnnounceUrl:
          type: string
          format: uri
          description: The URL to send conference announcements to.
          example: 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`.
          example: POST
          default: POST
        Coaching:
          type: boolean
          description: Whether the participant is coaching another call. Requires `CallSidToCoach` to be set.
          example: false
        CallSidToCoach:
          type: string
          format: uuid
          description: The unique identifier of the participant who is being coached. Required when `Coaching` is true.
          example: b3877c40-da60-4998-90ad-b792e98472co
        Hold:
          type: boolean
          description: Whether or not a participant is on hold.
          example: false
        HoldMethod:
          type: string
          enum:
            - GET
            - POST
          description: Whether the request to `HoldUrl` is a `GET` or a `POST`. Default is `GET`.
          example: GET
          default: GET
        HoldUrl:
          type: string
          format: uri
          description: The URL to send hold music to that will be played when participant is on hold.
          example: https://your-api-endpoint.com/hold-music
        Muted:
          type: boolean
          description: Whether or not a participant is muted.
          example: false
        WaitUrl:
          type: string
          format: uri
          description: The URL for wait music to be played while a conference is not yet started.
          example: https://your-api-endpoint.com/wait-music
        WaitMethod:
          type: string
          enum:
            - GET
            - POST
          description: Whether the request to `WaitUrl` is a `GET` or a `POST`. Default is `POST`.
          example: POST
          default: POST
      description: Request body for updating a conference participant.
    UpdateConferenceRecordingRequest:
      type: object
      required:
        - Status
      properties:
        Status:
          type: string
          enum:
            - paused
            - in-progress
            - stopped
          description: The status of the recording.
          example: paused
        PauseBehavior:
          type: string
          enum:
            - skip
            - silence
          description: What to do while recording is paused. Default is `silence`.
          example: silence
          default: silence
      description: Request body for updating a conference recording.
    UpdateConferenceRequest:
      type: object
      properties:
        Status:
          type: string
          enum:
            - completed
          description: The status of this conference. Only 'completed' is allowed to end the conference.
          example: completed
        AnnounceUrl:
          type: string
          format: uri
          description: The URL to send conference announcements to.
          example: 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`.
          example: POST
          default: POST
      description: Request body for updating a conference.
    UpdateConferenceStreamRequest:
      type: object
      required:
        - Status
      properties:
        Status:
          type: string
          enum:
            - stopped
          description: The status of the stream. Only 'stopped' is allowed.
          example: stopped
      description: Request body for updating a conference stream.
    UpdateCxmlScriptRequest:
      type: object
      required:
        - Name
      properties:
        Name:
          type: string
          minLength: 1
          description: A friendly name given to the cXML script. Required.
          example: Death Star IVR
        Contents:
          type: string
          description: The cXML contents of the script. Must be valid XML with proper Mustache syntax if templates are used.
          example: <Response><Say>Hello!</Say></Response>
      description: Request body for updating a cXML script.
    UpdateFaxRequest:
      type: object
      required:
        - Status
      properties:
        Status:
          type: string
          enum:
            - canceled
          description: The status to set. Only 'canceled' is allowed. The fax must be in 'queued' status to be canceled.
          example: canceled
      description: Request body for updating (canceling) a fax.
    UpdateIncomingPhoneNumberRequest:
      type: object
      properties:
        AccountSid:
          type: string
          format: uuid
          description: The unique identifier for an account to which the number should be transferred. Must be within the same Space.
          example: b3877c40-da60-4998-90ad-b792e98472ac
        EmergencyAddressSid:
          type: string
          format: uuid
          description: The unique identifier of the address associated with E911 for this phone number. Not supported for toll-free numbers or certain providers.
          example: b3877c40-da60-4998-90ad-b792e98472ad
        FriendlyName:
          type: string
          minLength: 1
          maxLength: 255
          description: A friendly name for the phone number.
          example: My Business Line
        SmsApplicationSid:
          type: string
          format: uuid
          description: The unique identifier for the application associated with SMS handling on this phone number.
          example: b3877c40-da60-4998-90ad-b792e98472sa
        SmsFallbackMethod:
          type: string
          enum:
            - GET
            - POST
          description: Whether the request to `SmsFallbackUrl` is a `GET` or a `POST`. Default is `POST`.
          example: POST
          default: POST
        SmsFallbackUrl:
          type: string
          format: uri
          description: The URL to request if errors occur when fetching SmsUrl.
          example: https://example.com/sms-fallback
        SmsMethod:
          type: string
          enum:
            - GET
            - POST
          description: Whether the request to SmsUrl is a `GET` or a `POST`. Default is `POST`.
          example: POST
          default: POST
        SmsUrl:
          type: string
          format: uri
          description: The URL to request when an incoming SMS is received.
          example: https://example.com/sms
        StatusCallback:
          type: string
          format: uri
          description: The URL to request to pass status updates to.
          example: https://example.com/status
        StatusCallbackMethod:
          type: string
          enum:
            - GET
            - POST
          description: Whether the request to StatusCallback is a `GET` or a `POST`. Default is `POST`.
          example: POST
          default: POST
        VoiceApplicationSid:
          type: string
          format: uuid
          description: The unique identifier for the application associated with call handling on this phone number.
          example: b3877c40-da60-4998-90ad-b792e98472va
        VoiceFallbackMethod:
          type: string
          enum:
            - GET
            - POST
          description: Whether the request to VoiceFallbackUrl is a `GET` or a `POST`. Default is `POST`.
          example: POST
          default: POST
        VoiceFallbackUrl:
          type: string
          format: uri
          description: The URL to request if errors occur when fetching VoiceUrl.
          example: https://example.com/voice-fallback
        VoiceMethod:
          type: string
          enum:
            - GET
            - POST
          description: Whether the request to VoiceUrl is a `GET` or a `POST`. Default is `POST`.
          example: POST
          default: POST
        VoiceReceiveMode:
          type: string
          enum:
            - voice
            - fax
            - none
          description: Whether this number can receive voice calls, faxes, or neither.
          example: voice
        VoiceUrl:
          type: string
          format: uri
          description: The URL to request when an incoming call is received.
          example: https://example.com/voice
      description: Request body for updating an incoming phone number.
    UpdateMessageRequest:
      type: object
      required:
        - Body
      properties:
        Body:
          type: string
          maxLength: 0
          description: The new body of the message. Must be an empty string to redact the message content.
          example: ''
      description: Request body for updating (redacting) a message.
    UpdateQueueMemberRequest:
      type: object
      required:
        - Url
      properties:
        Url:
          type: string
          format: uri
          description: The URL to redirect the dequeued member to. This URL should return cXML instructions for handling the call.
          example: https://your-application.com/dequeue-handler
        Method:
          type: string
          enum:
            - GET
            - POST
          description: The HTTP method to use when requesting the URL. Default is `POST`.
          example: POST
          default: POST
      description: Request body for dequeuing a queue member.
    UpdateQueueRequest:
      type: object
      required:
        - FriendlyName
      properties:
        FriendlyName:
          type: string
          minLength: 1
          pattern: ^\w+$
          description: A unique name for the queue. Must contain only alphanumeric characters and underscores.
          example: Queue1
        MaxSize:
          type: integer
          format: int32
          description: The maximum number of calls that are allowed to wait in a queue. Must be a positive integer.
          minimum: 0
          exclusiveMinimum: true
          example: 100
      description: Request body for updating a queue.
    UpdateTokenRequest:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          description: The name representing the project API token.
          example: John Doe's Token
        permissions:
          type: array
          items:
            type: string
          description: 'The permissions you would like to enable for this project API token. If not provided, existing permissions are kept. Valid permissions are: calling, chat, datasphere, fax, management, messaging, numbers, pubsub, storage, tasking, and video.'
          example:
            - calling
            - fax
            - messaging
      description: Request body for updating an API token.
servers:
  - url: https://{space_url}/api/laml/2010-04-01
    description: SignalWire Compatibility API
    variables:
      space_url:
        default: ''