openapi: 3.0.0
info:
  title: Compatibility API
  version: 1.0.0
tags:
  - name: Accounts
  - name: Applications
  - name: Available Phone Numbers
  - name: Calls
  - name: Call Recordings
  - name: Streams
  - name: Conferences
  - name: Conference Participants
  - name: Conference Streams
  - name: Faxes
  - name: Fax Media
  - name: Incoming Phone Numbers
  - name: Imported Phone Numbers
  - name: cXML Bins
  - name: Messages
  - name: Media
  - name: Recordings
  - name: Recording Transcriptions
  - name: Queues
  - name: Queue Members
  - name: Tokens
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
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountListResponse'
        '401':
          description: 401 Unauthorized response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      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:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountResponse'
        '400':
          description: 400 Bad Request response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: 401 Unauthorized response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      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: 'A named unique identifier for the resource. Allowed characters: `A-Za-z0-9_-`. Maximum of 100 characters.'
          schema:
            type: string
          explode: false
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationListResponse'
        '401':
          description: 401 Unauthorized response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      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:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationResponse'
        '400':
          description: 400 Bad Request response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: 401 Unauthorized response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      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: 401 Unauthorized response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: 404 Not Found response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      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: 401 Unauthorized response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: 404 Not Found response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      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: 401 Unauthorized response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: 404 Not Found response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      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: 401 Unauthorized response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      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/AvailablePhoneNumberResourcesResponse'
        '401':
          description: 401 Unauthorized response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      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`. Possible values are `true` or `false`.
          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: InRegion
          in: query
          required: false
          description: Limits search to same region as number.
          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: 401 Unauthorized response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      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`. Possible values are `true` or `false`.
          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: InRegion
          in: query
          required: false
          description: Limits search to same region as number.
          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: 401 Unauthorized response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      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
          explode: false
        - name: To
          in: query
          required: false
          description: The address that received the call.
          schema:
            type: string
          explode: false
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CallListResponse'
        '401':
          description: 401 Unauthorized response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      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: 400 Bad Request response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: 401 Unauthorized response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      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'
        '400':
          description: 400 Bad Request response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: 401 Unauthorized response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      tags:
        - Call 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: 401 Unauthorized response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: 404 Not Found response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      tags:
        - Call 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: 400 Bad Request response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: 401 Unauthorized response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      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: 401 Unauthorized response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: 404 Not Found response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      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: 401 Unauthorized response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: 404 Not Found response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      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: 401 Unauthorized response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: 404 Not Found response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      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: 401 Unauthorized response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: 404 Not Found response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      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.
          schema:
            type: string
          explode: false
        - name: DateUpdated
          in: query
          required: false
          description: Shows conferences that were updated on the date provided.
          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
          explode: false
        - name: Status
          in: query
          required: false
          description: The status of this conference.
          schema:
            type: string
          explode: false
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConferenceListResponse'
        '401':
          description: 401 Unauthorized response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      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
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConferenceParticipantListResponse'
        '401':
          description: 401 Unauthorized response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      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'
        '401':
          description: 401 Unauthorized response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: 404 Not Found response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      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'
        '401':
          description: 401 Unauthorized response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: 404 Not Found response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      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.
        '401':
          description: 401 Unauthorized response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: 404 Not Found response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      tags:
        - Conference Participants
  /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: 400 Bad Request response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: 401 Unauthorized response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: 422 Unprocessable Entity response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      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'
        '401':
          description: 401 Unauthorized response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: 404 Not Found response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: 422 Unprocessable Entity response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      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'
        '401':
          description: 401 Unauthorized response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: 404 Not Found response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      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'
        '401':
          description: 401 Unauthorized response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: 404 Not Found response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      tags:
        - Conferences
      requestBody:
        required: true
        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: 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'
        '401':
          description: 401 Unauthorized response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      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: 400 Bad Request response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: 401 Unauthorized response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      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'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FaxMediaListResponse'
        '401':
          description: 401 Unauthorized response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      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'
        '401':
          description: 401 Unauthorized response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: 404 Not Found response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      tags:
        - Fax Media
    delete:
      operationId: delete_fax_media
      summary: Delete Fax Media
      description: |-
        Delete 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:
        '204':
          description: 204 No Content response.
        '401':
          description: 401 Unauthorized response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: 404 Not Found response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      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'
        '401':
          description: 401 Unauthorized response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: 404 Not Found response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      tags:
        - Faxes
    post:
      operationId: update_fax
      summary: Update a fax
      description: |-
        Allows you to modify the properties of 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'
        '401':
          description: 401 Unauthorized response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: 404 Not Found response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      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.

        #### 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.
        '401':
          description: 401 Unauthorized response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: 404 Not Found response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      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: 400 Bad Request response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: 401 Unauthorized response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: 422 Unprocessable Entity response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      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: 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'
        '401':
          description: 401 Unauthorized response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      tags:
        - Incoming Phone Numbers
    post:
      operationId: create_incoming_phone_number
      summary: Create an Incoming Phone Number
      description: |-
        Create an Incoming Phone Number.

        #### Permissions
        The API token must include the following scopes: _Numbers_.
      parameters:
        - $ref: '#/components/parameters/IncomingPhoneNumbersAccountSidPath'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IncomingPhoneNumberResponse'
        '400':
          description: 400 Bad Request response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: 401 Unauthorized response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      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'
        '401':
          description: 401 Unauthorized response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: 404 Not Found response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      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'
        '401':
          description: 401 Unauthorized response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: 404 Not Found response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      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: |-
        Delete an incoming phone number.

        #### 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.
        '401':
          description: 401 Unauthorized response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: 404 Not Found response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      tags:
        - Incoming Phone Numbers
  /Accounts/{AccountSid}/LamlBins:
    get:
      operationId: list_cxml_applications
      summary: List All cXML Bins
      description: |-
        Returns a list of your cXML Bins. The bins 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/LamlBinsAccountSidPath'
        - name: Name
          in: query
          required: false
          description: A friendly name given to the cXML bin.
          schema:
            type: string
          explode: false
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LamlBinListResponse'
        '401':
          description: 401 Unauthorized response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      tags:
        - cXML Bins
    post:
      operationId: create_cxml_application
      summary: Create an cXML Bin
      description: |-
        Create an cXML bin.

        #### Permissions
        The API token must include one of the following scopes: _Voice_ or _Messaging_ or _Fax_.
      parameters:
        - $ref: '#/components/parameters/LamlBinsAccountSidPath'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LamlBinResponse'
        '400':
          description: 400 Bad Request response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: 401 Unauthorized response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      tags:
        - cXML Bins
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CreateLamlBinRequest'
  /Accounts/{AccountSid}/LamlBins/{Sid}:
    get:
      operationId: retrieve_cxml_application
      summary: Retrieve a cXML Bin
      description: |-
        Retrieve a cXML bin.

        #### Permissions
        The API token must include one of the following scopes: _Voice_ or _Messaging_ or _Fax_.
      parameters:
        - $ref: '#/components/parameters/LamlBinsAccountSidPath'
        - $ref: '#/components/parameters/LamlBinSidPath'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LamlBinResponse'
        '401':
          description: 401 Unauthorized response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: 404 Not Found response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      tags:
        - cXML Bins
    post:
      operationId: update_cxml_application
      summary: Update a cXML Bin
      description: |-
        Update a cXML bin.

        #### Permissions
        The API token must include one of the following scopes: _Voice_ or _Messaging_ or _Fax_.
      parameters:
        - $ref: '#/components/parameters/LamlBinsAccountSidPath'
        - $ref: '#/components/parameters/LamlBinSidPath'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LamlBinResponse'
        '401':
          description: 401 Unauthorized response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: 404 Not Found response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      tags:
        - cXML Bins
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/UpdateLamlBinRequest'
    delete:
      operationId: delete_cxml_application
      summary: Delete a cXML Bin
      description: |-
        Delete a cXML bin.

        #### Permissions
        The API token must include one of the following scopes: _Voice_ or _Messaging_ or _Fax_.
      parameters:
        - $ref: '#/components/parameters/LamlBinsAccountSidPath'
        - $ref: '#/components/parameters/LamlBinSidPath'
      responses:
        '204':
          description: 204 No Content response.
        '401':
          description: 401 Unauthorized response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: 404 Not Found response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      tags:
        - cXML Bins
  /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. You can also append `<` or `>` to return a range of messages.
          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:
            type: string
            enum:
              - queued
              - sending
              - sent
              - delivered
              - undelivered
              - failed
              - receiving
              - received
          explode: false
        - name: PageSize
          in: query
          required: false
          description: Specify the number of results to return on a single page. The default page size is `50` and the maximum is `1000`.
          schema:
            type: integer
            format: int32
          explode: false
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageListResponse'
        '401':
          description: 401 Unauthorized response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      tags:
        - Messages
    post:
      operationId: create_message
      summary: Create a Message
      description: |-
        Create a message.

        #### Permissions
        The API token must include the following scopes: _Messaging_.
      parameters:
        - $ref: '#/components/parameters/MessagesAccountSidPath'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageResponse'
        '400':
          description: 400 Bad Request response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: 401 Unauthorized response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      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: The date and time the message was sent in RFC 2822 format.
          schema:
            type: string
          explode: false
        - name: PageSize
          in: query
          required: false
          description: Specify the number of results to return on a single page. The default page size is `50` and the maximum is `1000`.
          schema:
            type: integer
            format: int32
          explode: false
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageMediaListResponse'
        '401':
          description: 401 Unauthorized response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      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: 401 Unauthorized response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: 404 Not Found response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      tags:
        - Media
    delete:
      operationId: delete_message_media
      summary: Delete Message Media
      description: |-
        Delete 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:
        '204':
          description: 204 No Content response.
        '401':
          description: 401 Unauthorized response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: 404 Not Found response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      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: 401 Unauthorized response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: 404 Not Found response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      tags:
        - Messages
    post:
      operationId: update_message
      summary: Update a Message
      description: |-
        Update a message body after it has been sent. Useful for removing sensitive information from the body after the message has been received.

        #### 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: 401 Unauthorized response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: 404 Not Found response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      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.

        #### 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: 401 Unauthorized response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: 404 Not Found response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      tags:
        - Messages
  /Accounts/{AccountSid}/Queues:
    get:
      operationId: list_queues
      summary: List All Queues
      description: |-
        The ability to read all of the queues that are associated with your account. This will be returned as a list of queues.

        #### Permissions
        The API token must include the following scopes: _Voice_.
      parameters:
        - $ref: '#/components/parameters/QueuesAccountSidPath'
        - name: FriendlyName
          in: query
          required: false
          description: A description that distinguishes a queue.
          schema:
            type: string
          explode: false
        - name: MaxSize
          in: query
          required: false
          description: The maximum number of calls that are allowed to wait in a queue.
          schema:
            type: string
          explode: false
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueueListResponse'
        '401':
          description: 401 Unauthorized response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      tags:
        - Queues
    post:
      operationId: create_queue
      summary: Create a Queue.
      description: |-
        Create a call queue.

        #### Permissions
        The API token must include the following scopes: _Voice_.
      parameters:
        - $ref: '#/components/parameters/QueuesAccountSidPath'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueueResponse'
        '400':
          description: 400 Bad Request response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: 401 Unauthorized response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      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: |-
        The ability to read all of the queue members that are waiting in a particular queue. This will be returned as a list of members.

        #### Permissions
        The API token must include the following scopes: _Voice_.
      parameters:
        - $ref: '#/components/parameters/QueuesAccountSidPath'
        - $ref: '#/components/parameters/QueueSidPathForMembers'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueueMemberListResponse'
        '401':
          description: 401 Unauthorized response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      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.

        #### 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'
        '401':
          description: 401 Unauthorized response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: 404 Not Found response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      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.

        #### Permissions
        The API token must include the following scopes: _Voice_.
      parameters:
        - $ref: '#/components/parameters/QueuesAccountSidPath'
        - $ref: '#/components/parameters/QueueSidPathForMembers'
        - $ref: '#/components/parameters/QueueMemberCallSidPath'
        - name: Url
          in: query
          required: true
          description: The URL to handle after dequeuing the member. This parameter lets you specify a webhook or different route in your code containing XML instructions.
          schema:
            type: string
          explode: false
        - name: Method
          in: query
          required: false
          description: Whether the request to `Url` is a `GET` or a `POST`. Default is `POST`.
          schema:
            type: string
            enum:
              - GET
              - POST
          explode: false
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueueMemberResponse'
        '401':
          description: 401 Unauthorized response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: 404 Not Found response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      tags:
        - Queue Members
  /Accounts/{AccountSid}/Queues/{Sid}:
    get:
      operationId: retrieve_queue
      summary: Retrieve a Queue.
      description: |-
        Retrieve a single queue.

        #### 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'
        '401':
          description: 401 Unauthorized response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: 404 Not Found response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      tags:
        - Queues
    post:
      operationId: update_queue
      summary: Update a Queue.
      description: |-
        Allows you to modify the properties of a single call queue.

        #### 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'
        '401':
          description: 401 Unauthorized response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: 404 Not Found response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      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 single call queue. Only empty queues can be deleted. 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/QueuesAccountSidPath'
        - $ref: '#/components/parameters/QueueSidPath'
      responses:
        '204':
          description: 204 No Content response.
        '401':
          description: 401 Unauthorized response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: 404 Not Found response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      tags:
        - Queues
  /Accounts/{AccountSid}/Recordings:
    get:
      operationId: list_recordings
      summary: List all Recordings
      description: |-
        List all recordings.

        #### Permissions
        The API token must include the following scopes: _Voice_.
      parameters:
        - $ref: '#/components/parameters/RecordingsAccountSidPath'
        - name: DateCreated
          in: query
          required: false
          description: The date, in RFC 2822 format, on which the recording was created.
          schema:
            type: string
          explode: false
        - name: CallSid
          in: query
          required: false
          description: The unique identifier for the call that is associated with this recording.
          schema:
            type: string
          explode: false
        - name: ConferenceSid
          in: query
          required: false
          description: The unique identifier for the conference that is associated with this recording.
          schema:
            type: string
          explode: false
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecordingListResponse'
        '401':
          description: 401 Unauthorized response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      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'
        '401':
          description: 401 Unauthorized response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: 404 Not Found response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      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.
        '401':
          description: 401 Unauthorized response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: 404 Not Found response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      tags:
        - Recordings
  /Accounts/{AccountSid}/Transcriptions:
    get:
      operationId: list_transcriptions
      summary: List all Transcriptions
      description: |-
        List all transcriptions.

        #### Permissions
        The API token must include the following scopes: _Voice_.
      parameters:
        - $ref: '#/components/parameters/TranscriptionsAccountSidPath'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TranscriptionListResponse'
        '401':
          description: 401 Unauthorized response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      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'
        '401':
          description: 401 Unauthorized response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: 404 Not Found response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      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.
        '401':
          description: 401 Unauthorized response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: 404 Not Found response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      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.
      parameters:
        - $ref: '#/components/parameters/TokensAccountSidPath'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TokenResponse'
        '401':
          description: 401 Unauthorized response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: 422 Unprocessable Entity response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      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.
      parameters:
        - $ref: '#/components/parameters/TokensAccountSidPath'
        - $ref: '#/components/parameters/TokenIdPath'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TokenResponse'
        '401':
          description: 401 Unauthorized response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: 422 Unprocessable Entity response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      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.
      parameters:
        - $ref: '#/components/parameters/TokensAccountSidPath'
        - $ref: '#/components/parameters/TokenIdPath'
      responses:
        '204':
          description: 204 No Content response.
        '401':
          description: 401 Unauthorized response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: 404 Not Found response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      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: 401 Unauthorized response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: 404 Not Found response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      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: 401 Unauthorized response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: 404 Not Found response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      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
    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
    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
    LamlBinSidPath:
      name: Sid
      in: path
      required: true
      description: The unique identifier of the cXML bin.
      schema:
        type: string
        format: uuid
    LamlBinsAccountSidPath:
      name: AccountSid
      in: path
      required: true
      description: The unique identifier for the account this Bin is associated with.
      schema:
        type: string
        format: uuid
    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.
      schema:
        type: string
        format: uuid
    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
      properties:
        auth_token:
          type: string
          description: The authorization token for this Project. This token should be kept a secret and is not returned in a normal request.
          example: Redacted
        date_created:
          type: string
          description: The date, in RFC 2822 GMT format, this Project was created.
          example: Sat, 15 Sept 2018 10:00:00 +0000
        date_updated:
          type: string
          description: The date, in RFC 2822 GMT format, this Project was updated.
          example: Sat, 16 Sept 2018 10:00:00 +0000
        friendly_name:
          type: string
          description: The name of the Project, up to 250 characters long.
          example: My Project
        owner_account_sid:
          type: string
          format: uuid
          description: The Project ID that uniquely identifies the parent of the Project.
          example: b3877c40-da60-4998-90ad-b792e98472af
        sid:
          type: string
          format: uuid
          description: The Project ID that uniquely identifies the Project.
          example: b3877c40-da60-4998-90ad-b792e98472af
        status:
          type: string
          description: 'The status of the Project. Possible values are: active, suspended, or closed.'
          example: active
        subproject:
          type: boolean
          description: Whether or not the project is a sub-project.
          example: false
        subresource_uris:
          allOf:
            - $ref: '#/components/schemas/SubresourceUris'
          description: A Map of sub-resources that are linked to the given Project.
        type:
          type: string
          description: 'The type of the Project. Possible values are: Trial and Full.'
          example: Full
        uri:
          type: string
          format: uri
          description: The URI for the Project.
          example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af.json
      description: Account/Project model representing a SignalWire project.
    AccountListResponse:
      type: object
      properties:
        links:
          allOf:
            - $ref: '#/components/schemas/Pagination'
          description: Pagination links.
        applications:
          type: array
          items:
            $ref: '#/components/schemas/Account'
          description: List of applications/accounts.
      description: Response containing a list of accounts.
    AccountResponse:
      type: object
      properties:
        auth_token:
          type: string
          description: The authorization token for this Project. This token should be kept a secret and is not returned in a normal request.
          example: Redacted
        date_created:
          type: string
          description: The date, in RFC 2822 GMT format, this Project was created.
          example: Sat, 15 Sept 2018 10:00:00 +0000
        date_updated:
          type: string
          description: The date, in RFC 2822 GMT format, this Project was updated.
          example: Sat, 16 Sept 2018 10:00:00 +0000
        friendly_name:
          type: string
          description: The name of the Project, up to 250 characters long.
          example: My Project
        owner_account_sid:
          type: string
          format: uuid
          description: The Project ID that uniquely identifies the parent of the Project.
          example: b3877c40-da60-4998-90ad-b792e98472af
        sid:
          type: string
          format: uuid
          description: The Project ID that uniquely identifies the Project.
          example: b3877c40-da60-4998-90ad-b792e98472af
        status:
          type: string
          description: 'The status of the Project. Possible values are: active, suspended, or closed.'
          example: active
        subproject:
          type: boolean
          description: Whether or not the project is a sub-project.
          example: false
        subresource_uris:
          allOf:
            - $ref: '#/components/schemas/SubresourceUris'
          description: A Map of sub-resources that are linked to the given Project.
        type:
          type: string
          description: 'The type of the Project. Possible values are: Trial and Full.'
          example: Full
        uri:
          type: string
          format: uri
          description: The URI for the Project.
          example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af.json
      description: Response containing a single account.
    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
      properties:
        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
        sid:
          type: string
          format: uuid
          description: The unique identifier for the Application.
          example: b3877c40-da60-4998-90ad-b792e98472af
        friendly_name:
          type: string
          description: 'A named unique identifier for the resource. Allowed characters: `A-Za-z0-9_-`. Maximum of 100 characters.'
          example: My Friendly Name
        message_status_callback:
          type: string
          description: If a message's `ApplicationSid` is set to this Application's `Sid`, when a message receives a status change, SignalWire will send a `POST` request to this URL with the message's details.
          example: http://www.example.com/sms-status-callback
        sms_fallback_method:
          type: string
          description: Whether the request to `SmsFallbackUrl` is a `GET` or a `POST`. Default is `POST`.
          example: GET
        sms_fallback_url:
          type: string
          description: The URL SignalWire will request if errors occur when fetching the `SmsUrl`.
          example: http://www.example.com/sms-fallback
        sms_method:
          type: string
          description: Whether the request to `SmsUrl` is a `GET` or a `POST`. Default is `POST`.
          example: GET
        sms_status_callback:
          type: string
          description: If a message's `ApplicationSid` is set to this Application's `Sid`, when a message receives a status change, SignalWire will send a `POST` request to this URL with the message's details.
          example: http://www.example.com/sms-status-callback
        sms_url:
          type: string
          description: The URL to request when an SMS is received.
          example: http://example.com
        status_callback:
          type: string
          description: The URL to pass status updates to the Application.
          example: http://example.com
        status_callback_method:
          type: string
          description: Whether the request to the `StatusCallback` URL is a `GET` or a `POST`. Default is `POST`.
          example: POST
        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_caller_id_lookup:
          type: boolean
          description: Whether or not to look up a caller's ID from the database. Possible values are `true` or `false`. Default is `false`.
          example: false
        voice_fallback_method:
          type: string
          description: Whether the request to `VoiceFallbackUrl` is a `GET` or a `POST`. Default is `POST`.
          example: GET
        voice_fallback_url:
          type: string
          description: The URL SignalWire will request if errors occur when fetching the `Url`.
          example: http://example.com
        voice_method:
          type: string
          description: Whether the request to `VoiceUrl` is a `GET` or a `POST`. Default is `POST`.
          example: GET
        voice_url:
          type: string
          description: The URL to request when a phone number receives a call or fax.
          example: http://example.com
      description: Application model representing a cXML application.
    ApplicationListResponse:
      type: object
      properties:
        links:
          allOf:
            - $ref: '#/components/schemas/Pagination'
          description: Pagination links.
        applications:
          type: array
          items:
            $ref: '#/components/schemas/Application'
          description: List of applications.
      description: Response containing a list of applications.
    ApplicationResponse:
      type: object
      properties:
        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
        sid:
          type: string
          format: uuid
          description: The unique identifier for the Application.
          example: b3877c40-da60-4998-90ad-b792e98472af
        friendly_name:
          type: string
          description: 'A named unique identifier for the resource. Allowed characters: `A-Za-z0-9_-`. Maximum of 100 characters.'
          example: My Friendly Name
        message_status_callback:
          type: string
          description: If a message's `ApplicationSid` is set to this Application's `Sid`, when a message receives a status change, SignalWire will send a `POST` request to this URL with the message's details.
          example: http://www.example.com/sms-status-callback
        sms_fallback_method:
          type: string
          description: Whether the request to `SmsFallbackUrl` is a `GET` or a `POST`. Default is `POST`.
          example: GET
        sms_fallback_url:
          type: string
          description: The URL SignalWire will request if errors occur when fetching the `SmsUrl`.
          example: http://www.example.com/sms-fallback
        sms_method:
          type: string
          description: Whether the request to `SmsUrl` is a `GET` or a `POST`. Default is `POST`.
          example: GET
        sms_status_callback:
          type: string
          description: If a message's `ApplicationSid` is set to this Application's `Sid`, when a message receives a status change, SignalWire will send a `POST` request to this URL with the message's details.
          example: http://www.example.com/sms-status-callback
        sms_url:
          type: string
          description: The URL to request when an SMS is received.
          example: http://example.com
        status_callback:
          type: string
          description: The URL to pass status updates to the Application.
          example: http://example.com
        status_callback_method:
          type: string
          description: Whether the request to the `StatusCallback` URL is a `GET` or a `POST`. Default is `POST`.
          example: POST
        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_caller_id_lookup:
          type: boolean
          description: Whether or not to look up a caller's ID from the database. Possible values are `true` or `false`. Default is `false`.
          example: false
        voice_fallback_method:
          type: string
          description: Whether the request to `VoiceFallbackUrl` is a `GET` or a `POST`. Default is `POST`.
          example: GET
        voice_fallback_url:
          type: string
          description: The URL SignalWire will request if errors occur when fetching the `Url`.
          example: http://example.com
        voice_method:
          type: string
          description: Whether the request to `VoiceUrl` is a `GET` or a `POST`. Default is `POST`.
          example: GET
        voice_url:
          type: string
          description: The URL to request when a phone number receives a call or fax.
          example: http://example.com
      description: Response containing a single application.
    AvailablePhoneNumber:
      type: object
      properties:
        beta:
          type: boolean
          description: New numbers on SignalWire are marked as `beta`. Possible values are `true` or `false`.
          example: false
        capabilities:
          allOf:
            - $ref: '#/components/schemas/PhoneNumberCapabilities'
          description: Whether or not a number can receive calls and messages.
        friendly_name:
          type: string
          description: A formatted version of the number.
          example: 253-218-6751
        iso_country:
          type: string
          description: The ISO country code of the number.
          example: US
        lata:
          type: string
          description: The LATA of the number. Only available for numbers in US and Canada.
          example: '888'
        latitude:
          type: string
          description: The latitude of the number. Only available for numbers in US and Canada.
          example: '47.3'
        longitude:
          type: string
          description: The longitude of the number. Only available for numbers in US and Canada.
          example: '-122.2'
        phone_number:
          type: string
          description: The number in E.164 format.
          example: '+12532186751'
        postal_code:
          type: string
          description: The postal/zip code of the number. Only available for numbers in US and Canada.
          example: '98002'
        rate_center:
          type: string
          description: The rate center of the number. Only available for numbers in US and Canada.
          example: AUBURN
        region:
          type: string
          description: The state or province abbreviation of the number. Only available for numbers in US and Canada.
          example: WA
      description: Available phone number model.
    AvailablePhoneNumberListResponse:
      type: object
      properties:
        uri:
          type: string
          description: The URI for the API call.
        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
      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
        beta:
          type: boolean
          description: New numbers on SignalWire are marked as `beta`. Possible values are `true` or `false`.
        country:
          type: string
          description: The country the number is from.
          example: United States
        country_code:
          type: string
          description: The ISO country code of the number.
          example: US
        subresource_uris:
          allOf:
            - $ref: '#/components/schemas/CountrySubresourceUris'
          description: URIs for subresources.
      description: Response containing a list of available phone number resources.
    Call:
      type: object
      properties:
        account_sid:
          type: string
          format: uuid
          description: The unique identifier for the account that created this call.
          example: b3877c40-da60-4998-90ad-b792e98472af
        annotation:
          type: string
          description: The annotation for the call.
          example: Call annotation text
        answered_by:
          allOf:
            - $ref: '#/components/schemas/AnsweredBy'
          description: Who/what the call was answered by. Possible values are `human` or `machine`.
        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 call was created.
          example: Wed, 19 Sept 2018 20:00:00 +0000
        date_updated:
          type: string
          description: The date, in RFC 2822 GMT format, this call was updated.
          example: Wed, 19 Sept 2018 21:00:00 +0000
        direction:
          allOf:
            - $ref: '#/components/schemas/CallDirection'
          description: The direction of the call. Possible values are `inbound` or `outbound`.
        duration:
          type: integer
          format: int32
          description: The duration, in seconds, of the call.
          example: 20
        end_time:
          type: string
          description: The time, in RFC 2822 GMT format, on which the call was terminated.
          example: Fri, 21 Sept 2018 10:00:00 +0000
        forwarded_from:
          type: string
          description: The number this call was forwarded from.
          example: '+13102259067'
        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: '+13102259067'
        parent_call_sid:
          type: string
          format: uuid
          description: The unique identifier for the call that created this call.
          example: b3877c40-da60-4998-90ad-b792e98472af
        phone_number_sid:
          type: string
          format: uuid
          description: The unique identifier for the phone number.
          example: b3877c40-da60-4998-90ad-b792e98472pn
        price:
          type: number
          format: float
          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
        sid:
          type: string
          format: uuid
          description: The unique identifier for the call.
          example: b3877c40-da60-4998-90ad-b792e98472ca
        start_time:
          type: string
          description: The time, in RFC 2822 GMT format, on which the call began.
          example: Wed, 19 Sept 2018 20:00:01 +0000
        status:
          allOf:
            - $ref: '#/components/schemas/CallStatus'
          description: The status of the call.
        subresource_uris:
          allOf:
            - $ref: '#/components/schemas/CallSubresourceUris'
          description: A Map of available sub-resources.
        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
        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
      description: Call model representing a voice call.
    CallDirection:
      type: string
      enum:
        - inbound
        - outbound
      description: Call direction.
    CallListResponse:
      type: object
      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
          description: The URI of the next page.
          example: /api/laml/2010-04-01/Accounts?Page=1&PageSize=50
        previous_page_uri:
          type: string
          description: The URI of the previous page.
        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
        account_sid:
          type: string
          format: uuid
          description: The unique identifier for the account.
        calls:
          type: array
          items:
            $ref: '#/components/schemas/Call'
          description: List of calls.
      description: Response containing a list of calls.
    CallRecordingResponse:
      type: object
      properties:
        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
          description: The unique identifier for the call that is associated with this recording.
          example: 43bb71ee-553f-4074-bb20-8e2747647cce
        conference_sid:
          type: string
          description: The unique identifier for the conference that is associated with this recording.
          example: 2071320d-ee82-4578-84e0-379fb227eb77
        channels:
          type: number
          enum:
            - 1
            - 2
          description: The number of channels in a recording. Possible values are `1` or `2`.
          example: 1
        date_created:
          type: string
          description: The date, in RFC 2822 format, this recording was created.
          example: Tue, 25 Sept 2018 23:00:00 +0000
        date_updated:
          type: string
          description: The date, in RFC 2822 format, this recording was updated.
          example: Wed, 26 Sept 2018 23:00:04 +0000
        end_time:
          type: string
          description: The time, in RFC 2822 format, this recording ended.
          example: Wed, 26 Sept 2018 23:00:04 +0000
        price:
          type: string
          description: The cost for the recording.
          example: '-0.0025'
        price_unit:
          type: string
          description: The currency of the price of the recording.
          example: USD
        duration:
          type: string
          description: The length, in seconds, of the recording.
          example: '4'
        sid:
          type: string
          description: The unique identifier for the recording.
          example: 19e436af-5688-4307-b03b-bdb2b42b8142
        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
          description: Further details about a failed recording.
          example: '21104'
        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
      description: Response containing a single call recording.
    CallResponse:
      type: object
      properties:
        account_sid:
          type: string
          format: uuid
          description: The unique identifier for the account that created this call.
          example: b3877c40-da60-4998-90ad-b792e98472af
        annotation:
          type: string
          description: The annotation for the call.
          example: Call annotation text
        answered_by:
          allOf:
            - $ref: '#/components/schemas/AnsweredBy'
          description: Who/what the call was answered by. Possible values are `human` or `machine`.
        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 call was created.
          example: Wed, 19 Sept 2018 20:00:00 +0000
        date_updated:
          type: string
          description: The date, in RFC 2822 GMT format, this call was updated.
          example: Wed, 19 Sept 2018 21:00:00 +0000
        direction:
          allOf:
            - $ref: '#/components/schemas/CallDirection'
          description: The direction of the call. Possible values are `inbound` or `outbound`.
        duration:
          type: integer
          format: int32
          description: The duration, in seconds, of the call.
          example: 20
        end_time:
          type: string
          description: The time, in RFC 2822 GMT format, on which the call was terminated.
          example: Fri, 21 Sept 2018 10:00:00 +0000
        forwarded_from:
          type: string
          description: The number this call was forwarded from.
          example: '+13102259067'
        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: '+13102259067'
        parent_call_sid:
          type: string
          format: uuid
          description: The unique identifier for the call that created this call.
          example: b3877c40-da60-4998-90ad-b792e98472af
        phone_number_sid:
          type: string
          format: uuid
          description: The unique identifier for the phone number.
          example: b3877c40-da60-4998-90ad-b792e98472pn
        price:
          type: number
          format: float
          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
        sid:
          type: string
          format: uuid
          description: The unique identifier for the call.
          example: b3877c40-da60-4998-90ad-b792e98472ca
        start_time:
          type: string
          description: The time, in RFC 2822 GMT format, on which the call began.
          example: Wed, 19 Sept 2018 20:00:01 +0000
        status:
          allOf:
            - $ref: '#/components/schemas/CallStatus'
          description: The status of the call.
        subresource_uris:
          allOf:
            - $ref: '#/components/schemas/CallSubresourceUris'
          description: A Map of available sub-resources.
        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
        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
      description: Response containing a single call.
    CallStatus:
      type: string
      enum:
        - queued
        - ringing
        - in-progress
        - canceled
        - completed
        - busy
        - failed
      description: Call status.
    CallStreamResponse:
      type: object
      properties:
        account_sid:
          type: string
          format: uuid
          description: The unique identifier for the account.
          example: b3877c40-da60-4998-90ad-b792e98472af
        api_version:
          type: string
          description: The version of the SignalWire API.
          example: '2010-04-01'
        call_sid:
          type: string
          format: uuid
          description: The unique identifier for the call.
          example: b3877c40-da60-4998-90ad-b792e98472ca
        date_created:
          type: string
          description: The date, in RFC 2822 GMT format, this stream was created.
          example: Wed, 19 Sept 2018 20:00:00 +0000
        date_updated:
          type: string
          description: The date, in RFC 2822 GMT format, this stream was updated.
          example: Wed, 19 Sept 2018 21:00:00 +0000
        error_code:
          type: integer
          format: int32
          description: The error code for the stream.
          example: 0
        name:
          type: string
          description: The name of the stream.
          example: my_first_stream
        sid:
          type: string
          format: uuid
          description: The unique identifier for the stream.
          example: b3877c40-da60-4998-90ad-b792e98472st
        status:
          allOf:
            - $ref: '#/components/schemas/StreamStatus'
          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/Calls/b3877c40-da60-4998-90ad-b792e98472ca/Streams/b3877c40-da60-4998-90ad-b792e98472st.json
      description: Response containing a single call stream.
    CallSubresourceUris:
      type: object
      properties:
        notifications:
          type: string
          description: The URI for notifications.
          example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Calls/b3877c40-da60-4998-90ad-b792e98472ca/Notifications.json
        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.
    Conference:
      type: object
      properties:
        account_sid:
          type: string
          description: The unique identifier for the account that created this conference.
          example: b3877c40-da60-4998-90ad-b792e98472ca
        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 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
        region:
          allOf:
            - $ref: '#/components/schemas/ConferenceRegion'
          description: The region where this conference audio was mixed.
        sid:
          type: string
          description: The unique identifier for this conference.
          example: b3877c40-da60-4998-90ad-b792e98472cf
        status:
          allOf:
            - $ref: '#/components/schemas/ConferenceStatus'
          description: The status of this conference.
        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
      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
          description: The URI of the next page.
          example: /api/laml/2010-04-01/Accounts?Page=1&PageSize=50
        previous_page_uri:
          type: string
          description: The URI of the previous page.
        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
        account_sid:
          type: string
          description: The unique identifier for the account that created this conference.
          example: b3877c40-da60-4998-90ad-b792e98472ca
        conferences:
          type: array
          items:
            $ref: '#/components/schemas/Conference'
          description: List of conferences.
      description: Response containing a list of conferences.
    ConferenceParticipant:
      type: object
      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
          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
      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
          description: The URI of the next page.
          example: /api/laml/2010-04-01/Accounts?Page=1&PageSize=50
        previous_page_uri:
          type: string
          description: The URI of the previous page.
        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
        account_sid:
          type: string
          format: uuid
          description: The unique identifier for the account.
        conference_sid:
          type: string
          format: uuid
          description: The unique identifier for the conference.
        participants:
          type: array
          items:
            $ref: '#/components/schemas/ConferenceParticipant'
          description: List of participants.
      description: Response containing a list of conference participants.
    ConferenceParticipantResponse:
      type: object
      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
          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.
    ConferenceRegion:
      type: string
      enum:
        - us1
        - us2
        - ie1
        - de1
        - sg1
        - br1
        - au1
        - jp1
      description: Conference region.
    ConferenceResponse:
      type: object
      properties:
        account_sid:
          type: string
          description: The unique identifier for the account that created this conference.
          example: b3877c40-da60-4998-90ad-b792e98472ca
        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 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
        region:
          allOf:
            - $ref: '#/components/schemas/ConferenceRegion'
          description: The region where this conference audio was mixed.
        sid:
          type: string
          description: The unique identifier for this conference.
          example: b3877c40-da60-4998-90ad-b792e98472cf
        status:
          allOf:
            - $ref: '#/components/schemas/ConferenceStatus'
          description: The status of this conference.
        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
      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_created:
          type: string
          description: The date, in RFC 2822 GMT format, this stream was created.
          example: Mon, 24 Sept 2018 21:00:00 +0000
        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
          description: The name of 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:
          type: string
          description: The status of the stream.
          example: in-progress
        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.
    ConferenceSubresourceUris:
      type: object
      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.
    CountrySubresourceUris:
      type: object
      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.json
        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.json
      description: Country subresource URIs.
    CreateApplicationRequest:
      type: object
      required:
        - FriendlyName
      properties:
        FriendlyName:
          type: string
          description: 'A named unique identifier for the resource. Allowed characters: `A-Za-z0-9_-`. Maximum of 100 characters.'
          example: My Friendly Name
        MessageStatusCallback:
          type: string
          description: If a message's `ApplicationSid` is set to this Application's `Sid`, when a message receives a status change, SignalWire will send a `POST` request to this URL with the message's details.
          example: http://www.example.com/sms-status-callback
        SmsFallbackMethod:
          type: string
          enum:
            - GET
            - POST
          description: Whether the request to `SmsFallbackUrl` is a `GET` or a `POST`. Default is `POST`.
          example: GET
          default: POST
        SmsFallbackUrl:
          type: string
          description: The URL SignalWire will request if errors occur when fetching the `SmsUrl`.
          example: http://www.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: GET
          default: POST
        SmsStatusCallback:
          type: string
          description: If a message's `ApplicationSid` is set to this Application's `Sid`, when a message receives a status change, SignalWire will send a `POST` request to this URL with the message's details.
          example: http://www.example.com/sms-status-callback
        SmsUrl:
          type: string
          description: The URL to request when an SMS is received.
          example: http://example.com
        StatusCallback:
          type: string
          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
        VoiceCallerIdLookup:
          type: boolean
          description: Whether or not to look up a caller's ID from the database. Possible values are `true` or `false`. Default is `false`.
          example: false
          default: false
        VoiceFallbackMethod:
          type: string
          enum:
            - GET
            - POST
          description: Whether the request to `VoiceFallbackUrl` is a `GET` or a `POST`. Default is `POST`.
          example: GET
          default: POST
        VoiceFallbackUrl:
          type: string
          description: The URL SignalWire will request if errors occur when fetching the `Url`.
          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: GET
          default: POST
        VoiceUrl:
          type: string
          description: The URL to request when a phone number receives a call or fax.
          example: http://example.com
      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).
          example: mono
        RecordingStatusCallback:
          type: string
          description: The URL to request to when recording is available.
          example: https://your-api-endpoint.com/recording-status
        RecordingStatusCallbackEvent:
          type: string
          enum:
            - completed
            - in-progress
            - absent
          description: The different recording statuses. Possible values are `completed`, `in-progress`, and `absent`. To specify multiple events, separate with a space. Defaults to `completed`.
          example: completed
        RecordingStatusCallbackMethod:
          type: string
          enum:
            - GET
            - POST
          description: Whether the request to `RecordingStatusCallback` URL is a `GET` or a `POST`. Default is `POST`.
          example: GET
          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. Defaults to `both`.
          example: inbound
          default: both
        Trim:
          type: string
          enum:
            - trim-silence
            - do-not-trim
          description: Whether leading and trailing silence is trimmed from a recording. Possible values are `trim-silence` and `do-not-trim`. Default is `trim-silence`.
          example: trim-silence
          default: trim-silence
      description: Request body for creating a call recording.
    CreateCallRequest:
      type: object
      required:
        - From
        - To
      properties:
        Url:
          type: string
          description: The URL to handle the call. Required if `ApplicationSid` is 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` is not used.
          example: b3877c40-da60-4998-90ad-b792e98472ap
        From:
          type: string
          description: The address that initiated the call.
          example: '+13103384645'
        To:
          type: string
          description: The address that received the call.
          example: '+13105678901'
        CallerId:
          type: string
          description: The number, in E.164 format, or identifier of the caller.
          example: '+13102259067'
        FallbackMethod:
          type: string
          enum:
            - GET
            - POST
          description: Whether the request to `FallbackUrl` is a `GET` or a `POST`. Default is `POST`.
          example: GET
          default: POST
        FallbackUrl:
          type: string
          description: The URL SignalWire will request if errors occur when fetching the `Url`.
          example: https://your-api-endpoint.com/path
        MachineDetection:
          type: string
          enum:
            - Enable
            - DetectMessageEnd
            - none
          description: Whether a human or machine picked up the call.
          example: Enable
        AsyncAmd:
          type: boolean
          description: Whether or not to execute machine detection asynchronously.
          example: false
          default: false
        AsyncAmdStatusCallback:
          type: string
          description: The URL to request when the machine detection is completed.
          example: https://your-api-endpoint.com/path
        AsyncAmdStatusCallbackMethod:
          type: string
          enum:
            - GET
            - POST
          description: Whether the request to `AsyncAmdStatusCallback` is a `GET` or a `POST`.
          example: GET
        AsyncAmdPartialResults:
          type: boolean
          description: Whether or not to report partial (interim) results to the callback url.
          example: false
        MachineDetectionSilenceTimeout:
          type: integer
          format: int32
          description: Number of milliseconds to wait for initial voice before giving up. Default is `5000` milliseconds.
          example: 5000
          default: 5000
        MachineDetectionSpeechThreshold:
          type: integer
          format: int32
          description: How many milliseconds of voice to decide it is a machine. Must be at least `1000` to a maximum of `6000`. Default is `2400` milliseconds.
          example: 2400
          default: 2400
        MachineDetectionSpeechEndThreshold:
          type: integer
          format: int32
          description: Number of milliseconds to wait for voice to finish. Must be at least `500` to a maximum of `5000`. Default is `1200` milliseconds.
          example: 1200
          default: 1200
        MachineDetectionTimeout:
          type: integer
          format: int32
          description: The time SignalWire will wait for machine detection before timing out. Default is `30` seconds.
          example: 30
          default: 30
        MachineWordsThreshold:
          type: integer
          format: int32
          description: How many words to count to decide it is a machine. Must be at least one to a maximum of `100`. Default is `6`.
          example: 6
          default: 6
        MaxPricePerMinute:
          type: number
          format: float
          description: The maximum price in USD acceptable for the call to be created.
          example: 0.0075
        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
        Record:
          type: boolean
          description: Whether or not to record a call.
          example: false
        RecordingChannels:
          type: string
          enum:
            - mono
            - dual
          description: The number of channels in the recording.
          example: mono
        RecordingStatusCallback:
          type: string
          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
        RecordingTrack:
          type: string
          enum:
            - inbound
            - outbound
            - both
          description: Specifies whether to record the `inbound`, `outbound`, or `both` audio. Defaults to `both`.
          example: both
          default: both
        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
        SendDigits:
          type: string
          description: The digits to press after a call is connected.
          example: w
        StatusCallback:
          type: string
          description: The URL SignalWire will send webhooks to on every requested `StatusCallbackEvent` event.
          example: https://your-api-endpoint.com/path
        StatusCallbackEvent:
          type: array
          items:
            type: string
          description: The status events that trigger a SignalWire webhook. Defaults to `completed`.
          example:
            - completed
        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
        Timeout:
          type: string
          description: The time SignalWire will wait before assuming the call has no answer. Max wait time is `600 seconds`. Default is `60` seconds.
          example: '60'
          default: '60'
        Trim:
          type: string
          enum:
            - trim-silence
            - do-not-trim
          description: Whether leading and trailing silence is trimmed from a recording. Possible values are `trim-silence` or `do-not-trim`. Default is `trim-silence`.
          example: trim-silence
          default: trim-silence
      description: Request body for creating a call.
    CreateCallStreamRequest:
      type: object
      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
          description: The URL to request to when stream is available.
          example: https://your-api-endpoint.com/stream-status
        Url:
          type: string
          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 wss server
          example: FirstName
        Parameter1.Value:
          type: string
          description: Custom parameter value to pass towards the wss server
          example: Jane
        Parameter2.Name:
          type: string
          description: Custom parameter name to pass towards the wss server
          example: FirstName
        Parameter2.Value:
          type: string
          description: Custom parameter value to pass towards the wss server
          example: Jane
      description: Request body for creating a call stream.
    CreateConferenceStreamRequest:
      type: object
      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
          description: The URL to request to when stream is available.
          example: https://your-api-endpoint.com/stream-status
        Url:
          type: string
          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
      description: Request body for creating a conference stream.
    CreateIncomingPhoneNumberRequest:
      type: object
      required:
        - AreaCode
        - PhoneNumber
      properties:
        AreaCode:
          type: string
          description: The area code of your new number.
          example: '310'
        PhoneNumber:
          type: string
          description: The incoming number in E.164 format.
          example: '+13103386745'
        AddressSid:
          type: string
          description: The unique identifier for the address associated with this phone number.
          example: b3877c40-da60-4998-90ad-b792e98472ad
        FriendlyName:
          type: string
          description: A formatted version of the number.
          example: 310-338-6745
        IdentitySid:
          type: string
          description: The unique identifier for the identity associated with this phone number.
          example: b3877c40-da60-4998-90ad-b792e98472ri
        SmsApplicationSid:
          type: string
          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
          description: The URL to request if errors occur when fetching SmsUrl.
          example: http://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
          description: The URL to request when an incoming SMS is received.
          example: http://example.com/sms
        StatusCallback:
          type: string
          description: The URL to request to pass status updates to.
          example: example.com
        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
        TrunkSid:
          type: string
          description: The unique identifier for the Trunk associated with this phone number.
          example: b3877c40-da60-4998-90ad-b792e98472tr
        VoiceApplicationSid:
          type: string
          description: The unique identifier for the application associated with call handling on this phone number.
          example: b3877c40-da60-4998-90ad-b792e98472va
        VoiceCallerIdLookup:
          type: boolean
          description: Whether or not to look up a caller's name in the database.
          example: false
        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
          description: The URL to request if errors occur when fetching `Url`.
          example: example.com
        VoiceMethod:
          type: string
          enum:
            - GET
            - POST
          description: Whether the request to Url is a `GET` or a `POST`. Default is `POST`.
          example: GET
          default: POST
        VoiceReceiveMode:
          type: string
          enum:
            - voice
            - fax
          description: Whether this number can receive calls or fax. Default is voice.
          example: voice
          default: voice
        VoiceUrl:
          type: string
          description: The URL to request when an incoming call is received.
          example: http://your-application.com/docs/voice.xml
      description: Request body for creating an incoming phone number.
    CreateLamlBinRequest:
      type: object
      required:
        - Name
      properties:
        Name:
          type: string
          description: A friendly name given to the cXML bin.
          example: Death Star IVR
        Contents:
          type: string
          description: The contents of the cXML bins.
          example: <Response><Say>Hello!</Say></Response>
      description: Request body for creating a cXML Bin.
    CreateMessageRequest:
      type: object
      required:
        - To
        - From
        - Body
      properties:
        To:
          type: string
          description: The phone number in E.164 format that received the message.
          example: '+15557654321'
        From:
          type: string
          description: The phone number in E.164 format that sent the message.
          example: '+15551234567'
        Body:
          type: string
          description: The text of the message. Up to 1600 characters long.
          example: Hello World!
        MediaUrl:
          type: string
          description: URL of media you wish to attach and send with the message.
          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
          description: The SID of a SignalWire cXML bin used to configure the message's `MessageStatusCallback` attribute.
          example: b3877c40-da60-4998-90ad-b792e98472ap
        MaxPrice:
          type: string
          description: The maximum price in USD acceptable for the message to be sent.
          example: '0.0075'
        StatusCallback:
          type: string
          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
          description: The number of seconds a message will allow being queued before canceling. Default value is `14400`.
          example: 14400
          default: 14400
        MessagingServiceSid:
          type: string
          description: If a number group was used when sending an outbound message, the number group's ID will be present.
          example: b3877c40-da60-4998-90ad-b792e98472ms
      description: Request body for creating a message.
    CreateQueueRequest:
      type: object
      required:
        - FriendlyName
      properties:
        FriendlyName:
          type: string
          description: A description that distinguishes a queue.
          example: Queue1
        MaxSize:
          type: string
          description: The maximum number of calls that are allowed to wait in a queue.
          example: '123'
      description: Request body for creating a queue.
    CreateSubprojectRequest:
      type: object
      required:
        - FriendlyName
      properties:
        FriendlyName:
          type: string
          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
          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. Valid permissions are calling, chat, fax, management, messaging, numbers, pubsub, storage, tasking, and video.
          example:
            - calling
            - fax
            - messaging
        subproject_id:
          type: string
          description: The unique identifier of the subproject you would like to create a token for.
          example: 9a7fc048-984f-11ee-b9d1-0242ac120002
      description: Request body for creating an API token.
    EmergencyStatus:
      type: string
      enum:
        - active
        - inactive
      description: Emergency status.
    ErrorResponse:
      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.
    Fax:
      type: object
      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. Possible values are `inbound` or `outbound`.
        from:
          type: string
          description: The phone number, in E.164 format, the fax was sent from.
          example: '+13103383454'
        media_url:
          type: string
          description: The URL hosting the received media.
          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
          description: The number of pages in the fax document.
          example: '3'
        price:
          type: string
          description: The cost of the fax.
          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
          description: Error code for this resource (if available).
          example: '34004'
        error_message:
          type: string
          description: The description of this error (if available).
          example: The call dropped prematurely
      description: Fax model.
    FaxDirection:
      type: string
      enum:
        - inbound
        - outbound
      description: Fax direction.
    FaxLinks:
      type: object
      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
      properties:
        meta:
          allOf:
            - $ref: '#/components/schemas/FaxMeta'
          description: Pagination and metadata information.
        faxes:
          type: array
          items:
            $ref: '#/components/schemas/Fax'
          description: List of faxes.
      description: Response containing a list of faxes.
    FaxMedia:
      type: object
      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 RFC 2822 GMT format, this media was created.
          example: '2018-11-26T20:00:00Z'
        date_updated:
          type: string
          description: The date, in RFC 2822 GMT 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
        url:
          type: string
          description: The URL for the media.
          example: /fax/v1/Faxes/b3877c40-da60-4998-90ad-b792e98472fx/Media/b3877c40-da60-4998-90ad-b792e98472me
      description: Fax media model.
    FaxMediaListResponse:
      type: object
      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
          description: The URI of the next page.
          example: /api/laml/2010-04-01/Accounts?Page=1&PageSize=50
        previous_page_uri:
          type: string
          description: The URI of the previous page.
        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.
      description: Response containing a list of fax media.
    FaxMediaResponse:
      type: object
      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 RFC 2822 GMT format, this media was created.
          example: '2018-11-26T20:00:00Z'
        date_updated:
          type: string
          description: The date, in RFC 2822 GMT 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
        url:
          type: string
          description: The URL for the media.
          example: /fax/v1/Faxes/b3877c40-da60-4998-90ad-b792e98472fx/Media/b3877c40-da60-4998-90ad-b792e98472me
      description: Response containing a single fax media.
    FaxMeta:
      type: object
      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
          description: The URI of the next page.
          example: /api/laml/2010-04-01/Accounts?Page=1&PageSize=50
        previous_page_uri:
          type: string
          description: The URI of the previous page.
        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
        key:
          type: string
          description: The name of the object.
          example: faxes
      description: Meta information for fax list response.
    FaxQuality:
      type: string
      enum:
        - standard
        - fine
        - superfine
      description: Fax quality.
    FaxResponse:
      type: object
      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. Possible values are `inbound` or `outbound`.
        from:
          type: string
          description: The phone number, in E.164 format, the fax was sent from.
          example: '+13103383454'
        media_url:
          type: string
          description: The URL hosting the received media.
          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
          description: The number of pages in the fax document.
          example: '3'
        price:
          type: string
          description: The cost of the fax.
          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
          description: Error code for this resource (if available).
          example: '34004'
        error_message:
          type: string
          description: The description of this error (if available).
          example: The call dropped prematurely
      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
      properties:
        number:
          type: string
          minLength: 5
          maxLength: 30
          description: The phone number to import in E.164 format. Number must be between 5 and 30 characters with no special characters besides a leading `+`.
          example: '+49152234333323'
        number_type:
          allOf:
            - $ref: '#/components/schemas/NumberType'
          description: The type of phone number being imported.
        capabilities:
          type: array
          items:
            $ref: '#/components/schemas/PhoneNumberCapability'
          description: The capabilities to enable for this phone number. Can include any combination of SMS, Voice, Fax, and MMS. If not provided, defaults to all capabilities (SMS, Voice, Fax, and MMS). Cannot be an empty array.
      description: Request body for importing a phone number.
    IncomingPhoneNumber:
      type: object
      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.
        address_sid:
          type: string
          description: The unique identifier for the address associated with this phone number.
          example: b3877c40-da60-4998-90ad-b792e98472ad
        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.
          example: false
        capabilities:
          allOf:
            - $ref: '#/components/schemas/IncomingPhoneNumberCapabilities'
          description: Whether or not a number can receive calls and messages.
        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
          description: The unique identifier of the address associated with E911 for this phone number.
          example: b3877c40-da60-4998-90ad-b792e98472ea
        emergency_status:
          allOf:
            - $ref: '#/components/schemas/EmergencyStatus'
          description: Whether the phone route has an active E911 address associated.
        friendly_name:
          type: string
          description: A formatted version of the number.
          example: 310-338-6745
        identity_sid:
          type: string
          description: The unique identifier for the identity associated with this phone number.
          example: b3877c40-da60-4998-90ad-b792e98472ri
        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
          description: The unique identifier for the application associated with SMS handling on this phone number.
          example: b3877c40-da60-4998-90ad-b792e98472sa
        sms_fallback_method:
          type: string
          description: Whether the request to `SmsFallbackUrl` is a `GET` or a `POST`. Default is `POST`.
          example: POST
        sms_fallback_url:
          type: string
          description: The URL to request if errors occur when fetching SmsUrl.
          example: http://example.com/sms-fallback
        sms_method:
          type: string
          description: Whether the request to SmsUrl is a `GET` or a `POST`. Default is `POST`.
          example: POST
        sms_url:
          type: string
          description: The URL to request when an incoming SMS is received.
          example: http://example.com/sms
        status_callback:
          type: string
          description: The URL to request to pass status updates to.
          example: example.com
        status_callback_method:
          type: string
          description: Whether the request to StatusCallback is a `GET` or a `POST`. Default is `POST`.
          example: POST
        trunk_sid:
          type: string
          description: The unique identifier for the Trunk associated with this phone number.
          example: b3877c40-da60-4998-90ad-b792e98472tr
        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
        voice_application_sid:
          type: string
          description: The unique identifier for the application associated with call handling on this phone number.
          example: b3877c40-da60-4998-90ad-b792e98472va
        voice_caller_id_lookup:
          type: boolean
          description: Whether or not to look up a caller's name in the database.
          example: false
        voice_fallback_method:
          type: string
          description: Whether the request to VoiceFallbackUrl is a `GET` or a `POST`. Default is `POST`.
          example: POST
        voice_fallback_url:
          type: string
          description: The URL to request if errors occur when fetching `Url`.
          example: example.com
        voice_method:
          type: string
          description: Whether the request to Url is a `GET` or a `POST`. Default is `POST`.
          example: GET
        voice_url:
          type: string
          description: The URL to request when an incoming call is received.
          example: http://your-application.com/docs/voice.xml
        country_code:
          type: string
          description: The country code for this phone number.
          example: US
      description: Incoming phone number model.
    IncomingPhoneNumberCapabilities:
      type: object
      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
      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
          description: The URI of the next page.
          example: /api/laml/2010-04-01/Accounts?Page=1&PageSize=50
        previous_page_uri:
          type: string
          description: The URI of the previous page.
        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
        end:
          type: string
          description: The end of the page.
          example: '0'
        num_pages:
          type: string
          description: The number of pages.
          example: '1'
        start:
          type: string
          description: The start of the page.
          example: '0'
        total:
          type: string
          description: The total number of results.
          example: '1'
        account_sid:
          type: string
          description: The unique identifier for this account.
          example: b3877c40-da60-4998-90ad-b792e98472ac
        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
      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.
        address_sid:
          type: string
          description: The unique identifier for the address associated with this phone number.
          example: b3877c40-da60-4998-90ad-b792e98472ad
        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.
          example: false
        capabilities:
          allOf:
            - $ref: '#/components/schemas/IncomingPhoneNumberCapabilities'
          description: Whether or not a number can receive calls and messages.
        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
          description: The unique identifier of the address associated with E911 for this phone number.
          example: b3877c40-da60-4998-90ad-b792e98472ea
        emergency_status:
          allOf:
            - $ref: '#/components/schemas/EmergencyStatus'
          description: Whether the phone route has an active E911 address associated.
        friendly_name:
          type: string
          description: A formatted version of the number.
          example: 310-338-6745
        identity_sid:
          type: string
          description: The unique identifier for the identity associated with this phone number.
          example: b3877c40-da60-4998-90ad-b792e98472ri
        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
          description: The unique identifier for the application associated with SMS handling on this phone number.
          example: b3877c40-da60-4998-90ad-b792e98472sa
        sms_fallback_method:
          type: string
          description: Whether the request to `SmsFallbackUrl` is a `GET` or a `POST`. Default is `POST`.
          example: POST
        sms_fallback_url:
          type: string
          description: The URL to request if errors occur when fetching SmsUrl.
          example: http://example.com/sms-fallback
        sms_method:
          type: string
          description: Whether the request to SmsUrl is a `GET` or a `POST`. Default is `POST`.
          example: POST
        sms_url:
          type: string
          description: The URL to request when an incoming SMS is received.
          example: http://example.com/sms
        status_callback:
          type: string
          description: The URL to request to pass status updates to.
          example: example.com
        status_callback_method:
          type: string
          description: Whether the request to StatusCallback is a `GET` or a `POST`. Default is `POST`.
          example: POST
        trunk_sid:
          type: string
          description: The unique identifier for the Trunk associated with this phone number.
          example: b3877c40-da60-4998-90ad-b792e98472tr
        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
        voice_application_sid:
          type: string
          description: The unique identifier for the application associated with call handling on this phone number.
          example: b3877c40-da60-4998-90ad-b792e98472va
        voice_caller_id_lookup:
          type: boolean
          description: Whether or not to look up a caller's name in the database.
          example: false
        voice_fallback_method:
          type: string
          description: Whether the request to VoiceFallbackUrl is a `GET` or a `POST`. Default is `POST`.
          example: POST
        voice_fallback_url:
          type: string
          description: The URL to request if errors occur when fetching `Url`.
          example: example.com
        voice_method:
          type: string
          description: Whether the request to Url is a `GET` or a `POST`. Default is `POST`.
          example: GET
        voice_url:
          type: string
          description: The URL to request when an incoming call is received.
          example: http://your-application.com/docs/voice.xml
        country_code:
          type: string
          description: The country code for this phone number.
          example: US
      description: Response containing a single incoming phone number.
    LamlBin:
      type: object
      properties:
        sid:
          type: string
          format: uuid
          description: The unique identifier of the cXML bin on SignalWire.
          example: 5184b831-184f-4209-872d-ccdccc80f2f1
        date_created:
          type: string
          description: The date and time, in ISO 8601 format, the Bin was created.
          example: '2019-11-26T20:00:00Z'
        date_updated:
          type: string
          description: The date and time, in ISO 8601 format, the Bin was updated.
          example: Sat, 15 Sept 2018 10:00:00 +0000
        date_last_accessed:
          type: string
          description: The date and time, in ISO 8601 format, the Bin was last accessed.
          example: '2020-06-05T20:00:00Z'
        account_sid:
          type: string
          description: The unique identifier for the account this Bin is associated with.
          example: b3877c40-da60-4998-90ad-b792e98472af
        name:
          type: string
          description: A friendly name given to the cXML bin.
          example: Death Star IVR
        contents:
          type: string
          description: The contents of the cXML bins.
          example: <Response><Say>Hello!</Say></Response>
        request_url:
          type: string
          description: The unique URL to the raw contents of the cXML Application.
          example: https://example.signalwire.com/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/LamlBins/5184b831-184f-4209-872d-ccdccc80f2f1
        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.json
      description: cXML Bin model.
    LamlBinListResponse:
      type: object
      properties:
        meta:
          allOf:
            - $ref: '#/components/schemas/Pagination'
          description: Pagination metadata.
        laml_bins:
          type: array
          items:
            $ref: '#/components/schemas/LamlBin'
          description: List of cXML bins.
      description: Response containing a list of cXML Bins.
    LamlBinResponse:
      type: object
      properties:
        sid:
          type: string
          format: uuid
          description: The unique identifier of the cXML bin on SignalWire.
          example: 5184b831-184f-4209-872d-ccdccc80f2f1
        date_created:
          type: string
          description: The date and time, in ISO 8601 format, the Bin was created.
          example: '2019-11-26T20:00:00Z'
        date_updated:
          type: string
          description: The date and time, in ISO 8601 format, the Bin was updated.
          example: Sat, 15 Sept 2018 10:00:00 +0000
        date_last_accessed:
          type: string
          description: The date and time, in ISO 8601 format, the Bin was last accessed.
          example: '2020-06-05T20:00:00Z'
        account_sid:
          type: string
          description: The unique identifier for the account this Bin is associated with.
          example: b3877c40-da60-4998-90ad-b792e98472af
        name:
          type: string
          description: A friendly name given to the cXML bin.
          example: Death Star IVR
        contents:
          type: string
          description: The contents of the cXML bins.
          example: <Response><Say>Hello!</Say></Response>
        request_url:
          type: string
          description: The unique URL to the raw contents of the cXML Application.
          example: https://example.signalwire.com/api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/LamlBins/5184b831-184f-4209-872d-ccdccc80f2f1
        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.json
      description: Response containing a single cXML Bin.
    Message:
      type: object
      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
          description: The text of the message. Up to 1600 characters long.
          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: string
          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
          description: The date and time the message was sent in RFC 2822 format.
          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
          description: If an error has occurred on the message, the error code will give you a specific code.
          example: '30001'
        error_message:
          type: string
          description: A human readable description of the error that occurred.
          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
          description: The cost of the individual message billed to your project.
          example: 0.005
        price_unit:
          type: string
          description: The currency in which `price` is charged as.
          example: USD
        sid:
          type: string
          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
          description: If a number group was used when sending an outbound message, the number group's ID will be present.
          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
      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
          description: The URI of the next page.
          example: /api/laml/2010-04-01/Accounts?Page=1&PageSize=50
        previous_page_uri:
          type: string
          description: The URI of the previous page.
        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
      properties:
        account_sid:
          type: string
          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
          description: The unique identifier for the message.
          example: 0a059168-ead0-41af-9d1f-343dae832527
        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: /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
      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
          description: The URI of the next page.
          example: /api/laml/2010-04-01/Accounts?Page=1&PageSize=50
        previous_page_uri:
          type: string
          description: The URI of the previous page.
        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
      properties:
        account_sid:
          type: string
          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
          description: The unique identifier for the message.
          example: 0a059168-ead0-41af-9d1f-343dae832527
        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: /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
      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
          description: The text of the message. Up to 1600 characters long.
          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: string
          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
          description: The date and time the message was sent in RFC 2822 format.
          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
          description: If an error has occurred on the message, the error code will give you a specific code.
          example: '30001'
        error_message:
          type: string
          description: A human readable description of the error that occurred.
          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
          description: The cost of the individual message billed to your project.
          example: 0.005
        price_unit:
          type: string
          description: The currency in which `price` is charged as.
          example: USD
        sid:
          type: string
          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
          description: If a number group was used when sending an outbound message, the number group's ID will be present.
          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
        - sending
        - sent
        - delivered
        - undelivered
        - failed
        - receiving
        - received
      description: Message status.
    MessageSubresourceUris:
      type: object
      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.
    Pagination:
      type: object
      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
          description: The URI of the next page.
          example: /api/laml/2010-04-01/Accounts?Page=1&PageSize=50
        previous_page_uri:
          type: string
          description: The URI of the previous page.
        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
      description: Pagination information for list responses.
    ParticipantStatus:
      type: string
      enum:
        - completed
        - in-progress
      description: Conference participant status.
    PhoneNumberCapabilities:
      type: object
      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
        fax:
          type: boolean
          description: Whether or not fax 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
      properties:
        account_sid:
          type: string
          description: The unique identifier for the account this Queue is associated with.
          example: b3877c40-da60-4998-90ad-b792e98472af
        average_wait_time:
          type: string
          description: The average wait time, in seconds, of callers in a queue.
          example: '0'
        current_size:
          type: string
          description: The number of calls waiting in the queue.
          example: '0'
        date_created:
          type: string
          description: The date and time, in ISO 8601 format, the Queue was created.
          example: Wed, 26 Sept 2018 18:00:00 +0000
        date_updated:
          type: string
          description: The date and time, in ISO 8601 format, the Queue was updated.
          example: Thur, 27 Sept 2018 19:00:00 +0000
        friendly_name:
          type: string
          description: A description that distinguishes a queue.
          example: Queue1
        max_size:
          type: string
          description: The maximum number of calls that are allowed to wait in a queue.
          example: '123'
        sid:
          type: string
          description: The unique identifier for the queue.
          example: b3877c40-da60-4998-90ad-b792e98472qu
        uri:
          type: string
          description: The URL of this resource.
          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
      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
          description: The URI of the next page.
          example: /api/laml/2010-04-01/Accounts?Page=1&PageSize=50
        previous_page_uri:
          type: string
          description: The URI of the previous page.
        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
        account_sid:
          type: string
          description: The unique identifier for this account.
          example: b3877c40-da60-4998-90ad-b792e98472ac
        queues:
          type: array
          items:
            $ref: '#/components/schemas/Queue'
          description: List of queues.
      description: Response containing a list of queues.
    QueueMember:
      type: object
      properties:
        call_sid:
          type: string
          description: The unique identifier for the call.
          example: b3877c40-da60-4998-90ad-b792e98472ca
        date_enqueued:
          type: string
          description: The date and time, in RFC 2822 format, the member was enqueued.
          example: Wed, 26 Sept 2018 18:00:00 +0000
        position:
          type: integer
          format: int32
          description: The position of the member in the queue.
          example: 1
        wait_time:
          type: string
          description: The wait time, in seconds, of the member in the queue.
          example: '0'
        uri:
          type: string
          description: The URI of this resource.
          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.
    QueueMemberListResponse:
      type: object
      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
          description: The URI of the next page.
          example: /api/laml/2010-04-01/Accounts?Page=1&PageSize=50
        previous_page_uri:
          type: string
          description: The URI of the previous page.
        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
        end:
          type: string
          description: The name of object.
          example: '0'
        last_page_uri:
          type: string
          description: The URI for the last page.
          example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472ac/Queues/b3877c40-da60-4998-90ad-b792e98472qu/Members.json?Page=0&PageSize=50
        num_pages:
          type: string
          description: The name of object.
          example: '1'
        start:
          type: string
          description: The name of object.
          example: '0'
        total:
          type: string
          description: The name of object.
          example: '1'
        account_sid:
          type: string
          description: The unique identifier for account.
          example: b3877c40-da60-4998-90ad-b792e98472ac
        queue_sid:
          type: string
          description: The unique identifier for queue.
          example: b3877c40-da60-4998-90ad-b792e98472qu
        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
      properties:
        call_sid:
          type: string
          description: The unique identifier for the call.
          example: b3877c40-da60-4998-90ad-b792e98472ca
        date_enqueued:
          type: string
          description: The date and time, in RFC 2822 format, the member was enqueued.
          example: Wed, 26 Sept 2018 18:00:00 +0000
        position:
          type: integer
          format: int32
          description: The position of the member in the queue.
          example: 1
        wait_time:
          type: string
          description: The wait time, in seconds, of the member in the queue.
          example: '0'
        uri:
          type: string
          description: The URI of this resource.
          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
      properties:
        account_sid:
          type: string
          description: The unique identifier for the account this Queue is associated with.
          example: b3877c40-da60-4998-90ad-b792e98472af
        average_wait_time:
          type: string
          description: The average wait time, in seconds, of callers in a queue.
          example: '0'
        current_size:
          type: string
          description: The number of calls waiting in the queue.
          example: '0'
        date_created:
          type: string
          description: The date and time, in ISO 8601 format, the Queue was created.
          example: Wed, 26 Sept 2018 18:00:00 +0000
        date_updated:
          type: string
          description: The date and time, in ISO 8601 format, the Queue was updated.
          example: Thur, 27 Sept 2018 19:00:00 +0000
        friendly_name:
          type: string
          description: A description that distinguishes a queue.
          example: Queue1
        max_size:
          type: string
          description: The maximum number of calls that are allowed to wait in a queue.
          example: '123'
        sid:
          type: string
          description: The unique identifier for the queue.
          example: b3877c40-da60-4998-90ad-b792e98472qu
        uri:
          type: string
          description: The URL of this resource.
          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
      properties:
        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
          description: The unique identifier for the call that is associated with this recording.
          example: 43bb71ee-553f-4074-bb20-8e2747647cce
        conference_sid:
          type: string
          description: The unique identifier for the conference that is associated with this recording.
          example: 2071320d-ee82-4578-84e0-379fb227eb77
        channels:
          type: integer
          format: int32
          description: The number of channels in a recording. Possible values are `1` or `2`.
          example: 1
        date_created:
          type: string
          description: The date, in RFC 2822 format, this recording was created.
          example: Tue, 25 Sept 2018 23:00:00 +0000
        date_updated:
          type: string
          description: The date, in RFC 2822 format, this recording was updated.
          example: Wed, 26 Sept 2018 23:00:04 +0000
        end_time:
          type: string
          description: The time, in RFC 2822 format, this recording ended.
          example: Wed, 26 Sept 2018 23:00:04 +0000
        price:
          type: string
          description: The cost for the recording.
          example: '-0.0025'
        price_unit:
          type: string
          description: The currency of the price of the recording.
          example: USD
        duration:
          type: string
          description: The length, in seconds, of the recording.
          example: '4'
        sid:
          type: string
          description: The unique identifier for the recording.
          example: 19e436af-5688-4307-b03b-bdb2b42b8142
        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
          description: Further details about a failed recording.
          example: '21104'
        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.
      description: Recording model.
    RecordingListResponse:
      type: object
      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
          description: The URI of the next page.
          example: /api/laml/2010-04-01/Accounts?Page=1&PageSize=50
        previous_page_uri:
          type: string
          description: The URI of the previous page.
        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
        end:
          type: string
          description: The name of object.
          example: '0'
        start:
          type: string
          description: The name of object.
          example: '0'
        account_sid:
          type: string
          description: The unique identifier for this account.
          example: b720796a0-8ee9-4350-83bd-2d07a3121f1e
        recordings:
          type: array
          items:
            $ref: '#/components/schemas/Recording'
          description: List of recordings.
      description: Response containing a list of recordings.
    RecordingResponse:
      type: object
      properties:
        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
          description: The unique identifier for the call that is associated with this recording.
          example: 43bb71ee-553f-4074-bb20-8e2747647cce
        conference_sid:
          type: string
          description: The unique identifier for the conference that is associated with this recording.
          example: 2071320d-ee82-4578-84e0-379fb227eb77
        channels:
          type: integer
          format: int32
          description: The number of channels in a recording. Possible values are `1` or `2`.
          example: 1
        date_created:
          type: string
          description: The date, in RFC 2822 format, this recording was created.
          example: Tue, 25 Sept 2018 23:00:00 +0000
        date_updated:
          type: string
          description: The date, in RFC 2822 format, this recording was updated.
          example: Wed, 26 Sept 2018 23:00:04 +0000
        end_time:
          type: string
          description: The time, in RFC 2822 format, this recording ended.
          example: Wed, 26 Sept 2018 23:00:04 +0000
        price:
          type: string
          description: The cost for the recording.
          example: '-0.0025'
        price_unit:
          type: string
          description: The currency of the price of the recording.
          example: USD
        duration:
          type: string
          description: The length, in seconds, of the recording.
          example: '4'
        sid:
          type: string
          description: The unique identifier for the recording.
          example: 19e436af-5688-4307-b03b-bdb2b42b8142
        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
          description: Further details about a failed recording.
          example: '21104'
        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.
      description: Response containing a single recording.
    RecordingSource:
      type: string
      enum:
        - DialVerb
        - Conference
        - OutBoundApi
        - Trunking
        - RecordVerb
        - StartCallRecordingApi
        - StartConferenceRecording
      description: Recording source.
    RecordingStatus:
      type: string
      enum:
        - paused
        - in-progress
        - stopped
      description: Recording status.
    RecordingSubresourceUris:
      type: object
      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 received media.
          example: https://example.com/fax.pdf
        To:
          type: string
          description: The phone number, in E.164 format, the fax was sent to.
          example: '+13104456789'
        From:
          type: string
          description: The phone number, in E.164 format, the fax was sent from.
          example: '+13103383454'
        Quality:
          type: string
          enum:
            - standard
            - fine
            - superfine
          description: The quality of the fax.
          example: standard
        StatusCallback:
          type: string
          description: The URL to send a `POST` request when the status of a fax changes.
          example: https://your-api-endpoint.com/path
      description: Request body for sending a fax.
    StreamStatus:
      type: string
      enum:
        - in-progress
        - stopped
      description: Stream status.
    SubresourceUris:
      type: object
      properties:
        available_phone_numbers:
          type: string
          format: uri
          description: URI for available phone numbers.
          example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/AvailablePhoneNumbers.json
        calls:
          type: string
          format: uri
          description: URI for calls.
          example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Calls.json
        conferences:
          type: string
          format: uri
          description: URI for conferences.
          example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Conferences.json
        incoming_phone_numbers:
          type: string
          format: uri
          description: URI for incoming phone numbers.
          example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/IncomingPhoneNumbers.json
        notifications:
          type: string
          format: uri
          description: URI for notifications.
          example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Notifications.json
        outgoing_caller_ids:
          type: string
          format: uri
          description: URI for outgoing caller IDs.
          example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/OutgoingCallerIds.json
        recordings:
          type: string
          format: uri
          description: URI for recordings.
          example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Recordings.json
        transcriptions:
          type: string
          format: uri
          description: URI for transcriptions.
          example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Transcriptions.json
        addresses:
          type: string
          format: uri
          description: URI for addresses.
          example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Addresses.json
        signing_keys:
          type: string
          format: uri
          description: URI for signing keys.
          example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/SigningKeys.json
        connect_apps:
          type: string
          format: uri
          description: URI for connect apps.
          example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/ConnectApps.json
        sip:
          type: string
          format: uri
          description: URI for SIP.
          example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/SIP.json
        authorized_connect_apps:
          type: string
          format: uri
          description: URI for authorized connect apps.
          example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/AuthorizedConnectApps.json
        usage:
          type: string
          format: uri
          description: URI for usage.
          example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Usage.json
        keys:
          type: string
          format: uri
          description: URI for keys.
          example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Keys.json
        applications:
          type: string
          format: uri
          description: URI for applications.
          example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Applications.json
        short_codes:
          type: string
          format: uri
          description: URI for short codes.
          example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/ShortCodes.json
        queues:
          type: string
          format: uri
          description: URI for queues.
          example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Queues.json
        messages:
          type: string
          format: uri
          description: URI for messages.
          example: /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Messages.json
      description: A Map of sub-resources that are linked to the given Project.
    TokenResponse:
      type: object
      properties:
        id:
          type: string
          description: The ID of the created API Token.
          example: ea14556a-984f-11ee-b9d1-0242ac120002
        name:
          type: string
          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
      properties:
        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'
        date_created:
          type: string
          description: The date, in RFC 2822 GMT format, this transcription was created.
          example: Thur, 27 Sept 2018 02:00:00 +0000
        date_updated:
          type: string
          description: The date, in RFC 2822 GMT format, this transcription was updated.
          example: Fri, 28 Sept 2018 03:00:00 +0000
        duration:
          type: string
          description: The time, in seconds, of the transcribed audio.
          example: '1'
        price:
          type: string
          description: The charge for the transcription.
          example: '-0.00025'
        price_unit:
          type: string
          description: The currency, in ISO 4127 format, for the price of the transcription.
          example: USD
        recording_sid:
          type: string
          description: The unique identifier for the recording that this transcription was created from.
          example: b3877c40-da60-4998-90ad-b792e98472re
        sid:
          type: string
          description: The unique identifier for the transcription.
          example: b3877c40-da60-4998-90ad-b792e98472tr
        status:
          allOf:
            - $ref: '#/components/schemas/TranscriptionStatus'
          description: The status of the transcription.
        transcription_text:
          type: string
          description: The text content of a transcription.
          example: Hello, this is a test transcription.
        type:
          type: string
          description: Type of the transcription.
          example: fast
        uri:
          type: string
          description: The URI of the transcription.
          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
      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
          description: The URI of the next page.
          example: /api/laml/2010-04-01/Accounts?Page=1&PageSize=50
        previous_page_uri:
          type: string
          description: The URI of the previous page.
        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
        account_sid:
          type: string
          description: The unique identifier of this account.
          example: b3877c40-da60-4998-90ad-b792e98472ac
        transcriptions:
          type: array
          items:
            $ref: '#/components/schemas/Transcription'
          description: List of transcriptions.
      description: Response containing a list of transcriptions.
    TranscriptionResponse:
      type: object
      properties:
        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'
        date_created:
          type: string
          description: The date, in RFC 2822 GMT format, this transcription was created.
          example: Thur, 27 Sept 2018 02:00:00 +0000
        date_updated:
          type: string
          description: The date, in RFC 2822 GMT format, this transcription was updated.
          example: Fri, 28 Sept 2018 03:00:00 +0000
        duration:
          type: string
          description: The time, in seconds, of the transcribed audio.
          example: '1'
        price:
          type: string
          description: The charge for the transcription.
          example: '-0.00025'
        price_unit:
          type: string
          description: The currency, in ISO 4127 format, for the price of the transcription.
          example: USD
        recording_sid:
          type: string
          description: The unique identifier for the recording that this transcription was created from.
          example: b3877c40-da60-4998-90ad-b792e98472re
        sid:
          type: string
          description: The unique identifier for the transcription.
          example: b3877c40-da60-4998-90ad-b792e98472tr
        status:
          allOf:
            - $ref: '#/components/schemas/TranscriptionStatus'
          description: The status of the transcription.
        transcription_text:
          type: string
          description: The text content of a transcription.
          example: Hello, this is a test transcription.
        type:
          type: string
          description: Type of the transcription.
          example: fast
        uri:
          type: string
          description: The URI of the transcription.
          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.
    TranscriptionStatus:
      type: string
      enum:
        - in-progress
        - completed
        - failed
      description: Transcription status.
    UpdateAccountRequest:
      type: object
      properties:
        FriendlyName:
          type: string
          description: The name of the Project, up to 250 characters long.
          example: My Project
      description: Request body for updating an account.
    UpdateApplicationRequest:
      type: object
      required:
        - FriendlyName
      properties:
        FriendlyName:
          type: string
          description: 'A named unique identifier for the resource. Allowed characters: `A-Za-z0-9_-`. Maximum of 100 characters.'
          example: My Friendly Name
        MessageStatusCallback:
          type: string
          description: If a message's `ApplicationSid` is set to this Application's `Sid`, when a message receives a status change, SignalWire will send a `POST` request to this URL with the message's details.
          example: http://www.example.com/sms-status-callback
        SmsFallbackMethod:
          type: string
          enum:
            - GET
            - POST
          description: Whether the request to `SmsFallbackUrl` is a `GET` or a `POST`. Default is `POST`.
          example: GET
          default: POST
        SmsFallbackUrl:
          type: string
          description: The URL SignalWire will request if errors occur when fetching the `SmsUrl`.
          example: http://www.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: GET
          default: POST
        SmsStatusCallback:
          type: string
          description: If a message's `ApplicationSid` is set to this Application's `Sid`, when a message receives a status change, SignalWire will send a `POST` request to this URL with the message's details.
          example: http://www.example.com/sms-status-callback
        SmsUrl:
          type: string
          description: The URL to request when an SMS is received.
          example: http://example.com
        StatusCallback:
          type: string
          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
        VoiceCallerIdLookup:
          type: boolean
          description: Whether or not to look up a caller's ID from the database. Possible values are `true` or `false`. Default is `false`.
          example: false
          default: false
        VoiceFallbackMethod:
          type: string
          enum:
            - GET
            - POST
          description: Whether the request to `VoiceFallbackUrl` is a `GET` or a `POST`. Default is `POST`.
          example: GET
          default: POST
        VoiceFallbackUrl:
          type: string
          description: The URL SignalWire will request if errors occur when fetching the `Url`.
          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: GET
          default: POST
        VoiceUrl:
          type: string
          description: The URL to request when a phone number receives a call or fax.
          example: http://example.com
      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.
          example: silence
      description: Request body for updating a call recording.
    UpdateCallRequest:
      type: object
      properties:
        Url:
          type: string
          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
          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
          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
      description: Request body for updating a call.
    UpdateCallStreamRequest:
      type: object
      required:
        - Status
      properties:
        Status:
          type: string
          enum:
            - in-progress
            - stopped
          description: The status of the stream.
          example: stopped
      description: Request body for updating a call stream.
    UpdateConferenceParticipantRequest:
      type: object
      properties:
        AnnounceUrl:
          type: string
          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
        Beep:
          type: boolean
          description: Whether or not to play the beep sound when updating the Participant.
          example: false
        Coaching:
          type: boolean
          description: Whether the participant is coaching another call.
          example: false
        CallSidToCoach:
          type: string
          format: uuid
          description: The unique identifier of the participant who is being coached.
          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 `POST`.
          example: POST
          default: POST
        HoldUrl:
          type: string
          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
      description: Request body for updating a conference participant.
    UpdateConferenceRequest:
      type: object
      properties:
        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
        AnnounceUrl:
          type: string
          description: The URL to send conference announcements to.
          example: https://your-api-endpoint.com/announce
        Status:
          type: string
          description: The status of this conference.
          example: completed
      description: Request body for updating a conference.
    UpdateConferenceStreamRequest:
      type: object
      required:
        - Status
      properties:
        Status:
          type: string
          enum:
            - in-progress
            - stopped
          description: The status of the stream.
          example: stopped
      description: Request body for updating a conference stream.
    UpdateFaxRequest:
      type: object
      properties:
        Status:
          type: string
          enum:
            - queued
            - processing
            - sending
            - delivered
            - receiving
            - received
            - no-answer
            - busy
            - failed
            - canceled
          description: The status of the fax.
          example: canceled
      description: Request body for updating a fax.
    UpdateIncomingPhoneNumberRequest:
      type: object
      properties:
        AccountSid:
          type: string
          description: The unique identifier for an account to which the number should be transferred to.
          example: b3877c40-da60-4998-90ad-b792e98472ac
        AddressSid:
          type: string
          description: The unique identifier for the address associated with this phone number.
          example: b3877c40-da60-4998-90ad-b792e98472ad
        EmergencyAddressSid:
          type: string
          description: The unique identifier of the address associated with E911 for this phone number.
          example: 'null'
        FriendlyName:
          type: string
          description: A formatted version of the number.
          example: 310-338-6745
        IdentitySid:
          type: string
          description: The unique identifier for the identity associated with this phone number.
          example: b3877c40-da60-4998-90ad-b792e98472ri
        SmsApplicationSid:
          type: string
          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`.
          example: POST
        SmsFallbackUrl:
          type: string
          description: The URL to request if errors occur when fetching SmsUrl.
          example: http://example.com/sms-fallback
        SmsMethod:
          type: string
          enum:
            - GET
            - POST
          description: Whether the request to SmsUrl is a `GET` or a `POST`.
          example: POST
        SmsUrl:
          type: string
          description: The URL to request when an incoming SMS is received.
          example: http://example.com/sms
        StatusCallback:
          type: string
          description: The URL to request to pass status updates to.
          example: example.com
        StatusCallbackMethod:
          type: string
          enum:
            - GET
            - POST
          description: Whether the request to StatusCallback is a `GET` or a `POST`.
          example: POST
        TrunkSid:
          type: string
          description: The unique identifier for the Trunk associated with this phone number.
          example: b3877c40-da60-4998-90ad-b792e98472tr
        VoiceApplicationSid:
          type: string
          description: The unique identifier for the application associated with call handling on this phone number.
          example: b3877c40-da60-4998-90ad-b792e98472va
        VoiceCallerIdLookup:
          type: boolean
          description: Whether or not to look up a caller's name in the database.
          example: false
        VoiceFallbackMethod:
          type: string
          enum:
            - GET
            - POST
          description: Whether the request to VoiceFallbackUrl is a `GET` or a `POST`.
          example: POST
        VoiceFallbackUrl:
          type: string
          description: The URL to request if errors occur when fetching `Url`.
          example: example.com
        VoiceMethod:
          type: string
          enum:
            - GET
            - POST
          description: Whether the request to Url is a `GET` or a `POST`.
          example: POST
        VoiceReceiveMode:
          type: string
          enum:
            - voice
            - fax
          description: Whether this number can receive calls or fax. Possible values are voice or fax.
          example: voice
        VoiceUrl:
          type: string
          description: The URL to request when an incoming call is received.
          example: http://your-application.com/docs/voice.xml
      description: Request body for updating an incoming phone number.
    UpdateLamlBinRequest:
      type: object
      required:
        - Name
      properties:
        Name:
          type: string
          description: A friendly name given to the cXML bin.
          example: Death Star IVR
        Contents:
          type: string
          description: The contents of the cXML bins.
          example: <Response><Say>Hello!</Say></Response>
      description: Request body for updating a cXML Bin.
    UpdateMessageRequest:
      type: object
      required:
        - Body
      properties:
        Body:
          type: string
          description: The text of the message.
          example: ''
      description: Request body for updating a message.
    UpdateQueueRequest:
      type: object
      required:
        - FriendlyName
      properties:
        FriendlyName:
          type: string
          description: A description that distinguishes a queue.
          example: Queue1
        MaxSize:
          type: string
          description: The maximum number of calls that are allowed to wait in a queue.
          example: '123'
      description: Request body for updating a queue.
    UpdateTokenRequest:
      type: object
      properties:
        name:
          type: string
          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. Valid permissions are calling, chat, 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: ''