_spec_.yaml

openapi: 3.0.3
info:
  version: 1.0.0
  title: RELAY REST API (previous version)
  description: >
    Welcome to SignalWire's Relay REST API. Relay is the next generation of
    interactive communication APIs available at SignalWire, and the REST API is
    a set of endpoints that make interacting with Relay, simple and familiar.
  termsOfService: https://signalwire.com/legal/signalwire-cloud-agreement
externalDocs:
  url: https://developer.signalwire.com
  description: Find more information about this and other SignalWire APIs.
servers:
  - url: https://{space_name}.signalwire.com/api/relay/rest
    variables:
      space_name:
        default: YOUR_SPACE
        description: Your SignalWire Space's subdomain.
security:
  - basic_auth: []
components:
  securitySchemes:
    basic_auth:
      type: http
      scheme: basic
  responses:
    '204':
      description: No Content
    '400':
      description: Bad Request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error'
    '401':
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error'
    '422':
      description: Unprocessable Entity
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error'
  schemas:
    domain_app_call_handlers:
      oneOf:
        - type: object
          properties:
            call_handler:
              type: string
              enum: [relay_topic]
              description: Specifies that this domain application uses a Relay topic handler
            call_relay_topic:
              type: string
              description: A string representing the Relay topic to forward incoming calls to.
              example: 'office'
            call_relay_topic_status_callback_url:
              type: string
              description: A string representing a URL to send status change messages to.
              example: "https://myapplication/handle_relay_callbacks"
          required:
            - call_handler
            - call_relay_topic

        - type: object
          properties:
            call_handler:
              type: string
              enum: [relay_application]
              description: Specifies that this domain application uses a Relay application handler
            call_relay_application:
              type: string
              description: A string representing the Relay Application to forward incoming calls to.
              example: 'my-relay-app'
          required:
            - call_handler
            - call_relay_application

        - type: object
          properties:
            call_handler:
              type: string
              enum: [laml_webhooks]
              description: Specifies that this domain application uses LaML webhooks
            call_request_url:
              type: string
              description: A string representing the LaML URL to access when a call is received.
              example: "https://example.com/laml"
            call_request_method:
              type: string
              enum: [GET, POST]
              description: A string representing the HTTP method to use with `call_request_url`.
              example: POST
            call_fallback_url:
              type: string
              description: A string representing the LaML URL to access when the call to `call_request_url` fails.
              example: "https://example.com/fallback"
            call_fallback_method:
              type: string
              enum: [GET, POST]
              description: A string representing the HTTP method to use with `call_fallback_url`.
              example: POST
            call_status_callback_url:
              type: string
              description: A string representing a URL to send status change messages to.
              example: "https://example.com/status"
            call_status_callback_method:
              type: string
              enum: [GET, POST]
              description: A string representing the HTTP method to use with `call_status_callback_url`.
              example: POST
          required:
            - call_handler
            - call_request_url
            - call_request_method

        - type: object
          properties:
            call_handler:
              type: string
              enum: [laml_application]
              description: Specifies that this domain application uses a LaML application
            call_laml_application_id:
              type: string
              description: A string representing the ID of the LaML application to forward incoming calls to.
              example: "app-123456"
          required:
            - call_handler
            - call_laml_application_id

        - type: object
          properties:
            call_handler:
              type: string
              enum: [video_room]
              description: Specifies that this domain application uses a Video Room
            call_video_room_id:
              type: string
              format: uuid
              description: A string representing the ID of the Video Room to forward incoming calls to.
              example: fe4093d9-58c2-4931-b4b9-5679f82652c6
          required:
            - call_handler
            - call_video_room_id

        - type: object
          properties:
            call_handler:
              type: string
              enum: [relay_script]
              description: Specifies that this domain application uses a Relay script
            call_relay_script_url:
              type: string
              description: A string representing the URL of the Relay script to execute when a call is received.
              example: "https://example.com/relay-script"
          required:
            - call_handler
            - call_relay_script_url

        - type: object
          properties:
            call_handler:
              type: string
              enum: [dialogflow]
              description: Specifies that this domain application uses a Dialogflow agent
            call_dialogflow_agent_id:
              type: string
              format: uuid
              description: A string representing the ID of the Dialogflow Agent to forward incoming calls to.
              example: fe4093d9-58c2-4931-b4b9-5679f82652c6
          required:
            - call_handler
            - call_dialogflow_agent_id

        - type: object
          properties:
            call_handler:
              type: string
              enum: [ai_agent]
              description: Specifies that this domain application uses an AI agent
            call_ai_agent_id:
              type: string
              format: uuid
              description: A string representing the ID of the AI Agent to forward incoming calls to.
              example: fe4093d9-58c2-4931-b4b9-5679f82652c6
          required:
            - call_handler
            - call_ai_agent_id

        - type: object
          properties:
            call_handler:
              type: string
              enum: [call_flow]
              description: Specifies that this domain application uses a Call Flow
            call_flow_id:
              type: string
              format: uuid
              description: A string representing the ID of the Call Flow to forward incoming calls to.
              example: fe4093d9-58c2-4931-b4b9-5679f82652c6
            call_flow_version:
              type: string
              enum: [working_copy, current_deployed]
              description: A string representing the version of your Call Flow you'd like to use.
              example: working_copy
          required:
            - call_handler
            - call_flow_id

        - type: object
          properties:
            call_handler:
              type: string
              enum: [relay_context]
              description: Specifies that this domain application uses a Relay context (Deprecated)
            call_relay_context:
              type: string
              description: >-
                A string representing the Relay context to forward incoming calls to.
                This handler type is deprecated.
              example: 'office'
              deprecated: true
            call_relay_context_status_callback_url:
              type: string
              description: >-
                A string representing a URL to send status change messages to.
                This property is deprecated.
              example: "https://myapplication/handle_relay_callbacks"
              deprecated: true
          required:
            - call_handler
            - call_relay_context
    QueueMember:
      type: object
      properties:
        call_id:
          type: string
          format: uuid
          example: "596e2dea-a269-4765-a0b4-01b82d11c120"
        date_enqueued:
          type: string
          format: date-time
          description: When the queue member was last enqueued.
          example: "2025-06-22T17:44:08.126Z"
        position:
          type: integer
          description: Queue member position in the queue.
          example: 2
        uri:
          type: string
          description: The URL of this queue member.
          example: "/api/relay/rest/queues/596e2dea-a269-4765-a0b4-01b82d11c120/members/596e2dea-a269-4765-a0b4-01b82d11c120"
        wait_time:
          type: integer
          description: Wait time in seconds since the member was enqueued. If not yet enqueued, it will be null.
          example: 172975
        project_id:
          type: string
          description: The ID of the project associated with this queue member.
          example: "d421473b-d696-449a-a1a1-4ddd83d2d0e5"
        queue_id:
          type: string
          description: The ID of the queue associated with this queue member.
          example: "596e2dea-a269-4765-a0b4-01b82d11c120"
      required:
      - call_id
      - position
      - uri
      - project_id
      - queue_id
    error:
      type: object
      properties:
        type:
          type: string
        code:
          type: string
        message:
          type: string
        attribute:
          type: string
        url:
          type: string
          format: uri
      required:
        - type
        - code
        - message
        - url
      example:
        type: validation_error
        code: invalid_parameter
        message: Name must be present
        attribute: name
        url: https://developer.signalwire.com/rest/signalwire-rest/overview/error-codes#field-invalid-parameter
    pagination:
      type: object
      properties:
        self:
          type: string
          example: /api/relay/rest/queues?page_number=0&page_size=50
        first:
          type: string
          example: /api/relay/rest/queues?page_size=50
        next:
          type: string
          example: /api/relay/rest/queues?page_number=1&page_size=50&page_token=PAbff61159-faab-48b3-959a-3021a8f5beca
        prev:
          type: string
          example: /api/relay/rest/queues?page_number=0&page_size=50&page_token=PAbff61159-faab-48b3-959a-3021a8f5beca
    RecordingListResponse:
      type: object
      required:
        - data
        - links
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/RecordingResponse'
        links:
          $ref: '#/components/schemas/RecordingPaginationResponse'
    RecordingPaginationResponse:
      type: object
      required:
        - self
        - first
        - next
      properties:
        self:
          type: string
          format: uri
          example: https://{space_name}.signalwire.com/api/relay/rest/recordings?page_number=0&page_size=50
          description: Link of the current page
        first:
          type: string
          format: uri
          example: https://{space_name}.signalwire.com/api/relay/rest/recordings?page_number=0&page_size=50
          description: Link to the first page
        next:
          type: string
          format: uri
          example: https://{space_name}.signalwire.com/api/relay/rest/recordings?page_number=1&page_size=50&page_token=PAbff61159-faab-48b3-959a-3021a8f5beca
          description: Link to the next page
    RecordingResponse:
      oneOf:
        - type: object
          title: PSTN
          required:
            - relay_pstn_leg_id
          properties:
            relay_pstn_leg_id:
              type: string
              format: uuid
              description: ID of the PSTN leg associated with the recording.
        - type: object
          title: SIP
          required:
            - relay_sip_leg_id
          properties:
            relay_sip_leg_id:
              type: string
              format: uuid
              description: ID of the SIP leg associated with the recording.
        - type: object
          title: WebRTC
          required:
            - relay_webrtc_leg_id
          properties:
            relay_webrtc_leg_id:
              type: string
              format: uuid
              description: ID of the WebRTC leg associated with the recording.
      allOf:
        - type: object
          required:
            - id
            - project_id
            - created_at
            - updated_at
            - duration_in_seconds
            - error_code
            - price
            - price_unit
            - status
            - url
            - stereo
            - byte_size
            - track
          properties:
            id:
              type: string
              example: d369a402-7b43-4512-8735-9d5e1f387814
              description: Unique ID of the recording.
            project_id:
              type: string
              example: d369a402-7b43-4512-8735-9d5e1f387814
              description: Unique ID of the project.
            created_at:
              type: string
              format: date-time
              example: 2024-10-17T14:14:53Z
              description: Date and time when the recording was created.
            updated_at:
              type: string
              format: date-time
              example: 2024-10-17T14:14:53Z
              description: Date and time when the recording was last updated.
            duration_in_seconds:
              type: integer
              format: int32
              example: 2
              description: Duration of the recording in seconds.
            error_code:
              type: string
              nullable: true
              example: null
              description: Error code if the recording failed.
            price:
              type: number
              example: 0.05
              description: Price of the recording.
            price_unit:
              type: string
              example: USD
              description: Currency unit for the price.
            status:
              type: string
              example: completed
              description: Status of the recording.
            url:
              type: string
              format: uri
              example: https://example.com/recording.mp3
              description: URL of the recording file.
            stereo:
              type: boolean
              example: false
              description: Indicates whether the recording is stereo.
            byte_size:
              type: integer
              format: int32
              nullable: true
              example: 10
              description: Size of the recording file in bytes.
            track:
              type: string
              example: inbound
              description: Audio track of the recording.
    uuid:
      type: string
      format: uuid
      description: Universal Unique Identifier.
    Queue:
      type: object
      required:
        - id
        - project_id
        - friendly_name
        - uri
      properties:
        id:
          type: string
          format: uuid
          example: aae131db-214c-46f5-88b6-92004f8467cf
        project_id:
          type: string
          format: uuid
          example: c6c4679b-716a-456a-9e41-a03821005005
        average_wait_time:
          type: integer
          format: int32
          example: 0
        current_size:
          type: integer
          format: int32
          example: 0
        date_created:
          type: string
          format: date-time
          example: 2025-05-30T15:16:52Z
        date_updated:
          type: string
          format: date-time
          example: 2025-05-30T15:16:52Z
        friendly_name:
          type: string
          example: test
        max_size:
          type: integer
          format: int32
          example: 5
        uri:
          type: string
          format: uri
          example: /api/relay/rest/queues/aae131db-214c-46f5-88b6-92004f8467cf
    QueueListResponse:
      type: object
      required:
        - data
        - links
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Queue'
        links:
          $ref: '#/components/schemas/pagination'
    UpdateQueueRequest:
      type: object
      properties:
        name:
          type: string
          example: Name 2
        max_size:
          type: integer
          format: int32
          example: 600
  parameters:
    RecordingPathID:
      name: id
      in: path
      required: true
      description: Unique ID of a Recording.
      schema:
        $ref: '#/components/schemas/uuid'
    QueuePathID:
      name: id
      in: path
      required: true
      description: Unique ID of a Queue.
      schema:
        $ref: '#/components/schemas/uuid'
    
tags:
  - name: Addresses
  - name: Campaign Registry (Beta)
  - name: Domain Applications
  - name: Number Groups
  - name: Number Group Membership
  - name: Phone Numbers
  - name: Imported Phone Numbers
  - name: Phone Number Lookup
  - name: Recordings
  - name: Signalwire Access Tokens
  - name: SIP Endpoints
  - name: SIP Profile
  - name: Multi-Factor Authentication
    description: >
      Multi-factor authentication, commonly known as MFA, adds security to your
      application by requesting a user to be verified via voice or via text
      message.


      It can also be used for One Time Password flows (OTP).


      SignalWire will place a voice call or send a message to the destination
      you specify, and create an unique code for them. When your application
      receives input from the user, it will use the verification endpoint to
      check that the ID for the request and the token match. The API keeps track
      of attempts.
  - name: Verified Caller IDs
    description: >
      This is an object that represents a phone number that is not purchased
      through SignalWire. In order place a call from a phone number not
      purchased through SignalWire, you must first verify that you are the owner
      of that number. For more information on Verified Caller IDs you can [read
      about
      them](https://signalwire.com/blogs/product/verified-caller-id-local-number-portability).


      ### How This Works

      In order to use a number that you have not purchased through SignalWire as
      a Caller ID, value you must first verify that you own that number. You are
      limited to 10 calls to a given number with a one week period.

       1. Create a Verified Caller ID Object using the appropriate REST endpoint.
       2. The SignalWire platform will place a call to the phone number that you specified.
         * You may request a redial by submitting a request to the Redial Verification Call Endpoint.
       3. When the phone is answered, we will read a six-digit code.
       4. To verify that you are the owner, take that number and submit it to the Validate Verifications Endpoint.
         * You have 5 attempts to enter the code correctly.
  - name: Queues
paths:
  /addresses:
    get:
      operationId: list_addresses
      summary: List all Addresses.
      description: >
        Returns a list of your Addresses. The addresses are returned sorted by
        creation date, with the most recent appearing first.


        #### Permissions

        The API token must include the following scopes: _Numbers_.
      tags:
        - Addresses
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  links:
                    type: object
                    properties:
                      self:
                        type: string
                      first:
                        type: string
                      next:
                        type: string
                      prev:
                        type: string
                  data:
                    type: array
                    items:
                      allOf:
                        - type: object
                          properties:
                            id:
                              type: string
                              description: >-
                                The unique identifier of the Address on
                                SignalWire. This can be used to show or delete
                                the address programmatically.
                              format: uuid
                          required:
                            - id
                        - type: object
                          properties:
                            label:
                              type: string
                              description: >-
                                A friendly name given to the address to help
                                distinguish and search for different addresses
                                within your project.
                              example: My Address
                            country:
                              type: string
                              description: >-
                                The [ISO 3166 Alpha
                                2](https://www.iban.com/country-codes) country
                                code.
                              example: US
                            first_name:
                              type: string
                              description: >-
                                First name of the occupant associated with this
                                address.
                              example: Emmett
                            last_name:
                              type: string
                              description: >-
                                Last name of the occupant associated with this
                                address.
                              example: Brown
                            street_number:
                              type: string
                              description: The number portion of the street address.
                              example: '1640'
                            street_name:
                              type: string
                              description: The name portion of the street address.
                              example: Riverside Drive
                            address_type:
                              type: string
                              description: >-
                                (Optional) If the address is divided into
                                multiple sub-addresses, such as an apartment or
                                office building, this identifies how the address
                                is divided. If the address is a single occupant
                                address, `address_type` may be omitted. Possible
                                values are: `Apartment`, `Basement`, `Building`,
                                `Department`, `Floor`, `Office`, `Penthouse`,
                                `Suite`, `Trailer`, `Unit`.
                              example: Apartment
                            address_number:
                              type: string
                              description: >-
                                (Optional) If the address is divided into
                                multiple sub-addresses, such as an apartment or
                                office building, this identifies the particular
                                sub-address. If the address is a single occupant
                                address, `address_number` may be omitted.
                              example: '42'
                            city:
                              type: string
                              description: The city portion of the street address.
                              example: Alexandria
                            state:
                              type: string
                              description: >-
                                The state/province/region of the street address.
                                In the USA and Canada, use the two-letter
                                abbreviated form, such as `CA` for California.
                              example: CA
                            postal_code:
                              type: string
                              description: The postal code of the street address.
                              example: '91905'
                          required:
                            - label
                            - country
                            - first_name
                            - last_name
                            - street_number
                            - street_name
                            - city
                            - state
                            - postal_code
    post:
      operationId: create_address
      summary: Create an address
      description: |
        To create a new Address, make a POST request to the Address resource.

        #### Permissions
        The API token must include the following scopes: _Numbers_.
      tags:
        - Addresses
      requestBody:
        required: true
        content:
          application/json:
            schema:
              allOf:
                - type: object
                  properties:
                    label:
                      type: string
                      description: >-
                        A friendly name given to the address to help distinguish
                        and search for different addresses within your project.
                      example: My Address
                    country:
                      type: string
                      description: >-
                        The [ISO 3166 Alpha
                        2](https://www.iban.com/country-codes) country code.
                      example: US
                    first_name:
                      type: string
                      description: First name of the occupant associated with this address.
                      example: Emmett
                    last_name:
                      type: string
                      description: Last name of the occupant associated with this address.
                      example: Brown
                    street_number:
                      type: string
                      description: The number portion of the street address.
                      example: '1640'
                    street_name:
                      type: string
                      description: The name portion of the street address.
                      example: Riverside Drive
                    address_type:
                      type: string
                      description: >-
                        (Optional) If the address is divided into multiple
                        sub-addresses, such as an apartment or office building,
                        this identifies how the address is divided. If the
                        address is a single occupant address, `address_type` may
                        be omitted. Possible values are: `Apartment`,
                        `Basement`, `Building`, `Department`, `Floor`, `Office`,
                        `Penthouse`, `Suite`, `Trailer`, `Unit`.
                      example: Apartment
                    address_number:
                      type: string
                      description: >-
                        (Optional) If the address is divided into multiple
                        sub-addresses, such as an apartment or office building,
                        this identifies the particular sub-address. If the
                        address is a single occupant address, `address_number`
                        may be omitted.
                      example: '42'
                    city:
                      type: string
                      description: The city portion of the street address.
                      example: Alexandria
                    state:
                      type: string
                      description: >-
                        The state/province/region of the street address. In the
                        USA and Canada, use the two-letter abbreviated form,
                        such as `CA` for California.
                      example: CA
                    postal_code:
                      type: string
                      description: The postal code of the street address.
                      example: '91905'
                  required:
                    - label
                    - country
                    - first_name
                    - last_name
                    - street_number
                    - street_name
                    - city
                    - state
                    - postal_code
      responses:
        '201':
          description: CREATED
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      id:
                        type: string
                        description: >-
                          The unique identifier of the Address on SignalWire.
                          This can be used to show or delete the address
                          programmatically.
                        format: uuid
                    required:
                      - id
                  - type: object
                    properties:
                      label:
                        type: string
                        description: >-
                          A friendly name given to the address to help
                          distinguish and search for different addresses within
                          your project.
                        example: My Address
                      country:
                        type: string
                        description: >-
                          The [ISO 3166 Alpha
                          2](https://www.iban.com/country-codes) country code.
                        example: US
                      first_name:
                        type: string
                        description: >-
                          First name of the occupant associated with this
                          address.
                        example: Emmett
                      last_name:
                        type: string
                        description: >-
                          Last name of the occupant associated with this
                          address.
                        example: Brown
                      street_number:
                        type: string
                        description: The number portion of the street address.
                        example: '1640'
                      street_name:
                        type: string
                        description: The name portion of the street address.
                        example: Riverside Drive
                      address_type:
                        type: string
                        description: >-
                          (Optional) If the address is divided into multiple
                          sub-addresses, such as an apartment or office
                          building, this identifies how the address is divided.
                          If the address is a single occupant address,
                          `address_type` may be omitted. Possible values are:
                          `Apartment`, `Basement`, `Building`, `Department`,
                          `Floor`, `Office`, `Penthouse`, `Suite`, `Trailer`,
                          `Unit`.
                        example: Apartment
                      address_number:
                        type: string
                        description: >-
                          (Optional) If the address is divided into multiple
                          sub-addresses, such as an apartment or office
                          building, this identifies the particular sub-address.
                          If the address is a single occupant address,
                          `address_number` may be omitted.
                        example: '42'
                      city:
                        type: string
                        description: The city portion of the street address.
                        example: Alexandria
                      state:
                        type: string
                        description: >-
                          The state/province/region of the street address. In
                          the USA and Canada, use the two-letter abbreviated
                          form, such as `CA` for California.
                        example: CA
                      postal_code:
                        type: string
                        description: The postal code of the street address.
                        example: '91905'
                    required:
                      - label
                      - country
                      - first_name
                      - last_name
                      - street_number
                      - street_name
                      - city
                      - state
                      - postal_code
  /addresses/{id}:
    get:
      operationId: get_address
      summary: Retrieve an Address
      description: >
        Retrieves the details of an Address that has been previously created.

        Use the unique ID that was returned from your previous request to
        identify the specific instance.


        #### Permissions

        The API token must include the following scopes: _Numbers_.
      tags:
        - Addresses
      parameters:
        - name: id
          in: path
          description: Unique ID of the address
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      id:
                        type: string
                        description: >-
                          The unique identifier of the Address on SignalWire.
                          This can be used to show or delete the address
                          programmatically.
                        format: uuid
                    required:
                      - id
                  - type: object
                    properties:
                      label:
                        type: string
                        description: >-
                          A friendly name given to the address to help
                          distinguish and search for different addresses within
                          your project.
                        example: My Address
                      country:
                        type: string
                        description: >-
                          The [ISO 3166 Alpha
                          2](https://www.iban.com/country-codes) country code.
                        example: US
                      first_name:
                        type: string
                        description: >-
                          First name of the occupant associated with this
                          address.
                        example: Emmett
                      last_name:
                        type: string
                        description: >-
                          Last name of the occupant associated with this
                          address.
                        example: Brown
                      street_number:
                        type: string
                        description: The number portion of the street address.
                        example: '1640'
                      street_name:
                        type: string
                        description: The name portion of the street address.
                        example: Riverside Drive
                      address_type:
                        type: string
                        description: >-
                          (Optional) If the address is divided into multiple
                          sub-addresses, such as an apartment or office
                          building, this identifies how the address is divided.
                          If the address is a single occupant address,
                          `address_type` may be omitted. Possible values are:
                          `Apartment`, `Basement`, `Building`, `Department`,
                          `Floor`, `Office`, `Penthouse`, `Suite`, `Trailer`,
                          `Unit`.
                        example: Apartment
                      address_number:
                        type: string
                        description: >-
                          (Optional) If the address is divided into multiple
                          sub-addresses, such as an apartment or office
                          building, this identifies the particular sub-address.
                          If the address is a single occupant address,
                          `address_number` may be omitted.
                        example: '42'
                      city:
                        type: string
                        description: The city portion of the street address.
                        example: Alexandria
                      state:
                        type: string
                        description: >-
                          The state/province/region of the street address. In
                          the USA and Canada, use the two-letter abbreviated
                          form, such as `CA` for California.
                        example: CA
                      postal_code:
                        type: string
                        description: The postal code of the street address.
                        example: '91905'
                    required:
                      - label
                      - country
                      - first_name
                      - last_name
                      - street_number
                      - street_name
                      - city
                      - state
                      - postal_code
    delete:
      operationId: delete_address
      summary: Delete an Address
      description: >
        Removes an Address for your account's active addresses but the address
        will continue to be associated with any numbers it was applied to.

        For example, if an address is associated as the E911 address of a phone
        number and the address is then deleted from your project,

        it will stay associated as the E911 address for that number.


        #### Permissions

        The API token must include the following scopes: _Numbers_.
      tags:
        - Addresses
      parameters:
        - name: id
          in: path
          description: Unique ID of the address
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '204':
          description: No Content
  /registry/beta/brands:
    post:
      operationId: create_brand
      summary: Create a Brand
      description: |
        You can register your brand with The Campaign Registry by sending a
        POST request to our Brand resource including all of the parameters
        except for `csp_brand_reference` and `csp_self_registered`.

        If you have already registered your brand directly with The Campaign
        Registry, you can create a self-registered brand via our Create Brand
        API by sending a POST request to our brand resource including only the
        `name`, `csp_brand_reference`, and `csp_self_registered` parameters.

        **This is a Beta endpoint that may change or be removed in the
        future.**

        #### Permissions
        The API token must include the following scopes: _Messaging_.
      tags:
        - Campaign Registry (Beta)
      requestBody:
        required: true
        content:
          application/json:
            schema:
              allOf:
                - type: object
                  properties:
                    name:
                      type: string
                      description: Brand/Marketing/DBA name of the business if applicable..
                      example: My Brand
                    company_name:
                      type: string
                      description: The legal name of the business.
                      example: BrandCo
                    contact_email:
                      type: string
                      description: A company contact email for this brand.
                      example: brand_info@example.com
                    contact_phone:
                      type: string
                      description: A contact phone number for this brand.
                      example: '+18995551212'
                    ein_issuing_country:
                      type: string
                      description: Country of registration.
                      example: United States
                    legal_entity_type:
                      type: string
                      description: >-
                        What type of legal entity is the organization?
                        (`PRIVATE_PROFIT`, `PUBLIC_PROFIT`, `NON_PROFIT`)
                      example: Private Company
                    ein:
                      type: string
                      description: Company EIN Number/Tax ID
                      example: 12-3456789
                    company_address:
                      type: string
                      description: Full company address.
                      example: 123 Brand St, Hill Valley CA, 91905
                    company_vertical:
                      type: string
                      description: >-
                        An optional Vertical for the brand (`REAL_ESTATE`,
                        `HEALTHCARE`, `ENERGY`, `ENTERTAINMENT`, `RETAIL`,
                        `AGRICULTURE`, `INSURANCE`, `EDUCATION`, `HOSPITALITY`,
                        `FINANCIAL`, `GAMBLING`, `CONSTRUCTION`, `NGO`,
                        `MANUFACTURING`, `GOVERNMENT`, `TECHNOLOGY`,
                        `COMMUNICATION`).
                      example: Healthcare
                    company_website:
                      type: string
                      description: Link to the company website.
                      example: www.example.com
                    csp_brand_reference:
                      type: string
                      description: >-
                        If you are your own Campaign Service Provider, this is
                        the approved Brand ID (Mandatory for CSPs, otherwise
                        please omit)
                      example: null
                    csp_self_registered:
                      type: boolean
                      description: This value must be true for all self-registered brands.
                      example: false
                    status_callback_url:
                      type: string
                      description: >-
                        Optional: Specify a URL to receive webhook notifications
                        when your brand’s state changes.
                      example: https//example.com/handle_callback
      responses:
        '201':
          description: CREATED
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      id:
                        type: string
                        description: The unique id of the brand.
                        format: uuid
                    required:
                      - id
                  - type: object
                    properties:
                      state:
                        type: string
                        description: The current state of the brand.
                        example: pending
                  - type: object
                    properties:
                      name:
                        type: string
                        description: >-
                          Brand/Marketing/DBA name of the business if
                          applicable..
                        example: My Brand
                      company_name:
                        type: string
                        description: The legal name of the business.
                        example: BrandCo
                      contact_email:
                        type: string
                        description: A company contact email for this brand.
                        example: brand_info@example.com
                      contact_phone:
                        type: string
                        description: A contact phone number for this brand.
                        example: '+18995551212'
                      ein_issuing_country:
                        type: string
                        description: Country of registration.
                        example: United States
                      legal_entity_type:
                        type: string
                        description: >-
                          What type of legal entity is the organization?
                          (`PRIVATE_PROFIT`, `PUBLIC_PROFIT`, `NON_PROFIT`)
                        example: Private Company
                      ein:
                        type: string
                        description: Company EIN Number/Tax ID
                        example: 12-3456789
                      company_address:
                        type: string
                        description: Full company address.
                        example: 123 Brand St, Hill Valley CA, 91905
                      company_vertical:
                        type: string
                        description: >-
                          An optional Vertical for the brand (`REAL_ESTATE`,
                          `HEALTHCARE`, `ENERGY`, `ENTERTAINMENT`, `RETAIL`,
                          `AGRICULTURE`, `INSURANCE`, `EDUCATION`,
                          `HOSPITALITY`, `FINANCIAL`, `GAMBLING`,
                          `CONSTRUCTION`, `NGO`, `MANUFACTURING`, `GOVERNMENT`,
                          `TECHNOLOGY`, `COMMUNICATION`).
                        example: Healthcare
                      company_website:
                        type: string
                        description: Link to the company website.
                        example: www.example.com
                      csp_brand_reference:
                        type: string
                        description: >-
                          If you are your own Campaign Service Provider, this is
                          the approved Brand ID (Mandatory for CSPs, otherwise
                          please omit)
                        example: null
                      csp_self_registered:
                        type: boolean
                        description: >-
                          This value must be true for all self-registered
                          brands.
                        example: false
                      status_callback_url:
                        type: string
                        description: >-
                          Optional: Specify a URL to receive webhook
                          notifications when your brand’s state changes.
                        example: https//example.com/handle_callback
                  - type: object
                    properties:
                      created_at:
                        type: string
                        format: date-time
                      updated_at:
                        type: string
                        format: date-time
    get:
      operationId: list_brands
      summary: List all Brands.
      description: |
        Returns a list of your Brands. The brands are returned sorted by
        creation date, with the most recent appearing first. The list is
        filterable by sending in any of the following parameters.

        #### Permissions
        The API token must include the following scopes: _Messaging_.
      tags:
        - Campaign Registry (Beta)
      parameters:
        - name: filter_name
          in: query
          description: >-
            The name given to the brand. Will return all Brands containing this
            value as a substring.
          required: false
          schema:
            type: string
        - name: filter_state
          in: query
          description: >-
            The state of the brand in the registration process, such as pending
            or complete. Will return all Brands with this value.
          required: false
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  links:
                    type: object
                    properties:
                      self:
                        type: string
                      first:
                        type: string
                      next:
                        type: string
                      prev:
                        type: string
                  data:
                    type: array
                    items:
                      allOf:
                        - type: object
                          properties:
                            id:
                              type: string
                              description: The unique id of the brand.
                              format: uuid
                          required:
                            - id
                        - type: object
                          properties:
                            state:
                              type: string
                              description: The current state of the brand.
                              example: pending
                        - type: object
                          properties:
                            name:
                              type: string
                              description: >-
                                Brand/Marketing/DBA name of the business if
                                applicable..
                              example: My Brand
                            company_name:
                              type: string
                              description: The legal name of the business.
                              example: BrandCo
                            contact_email:
                              type: string
                              description: A company contact email for this brand.
                              example: brand_info@example.com
                            contact_phone:
                              type: string
                              description: A contact phone number for this brand.
                              example: '+18995551212'
                            ein_issuing_country:
                              type: string
                              description: Country of registration.
                              example: United States
                            legal_entity_type:
                              type: string
                              description: >-
                                What type of legal entity is the organization?
                                (`PRIVATE_PROFIT`, `PUBLIC_PROFIT`,
                                `NON_PROFIT`)
                              example: Private Company
                            ein:
                              type: string
                              description: Company EIN Number/Tax ID
                              example: 12-3456789
                            company_address:
                              type: string
                              description: Full company address.
                              example: 123 Brand St, Hill Valley CA, 91905
                            company_vertical:
                              type: string
                              description: >-
                                An optional Vertical for the brand
                                (`REAL_ESTATE`, `HEALTHCARE`, `ENERGY`,
                                `ENTERTAINMENT`, `RETAIL`, `AGRICULTURE`,
                                `INSURANCE`, `EDUCATION`, `HOSPITALITY`,
                                `FINANCIAL`, `GAMBLING`, `CONSTRUCTION`, `NGO`,
                                `MANUFACTURING`, `GOVERNMENT`, `TECHNOLOGY`,
                                `COMMUNICATION`).
                              example: Healthcare
                            company_website:
                              type: string
                              description: Link to the company website.
                              example: www.example.com
                            csp_brand_reference:
                              type: string
                              description: >-
                                If you are your own Campaign Service Provider,
                                this is the approved Brand ID (Mandatory for
                                CSPs, otherwise please omit)
                              example: null
                            csp_self_registered:
                              type: boolean
                              description: >-
                                This value must be true for all self-registered
                                brands.
                              example: false
                            status_callback_url:
                              type: string
                              description: >-
                                Optional: Specify a URL to receive webhook
                                notifications when your brand’s state changes.
                              example: https//example.com/handle_callback
                        - type: object
                          properties:
                            created_at:
                              type: string
                              format: date-time
                            updated_at:
                              type: string
                              format: date-time
  /registry/beta/brands/{id}:
    get:
      operationId: retrieve_brand
      summary: Retrieve a Brand
      description: |
        Retrieves the details of a Brand that has been previously created. Use
        the unique ID that was returned from your previous request to identify
        the specific Brand.

        #### Permissions
        The API token must include the following scopes: _Messaging_.
      tags:
        - Campaign Registry (Beta)
      parameters:
        - name: id
          in: path
          description: Unique ID of the brand
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      id:
                        type: string
                        description: The unique id of the brand.
                        format: uuid
                    required:
                      - id
                  - type: object
                    properties:
                      state:
                        type: string
                        description: The current state of the brand.
                        example: pending
                  - type: object
                    properties:
                      name:
                        type: string
                        description: >-
                          Brand/Marketing/DBA name of the business if
                          applicable..
                        example: My Brand
                      company_name:
                        type: string
                        description: The legal name of the business.
                        example: BrandCo
                      contact_email:
                        type: string
                        description: A company contact email for this brand.
                        example: brand_info@example.com
                      contact_phone:
                        type: string
                        description: A contact phone number for this brand.
                        example: '+18995551212'
                      ein_issuing_country:
                        type: string
                        description: Country of registration.
                        example: United States
                      legal_entity_type:
                        type: string
                        description: >-
                          What type of legal entity is the organization?
                          (`PRIVATE_PROFIT`, `PUBLIC_PROFIT`, `NON_PROFIT`)
                        example: Private Company
                      ein:
                        type: string
                        description: Company EIN Number/Tax ID
                        example: 12-3456789
                      company_address:
                        type: string
                        description: Full company address.
                        example: 123 Brand St, Hill Valley CA, 91905
                      company_vertical:
                        type: string
                        description: >-
                          An optional Vertical for the brand (`REAL_ESTATE`,
                          `HEALTHCARE`, `ENERGY`, `ENTERTAINMENT`, `RETAIL`,
                          `AGRICULTURE`, `INSURANCE`, `EDUCATION`,
                          `HOSPITALITY`, `FINANCIAL`, `GAMBLING`,
                          `CONSTRUCTION`, `NGO`, `MANUFACTURING`, `GOVERNMENT`,
                          `TECHNOLOGY`, `COMMUNICATION`).
                        example: Healthcare
                      company_website:
                        type: string
                        description: Link to the company website.
                        example: www.example.com
                      csp_brand_reference:
                        type: string
                        description: >-
                          If you are your own Campaign Service Provider, this is
                          the approved Brand ID (Mandatory for CSPs, otherwise
                          please omit)
                        example: null
                      csp_self_registered:
                        type: boolean
                        description: >-
                          This value must be true for all self-registered
                          brands.
                        example: false
                      status_callback_url:
                        type: string
                        description: >-
                          Optional: Specify a URL to receive webhook
                          notifications when your brand’s state changes.
                        example: https//example.com/handle_callback
                  - type: object
                    properties:
                      created_at:
                        type: string
                        format: date-time
                      updated_at:
                        type: string
                        format: date-time
  /registry/beta/brands/{id}/campaigns:
    get:
      operationId: list_campaigns
      summary: List all Campaigns
      description: |
        Returns a list of the campaigns for a brand. The campaigns are
        returned sorted by creation date, with the most recent appearing
        first. The list is filterable by sending in any of the following
        parameters.

        #### Permissions
        The API token must include the following scopes: _Messaging_.
      tags:
        - Campaign Registry (Beta)
      parameters:
        - name: id
          in: path
          description: Unique ID of the brand
          required: true
          schema:
            type: string
            format: uuid
        - name: filter_name
          in: query
          description: >-
            The name given to the campaign. Will return all Campaigns containing
            this value as a substring.
          required: false
          schema:
            type: string
        - name: filter_state
          in: query
          description: >-
            The state of the campaign in the registration process, such as
            pending or complete. Will return all campaigns with this value.
          required: false
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  links:
                    type: object
                    properties:
                      self:
                        type: string
                      first:
                        type: string
                      next:
                        type: string
                      prev:
                        type: string
                  data:
                    type: array
                    items:
                      allOf:
                        - type: object
                          properties:
                            id:
                              type: string
                              description: The unique id of the campaign.
                              format: uuid
                          required:
                            - id
                        - type: object
                          properties:
                            name:
                              type: string
                              description: A name for the campaign.
                              example: My Campaign
                        - type: object
                          properties:
                            state:
                              type: string
                              description: The current state of the campaign.
                              example: pending
                        - type: object
                          properties:
                            sms_use_case:
                              type: string
                              description: >-
                                An SMS Use Case category for the campaign (2FA,
                                ACCOUNT_NOTIFICATION, AGENTS_FRANCHISES,
                                CARRIER_EXEMPT, CHARITY, CUSTOMER_CARE,
                                DELIVERY_NOTIFICATION, EMERGENCY, FRAUD_ALERT,
                                HIGHER_EDUCATION, K12_EDUCATION,
                                LOW_VOLUME_MIXED, MARKETING, MIXED, POLITICAL,
                                POLITICAL_SECTION_527, POLLING_VOTING, PROXY,
                                PUBLIC_SERVICE_ANNOUNCEMENT, SECURITY_ALERT,
                                SOCIAL, SWEEPSTAKE, TRIAL, UCAAS_HIGH_VOLUME,
                                UCAAS_LOW_VOLUME).
                              example: MARKETING
                            sub_use_cases:
                              type: array
                              items:
                                type: string
                              description: >-
                                A sub use case category for MIXED or
                                LOW_VOLUME_MIXED campaigns (CUSTOMER_CARE,
                                HIGHER_EDUCATION, POLLING_VOTING,
                                PUBLIC_SERVICE_ANNOUNCEMENT, MARKETING,
                                SECURITY_ALERT, 2FA, ACCOUNT_NOTIFICATION,
                                DELIVERY_NOTIFICATION, FRAUD_ALERT).
                              example:
                                - MARKETING
                                - 2FA
                            campaign_verify_token:
                              type: string
                              description: >-
                                Campaign Verifiy token. Required if sms use case
                                is POLITICAL_SECTION_527. (Some U.S. wireless
                                carriers require political committees to obtain
                                Campaign Verify verification in order to access
                                special political campaign classes for the new
                                10DLC text messaging routes. Visit
                                www.campaignverify.org for more information and
                                to obtain your token)
                              example: null
                            description:
                              type: string
                              description: >-
                                A description for the campaign. Please use at
                                least 40 characters.
                              example: null
                            sample1:
                              type: string
                              description: >-
                                Sample message template/content. At least two
                                samples are required and up to five can be
                                provided. Please use at least 20 characters.
                              example: >-
                                this is a sample message your customer might
                                receive
                            sample2:
                              type: string
                              description: Sample 2.
                              example: >-
                                this is a sample message your customer might
                                receive
                            sample3:
                              type: string
                              description: Sample 3.
                            sample4:
                              type: string
                              description: Sample 4.
                            sample5:
                              type: string
                              description: Sample 5.
                            dynamic_templates:
                              type: string
                              description: >-
                                If your messaging content will be modified in
                                any way beyond what you shared in your
                                templates, please describe the nature of how the
                                content will change.
                            message_flow:
                              type: string
                              description: >-
                                Please describe the call to action/message flow
                                your intended recipients will experience.
                              example: >-
                                Users will opt in to receive messages from their
                                doctor through a written form and we will send
                                them an opt in message. Appointment reminders
                                will then be sent ahead of their appointments.
                            opt_in_message:
                              type: string
                              description: >-
                                Please share the message subscribers receive
                                when they opt in.
                              example: >-
                                Thanks for subscribing. Reply STOP to cancel at
                                any time.
                            opt_out_message:
                              type: string
                              description: >-
                                Please share the message subscribers receive
                                when they opt out.
                              example: >-
                                You have successfully been opted out. Reply
                                START to opt back in at any time.
                            help_message:
                              type: string
                              description: >-
                                Please share the message subscribers receive
                                when they opt out.
                              example: >-
                                You have successfully been opted out. Reply
                                SUBSCRIBE to opt back in at any time.
                            opt_in_keywords:
                              type: string
                              description: >-
                                You can share any opt in keywords that
                                subscribers can use here. Default = START
                              example: Start,Subscribe,Opt In
                            opt_out_keywords:
                              type: string
                              description: >-
                                You can share any opt in keywords that
                                subscribers can use here. Default = STOP
                              example: Stop,Opt Out,Unsubscribe
                            help_keywords:
                              type: string
                              description: >-
                                You can share any help keywords that subscribers
                                can use here. Default = HELP
                              example: Help,Support,Request Call
                            number_pooling_required:
                              type: boolean
                              description: >-
                                Will 50 or more numbers be used with this single
                                campaign? If so, please enter true.
                              example: true
                            number_pooling_per_campaign:
                              type: string
                              description: >-
                                If you will be using number pooling, please
                                provide an explanation as to why it is needed.
                              example: >-
                                We have customer reps in every state and they
                                each need their own number with local area code.
                            direct_lending:
                              type: boolean
                              description: >-
                                Will this campaign include content related to
                                direct lending or other loan agreements?
                              example: true
                            embedded_link:
                              type: boolean
                              description: >-
                                Will you be using an embedded link of any kind?
                                Note that public URL shorteners (bitly, tinyurl)
                                will not be accepted.
                              example: false
                            embedded_phone:
                              type: boolean
                              description: >-
                                Are you using an embedded phone number (except
                                the required HELP information contact phone
                                number)?
                              example: false
                            age_gated_content:
                              type: boolean
                              description: >-
                                Will this campaign include any age gated content
                                as defined by carrier and CTA guidelines?
                              example: true
                            lead_generation:
                              type: boolean
                              description: >-
                                Is there any intent of this campaign to generate
                                leads?
                              example: true
                            csp_campaign_reference:
                              type: string
                              description: >-
                                If you are your own Campaign Service Provider,
                                what is the approved Campaign ID? (Mandatory for
                                CSPs, otherwise please omit)
                              example: '1231231'
                            status_callback_url:
                              type: string
                              description: >-
                                Optional: Specify a URL to receive webhook
                                notifications when your campaign’s state
                                changes.
                              example: https//example.com/handle_callback
                        - type: object
                          properties:
                            created_at:
                              type: string
                              format: date-time
                            updated_at:
                              type: string
                              format: date-time
    post:
      operationId: create_campaign
      summary: Create a Campaign
      description: |
        A Campaign belongs to a Brand.

        To create a new managed campaign, send a POST request to the Campaign
        resource with all of the parameters except for
        `csp_campaign_reference`.

        To create a new self-registered campaign, send a POST request to the
        same Campaign resource except that you only need to fill out the
        `name` and `csp_campaign_reference` parameters.

        *Please note: the `csp_self_registered` parameter has been deprecated
        and is no longer required.*

        #### Permissions
        The API token must include the following scopes: _Messaging_.
      tags:
        - Campaign Registry (Beta)
      parameters:
        - name: id
          in: path
          description: Unique ID of the brand
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              allOf:
                - type: object
                  properties:
                    name:
                      type: string
                      description: A name for the campaign.
                      example: My Campaign
                - type: object
                  properties:
                    sms_use_case:
                      type: string
                      description: >-
                        An SMS Use Case category for the campaign (2FA,
                        ACCOUNT_NOTIFICATION, AGENTS_FRANCHISES, CARRIER_EXEMPT,
                        CHARITY, CUSTOMER_CARE, DELIVERY_NOTIFICATION,
                        EMERGENCY, FRAUD_ALERT, HIGHER_EDUCATION, K12_EDUCATION,
                        LOW_VOLUME_MIXED, MARKETING, MIXED, POLITICAL,
                        POLITICAL_SECTION_527, POLLING_VOTING, PROXY,
                        PUBLIC_SERVICE_ANNOUNCEMENT, SECURITY_ALERT, SOCIAL,
                        SWEEPSTAKE, TRIAL, UCAAS_HIGH_VOLUME, UCAAS_LOW_VOLUME).
                      example: MARKETING
                    sub_use_cases:
                      type: array
                      items:
                        type: string
                      description: >-
                        A sub use case category for MIXED or LOW_VOLUME_MIXED
                        campaigns (CUSTOMER_CARE, HIGHER_EDUCATION,
                        POLLING_VOTING, PUBLIC_SERVICE_ANNOUNCEMENT, MARKETING,
                        SECURITY_ALERT, 2FA, ACCOUNT_NOTIFICATION,
                        DELIVERY_NOTIFICATION, FRAUD_ALERT).
                      example:
                        - MARKETING
                        - 2FA
                    campaign_verify_token:
                      type: string
                      description: >-
                        Campaign Verifiy token. Required if sms use case is
                        POLITICAL_SECTION_527. (Some U.S. wireless carriers
                        require political committees to obtain Campaign Verify
                        verification in order to access special political
                        campaign classes for the new 10DLC text messaging
                        routes. Visit www.campaignverify.org for more
                        information and to obtain your token)
                      example: null
                    description:
                      type: string
                      description: >-
                        A description for the campaign. Please use at least 40
                        characters.
                      example: null
                    sample1:
                      type: string
                      description: >-
                        Sample message template/content. At least two samples
                        are required and up to five can be provided. Please use
                        at least 20 characters.
                      example: this is a sample message your customer might receive
                    sample2:
                      type: string
                      description: Sample 2.
                      example: this is a sample message your customer might receive
                    sample3:
                      type: string
                      description: Sample 3.
                    sample4:
                      type: string
                      description: Sample 4.
                    sample5:
                      type: string
                      description: Sample 5.
                    dynamic_templates:
                      type: string
                      description: >-
                        If your messaging content will be modified in any way
                        beyond what you shared in your templates, please
                        describe the nature of how the content will change.
                    message_flow:
                      type: string
                      description: >-
                        Please describe the call to action/message flow your
                        intended recipients will experience.
                      example: >-
                        Users will opt in to receive messages from their doctor
                        through a written form and we will send them an opt in
                        message. Appointment reminders will then be sent ahead
                        of their appointments.
                    opt_in_message:
                      type: string
                      description: >-
                        Please share the message subscribers receive when they
                        opt in.
                      example: >-
                        Thanks for subscribing. Reply STOP to cancel at any
                        time.
                    opt_out_message:
                      type: string
                      description: >-
                        Please share the message subscribers receive when they
                        opt out.
                      example: >-
                        You have successfully been opted out. Reply START to opt
                        back in at any time.
                    help_message:
                      type: string
                      description: >-
                        Please share the message subscribers receive when they
                        opt out.
                      example: >-
                        You have successfully been opted out. Reply SUBSCRIBE to
                        opt back in at any time.
                    opt_in_keywords:
                      type: string
                      description: >-
                        You can share any opt in keywords that subscribers can
                        use here. Default = START
                      example: Start,Subscribe,Opt In
                    opt_out_keywords:
                      type: string
                      description: >-
                        You can share any opt in keywords that subscribers can
                        use here. Default = STOP
                      example: Stop,Opt Out,Unsubscribe
                    help_keywords:
                      type: string
                      description: >-
                        You can share any help keywords that subscribers can use
                        here. Default = HELP
                      example: Help,Support,Request Call
                    number_pooling_required:
                      type: boolean
                      description: >-
                        Will 50 or more numbers be used with this single
                        campaign? If so, please enter true.
                      example: true
                    number_pooling_per_campaign:
                      type: string
                      description: >-
                        If you will be using number pooling, please provide an
                        explanation as to why it is needed.
                      example: >-
                        We have customer reps in every state and they each need
                        their own number with local area code.
                    direct_lending:
                      type: boolean
                      description: >-
                        Will this campaign include content related to direct
                        lending or other loan agreements?
                      example: true
                    embedded_link:
                      type: boolean
                      description: >-
                        Will you be using an embedded link of any kind? Note
                        that public URL shorteners (bitly, tinyurl) will not be
                        accepted.
                      example: false
                    embedded_phone:
                      type: boolean
                      description: >-
                        Are you using an embedded phone number (except the
                        required HELP information contact phone number)?
                      example: false
                    age_gated_content:
                      type: boolean
                      description: >-
                        Will this campaign include any age gated content as
                        defined by carrier and CTA guidelines?
                      example: true
                    lead_generation:
                      type: boolean
                      description: Is there any intent of this campaign to generate leads?
                      example: true
                    csp_campaign_reference:
                      type: string
                      description: >-
                        If you are your own Campaign Service Provider, what is
                        the approved Campaign ID? (Mandatory for CSPs, otherwise
                        please omit)
                      example: '1231231'
                    status_callback_url:
                      type: string
                      description: >-
                        Optional: Specify a URL to receive webhook notifications
                        when your campaign’s state changes.
                      example: https//example.com/handle_callback
                - type: object
                  properties:
                    terms_and_conditions:
                      type: boolean
                      description: >-
                        I agree to the terms and conditions which do not allow
                        me to use this campaign for affiliate marketing.
                      example: true
      responses:
        '201':
          description: CREATED
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      id:
                        type: string
                        description: The unique id of the campaign.
                        format: uuid
                    required:
                      - id
                  - type: object
                    properties:
                      name:
                        type: string
                        description: A name for the campaign.
                        example: My Campaign
                  - type: object
                    properties:
                      state:
                        type: string
                        description: The current state of the campaign.
                        example: pending
                  - type: object
                    properties:
                      sms_use_case:
                        type: string
                        description: >-
                          An SMS Use Case category for the campaign (2FA,
                          ACCOUNT_NOTIFICATION, AGENTS_FRANCHISES,
                          CARRIER_EXEMPT, CHARITY, CUSTOMER_CARE,
                          DELIVERY_NOTIFICATION, EMERGENCY, FRAUD_ALERT,
                          HIGHER_EDUCATION, K12_EDUCATION, LOW_VOLUME_MIXED,
                          MARKETING, MIXED, POLITICAL, POLITICAL_SECTION_527,
                          POLLING_VOTING, PROXY, PUBLIC_SERVICE_ANNOUNCEMENT,
                          SECURITY_ALERT, SOCIAL, SWEEPSTAKE, TRIAL,
                          UCAAS_HIGH_VOLUME, UCAAS_LOW_VOLUME).
                        example: MARKETING
                      sub_use_cases:
                        type: array
                        items:
                          type: string
                        description: >-
                          A sub use case category for MIXED or LOW_VOLUME_MIXED
                          campaigns (CUSTOMER_CARE, HIGHER_EDUCATION,
                          POLLING_VOTING, PUBLIC_SERVICE_ANNOUNCEMENT,
                          MARKETING, SECURITY_ALERT, 2FA, ACCOUNT_NOTIFICATION,
                          DELIVERY_NOTIFICATION, FRAUD_ALERT).
                        example:
                          - MARKETING
                          - 2FA
                      campaign_verify_token:
                        type: string
                        description: >-
                          Campaign Verifiy token. Required if sms use case is
                          POLITICAL_SECTION_527. (Some U.S. wireless carriers
                          require political committees to obtain Campaign Verify
                          verification in order to access special political
                          campaign classes for the new 10DLC text messaging
                          routes. Visit www.campaignverify.org for more
                          information and to obtain your token)
                        example: null
                      description:
                        type: string
                        description: >-
                          A description for the campaign. Please use at least 40
                          characters.
                        example: null
                      sample1:
                        type: string
                        description: >-
                          Sample message template/content. At least two samples
                          are required and up to five can be provided. Please
                          use at least 20 characters.
                        example: this is a sample message your customer might receive
                      sample2:
                        type: string
                        description: Sample 2.
                        example: this is a sample message your customer might receive
                      sample3:
                        type: string
                        description: Sample 3.
                      sample4:
                        type: string
                        description: Sample 4.
                      sample5:
                        type: string
                        description: Sample 5.
                      dynamic_templates:
                        type: string
                        description: >-
                          If your messaging content will be modified in any way
                          beyond what you shared in your templates, please
                          describe the nature of how the content will change.
                      message_flow:
                        type: string
                        description: >-
                          Please describe the call to action/message flow your
                          intended recipients will experience.
                        example: >-
                          Users will opt in to receive messages from their
                          doctor through a written form and we will send them an
                          opt in message. Appointment reminders will then be
                          sent ahead of their appointments.
                      opt_in_message:
                        type: string
                        description: >-
                          Please share the message subscribers receive when they
                          opt in.
                        example: >-
                          Thanks for subscribing. Reply STOP to cancel at any
                          time.
                      opt_out_message:
                        type: string
                        description: >-
                          Please share the message subscribers receive when they
                          opt out.
                        example: >-
                          You have successfully been opted out. Reply START to
                          opt back in at any time.
                      help_message:
                        type: string
                        description: >-
                          Please share the message subscribers receive when they
                          opt out.
                        example: >-
                          You have successfully been opted out. Reply SUBSCRIBE
                          to opt back in at any time.
                      opt_in_keywords:
                        type: string
                        description: >-
                          You can share any opt in keywords that subscribers can
                          use here. Default = START
                        example: Start,Subscribe,Opt In
                      opt_out_keywords:
                        type: string
                        description: >-
                          You can share any opt in keywords that subscribers can
                          use here. Default = STOP
                        example: Stop,Opt Out,Unsubscribe
                      help_keywords:
                        type: string
                        description: >-
                          You can share any help keywords that subscribers can
                          use here. Default = HELP
                        example: Help,Support,Request Call
                      number_pooling_required:
                        type: boolean
                        description: >-
                          Will 50 or more numbers be used with this single
                          campaign? If so, please enter true.
                        example: true
                      number_pooling_per_campaign:
                        type: string
                        description: >-
                          If you will be using number pooling, please provide an
                          explanation as to why it is needed.
                        example: >-
                          We have customer reps in every state and they each
                          need their own number with local area code.
                      direct_lending:
                        type: boolean
                        description: >-
                          Will this campaign include content related to direct
                          lending or other loan agreements?
                        example: true
                      embedded_link:
                        type: boolean
                        description: >-
                          Will you be using an embedded link of any kind? Note
                          that public URL shorteners (bitly, tinyurl) will not
                          be accepted.
                        example: false
                      embedded_phone:
                        type: boolean
                        description: >-
                          Are you using an embedded phone number (except the
                          required HELP information contact phone number)?
                        example: false
                      age_gated_content:
                        type: boolean
                        description: >-
                          Will this campaign include any age gated content as
                          defined by carrier and CTA guidelines?
                        example: true
                      lead_generation:
                        type: boolean
                        description: >-
                          Is there any intent of this campaign to generate
                          leads?
                        example: true
                      csp_campaign_reference:
                        type: string
                        description: >-
                          If you are your own Campaign Service Provider, what is
                          the approved Campaign ID? (Mandatory for CSPs,
                          otherwise please omit)
                        example: '1231231'
                      status_callback_url:
                        type: string
                        description: >-
                          Optional: Specify a URL to receive webhook
                          notifications when your campaign’s state changes.
                        example: https//example.com/handle_callback
                  - type: object
                    properties:
                      created_at:
                        type: string
                        format: date-time
                      updated_at:
                        type: string
                        format: date-time
  /registry/beta/campaigns/{id}:
    get:
      operationId: retrieve_campaign
      summary: Retrieve a Campaign
      description: |
        Retrieves the details of a Campaign that has been previously created.
        Use the unique ID that was returned from your previous request to
        identify the specific Campaign.

        #### Permissions
        The API token must include the following scopes: _Messaging_.
      tags:
        - Campaign Registry (Beta)
      parameters:
        - name: id
          in: path
          description: Unique ID of the campaign
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      id:
                        type: string
                        description: The unique id of the campaign.
                        format: uuid
                    required:
                      - id
                  - type: object
                    properties:
                      name:
                        type: string
                        description: A name for the campaign.
                        example: My Campaign
                  - type: object
                    properties:
                      state:
                        type: string
                        description: The current state of the campaign.
                        example: pending
                  - type: object
                    properties:
                      sms_use_case:
                        type: string
                        description: >-
                          An SMS Use Case category for the campaign (2FA,
                          ACCOUNT_NOTIFICATION, AGENTS_FRANCHISES,
                          CARRIER_EXEMPT, CHARITY, CUSTOMER_CARE,
                          DELIVERY_NOTIFICATION, EMERGENCY, FRAUD_ALERT,
                          HIGHER_EDUCATION, K12_EDUCATION, LOW_VOLUME_MIXED,
                          MARKETING, MIXED, POLITICAL, POLITICAL_SECTION_527,
                          POLLING_VOTING, PROXY, PUBLIC_SERVICE_ANNOUNCEMENT,
                          SECURITY_ALERT, SOCIAL, SWEEPSTAKE, TRIAL,
                          UCAAS_HIGH_VOLUME, UCAAS_LOW_VOLUME).
                        example: MARKETING
                      sub_use_cases:
                        type: array
                        items:
                          type: string
                        description: >-
                          A sub use case category for MIXED or LOW_VOLUME_MIXED
                          campaigns (CUSTOMER_CARE, HIGHER_EDUCATION,
                          POLLING_VOTING, PUBLIC_SERVICE_ANNOUNCEMENT,
                          MARKETING, SECURITY_ALERT, 2FA, ACCOUNT_NOTIFICATION,
                          DELIVERY_NOTIFICATION, FRAUD_ALERT).
                        example:
                          - MARKETING
                          - 2FA
                      campaign_verify_token:
                        type: string
                        description: >-
                          Campaign Verifiy token. Required if sms use case is
                          POLITICAL_SECTION_527. (Some U.S. wireless carriers
                          require political committees to obtain Campaign Verify
                          verification in order to access special political
                          campaign classes for the new 10DLC text messaging
                          routes. Visit www.campaignverify.org for more
                          information and to obtain your token)
                        example: null
                      description:
                        type: string
                        description: >-
                          A description for the campaign. Please use at least 40
                          characters.
                        example: null
                      sample1:
                        type: string
                        description: >-
                          Sample message template/content. At least two samples
                          are required and up to five can be provided. Please
                          use at least 20 characters.
                        example: this is a sample message your customer might receive
                      sample2:
                        type: string
                        description: Sample 2.
                        example: this is a sample message your customer might receive
                      sample3:
                        type: string
                        description: Sample 3.
                      sample4:
                        type: string
                        description: Sample 4.
                      sample5:
                        type: string
                        description: Sample 5.
                      dynamic_templates:
                        type: string
                        description: >-
                          If your messaging content will be modified in any way
                          beyond what you shared in your templates, please
                          describe the nature of how the content will change.
                      message_flow:
                        type: string
                        description: >-
                          Please describe the call to action/message flow your
                          intended recipients will experience.
                        example: >-
                          Users will opt in to receive messages from their
                          doctor through a written form and we will send them an
                          opt in message. Appointment reminders will then be
                          sent ahead of their appointments.
                      opt_in_message:
                        type: string
                        description: >-
                          Please share the message subscribers receive when they
                          opt in.
                        example: >-
                          Thanks for subscribing. Reply STOP to cancel at any
                          time.
                      opt_out_message:
                        type: string
                        description: >-
                          Please share the message subscribers receive when they
                          opt out.
                        example: >-
                          You have successfully been opted out. Reply START to
                          opt back in at any time.
                      help_message:
                        type: string
                        description: >-
                          Please share the message subscribers receive when they
                          opt out.
                        example: >-
                          You have successfully been opted out. Reply SUBSCRIBE
                          to opt back in at any time.
                      opt_in_keywords:
                        type: string
                        description: >-
                          You can share any opt in keywords that subscribers can
                          use here. Default = START
                        example: Start,Subscribe,Opt In
                      opt_out_keywords:
                        type: string
                        description: >-
                          You can share any opt in keywords that subscribers can
                          use here. Default = STOP
                        example: Stop,Opt Out,Unsubscribe
                      help_keywords:
                        type: string
                        description: >-
                          You can share any help keywords that subscribers can
                          use here. Default = HELP
                        example: Help,Support,Request Call
                      number_pooling_required:
                        type: boolean
                        description: >-
                          Will 50 or more numbers be used with this single
                          campaign? If so, please enter true.
                        example: true
                      number_pooling_per_campaign:
                        type: string
                        description: >-
                          If you will be using number pooling, please provide an
                          explanation as to why it is needed.
                        example: >-
                          We have customer reps in every state and they each
                          need their own number with local area code.
                      direct_lending:
                        type: boolean
                        description: >-
                          Will this campaign include content related to direct
                          lending or other loan agreements?
                        example: true
                      embedded_link:
                        type: boolean
                        description: >-
                          Will you be using an embedded link of any kind? Note
                          that public URL shorteners (bitly, tinyurl) will not
                          be accepted.
                        example: false
                      embedded_phone:
                        type: boolean
                        description: >-
                          Are you using an embedded phone number (except the
                          required HELP information contact phone number)?
                        example: false
                      age_gated_content:
                        type: boolean
                        description: >-
                          Will this campaign include any age gated content as
                          defined by carrier and CTA guidelines?
                        example: true
                      lead_generation:
                        type: boolean
                        description: >-
                          Is there any intent of this campaign to generate
                          leads?
                        example: true
                      csp_campaign_reference:
                        type: string
                        description: >-
                          If you are your own Campaign Service Provider, what is
                          the approved Campaign ID? (Mandatory for CSPs,
                          otherwise please omit)
                        example: '1231231'
                      status_callback_url:
                        type: string
                        description: >-
                          Optional: Specify a URL to receive webhook
                          notifications when your campaign’s state changes.
                        example: https//example.com/handle_callback
                  - type: object
                    properties:
                      created_at:
                        type: string
                        format: date-time
                      updated_at:
                        type: string
                        format: date-time
    put:
      operationId: update_campaign
      summary: Update a Campaign
      description: |
        Allows updating the friendly name associated with a campaign

        #### Permissions
        The API token must include the following scopes: _Messaging_.
      tags:
        - Campaign Registry (Beta)
      parameters:
        - name: id
          in: path
          description: Unique ID of the campaign
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              allOf:
                - allOf:
                    - type: object
                      properties:
                        name:
                          type: string
                          description: A name for the campaign.
                          example: My Campaign
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      id:
                        type: string
                        description: The unique id of the campaign.
                        format: uuid
                    required:
                      - id
                  - type: object
                    properties:
                      name:
                        type: string
                        description: A name for the campaign.
                        example: My Campaign
                  - type: object
                    properties:
                      state:
                        type: string
                        description: The current state of the campaign.
                        example: pending
                  - type: object
                    properties:
                      sms_use_case:
                        type: string
                        description: >-
                          An SMS Use Case category for the campaign (2FA,
                          ACCOUNT_NOTIFICATION, AGENTS_FRANCHISES,
                          CARRIER_EXEMPT, CHARITY, CUSTOMER_CARE,
                          DELIVERY_NOTIFICATION, EMERGENCY, FRAUD_ALERT,
                          HIGHER_EDUCATION, K12_EDUCATION, LOW_VOLUME_MIXED,
                          MARKETING, MIXED, POLITICAL, POLITICAL_SECTION_527,
                          POLLING_VOTING, PROXY, PUBLIC_SERVICE_ANNOUNCEMENT,
                          SECURITY_ALERT, SOCIAL, SWEEPSTAKE, TRIAL,
                          UCAAS_HIGH_VOLUME, UCAAS_LOW_VOLUME).
                        example: MARKETING
                      sub_use_cases:
                        type: array
                        items:
                          type: string
                        description: >-
                          A sub use case category for MIXED or LOW_VOLUME_MIXED
                          campaigns (CUSTOMER_CARE, HIGHER_EDUCATION,
                          POLLING_VOTING, PUBLIC_SERVICE_ANNOUNCEMENT,
                          MARKETING, SECURITY_ALERT, 2FA, ACCOUNT_NOTIFICATION,
                          DELIVERY_NOTIFICATION, FRAUD_ALERT).
                        example:
                          - MARKETING
                          - 2FA
                      campaign_verify_token:
                        type: string
                        description: >-
                          Campaign Verifiy token. Required if sms use case is
                          POLITICAL_SECTION_527. (Some U.S. wireless carriers
                          require political committees to obtain Campaign Verify
                          verification in order to access special political
                          campaign classes for the new 10DLC text messaging
                          routes. Visit www.campaignverify.org for more
                          information and to obtain your token)
                        example: null
                      description:
                        type: string
                        description: >-
                          A description for the campaign. Please use at least 40
                          characters.
                        example: null
                      sample1:
                        type: string
                        description: >-
                          Sample message template/content. At least two samples
                          are required and up to five can be provided. Please
                          use at least 20 characters.
                        example: this is a sample message your customer might receive
                      sample2:
                        type: string
                        description: Sample 2.
                        example: this is a sample message your customer might receive
                      sample3:
                        type: string
                        description: Sample 3.
                      sample4:
                        type: string
                        description: Sample 4.
                      sample5:
                        type: string
                        description: Sample 5.
                      dynamic_templates:
                        type: string
                        description: >-
                          If your messaging content will be modified in any way
                          beyond what you shared in your templates, please
                          describe the nature of how the content will change.
                      message_flow:
                        type: string
                        description: >-
                          Please describe the call to action/message flow your
                          intended recipients will experience.
                        example: >-
                          Users will opt in to receive messages from their
                          doctor through a written form and we will send them an
                          opt in message. Appointment reminders will then be
                          sent ahead of their appointments.
                      opt_in_message:
                        type: string
                        description: >-
                          Please share the message subscribers receive when they
                          opt in.
                        example: >-
                          Thanks for subscribing. Reply STOP to cancel at any
                          time.
                      opt_out_message:
                        type: string
                        description: >-
                          Please share the message subscribers receive when they
                          opt out.
                        example: >-
                          You have successfully been opted out. Reply START to
                          opt back in at any time.
                      help_message:
                        type: string
                        description: >-
                          Please share the message subscribers receive when they
                          opt out.
                        example: >-
                          You have successfully been opted out. Reply SUBSCRIBE
                          to opt back in at any time.
                      opt_in_keywords:
                        type: string
                        description: >-
                          You can share any opt in keywords that subscribers can
                          use here. Default = START
                        example: Start,Subscribe,Opt In
                      opt_out_keywords:
                        type: string
                        description: >-
                          You can share any opt in keywords that subscribers can
                          use here. Default = STOP
                        example: Stop,Opt Out,Unsubscribe
                      help_keywords:
                        type: string
                        description: >-
                          You can share any help keywords that subscribers can
                          use here. Default = HELP
                        example: Help,Support,Request Call
                      number_pooling_required:
                        type: boolean
                        description: >-
                          Will 50 or more numbers be used with this single
                          campaign? If so, please enter true.
                        example: true
                      number_pooling_per_campaign:
                        type: string
                        description: >-
                          If you will be using number pooling, please provide an
                          explanation as to why it is needed.
                        example: >-
                          We have customer reps in every state and they each
                          need their own number with local area code.
                      direct_lending:
                        type: boolean
                        description: >-
                          Will this campaign include content related to direct
                          lending or other loan agreements?
                        example: true
                      embedded_link:
                        type: boolean
                        description: >-
                          Will you be using an embedded link of any kind? Note
                          that public URL shorteners (bitly, tinyurl) will not
                          be accepted.
                        example: false
                      embedded_phone:
                        type: boolean
                        description: >-
                          Are you using an embedded phone number (except the
                          required HELP information contact phone number)?
                        example: false
                      age_gated_content:
                        type: boolean
                        description: >-
                          Will this campaign include any age gated content as
                          defined by carrier and CTA guidelines?
                        example: true
                      lead_generation:
                        type: boolean
                        description: >-
                          Is there any intent of this campaign to generate
                          leads?
                        example: true
                      csp_campaign_reference:
                        type: string
                        description: >-
                          If you are your own Campaign Service Provider, what is
                          the approved Campaign ID? (Mandatory for CSPs,
                          otherwise please omit)
                        example: '1231231'
                      status_callback_url:
                        type: string
                        description: >-
                          Optional: Specify a URL to receive webhook
                          notifications when your campaign’s state changes.
                        example: https//example.com/handle_callback
                  - type: object
                    properties:
                      created_at:
                        type: string
                        format: date-time
                      updated_at:
                        type: string
                        format: date-time
  /registry/beta/campaigns/{id}/numbers:
    get:
      operationId: list_number_assignments
      summary: List all Phone Number Assignments
      description: |
        Returns a list of the phone number assignments for a campaign. The
        numbers are returned sorted by creation date, with the most recent
        appearing first. The list is filterable by sending in any of the
        following parameters.

        #### Permissions
        The API token must include the following scopes: _Messaging_.
      tags:
        - Campaign Registry (Beta)
      parameters:
        - name: id
          in: path
          description: Unique ID of the campaign
          required: true
          schema:
            type: string
            format: uuid
        - name: filter_state
          in: query
          description: >-
            The state of the assignments in the registration process, such as
            pending or complete. Will return all assignments with this value.
          required: false
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  links:
                    type: object
                    properties:
                      self:
                        type: string
                      first:
                        type: string
                      next:
                        type: string
                      prev:
                        type: string
                  data:
                    type: array
                    items:
                      allOf:
                        - type: object
                          properties:
                            id:
                              type: string
                              description: The unique id of the assignment.
                              format: uuid
                          required:
                            - id
                        - type: object
                          properties:
                            state:
                              type: string
                              description: The current state of the assignment.
                              example: pending
                        - type: object
                          properties:
                            campaign_id:
                              type: string
                              format: uuid
                            phone_number:
                              type: object
                              properties:
                                id:
                                  type: string
                                  format: uuid
                                name:
                                  type: string
                                  example: Jenny
                                number:
                                  type: string
                                  example: '+15558675309'
                                status_callback_url:
                                  type: string
                                  example: https//example.com/handle_callback
                            created_at:
                              type: string
                              format: date-time
                            updated_at:
                              type: string
                              format: date-time
  /registry/beta/campaigns/{id}/orders:
    get:
      operationId: list_orders
      summary: List all Phone Number Assignment Orders
      description: |
        Returns a list of the phone number assignment orders for a campaign.
        The orders are returned sorted by creation date, with the most recent
        appearing first. The list is filterable by sending in any of the
        following parameters.

        #### Permissions
        The API token must include the following scopes: _Messaging_.
      tags:
        - Campaign Registry (Beta)
      parameters:
        - name: id
          in: path
          description: Unique ID of the campaign
          required: true
          schema:
            type: string
            format: uuid
        - name: filter_state
          in: query
          description: >-
            The state of the orders in the registration process, such as pending
            or processed. Will return all orders with this value.
          required: false
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  links:
                    type: object
                    properties:
                      self:
                        type: string
                      first:
                        type: string
                      next:
                        type: string
                      prev:
                        type: string
                  data:
                    type: array
                    items:
                      allOf:
                        - type: object
                          properties:
                            id:
                              type: string
                              description: The unique id of the order.
                              format: uuid
                          required:
                            - id
                        - type: object
                          properties:
                            state:
                              type: string
                              description: The current state of the order.
                              example: pending
                        - type: object
                          properties:
                            processed_at:
                              type: string
                              format: date-time
                              example: null
                            created_at:
                              type: string
                              format: date-time
                            updated_at:
                              type: string
                              format: date-time
                            status_callback_url:
                              type: string
                              description: >-
                                Optional: Specify a URL to receive webhook
                                notifications when your number assignment order
                                and the number assignments that belong to it
                                change state.
                              example: https//example.com/handle_callback
    post:
      operationId: create_order
      summary: Create a Phone Number Assignment Order
      description: |
        To create a new Phone Number Assignment Order, you send a `POST` request
        to the Orders resource. Phone Number Assignments belong to Campaigns.
        A list of `phone_numbers` in E164 format is required. 

        #### Permissions
        The API token must include the following scopes: _Messaging_.
      tags:
        - Campaign Registry (Beta)
      parameters:
        - name: id
          in: path
          description: Unique ID of the campaign
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              allOf:
                - type: object
                  properties:
                    phone_numbers:
                      type: array
                      items:
                        type: string
                      description: A list of phone number in E164 format.
                      example:
                        - '+15558675309'
                    status_callback_url:
                      type: string
                      description: >-
                        Optional: Specify a URL to receive webhook notifications
                        when your number assignment order and the number
                        assignments that belong to it change state.
                      example: https//example.com/handle_callback
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      id:
                        type: string
                        description: The unique id of the order.
                        format: uuid
                    required:
                      - id
                  - type: object
                    properties:
                      state:
                        type: string
                        description: The current state of the order.
                        example: pending
                  - type: object
                    properties:
                      processed_at:
                        type: string
                        format: date-time
                        example: null
                      created_at:
                        type: string
                        format: date-time
                      updated_at:
                        type: string
                        format: date-time
                      status_callback_url:
                        type: string
                        description: >-
                          Optional: Specify a URL to receive webhook
                          notifications when your number assignment order and
                          the number assignments that belong to it change state.
                        example: https//example.com/handle_callback
  /registry/beta/orders/{id}:
    get:
      operationId: retrieve_order
      summary: Retrieve a Phone Number Assignment Order
      description: |
        Returns a phone number assignment order.

        #### Permissions
        The API token must include the following scopes: _Messaging_.
      tags:
        - Campaign Registry (Beta)
      parameters:
        - name: id
          in: path
          description: Unique ID of the order
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      id:
                        type: string
                        description: The unique id of the order.
                        format: uuid
                    required:
                      - id
                  - type: object
                    properties:
                      state:
                        type: string
                        description: The current state of the order.
                        example: pending
                  - type: object
                    properties:
                      processed_at:
                        type: string
                        format: date-time
                        example: null
                      created_at:
                        type: string
                        format: date-time
                      updated_at:
                        type: string
                        format: date-time
                      status_callback_url:
                        type: string
                        description: >-
                          Optional: Specify a URL to receive webhook
                          notifications when your number assignment order and
                          the number assignments that belong to it change state.
                        example: https//example.com/handle_callback
  /registry/beta/numbers/{id}:
    delete:
      operationId: delete_number_assignment
      summary: Delete a Phone Number Assignment
      description: >
        Permanently deletes a phone number assignment. It cannot be undone.


        Please note: numbers can only be removed via the API once they are
        completed (i.e. not pending or processing).


        #### Permissions

        The API token must include the following scopes: _Messaging_.
      tags:
        - Campaign Registry (Beta)
      parameters:
        - name: id
          in: path
          description: Assignment ID
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '204':
          description: No Content
  /domain_applications:
    get:
      operationId: list_domain_applications
      summary: List all Domain Applications
      description: |
        Returns a list of your domain applications. The domain applications
        are returned sorted by creation date, with the most recent domain
        applications appearing first. The list is filterable by sending in any
        of the following parameters.

        #### Permissions
        The API token must include the following scopes: _Voice_.
      tags:
        - Domain Applications
      parameters:
        - name: filter_domain
          in: query
          description: >-
            String representing the domain portion of the domain application.
            Will return all domain applications containing this value as a
            substring.
          required: false
          schema:
            type: string
        - name: filter_name
          in: query
          description: >-
            String representing the name portion of the domain application. Will
            return all domain applications containing this value as a substring.
          required: false
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  links:
                    type: object
                    properties:
                      self:
                        type: string
                      first:
                        type: string
                      next:
                        type: string
                      prev:
                        type: string
                  data:
                    type: array
                    items:
                      allOf:
                        - type: object
                          properties:
                            id:
                              type: string
                              description: >-
                                The unique identifier of the domain application
                                on SignalWire. This can be used to update or
                                delete the application programmatically.
                              format: uuid
                          required:
                            - id
                        - type: object
                          properties:
                            type:
                              type: string
                              description: >-
                                A string representation of the type of object
                                this record is.
                              example: domain_application
                            domain:
                              type: string
                              description: >-
                                A string representation of the subdomain for
                                this application.
                              example: your-space-test_id
                        - type: object
                          properties:
                            name:
                              type: string
                              description: >-
                                A string representing the friendly name for this
                                domain application.
                              example: Test App
                            identifier:
                              type: string
                              description: >-
                                A string representing the identifier portion of
                                the domain application. The combination of identifier and user must be unique across projects. 
                                Must be letters, numbers, and dash only.
                            user:
                              type: string
                              description: >-
                                A string representing the user portion of
                                the domain application. The combination of identifier and user must be unique across projects. 
                                Must be letters, numbers, and dash only. Default is '*'.
                              example: helpdesk
                            ip_auth_enabled:
                              type: boolean
                              description: >-
                                Whether the domain application will enforce IP
                                authentication for incoming requests.
                              example: true
                            ip_auth:
                              type: array
                              items:
                                type: string
                              description: >-
                                A list containing whitelisted IP addresses and
                                IP blocks used if `ip_auth_enabled` is `true`.
                              example:
                                - 8.8.8.8
                                - 4.4.4.4
                            call_handler:
                              type: string
                              description: >-
                                A string representing how this domain
                                application handles calls. Valid values are
                                `relay_context`, `relay_topic`, `relay_application`,
                                `laml_webhooks`, `laml_application`,
                                `video_room`, `relay_script`, `dialogflow`,
                                `ai_agent`, and `call_flow`.
                              example: relay_application
                            call_request_url:
                              type: string
                              description: >-
                                A string representing the LaML URL to access
                                when a call is received. This is only used (and
                                required) when `call_handler` is set to
                                `laml_webhooks`.
                              example: null
                            call_request_method:
                              type: string
                              description: >-
                                A string representing the HTTP method to use
                                with `call_request_url`. Valid values are `GET`
                                and `POST`. This is only used (and required)
                                when `call_handler` is set to `laml_webhooks`.
                              example: POST
                            call_fallback_url:
                              type: string
                              description: >-
                                A string representing the LaML URL to access
                                when the call to `call_request_url` fails. This
                                is only used (and required) when `call_handler`
                                is set to `laml_webhooks`.
                              example: null
                            call_fallback_method:
                              type: string
                              description: >-
                                A string representing the HTTP method to use
                                with `call_fallback_url`. Valid values are `GET`
                                and `POST`. This is only used (and required)
                                when `call_handler` is set to `laml_webhooks`.
                              example: POST
                            call_status_callback_url:
                              type: string
                              description: >-
                                A string representing a URL to send status
                                change messages to. This is only used (and
                                required) when `call_handler` is set to
                                `laml_webhooks`.
                              example: null
                            call_status_callback_method:
                              type: string
                              description: >-
                                A string representing the HTTP method to use
                                with `call_status_callback_url`. Valid values
                                are `GET` and `POST`. This is only used (and
                                required) when `call_handler` is set to
                                `laml_webhooks`.
                              example: POST
                            call_relay_topic:
                              type: string
                              description: >-
                                A string representing the Relay topic to
                                forward incoming calls to. This is only used
                                (and required) when `call_handler` is set to
                                `relay_topic`. Alias of
                                `call_relay_application`. If both are sent,
                                `call_relay_application` takes precedence.
                              example: 'office'
                            call_relay_topic_status_callback_url:
                              type: string
                              description: >-
                                A string representing a URL to send status change
                                messages to. This is only used (and required) when
                                `call_handler` is set to `relay_topic`.
                              example: "https://myapplication/handle_relay_callbacks"
                            call_relay_context:
                              type: string
                              description: >-
                                Deprecated. Use `call_relay_application` instead.
                              example: 'office'
                              deprecated: true
                            call_relay_context_status_callback_url:
                              type: string
                              deprecated: true
                              description: >-
                                Deprecated. Use `call_relay_topic_status_callback_url` instead.
                            call_relay_application:
                              type: string
                              description: >-
                                A string representing the Relay Application to
                                forward incoming calls to. This is only used
                                (and required) when `call_handler` is set to
                                `relay_application`. Alias of
                                `call_relay_topic`. If both are sent,
                                `call_relay_application` takes precedence.
                              example: null
                            call_relay_script_url:
                              type: string
                              description: >-
                                A string representing the URL of the Relay
                                script to execute when a call is received. This
                                is only used (and required) when `call_handler`
                                is set to `relay_script`.
                              example: null
                            call_laml_application_id:
                              type: string
                              description: >-
                                A string representing the ID of the LaML
                                application to forward incoming calls to. This
                                is only used (and required) when `call_handler`
                                is set to `laml_application`.
                              example: null
                            call_video_room_id:
                              type: string
                              format: uuid
                              description: >-
                                A string representing the ID of the Video Room
                                to forward incoming calls to. This is only used
                                (and required) when `call_handler` is set to
                                `video_room`.
                              example: fe4093d9-58c2-4931-b4b9-5679f82652c6
                            call_dialogflow_agent_id:
                              type: string
                              format: uuid
                              description: >-
                                A string representing the ID of the Dialogflow
                                Agent to forward incoming calls to. This is only
                                used (and required) when `call_handler` is set
                                to `dialogflow`.
                              example: fe4093d9-58c2-4931-b4b9-5679f82652c6
                            call_ai_agent_id:
                              type: string
                              format: uuid
                              description: >-
                                A string representing the ID of the AI Agent to
                                forward incoming calls to. This is only used
                                (and required) when `call_handler` is set to
                                `ai_agent`.
                              example: fe4093d9-58c2-4931-b4b9-5679f82652c6
                            call_flow_id:
                              type: string
                              format: uuid
                              description: >-
                                A string representing the ID of the Call Flow to
                                forward incoming calls to. This is only used
                                (and required) when `call_handler` is set to
                                `call_flow`.
                              example: fe4093d9-58c2-4931-b4b9-5679f82652c6
                            call_flow_version:
                              type: string
                              description: >-
                                A string representing the version of your Call
                                Flow you'd like to use. Valid options are
                                `working_copy` or `current_deployed`. This is
                                only used when `call_handler` is set to
                                `call_flow`.
                              example: working_copy
                            encryption:
                              type: string
                              description: >-
                                A string representing whether connections to
                                this domain application require encryption or if
                                encryption is optional. Encryption will always
                                be used if possible. Valid values are `optional`
                                and `required`.
                              example: required
                            codecs:
                              type: array
                              items:
                                type: string
                              description: >-
                                A list of codecs this domain application will
                                support. Currently supported values are: `OPUS`,
                                `G722`, `PCMU`, `PCMA`, `VP8`, and `H264`. At
                                least one value must be supplied.
                              example:
                                - PCMU
                                - PCMA
                            ciphers:
                              type: array
                              items:
                                type: string
                              description: >-
                                A list of encryption ciphers this domain
                                application will support. Currently supported
                                values are: `AEAD_AES_256_GCM_8`,
                                `AES_256_CM_HMAC_SHA1_80`,
                                `AES_CM_128_HMAC_SHA1_80`,
                                `AES_256_CM_HMAC_SHA1_32`, and
                                `AES_CM_128_HMAC_SHA1_32`. At least one value
                                must be supplied.
                              example:
                                - AEAD_AES_256_GCM_8
                          required:
                            - name
                            - identifier
                            - call_handler
    post:
      operationId: create_domain_application
      summary: Create a Domain Application
      description: |
        To create a new domain application, you send a `POST` request to the
        domain application resource.

        #### Permissions
        The API token must include the following scopes: _Voice_.
      tags:
        - Domain Applications
      requestBody:
        required: true
        content:
          application/json:
            schema:
              allOf:
                - type: object
                  properties:
                    name:
                      type: string
                      description: A string representing the friendly name for this domain application.
                      example: Test App
                    identifier:
                      type: string
                      description: >-
                        A string representing the identifier portion of
                        the domain application. The combination of identifier and user must be unique across projects. 
                        Must be letters, numbers, and dash only.
                    user:
                      type: string
                      description: >-
                        A string representing the user portion of
                        the domain application. The combination of identifier and user must be unique across projects. 
                        Must be letters, numbers, and dash only. Default is '*'.
                      example: helpdesk
                    ip_auth_enabled:
                      type: boolean
                      description: Whether the domain application will enforce IP authentication for incoming requests.
                      example: true
                    ip_auth:
                      type: array
                      items:
                        type: string
                      description: A list containing whitelisted IP addresses and IP blocks used if `ip_auth_enabled` is `true`.
                      example:
                        - 8.8.8.8
                        - 4.4.4.4
                    encryption:
                      type: string
                      description: A string representing whether connections to this domain application require encryption or if encryption is optional. Encryption will always be used if possible. Valid values are `optional` and `required`.
                      example: required
                    codecs:
                      type: array
                      items:
                        type: string
                      description: A list of codecs this domain application will support. Currently supported values are `OPUS`, `G722`, `PCMU`, `PCMA`, `VP8`, and `H264`. At least one value must be supplied.
                      example:
                        - PCMU
                        - PCMA
                    ciphers:
                      type: array
                      items:
                        type: string
                      description: A list of encryption ciphers this domain application will support. Currently supported values are `AEAD_AES_256_GCM_8`, `AES_256_CM_HMAC_SHA1_80`, `AES_CM_128_HMAC_SHA1_80`, `AES_256_CM_HMAC_SHA1_32`, and `AES_CM_128_HMAC_SHA1_32`. At least one value must be supplied.
                      example:
                        - AEAD_AES_256_GCM_8
                  required:
                    - name
                    - identifier
                - oneOf:
                    - type: object
                      title: Relay Topic
                      properties:
                        call_handler:
                          type: string
                          enum: [relay_topic]
                          description: Specifies that this domain application uses a Relay topic handler
                        call_relay_topic:
                          type: string
                          description: A string representing the Relay topic to forward incoming calls to.
                          example: 'office'
                        call_relay_topic_status_callback_url:
                          type: string
                          description: A string representing a URL to send status change messages to.
                          example: "https://myapplication/handle_relay_callbacks"
                      required:
                        - call_handler
                        - call_relay_topic

                    - type: object
                      title: Relay Application
                      properties:
                        call_handler:
                          type: string
                          enum: [relay_application]
                          description: Specifies that this domain application uses a Relay application handler
                        call_relay_application:
                          type: string
                          description: A string representing the Relay Application to forward incoming calls to.
                          example: 'my-relay-app'
                      required:
                        - call_handler
                        - call_relay_application

                    - type: object
                      title: LaML Webhooks
                      properties:
                        call_handler:
                          type: string
                          enum: [laml_webhooks]
                          description: Specifies that this domain application uses LaML webhooks
                        call_request_url:
                          type: string
                          description: A string representing the LaML URL to access when a call is received.
                          example: "https://example.com/laml"
                        call_request_method:
                          type: string
                          enum: [GET, POST]
                          description: A string representing the HTTP method to use with `call_request_url`.
                          example: POST
                        call_fallback_url:
                          type: string
                          description: A string representing the LaML URL to access when the call to `call_request_url` fails.
                          example: "https://example.com/fallback"
                        call_fallback_method:
                          type: string
                          enum: [GET, POST]
                          description: A string representing the HTTP method to use with `call_fallback_url`.
                          example: POST
                        call_status_callback_url:
                          type: string
                          description: A string representing a URL to send status change messages to.
                          example: "https://example.com/status"
                        call_status_callback_method:
                          type: string
                          enum: [GET, POST]
                          description: A string representing the HTTP method to use with `call_status_callback_url`.
                          example: POST
                      required:
                        - call_handler
                        - call_request_url
                        - call_request_method

                    - type: object
                      title: LaML Application
                      properties:
                        call_handler:
                          type: string
                          enum: [laml_application]
                          description: Specifies that this domain application uses a LaML application
                        call_laml_application_id:
                          type: string
                          description: A string representing the ID of the LaML application to forward incoming calls to.
                          example: "app-123456"
                      required:
                        - call_handler
                        - call_laml_application_id

                    - type: object
                      title: Video Room
                      properties:
                        call_handler:
                          type: string
                          enum: [video_room]
                          description: Specifies that this domain application uses a Video Room
                        call_video_room_id:
                          type: string
                          format: uuid
                          description: A string representing the ID of the Video Room to forward incoming calls to.
                          example: fe4093d9-58c2-4931-b4b9-5679f82652c6
                      required:
                        - call_handler
                        - call_video_room_id

                    - type: object
                      title: Relay Script
                      properties:
                        call_handler:
                          type: string
                          enum: [relay_script]
                          description: Specifies that this domain application uses a Relay script
                        call_relay_script_url:
                          type: string
                          description: A string representing the URL of the Relay script to execute when a call is received.
                          example: "https://example.com/relay-script"
                      required:
                        - call_handler
                        - call_relay_script_url

                    - type: object
                      title: Dialogflow
                      properties:
                        call_handler:
                          type: string
                          enum: [dialogflow]
                          description: Specifies that this domain application uses a Dialogflow agent
                        call_dialogflow_agent_id:
                          type: string
                          format: uuid
                          description: A string representing the ID of the Dialogflow Agent to forward incoming calls to.
                          example: fe4093d9-58c2-4931-b4b9-5679f82652c6
                      required:
                        - call_handler
                        - call_dialogflow_agent_id

                    - type: object
                      title: AI Agent
                      properties:
                        call_handler:
                          type: string
                          enum: [ai_agent]
                          description: Specifies that this domain application uses an AI agent
                        call_ai_agent_id:
                          type: string
                          format: uuid
                          description: A string representing the ID of the AI Agent to forward incoming calls to.
                          example: fe4093d9-58c2-4931-b4b9-5679f82652c6
                      required:
                        - call_handler
                        - call_ai_agent_id

                    - type: object
                      title: Call Flow
                      properties:
                        call_handler:
                          type: string
                          enum: [call_flow]
                          description: Specifies that this domain application uses a Call Flow
                        call_flow_id:
                          type: string
                          format: uuid
                          description: A string representing the ID of the Call Flow to forward incoming calls to.
                          example: fe4093d9-58c2-4931-b4b9-5679f82652c6
                        call_flow_version:
                          type: string
                          enum: [working_copy, current_deployed]
                          description: A string representing the version of your Call Flow you'd like to use.
                          example: working_copy
                      required:
                        - call_handler
                        - call_flow_id

                    - type: object
                      title: Relay Context (Deprecated)
                      deprecated: true
                      properties:
                        call_handler:
                          type: string
                          enum: [relay_context]
                          description: This handler type is deprecated. Please use `call_relay_application` or `call_relay_topic` instead.
                        call_relay_context:
                          type: string
                          description: >-
                            This handler type is deprecated. Please use `call_relay_application` or `call_relay_topic` instead.
                          example: 'office'
                          deprecated: true
                        call_relay_context_status_callback_url:
                          type: string
                          description: >-
                            This property is deprecated. Please use `call_relay_topic_status_callback_url` instead. 
                          example: "https://myapplication/handle_relay_callbacks"
                          deprecated: true
                      required:
                        - call_handler
                        - call_relay_context
      responses:
        '201':
          description: CREATED
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      id:
                        type: string
                        description: >-
                          The unique identifier of the domain application on
                          SignalWire. This can be used to update or delete the
                          application programmatically.
                        format: uuid
                    required:
                      - id
                  - type: object
                    properties:
                      type:
                        type: string
                        description: >-
                          A string representation of the type of object this
                          record is.
                        example: domain_application
                      domain:
                        type: string
                        description: >-
                          A string representation of the subdomain for this
                          application.
                        example: your-space-test_id
                  - type: object
                    properties:
                      name:
                        type: string
                        description: >-
                          A string representing the friendly name for this
                          domain application.
                        example: Test App
                      identifier:
                        type: string
                        description: >-
                          A string representing the identifier portion of
                          the domain application. The combination of identifier and user must be unique across projects. 
                          Must be letters, numbers, and dash only.
                      user:
                        type: string
                        description: >-
                          A string representing the user portion of
                          the domain application. The combination of identifier and user must be unique across projects. 
                          Must be letters, numbers, and dash only. Default is '*'.
                        example: helpdesk
                      ip_auth_enabled:
                        type: boolean
                        description: >-
                          Whether the domain application will enforce IP
                          authentication for incoming requests.
                        example: true
                      ip_auth:
                        type: array
                        items:
                          type: string
                        description: >-
                          A list containing whitelisted IP addresses and IP
                          blocks used if `ip_auth_enabled` is `true`.
                        example:
                          - 8.8.8.8
                          - 4.4.4.4
                      call_handler:
                        type: string
                        description: >-
                          A string representing how this domain application
                          handles calls. Valid values are `relay_context`, `relay_topic`, 
                          `relay_application`, `laml_webhooks`,
                          `laml_application`, `video_room`, `relay_script`,
                          `dialogflow`, `ai_agent`, and `call_flow`.
                        example: relay_application
                      call_request_url:
                        type: string
                        description: >-
                          A string representing the LaML URL to access when a
                          call is received. This is only used (and required)
                          when `call_handler` is set to `laml_webhooks`.
                        example: null
                      call_request_method:
                        type: string
                        description: >-
                          A string representing the HTTP method to use with
                          `call_request_url`. Valid values are `GET` and `POST`.
                          This is only used (and required) when `call_handler`
                          is set to `laml_webhooks`.
                        example: POST
                      call_fallback_url:
                        type: string
                        description: >-
                          A string representing the LaML URL to access when the
                          call to `call_request_url` fails. This is only used
                          (and required) when `call_handler` is set to
                          `laml_webhooks`.
                        example: null
                      call_fallback_method:
                        type: string
                        description: >-
                          A string representing the HTTP method to use with
                          `call_fallback_url`. Valid values are `GET` and
                          `POST`. This is only used (and required) when
                          `call_handler` is set to `laml_webhooks`.
                        example: POST
                      call_status_callback_url:
                        type: string
                        description: >-
                          A string representing a URL to send status change
                          messages to. This is only used (and required) when
                          `call_handler` is set to `laml_webhooks`.
                        example: null
                      call_status_callback_method:
                        type: string
                        description: >-
                          A string representing the HTTP method to use with
                          `call_status_callback_url`. Valid values are `GET` and
                          `POST`. This is only used (and required) when
                          `call_handler` is set to `laml_webhooks`.
                        example: POST
                      call_relay_topic:
                        type: string
                        description: >-
                          A string representing the Relay topic to
                          forward incoming calls to. This is only used
                          (and required) when `call_handler` is set to
                          `relay_topic`. Alias of
                          `call_relay_application`. If both are sent,
                          `call_relay_application` takes precedence.
                        example: 'office'
                      call_relay_topic_status_callback_url:
                        type: string
                        description: >-
                          A string representing a URL to send status change
                          messages to. This is only used (and required) when
                          `call_handler` is set to `relay_topic`.
                        example: "https://myapplication/handle_relay_callbacks"
                      call_relay_context:
                        type: string
                        description: >-
                          A string representing the Relay context to forward
                          incoming calls to. This is only used (and required)
                          when `call_handler` is set to `relay_context`. Alias
                          of `call_relay_application`. If both are sent,
                          `call_relay_application` takes precedence.
                        example: 'office'
                        deprecated: true
                      call_relay_context_status_callback_url:
                        type: string
                        description: >-
                          A string representing a URL to send status change
                          messages to. This is only used (and required) when
                          `call_handler` is set to `relay_context`.
                        example: "https://myapplication/handle_relay_callbacks"
                        deprecated: true
                      call_relay_application:
                        type: string
                        description: >-
                          A string representing the Relay Application to forward
                          incoming calls to. This is only used (and required)
                          when `call_handler` is set to `relay_application`.
                          Alias of `call_relay_context`. If both are sent,
                          `call_relay_application` takes precedence.
                        example: null
                      call_relay_script_url:
                        type: string
                        description: >-
                          A string representing the URL of the Relay script to
                          execute when a call is received. This is only used
                          (and required) when `call_handler` is set to
                          `relay_script`.
                        example: null
                      call_laml_application_id:
                        type: string
                        description: >-
                          A string representing the ID of the LaML application
                          to forward incoming calls to. This is only used (and
                          required) when `call_handler` is set to
                          `laml_application`.
                        example: null
                      call_video_room_id:
                        type: string
                        format: uuid
                        description: >-
                          A string representing the ID of the Video Room to
                          forward incoming calls to. This is only used (and
                          required) when `call_handler` is set to `video_room`.
                        example: fe4093d9-58c2-4931-b4b9-5679f82652c6
                      call_dialogflow_agent_id:
                        type: string
                        format: uuid
                        description: >-
                          A string representing the ID of the Dialogflow Agent
                          to forward incoming calls to. This is only used (and
                          required) when `call_handler` is set to `dialogflow`.
                        example: fe4093d9-58c2-4931-b4b9-5679f82652c6
                      call_ai_agent_id:
                        type: string
                        format: uuid
                        description: >-
                          A string representing the ID of the AI Agent to
                          forward incoming calls to. This is only used (and
                          required) when `call_handler` is set to `ai_agent`.
                        example: fe4093d9-58c2-4931-b4b9-5679f82652c6
                      call_flow_id:
                        type: string
                        format: uuid
                        description: >-
                          A string representing the ID of the Call Flow to
                          forward incoming calls to. This is only used (and
                          required) when `call_handler` is set to `call_flow`.
                        example: fe4093d9-58c2-4931-b4b9-5679f82652c6
                      call_flow_version:
                        type: string
                        description: >-
                          A string representing the version of your Call Flow
                          you'd like to use. Valid options are `working_copy` or
                          `current_deployed`. This is only used when
                          `call_handler` is set to `call_flow`.
                        example: working_copy
                      encryption:
                        type: string
                        description: >-
                          A string representing whether connections to this
                          domain application require encryption or if encryption
                          is optional. Encryption will always be used if
                          possible. Valid values are `optional` and `required`.
                        example: required
                      codecs:
                        type: array
                        items:
                          type: string
                        description: >-
                          A list of codecs this domain application will support.
                          Currently supported values are: `OPUS`, `G722`,
                          `PCMU`, `PCMA`, `VP8`, and `H264`. At least one value
                          must be supplied.
                        example:
                          - PCMU
                          - PCMA
                      ciphers:
                        type: array
                        items:
                          type: string
                        description: >-
                          A list of encryption ciphers this domain application
                          will support. Currently supported values are:
                          `AEAD_AES_256_GCM_8`, `AES_256_CM_HMAC_SHA1_80`,
                          `AES_CM_128_HMAC_SHA1_80`, `AES_256_CM_HMAC_SHA1_32`,
                          and `AES_CM_128_HMAC_SHA1_32`. At least one value must
                          be supplied.
                        example:
                          - AEAD_AES_256_GCM_8
                    required:
                      - name
                      - identifier
                      - call_handler
  /domain_applications/{id}:
    get:
      operationId: retrieve_domain_application
      summary: Retrieve a Domain Application
      description: |
        Retrieves the details of a domain application that has been previously
        created. Use the unique ID that was returned from your previous
        request to identify the specific domain application.

        #### Permissions
        The API token must include the following scopes: _Voice_.
      tags:
        - Domain Applications
      parameters:
        - name: id
          in: path
          description: Unique ID of the domain application
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      id:
                        type: string
                        description: >-
                          The unique identifier of the domain application on
                          SignalWire. This can be used to update or delete the
                          application programmatically.
                        format: uuid
                    required:
                      - id
                  - type: object
                    properties:
                      type:
                        type: string
                        description: >-
                          A string representation of the type of object this
                          record is.
                        example: domain_application
                      domain:
                        type: string
                        description: >-
                          A string representation of the subdomain for this
                          application.
                        example: your-space-test_id
                  - type: object
                    properties:
                      name:
                        type: string
                        description: >-
                          A string representing the friendly name for this
                          domain application.
                        example: Test App
                      identifier:
                        type: string
                        description: >-
                          A string representing the identifier portion of
                          the domain application. The combination of identifier and user must be unique across projects. 
                          Must be letters, numbers, and dash only.
                      user:
                        type: string
                        description: >-
                          A string representing the user portion of
                          the domain application. The combination of identifier and user must be unique across projects. 
                          Must be letters, numbers, and dash only. Default is '*'.
                        example: helpdesk
                      ip_auth_enabled:
                        type: boolean
                        description: >-
                          Whether the domain application will enforce IP
                          authentication for incoming requests.
                        example: true
                      ip_auth:
                        type: array
                        items:
                          type: string
                        description: >-
                          A list containing whitelisted IP addresses and IP
                          blocks used if `ip_auth_enabled` is `true`.
                        example:
                          - 8.8.8.8
                          - 4.4.4.4
                      call_handler:
                        type: string
                        description: >-
                          A string representing how this domain application
                          handles calls. Valid values are `relay_context`, `relay_topic`, 
                          `relay_application`, `laml_webhooks`,
                          `laml_application`, `video_room`, `relay_script`,
                          `dialogflow`, `ai_agent`, and `call_flow`.
                        example: relay_application
                      call_request_url:
                        type: string
                        description: >-
                          A string representing the LaML URL to access when a
                          call is received. This is only used (and required)
                          when `call_handler` is set to `laml_webhooks`.
                        example: null
                      call_request_method:
                        type: string
                        description: >-
                          A string representing the HTTP method to use with
                          `call_request_url`. Valid values are `GET` and `POST`.
                          This is only used (and required) when `call_handler`
                          is set to `laml_webhooks`.
                        example: POST
                      call_fallback_url:
                        type: string
                        description: >-
                          A string representing the LaML URL to access when the
                          call to `call_request_url` fails. This is only used
                          (and required) when `call_handler` is set to
                          `laml_webhooks`.
                        example: null
                      call_fallback_method:
                        type: string
                        description: >-
                          A string representing the HTTP method to use with
                          `call_fallback_url`. Valid values are `GET` and
                          `POST`. This is only used (and required) when
                          `call_handler` is set to `laml_webhooks`.
                        example: POST
                      call_status_callback_url:
                        type: string
                        description: >-
                          A string representing a URL to send status change
                          messages to. This is only used (and required) when
                          `call_handler` is set to `laml_webhooks`.
                        example: null
                      call_status_callback_method:
                        type: string
                        description: >-
                          A string representing the HTTP method to use with
                          `call_status_callback_url`. Valid values are `GET` and
                          `POST`. This is only used (and required) when
                          `call_handler` is set to `laml_webhooks`.
                        example: POST
                      call_relay_topic:
                        type: string
                        description: >-
                          A string representing the Relay topic to
                          forward incoming calls to. This is only used
                          (and required) when `call_handler` is set to
                          `relay_topic`. Alias of
                          `call_relay_application`. If both are sent,
                          `call_relay_application` takes precedence.
                        example: 'office'
                      call_relay_topic_status_callback_url:
                        type: string
                        description: >-
                          A string representing a URL to send status change
                          messages to. This is only used (and required) when
                          `call_handler` is set to `relay_topic`.
                        example: "https://myapplication/handle_relay_callbacks"
                      call_relay_context:
                        type: string
                        description: >-
                          Deprecated. Use `call_relay_application` instead.
                        example: 'office'
                        deprecated: true
                      call_relay_context_status_callback_url:
                        type: string
                        description: >-
                          Deprecated. Use `call_relay_topic_status_callback_url` instead.
                        example: "https://myapplication/handle_relay_callbacks"
                        deprecated: true
                      call_relay_application:
                        type: string
                        description: >-
                          A string representing the Relay Application to forward
                          incoming calls to. This is only used (and required)
                          when `call_handler` is set to `relay_application`.
                        example: null
                      call_relay_script_url:
                        type: string
                        description: >-
                          A string representing the URL of the Relay script to
                          execute when a call is received. This is only used
                          (and required) when `call_handler` is set to
                          `relay_script`.
                        example: null
                      call_laml_application_id:
                        type: string
                        description: >-
                          A string representing the ID of the LaML application
                          to forward incoming calls to. This is only used (and
                          required) when `call_handler` is set to
                          `laml_application`.
                        example: null
                      call_video_room_id:
                        type: string
                        format: uuid
                        description: >-
                          A string representing the ID of the Video Room to
                          forward incoming calls to. This is only used (and
                          required) when `call_handler` is set to `video_room`.
                        example: fe4093d9-58c2-4931-b4b9-5679f82652c6
                      call_dialogflow_agent_id:
                        type: string
                        format: uuid
                        description: >-
                          A string representing the ID of the Dialogflow Agent
                          to forward incoming calls to. This is only used (and
                          required) when `call_handler` is set to `dialogflow`.
                        example: fe4093d9-58c2-4931-b4b9-5679f82652c6
                      call_ai_agent_id:
                        type: string
                        format: uuid
                        description: >-
                          A string representing the ID of the AI Agent to
                          forward incoming calls to. This is only used (and
                          required) when `call_handler` is set to `ai_agent`.
                        example: fe4093d9-58c2-4931-b4b9-5679f82652c6
                      call_flow_id:
                        type: string
                        format: uuid
                        description: >-
                          A string representing the ID of the Call Flow to
                          forward incoming calls to. This is only used (and
                          required) when `call_handler` is set to `call_flow`.
                        example: fe4093d9-58c2-4931-b4b9-5679f82652c6
                      call_flow_version:
                        type: string
                        description: >-
                          A string representing the version of your Call Flow
                          you'd like to use. Valid options are `working_copy` or
                          `current_deployed`. This is only used when
                          `call_handler` is set to `call_flow`.
                        example: working_copy
                      encryption:
                        type: string
                        description: >-
                          A string representing whether connections to this
                          domain application require encryption or if encryption
                          is optional. Encryption will always be used if
                          possible. Valid values are `optional` and `required`.
                        example: required
                      codecs:
                        type: array
                        items:
                          type: string
                        description: >-
                          A list of codecs this domain application will support.
                          Currently supported values are: `OPUS`, `G722`,
                          `PCMU`, `PCMA`, `VP8`, and `H264`. At least one value
                          must be supplied.
                        example:
                          - PCMU
                          - PCMA
                      ciphers:
                        type: array
                        items:
                          type: string
                        description: >-
                          A list of encryption ciphers this domain application
                          will support. Currently supported values are:
                          `AEAD_AES_256_GCM_8`, `AES_256_CM_HMAC_SHA1_80`,
                          `AES_CM_128_HMAC_SHA1_80`, `AES_256_CM_HMAC_SHA1_32`,
                          and `AES_CM_128_HMAC_SHA1_32`. At least one value must
                          be supplied.
                        example:
                          - AEAD_AES_256_GCM_8
                    required:
                      - name
                      - identifier
                      - call_handler
    put:
      operationId: update_domain_application
      summary: Update a Domain Application
      description: |
        Updates the specific domain application by setting the values of any
        parameters passed in. Any parameters not provided will be unchanged.

        #### Permissions
        The API token must include the following scopes: _Voice_.
      tags:
        - Domain Applications
      parameters:
        - name: id
          in: path
          description: Unique ID of the domain application
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              allOf:
                - type: object
                  properties:
                    name:
                      type: string
                      description: A string representing the friendly name for this domain application.
                      example: Test App
                    identifier:
                      type: string
                      description: >-
                        A string representing the identifier portion of
                        the domain application. The combination of identifier and user must be unique across projects. 
                        Must be letters, numbers, and dash only.
                    user:
                      type: string
                      description: >-
                        A string representing the user portion of
                        the domain application. The combination of identifier and user must be unique across projects. 
                        Must be letters, numbers, and dash only. Default is '*'.
                      example: helpdesk
                    ip_auth_enabled:
                      type: boolean
                      description: Whether the domain application will enforce IP authentication for incoming requests.
                      example: true
                    ip_auth:
                      type: array
                      items:
                        type: string
                      description: A list containing whitelisted IP addresses and IP blocks used if `ip_auth_enabled` is `true`.
                      example:
                        - 8.8.8.8
                        - 4.4.4.4
                    encryption:
                      type: string
                      description: A string representing whether connections to this domain application require encryption or if encryption is optional. Encryption will always be used if possible. Valid values are `optional` and `required`.
                      example: required
                    codecs:
                      type: array
                      items:
                        type: string
                      description: A list of codecs this domain application will support. Currently supported values are `OPUS`, `G722`, `PCMU`, `PCMA`, `VP8`, and `H264`. At least one value must be supplied.
                      example:
                        - PCMU
                        - PCMA
                    ciphers:
                      type: array
                      items:
                        type: string
                      description: A list of encryption ciphers this domain application will support. Currently supported values are `AEAD_AES_256_GCM_8`, `AES_256_CM_HMAC_SHA1_80`, `AES_CM_128_HMAC_SHA1_80`, `AES_256_CM_HMAC_SHA1_32`, and `AES_CM_128_HMAC_SHA1_32`. At least one value must be supplied.
                      example:
                        - AEAD_AES_256_GCM_8
                - oneOf:
                    - type: object
                      title: Relay Topic
                      properties:
                        call_handler:
                          type: string
                          enum: [relay_topic]
                          description: Specifies that this domain application uses a Relay topic handler
                        call_relay_topic:
                          type: string
                          description: A string representing the Relay topic to forward incoming calls to.
                          example: 'office'
                        call_relay_topic_status_callback_url:
                          type: string
                          description: A string representing a URL to send status change messages to.
                          example: "https://myapplication/handle_relay_callbacks"
                    - type: object
                      title: Relay Application
                      properties:
                        call_handler:
                          type: string
                          enum: [relay_application]
                          description: Specifies that this domain application uses a Relay application handler
                        call_relay_application:
                          type: string
                          description: A string representing the Relay Application to forward incoming calls to.
                          example: 'my-relay-app'

                    - type: object
                      title: LaML Webhooks
                      properties:
                        call_handler:
                          type: string
                          enum: [laml_webhooks]
                          description: Specifies that this domain application uses LaML webhooks
                        call_request_url:
                          type: string
                          description: A string representing the LaML URL to access when a call is received.
                          example: "https://example.com/laml"
                        call_request_method:
                          type: string
                          enum: [GET, POST]
                          description: A string representing the HTTP method to use with `call_request_url`.
                          example: POST
                        call_fallback_url:
                          type: string
                          description: A string representing the LaML URL to access when the call to `call_request_url` fails.
                          example: "https://example.com/fallback"
                        call_fallback_method:
                          type: string
                          enum: [GET, POST]
                          description: A string representing the HTTP method to use with `call_fallback_url`.
                          example: POST
                        call_status_callback_url:
                          type: string
                          description: A string representing a URL to send status change messages to.
                          example: "https://example.com/status"
                        call_status_callback_method:
                          type: string
                          enum: [GET, POST]
                          description: A string representing the HTTP method to use with `call_status_callback_url`.
                          example: POST

                    - type: object
                      title: LaML Application
                      properties:
                        call_handler:
                          type: string
                          enum: [laml_application]
                          description: Specifies that this domain application uses a LaML application
                        call_laml_application_id:
                          type: string
                          description: A string representing the ID of the LaML application to forward incoming calls to.
                          example: "app-123456"

                    - type: object
                      title: Video Room
                      properties:
                        call_handler:
                          type: string
                          enum: [video_room]
                          description: Specifies that this domain application uses a Video Room
                        call_video_room_id:
                          type: string
                          format: uuid
                          description: A string representing the ID of the Video Room to forward incoming calls to.
                          example: fe4093d9-58c2-4931-b4b9-5679f82652c6

                    - type: object
                      title: Relay Script
                      properties:
                        call_handler:
                          type: string
                          enum: [relay_script]
                          description: Specifies that this domain application uses a Relay script
                        call_relay_script_url:
                          type: string
                          description: A string representing the URL of the Relay script to execute when a call is received.
                          example: "https://example.com/relay-script"

                    - type: object
                      title: Dialogflow
                      properties:
                        call_handler:
                          type: string
                          enum: [dialogflow]
                          description: Specifies that this domain application uses a Dialogflow agent
                        call_dialogflow_agent_id:
                          type: string
                          format: uuid
                          description: A string representing the ID of the Dialogflow Agent to forward incoming calls to.
                          example: fe4093d9-58c2-4931-b4b9-5679f82652c6

                    - type: object
                      title: AI Agent
                      properties:
                        call_handler:
                          type: string
                          enum: [ai_agent]
                          description: Specifies that this domain application uses an AI agent
                        call_ai_agent_id:
                          type: string
                          format: uuid
                          description: A string representing the ID of the AI Agent to forward incoming calls to.
                          example: fe4093d9-58c2-4931-b4b9-5679f82652c6

                    - type: object
                      title: Call Flow
                      properties:
                        call_handler:
                          type: string
                          enum: [call_flow]
                          description: Specifies that this domain application uses a Call Flow
                        call_flow_id:
                          type: string
                          format: uuid
                          description: A string representing the ID of the Call Flow to forward incoming calls to.
                          example: fe4093d9-58c2-4931-b4b9-5679f82652c6
                        call_flow_version:
                          type: string
                          enum: [working_copy, current_deployed]
                          description: A string representing the version of your Call Flow you'd like to use.
                          example: working_copy

                    - type: object
                      title: Relay Context (Deprecated)
                      deprecated: true
                      properties:
                        call_handler:
                          type: string
                          enum: [relay_context]
                          description: This handler type is deprecated. Please use `call_relay_application` or `call_relay_topic` instead.
                        call_relay_context:
                          type: string
                          description: >-
                            This handler type is deprecated. Please use `call_relay_application` or `call_relay_topic` instead.
                          example: 'office'
                          deprecated: true
                        call_relay_context_status_callback_url:
                          type: string
                          description: >-
                            This property is deprecated. Please use `call_relay_topic_status_callback_url` instead.
                          example: "https://myapplication/handle_relay_callbacks"
                          deprecated: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  links:
                    type: object
                    properties:
                      self:
                        type: string
                      first:
                        type: string
                      next:
                        type: string
                      prev:
                        type: string
                  data:
                    type: array
                    items:
                      allOf:
                        - type: object
                          properties:
                            id:
                              type: string
                              description: >-
                                The unique identifier of the domain application
                                on SignalWire. This can be used to update or
                                delete the application programmatically.
                              format: uuid
                          required:
                            - id
                        - type: object
                          properties:
                            type:
                              type: string
                              description: >-
                                A string representation of the type of object
                                this record is.
                              example: domain_application
                            domain:
                              type: string
                              description: >-
                                A string representation of the subdomain for
                                this application.
                              example: your-space-test_id
                        - type: object
                          properties:
                            name:
                              type: string
                              description: >-
                                A string representing the friendly name for this
                                domain application.
                              example: Test App
                            identifier:
                              type: string
                              description: >-
                                A string representing the identifier portion of
                                the domain application. The combination of identifier and user must be unique across projects. 
                                Must be letters, numbers, and dash only.
                            user:
                              type: string
                              description: >-
                                A string representing the user portion of
                                the domain application. The combination of identifier and user must be unique across projects. 
                                Must be letters, numbers, and dash only. Default is '*'.
                              example: helpdesk
                            ip_auth_enabled:
                              type: boolean
                              description: >-
                                Whether the domain application will enforce IP
                                authentication for incoming requests.
                              example: true
                            ip_auth:
                              type: array
                              items:
                                type: string
                              description: >-
                                A list containing whitelisted IP addresses and
                                IP blocks used if `ip_auth_enabled` is `true`.
                              example:
                                - 8.8.8.8
                                - 4.4.4.4
                            call_handler:
                              type: string
                              description: >-
                                A string representing how this domain
                                application handles calls. Valid values are
                                `relay_context`, `relay_topic`, `relay_application`,
                                `laml_webhooks`, `laml_application`,
                                `video_room`, `relay_script`, `dialogflow`,
                                `ai_agent`, and `call_flow`.
                              example: relay_application
                            call_request_url:
                              type: string
                              description: >-
                                A string representing the LaML URL to access
                                when a call is received. This is only used (and
                                required) when `call_handler` is set to
                                `laml_webhooks`.
                              example: null
                            call_request_method:
                              type: string
                              description: >-
                                A string representing the HTTP method to use
                                with `call_request_url`. Valid values are `GET`
                                and `POST`. This is only used (and required)
                                when `call_handler` is set to `laml_webhooks`.
                              example: POST
                            call_fallback_url:
                              type: string
                              description: >-
                                A string representing the LaML URL to access
                                when the call to `call_request_url` fails. This
                                is only used (and required) when `call_handler`
                                is set to `laml_webhooks`.
                              example: null
                            call_fallback_method:
                              type: string
                              description: >-
                                A string representing the HTTP method to use
                                with `call_fallback_url`. Valid values are `GET`
                                and `POST`. This is only used (and required)
                                when `call_handler` is set to `laml_webhooks`.
                              example: POST
                            call_status_callback_url:
                              type: string
                              description: >-
                                A string representing a URL to send status
                                change messages to. This is only used (and
                                required) when `call_handler` is set to
                                `laml_webhooks`.
                              example: null
                            call_status_callback_method:
                              type: string
                              description: >-
                                A string representing the HTTP method to use
                                with `call_status_callback_url`. Valid values
                                are `GET` and `POST`. This is only used (and
                                required) when `call_handler` is set to
                                `laml_webhooks`.
                              example: POST
                            call_relay_topic:
                              type: string
                              description: >-
                                A string representing the Relay topic to
                                forward incoming calls to. This is only used
                                (and required) when `call_handler` is set to
                                `relay_topic`. Alias of
                                `call_relay_application`. If both are sent,
                                `call_relay_application` takes precedence.
                              example: 'office'
                            call_relay_topic_status_callback_url:
                              type: string
                              description: >-
                                A string representing a URL to send status change
                                messages to. This is only used (and required) when
                                `call_handler` is set to `relay_topic`.
                              example: "https://myapplication/handle_relay_callbacks"
                            call_relay_context:
                              type: string
                              description: >-
                                A string representing the Relay context to
                                forward incoming calls to. This is only used
                                (and required) when `call_handler` is set to
                                `relay_context`. Alias of
                                `call_relay_application`. If both are sent,
                                `call_relay_application` takes precedence.
                              example: 'office'
                              deprecated: true
                            call_relay_context_status_callback_url:
                              type: string
                              description: >-
                                Deprecated. Use `call_relay_topic_status_callback_url` instead.
                              example: "https://myapplication/handle_relay_callbacks"
                              deprecated: true
                            call_relay_application:
                              type: string
                              description: >-
                                A string representing the Relay Application to
                                forward incoming calls to. This is only used
                                (and required) when `call_handler` is set to
                                `relay_application`. Alias of
                                `call_relay_context`. If both are sent,
                                `call_relay_application` takes precedence.
                              example: null
                            call_relay_script_url:
                              type: string
                              description: >-
                                A string representing the URL of the Relay
                                script to execute when a call is received. This
                                is only used (and required) when `call_handler`
                                is set to `relay_script`.
                              example: null
                            call_laml_application_id:
                              type: string
                              description: >-
                                A string representing the ID of the LaML
                                application to forward incoming calls to. This
                                is only used (and required) when `call_handler`
                                is set to `laml_application`.
                              example: null
                            call_video_room_id:
                              type: string
                              format: uuid
                              description: >-
                                A string representing the ID of the Video Room
                                to forward incoming calls to. This is only used
                                (and required) when `call_handler` is set to
                                `video_room`.
                              example: fe4093d9-58c2-4931-b4b9-5679f82652c6
                            call_dialogflow_agent_id:
                              type: string
                              format: uuid
                              description: >-
                                A string representing the ID of the Dialogflow
                                Agent to forward incoming calls to. This is only
                                used (and required) when `call_handler` is set
                                to `dialogflow`.
                              example: fe4093d9-58c2-4931-b4b9-5679f82652c6
                            call_ai_agent_id:
                              type: string
                              format: uuid
                              description: >-
                                A string representing the ID of the AI Agent to
                                forward incoming calls to. This is only used
                                (and required) when `call_handler` is set to
                                `ai_agent`.
                              example: fe4093d9-58c2-4931-b4b9-5679f82652c6
                            call_flow_id:
                              type: string
                              format: uuid
                              description: >-
                                A string representing the ID of the Call Flow to
                                forward incoming calls to. This is only used
                                (and required) when `call_handler` is set to
                                `call_flow`.
                              example: fe4093d9-58c2-4931-b4b9-5679f82652c6
                            call_flow_version:
                              type: string
                              description: >-
                                A string representing the version of your Call
                                Flow you'd like to use. Valid options are
                                `working_copy` or `current_deployed`. This is
                                only used when `call_handler` is set to
                                `call_flow`.
                              example: working_copy
                            encryption:
                              type: string
                              description: >-
                                A string representing whether connections to
                                this domain application require encryption or if
                                encryption is optional. Encryption will always
                                be used if possible. Valid values are `optional`
                                and `required`.
                              example: required
                            codecs:
                              type: array
                              items:
                                type: string
                              description: >-
                                A list of codecs this domain application will
                                support. Currently supported values are: `OPUS`,
                                `G722`, `PCMU`, `PCMA`, `VP8`, and `H264`. At
                                least one value must be supplied.
                              example:
                                - PCMU
                                - PCMA
                            ciphers:
                              type: array
                              items:
                                type: string
                              description: >-
                                A list of encryption ciphers this domain
                                application will support. Currently supported
                                values are: `AEAD_AES_256_GCM_8`,
                                `AES_256_CM_HMAC_SHA1_80`,
                                `AES_CM_128_HMAC_SHA1_80`,
                                `AES_256_CM_HMAC_SHA1_32`, and
                                `AES_CM_128_HMAC_SHA1_32`. At least one value
                                must be supplied.
                              example:
                                - AEAD_AES_256_GCM_8
                          required:
                            - name
                            - identifier
                            - call_handler
    delete:
      operationId: delete_domain_application
      summary: Delete a Domain Application
      description: |
        Permanently deletes a domain application. It cannot be undone. Will
        reject any audio or video from currently registered devices and
        deregister any connections.

        #### Permissions
        The API token must include the following scopes: _Voice_.
      tags:
        - Domain Applications
      parameters:
        - name: id
          in: path
          description: Unique ID of the domain application
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '204':
          description: No Content
  /number_groups:
    get:
      operationId: list_number_groups
      summary: List all Number Groups
      description: |
        Returns a list of your Number Groups. The groups are returned sorted
        by creation date, with the most recent appearing first. The list is
        filterable by sending in any of the following parameters.

        #### Permissions
        The API token must include the following scopes: _Numbers_.
      tags:
        - Number Groups
      parameters:
        - name: filter_name
          in: query
          description: >-
            The name given to the number group to distinguish different groups
            within your project. Will return all SIP Endpoints containing this
            value as a substring.
          required: false
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  links:
                    type: object
                    properties:
                      self:
                        type: string
                      first:
                        type: string
                      next:
                        type: string
                      prev:
                        type: string
                  data:
                    type: array
                    items:
                      allOf:
                        - type: object
                          properties:
                            id:
                              type: string
                              description: >-
                                The unique identifier of the Number Group on
                                SignalWire. This can be used to update or delete
                                the group programmatically.
                              format: uuid
                          required:
                            - id
                        - allOf:
                            - type: object
                              properties:
                                name:
                                  type: string
                                  description: >-
                                    The name given to the number group. Helps to
                                    distinguish different groups within your
                                    project.
                                  example: My Number Group
                              required:
                                - name
                            - type: object
                              properties:
                                sticky_sender:
                                  type: boolean
                                  description: >-
                                    Whether the number group uses the same
                                    'From' number for outbound requests to a
                                    number, or chooses a random one. Defaults to
                                    `false`.
                                  example: false
                        - type: object
                          properties:
                            phone_number_count:
                              type: number
                              description: The number of phone numbers within the group.
                              example: 4
    post:
      operationId: create_number_group
      summary: Create a Number Group
      description: |
        To create a new Number Group, you send a `POST` request to the Number
        Group resource.

        #### Permissions
        The API token must include the following scopes: _Numbers_.
      tags:
        - Number Groups
      requestBody:
        required: true
        content:
          application/json:
            schema:
              allOf:
                - allOf:
                    - type: object
                      properties:
                        name:
                          type: string
                          description: >-
                            The name given to the number group. Helps to
                            distinguish different groups within your project.
                          example: My Number Group
                      required:
                        - name
                    - type: object
                      properties:
                        sticky_sender:
                          type: boolean
                          description: >-
                            Whether the number group uses the same 'From' number
                            for outbound requests to a number, or chooses a
                            random one. Defaults to `false`.
                          example: false
      responses:
        '201':
          description: CREATED
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      id:
                        type: string
                        description: >-
                          The unique identifier of the Number Group on
                          SignalWire. This can be used to update or delete the
                          group programmatically.
                        format: uuid
                    required:
                      - id
                  - allOf:
                      - type: object
                        properties:
                          name:
                            type: string
                            description: >-
                              The name given to the number group. Helps to
                              distinguish different groups within your project.
                            example: My Number Group
                        required:
                          - name
                      - type: object
                        properties:
                          sticky_sender:
                            type: boolean
                            description: >-
                              Whether the number group uses the same 'From'
                              number for outbound requests to a number, or
                              chooses a random one. Defaults to `false`.
                            example: false
                  - type: object
                    properties:
                      phone_number_count:
                        type: number
                        description: The number of phone numbers within the group.
                        example: 4
  /number_groups/{id}:
    get:
      operationId: retrieve_number_group
      summary: Retrieve a Number Group
      description: |
        Retrieves the details of a Number Group that has been previously
        created. Use the unique ID that was returned from your previous
        request to identify the specific Number Group.

        #### Permissions
        The API token must include the following scopes: _Numbers_.
      tags:
        - Number Groups
      parameters:
        - name: id
          in: path
          description: Unique ID of the number group
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      id:
                        type: string
                        description: >-
                          The unique identifier of the Number Group on
                          SignalWire. This can be used to update or delete the
                          group programmatically.
                        format: uuid
                    required:
                      - id
                  - allOf:
                      - type: object
                        properties:
                          name:
                            type: string
                            description: >-
                              The name given to the number group. Helps to
                              distinguish different groups within your project.
                            example: My Number Group
                        required:
                          - name
                      - type: object
                        properties:
                          sticky_sender:
                            type: boolean
                            description: >-
                              Whether the number group uses the same 'From'
                              number for outbound requests to a number, or
                              chooses a random one. Defaults to `false`.
                            example: false
                  - type: object
                    properties:
                      phone_number_count:
                        type: number
                        description: The number of phone numbers within the group.
                        example: 4
    put:
      operationId: update_number_group
      summary: Update a Number Group
      description: |
        Updates the specific Number Group by setting the values of any
        parameters passed in. Any parameters not provided will be unchanged.

        #### Permissions
        The API token must include the following scopes: _Numbers_.
      tags:
        - Number Groups
      parameters:
        - name: id
          in: path
          description: Unique ID of the number group
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              allOf:
                - type: object
                  properties:
                    name:
                      type: string
                      description: >-
                        The name given to the number group. Helps to distinguish
                        different groups within your project.
                      example: My Number Group
                  required:
                    - name
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      id:
                        type: string
                        description: >-
                          The unique identifier of the Number Group on
                          SignalWire. This can be used to update or delete the
                          group programmatically.
                        format: uuid
                    required:
                      - id
                  - allOf:
                      - type: object
                        properties:
                          name:
                            type: string
                            description: >-
                              The name given to the number group. Helps to
                              distinguish different groups within your project.
                            example: My Number Group
                        required:
                          - name
                      - type: object
                        properties:
                          sticky_sender:
                            type: boolean
                            description: >-
                              Whether the number group uses the same 'From'
                              number for outbound requests to a number, or
                              chooses a random one. Defaults to `false`.
                            example: false
                  - type: object
                    properties:
                      phone_number_count:
                        type: number
                        description: The number of phone numbers within the group.
                        example: 4
    delete:
      operationId: delete_number_group
      summary: Delete a Number Group
      description: |
        Permanently deletes a Number Group. This cannot be undone. This action
        will not release Phone Numbers, it will just disassociate them from
        the Number Group.

        #### Permissions
        The API token must include the following scopes: _Numbers_.
      tags:
        - Number Groups
      parameters:
        - name: id
          in: path
          description: Unique ID of the number group
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '204':
          description: No Content
  /number_groups/{NumberGroupId}/number_group_memberships:
    get:
      operationId: list_number_group_memberships
      summary: List all Number Group Memberships
      description: |
        Returns a list of a Number Group's Memberships. The memberships are
        returned sorted by creation date, with the most recent appearing
        first.

        #### Permissions
        The API token must include the following scopes: _Numbers_.
      tags:
        - Number Group Membership
      parameters:
        - name: NumberGroupId
          in: path
          description: Unique ID of the number group
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  links:
                    type: object
                    properties:
                      self:
                        type: string
                      first:
                        type: string
                      next:
                        type: string
                      prev:
                        type: string
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          description: >-
                            The unique identifier of the Number Group Membership
                            on SignalWire. This can be used to delete the
                            membership programmatically.
                          format: uuid
                        number_group_id:
                          type: string
                          description: >-
                            The unique identifier of the Number Group this
                            membership is associated with.
                          format: uuid
                        phone_number:
                          type: object
                          description: >-
                            A representation of the phone number this membership
                            is associated with.
                          properties:
                            id:
                              type: string
                              format: uuid
                            name:
                              type: string
                              example: Jenny
                            number:
                              type: string
                              example: '+15558675309'
                            capabilities:
                              type: array
                              items:
                                type: string
                              example:
                                - voice
                                - sms
                                - mms
                                - fax
    post:
      operationId: create_number_group_membership
      summary: Create a Number Group Membership
      description: |
        To create a new Number Group Membership, you send a POST request to
        the Number Group Membership resource.

        #### Permissions
        The API token must include the following scopes: _Numbers_.
      tags:
        - Number Group Membership
      parameters:
        - name: NumberGroupId
          in: path
          description: Unique ID of the number group
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              allOf:
                - type: object
                  properties:
                    phone_number_id:
                      type: string
                      description: >-
                        The unique identifier of the Phone Number you would like
                        to add to the Number Group.
                      format: uuid
                  required:
                    - phone_number_id
      responses:
        '201':
          description: CREATED
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    description: >-
                      The unique identifier of the Number Group Membership on
                      SignalWire. This can be used to delete the membership
                      programmatically.
                    format: uuid
                  number_group_id:
                    type: string
                    description: >-
                      The unique identifier of the Number Group this membership
                      is associated with.
                    format: uuid
                  phone_number:
                    type: object
                    description: >-
                      A representation of the phone number this membership is
                      associated with.
                    properties:
                      id:
                        type: string
                        format: uuid
                      name:
                        type: string
                        example: Jenny
                      number:
                        type: string
                        example: '+15558675309'
                      capabilities:
                        type: array
                        items:
                          type: string
                        example:
                          - voice
                          - sms
                          - mms
                          - fax
  /number_group_memberships/{id}:
    get:
      operationId: retrieve_number_group_membership
      summary: Retrieve a Number Group Membership
      description: |
        Retrieves the details of a Number Group Membership that has been
        previously created. Use the unique ID that was returned from your
        previous request to identify the specific Number Group Membership.

        #### Permissions
        The API token must include the following scopes: _Numbers_.
      tags:
        - Number Group Membership
      parameters:
        - name: id
          in: path
          description: Unique ID of the number group membership
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    description: >-
                      The unique identifier of the Number Group Membership on
                      SignalWire. This can be used to delete the membership
                      programmatically.
                    format: uuid
                  number_group_id:
                    type: string
                    description: >-
                      The unique identifier of the Number Group this membership
                      is associated with.
                    format: uuid
                  phone_number:
                    type: object
                    description: >-
                      A representation of the phone number this membership is
                      associated with.
                    properties:
                      id:
                        type: string
                        format: uuid
                      name:
                        type: string
                        example: Jenny
                      number:
                        type: string
                        example: '+15558675309'
                      capabilities:
                        type: array
                        items:
                          type: string
                        example:
                          - voice
                          - sms
                          - mms
                          - fax
    delete:
      operationId: delete_number_group_membership
      summary: Delete a Number Group Membership
      description: |
        Permanently deletes a Number Group Membership. This cannot be undone.
        This action will not release Phone Numbers, it will just disassociate
        the Phone Number from the Number Group.

        #### Permissions
        The API token must include the following scopes: _Numbers_.
      tags:
        - Number Group Membership
      parameters:
        - name: id
          in: path
          description: Unique ID of the number group membership
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '204':
          description: No Content
  /imported_phone_numbers:
    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_.
      tags:
        - Imported Phone Numbers
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - number
                - number_type
              properties:
                number:
                  type: string
                  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'
                  minLength: 5
                  maxLength: 30
                number_type:
                  type: string
                  description: The type of phone number being imported.
                  enum:
                    - longcode
                    - tollfree
                  example: longcode
                capabilities:
                  type: array
                  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.
                  items:
                    type: string
                    enum:
                      - sms
                      - voice
                      - fax
                      - mms
                  example: ['sms', 'fax']
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    description: The unique identifier of the phone number on SignalWire.
                    example: alpha-numeric-string
                  name:
                    type: string
                    nullable: true
                    description: The name given to the phone number.
                    example: null
                  number:
                    type: string
                    description: The phone number in E.164 format.
                    example: '+491522343333'
                  capabilities:
                    type: array
                    description: The enabled capabilities for this phone number.
                    items:
                      type: string
                      enum:
                        - sms
                        - voice
                        - fax
                        - mms
                    example: ['sms', 'voice']
                  number_type:
                    type: string
                    description: The type of phone number.
                    enum:
                      - longcode
                      - tollfree
                    example: longcode
                  e911_address_id:
                    type: string
                    nullable: true
                    description: The ID of the E911 address associated with this number.
                    example: null
                  created_at:
                    type: string
                    format: date-time
                    description: The date and time when this phone number was created.
                    example: '2023-09-28T18:04:40Z'
                  updated_at:
                    type: string
                    format: date-time
                    description: The date and time when this phone number was last updated.
                    example: '2023-09-28T18:04:40Z'
                  next_billed_at:
                    type: string
                    nullable: true
                    format: date-time
                    description: The date and time when this phone number will be billed next.
                    example: null
                  call_handler:
                    type: string
                    description: What type of handler you want to run on inbound calls.
                    example: laml_webhooks
                  call_receive_mode:
                    type: string
                    description: How to receive the incoming call (voice or fax).
                    example: voice
                  call_request_url:
                    type: string
                    nullable: true
                    description: The URL to make a request to when using the laml_webhooks call handler.
                    example: null
                  call_request_method:
                    type: string
                    nullable: true
                    description: The HTTP method to use when making a request to the call_request_url.
                    example: null
                  call_fallback_url:
                    type: string
                    nullable: true
                    description: The fallback URL to make a request to when the call_request_url fails.
                    example: null
                  call_fallback_method:
                    type: string
                    nullable: true
                    description: The HTTP method to use when making a request to the call_fallback_url.
                    example: null
                  call_status_callback_url:
                    type: string
                    nullable: true
                    description: The URL to make status callbacks to.
                    example: null
                  call_status_callback_method:
                    type: string
                    nullable: true
                    description: The HTTP method to use when making a request to the call_status_callback_url.
                    example: null
                  call_laml_application_id:
                    type: string
                    nullable: true
                    description: The ID of the LaML Application to use.
                    example: null
                  call_dialogflow_agent_id:
                    type: string
                    nullable: true
                    description: The ID of the Dialogflow Agent to start.
                    example: null
                  call_relay_context:
                    type: string
                    nullable: true
                    description: The name of the Relay Context to send this call to.
                    example: null
                  call_relay_application:
                    type: string
                    nullable: true
                    description: The name of the Relay Application to send this call to.
                    example: null
                  call_relay_connector_id:
                    type: string
                    nullable: true
                    description: The ID of the Relay Connector to use.
                    example: null
                  call_sip_endpoint_id:
                    type: string
                    nullable: true
                    description: The ID of the SIP Endpoint to use.
                    example: null
                  call_verto_resource:
                    type: string
                    nullable: true
                    description: The Verto resource to use.
                    example: null
                  call_video_room_id:
                    type: string
                    nullable: true
                    description: The ID of the Video Room to use.
                    example: null
                  call_relay_script_url:
                    type: string
                    nullable: true
                    description: The URL to make a request to when using the relay_script call handler.
                    example: null
                  message_handler:
                    type: string
                    description: What type of handler you want to run on inbound messages.
                    example: laml_webhooks
                  message_request_url:
                    type: string
                    nullable: true
                    description: The URL to make a request to when using the laml_webhooks message handler.
                    example: null
                  message_request_method:
                    type: string
                    nullable: true
                    description: The HTTP method to use when making a request to the message_request_url.
                    example: null
                  message_fallback_url:
                    type: string
                    nullable: true
                    description: The fallback URL to make a request to when the message_request_url fails.
                    example: null
                  message_fallback_method:
                    type: string
                    nullable: true
                    description: The HTTP method to use when making a request to the message_fallback_url.
                    example: null
                  message_laml_application_id:
                    type: string
                    nullable: true
                    description: The ID of the LaML Application to use for messages.
                    example: null
                  message_relay_context:
                    type: string
                    nullable: true
                    description: The name of the Relay Context to send this message to.
                    example: null
                  country_code:
                    type: string
                    nullable: true
                    description: The country code for this phone number.
                    example: null
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        detail:
                          type: string
                          description: A human-readable error message.
                          example: "Number type can't be blank"
                        status:
                          type: string
                          description: The HTTP status code.
                          example: '422'
                        title:
                          type: string
                          description: A short, human-readable summary of the problem.
                          example: Invalid Attribute
                        code:
                          type: string
                          description: The error code.
                          example: '422'
  /phone_numbers:
    get:
      operationId: list_phone_numbers
      summary: List all Phone Numbers
      description: |
        Returns a list of your Phone Numbers. The phone numbers are returned
        sorted by creation date, with the most recent phone numbers appearing
        first. The list is filterable by sending in any of the following
        parameters.

        #### Permissions
        The API token must include the following scopes: _Numbers_.
      tags:
        - Phone Numbers
      parameters:
        - name: filter_name
          in: query
          description: >-
            The name given to the phone number. Will return all Phone Numbers
            containing this value as a substring.
          required: false
          schema:
            type: string
        - name: filter_number
          in: query
          description: >-
            The phone number in E164 format. Will return all Phone Numbers
            containing this value as a substring.
          required: false
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  links:
                    type: object
                    properties:
                      self:
                        type: string
                      first:
                        type: string
                      next:
                        type: string
                      prev:
                        type: string
                  data:
                    type: array
                    items:
                      allOf:
                        - type: object
                          properties:
                            id:
                              type: string
                              description: >-
                                The unique identifier of the Phone Number on
                                SignalWire. This can be used to find, update or
                                delete the phone number programmatically.
                              format: uuid
                        - type: object
                          properties:
                            number:
                              type: string
                              description: The phone number in E164 format.
                              example: '+15558675309'
                          required:
                            - number
                        - type: object
                          properties:
                            name:
                              type: string
                              description: >-
                                The name given to the phone number. Helps to
                                distinguish different phone numbers within your
                                project.
                              example: Jenny
                            call_handler:
                              description: >
                                What type of handler you want to run on inbound calls.
                              type: string
                              enum:
                                - relay_script
                                - relay_context
                                - relay_topic
                                - relay_application
                                - laml_webhooks
                                - laml_application
                                - dialogflow
                                - relay_connector
                                - relay_sip_endpoint
                                - relay_verto_endpoint
                                - video_room
                              example: relay_context
                            call_receive_mode:
                              type: string
                              description: >-
                                How do you want to receive the incoming call.
                                Possible values are: `voice` or `fax`. Default
                                is `voice`.
                              example: voice
                            call_request_url:
                              type: string
                              description: >-
                                The URL to make a request to when using the
                                `laml_webhooks` call handler.
                              example: ''
                            call_request_method:
                              type: string
                              description: >-
                                The HTTP method to use when making a request to
                                the `call_request_url`. Possible values are:
                                `POST` or `GET`. Default is `POST`.
                              example: POST
                            call_fallback_url:
                              type: string
                              description: >-
                                The fallback URL to make a request to when using
                                the `laml_webhooks` call handler and the
                                `call_request_url` fails.
                              example: ''
                            call_fallback_method:
                              type: string
                              description: >-
                                The HTTP method to use when making a request to
                                the `call_fallback_url`. Possible values are:
                                `POST` or `GET`. Default is `POST`.
                              example: POST
                            call_status_callback_url:
                              type: string
                              description: >-
                                The URL to make status callbacks to when using
                                the `laml_webhooks` call handler.
                              example: ''
                            call_status_callback_method:
                              type: string
                              description: >-
                                The HTTP method to use when making a request to
                                the `call_status_callback_url`. Possible values
                                are: `POST` or `GET`. Default is `POST`.
                              example: POST
                            call_laml_application_id:
                              type: string
                              description: >-
                                The ID of the LaML Application to use when using
                                the `laml_application` call handler.
                              example: null
                            call_dialogflow_agent_id:
                              type: string
                              description: >-
                                The ID of the Dialogflow Agent to start when
                                using the `dialogflow` call handler.
                              example: null
                            call_relay_topic:
                              type: string
                              description: >-
                                A string representing the Relay topic to
                                forward incoming calls to. This is only used
                                (and required) when `call_handler` is set to
                                `relay_topic`. Alias of
                                `call_relay_application`. If both are sent,
                                `call_relay_application` takes precedence.
                              example: 'office'
                            call_relay_topic_status_callback_url:
                              type: string
                              description: >-
                                A string representing a URL to send status change
                                messages to. This is only used (and required) when
                                `call_handler` is set to `relay_topic`.
                              example: "https://myapplication/handle_relay_callbacks"
                            call_relay_script_url:
                              type: string
                              description: >-
                                The URL to make a request to when using the
                                `relay_script` call handler. The URL must respond with a valid [`SWML`](/swml) script.
                              example: https://example.signalwire.com/relay-bins/60e2ba7b-366e-44de-84e3-0c76cfccf1cc
                            call_relay_context:
                              type: string
                              description: >-
                                The name of the Relay Context to send this call
                                to when using the `relay_context` call handler.
                                Alias of `message_relay_application`. If both
                                are sent, `call_relay_application` takes
                                precedence.
                              example: my_relay_app
                            call_relay_context_status_callback_url:
                              type: string
                              description: >-
                                A string representing a URL to send status change
                                messages to. This is only used (and required) when
                                `call_handler` is set to `relay_context`.
                              example: "https://myapplication/handle_relay_callbacks"
                            call_relay_application:
                              type: string
                              description: >-
                                The name of the Relay Application to send this
                                call to when using the `relay_application` call
                                handler. Alias of `call_relay_context`. If
                                both are sent, `call_relay_application` takes
                                precedence.
                              example: my_relay_app
                            call_relay_connector_id:
                              type: string
                              description: >-
                                The ID of the Relay Connector to send this call
                                to when using the `relay_connector` call
                                handler.
                              example: null
                            call_sip_endpoint_id:
                              type: string
                              description: >-
                                The ID of the Relay SIP Endpoint to send this
                                call to when using the `relay_sip_endpoint` call
                                handler.
                              example: null
                            call_verto_resource:
                              type: string
                              description: >-
                                The name of the Verto Relay Endpoint to send
                                this call to when using the
                                `relay_verto_endpoint` call handler.
                              example: ''
                            call_video_room_id:
                              type: string
                              format: uuid
                              description: >-
                                The ID of the Video Room to send this call to
                                when using the `video_room` call handler.
                              example: fe4093d9-58c2-4931-b4b9-5679f82652c6
                            message_handler:
                              type: string
                              description: >-
                                What type of handler you want to run on inbound
                                messages. Possible values are: `relay_context`, `relay_topic`, 
                                `relay_application`, `laml_webhooks`,
                                `laml_application`.
                              example: relay_application
                            message_request_url:
                              type: string
                              description: >-
                                The URL to make a request to when using the
                                `laml_webhooks` message handler.
                              example: ''
                            message_request_method:
                              type: string
                              description: >-
                                The HTTP method to use when making a request to
                                the `message_request_url`. Possible values are:
                                `POST` or `GET`. Default is `POST`.
                              example: POST
                            message_fallback_url:
                              type: string
                              description: >-
                                The fallback URL to make a request to when using
                                the `laml_webhooks` message handler and the
                                `message_request_url` fails.
                              example: ''
                            message_fallback_method:
                              type: string
                              description: >-
                                The HTTP method to use when making a request to
                                the `message_fallback_url`. Possible values are:
                                `POST` or `GET`. Default is `POST`.
                              example: POST
                            message_laml_application_id:
                              type: string
                              description: >-
                                The ID of the LaML Application to use when using
                                the `laml_application` message handler.
                              example: 'null'
                            message_relay_topic:
                              type: string
                              description: >-
                                The name of the Relay Topic to send this
                                message to when using the `relay_topic`
                                message handler. Alias of
                                `message_relay_application`. If both are sent,
                                `message_relay_application` takes precedence.
                            message_relay_context:
                              type: string
                              description: >-
                                The name of the Relay Context to send this
                                message to when using the `relay_context`
                                message handler. Alias of
                                `message_relay_application`. If both are sent,
                                `message_relay_application` takes precedence.
                              example: my_relay_app
                            message_relay_application:
                              type: string
                              description: >-
                                The name of the Relay Application to send this
                                message to when using the `relay_application`
                                message handler. Alias of
                                `message_relay_context`. If both are sent,
                                `message_relay_application` takes precedence.
                              example: my_relay_app
                        - type: object
                          properties:
                            capabilities:
                              type: array
                              items:
                                type: string
                              description: >-
                                A list of communication methods this phone
                                number supports. Possible values are: `voice`,
                                `fax`, `sms`, `mms`.
                              example:
                                - voice
                                - sms
                                - mms
                                - fax
                            number_type:
                              type: string
                              description: >-
                                The type of number this is defined as. Possible
                                values are: `toll-free` or `longcode`.
                              example: toll-free
                            e911_address_id:
                              type: string
                              description: >-
                                A list of communication methods this phone
                                number supports.
                              example: null
                            created_at:
                              type: string
                              description: The date the number was added to your project.
                              format: date-time
                            updated_at:
                              type: string
                              description: The date the number was last updated.
                              format: date-time
                            next_billed_at:
                              type: string
                              description: The next date the number will be billed for.
                              format: date-time
    post:
      operationId: purchase_phone_number
      summary: Purchase a Phone Number
      description: |
        Purchase a number and add it to your project.

        #### Permissions
        The API token must include the following scopes: _Numbers_.
      tags:
        - Phone Numbers
      requestBody:
        required: true
        content:
          application/json:
            schema:
              allOf:
                - allOf:
                    - type: object
                      properties:
                        number:
                          type: string
                          description: The phone number in E164 format.
                          example: '+15558675309'
                      required:
                        - number
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      id:
                        type: string
                        description: >-
                          The unique identifier of the Phone Number on
                          SignalWire. This can be used to find, update or delete
                          the phone number programmatically.
                        format: uuid
                  - type: object
                    properties:
                      number:
                        type: string
                        description: The phone number in E164 format.
                        example: '+15558675309'
                    required:
                      - number
                  - type: object
                    properties:
                      name:
                        type: string
                        description: >-
                          The name given to the phone number. Helps to
                          distinguish different phone numbers within your
                          project.
                        example: Jenny
                      call_handler:
                        description: >
                          What type of handler you want to run on inbound calls.
                        type: string
                        enum:
                          - relay_script
                          - relay_context
                          - relay_topic
                          - relay_application
                          - laml_webhooks
                          - laml_application
                          - dialogflow
                          - relay_connector
                          - relay_sip_endpoint
                          - relay_verto_endpoint
                          - video_room
                        example: relay_context
                      call_receive_mode:
                        type: string
                        description: >-
                          How do you want to receive the incoming call. Possible
                          values are: `voice` or `fax`. Default is `voice`.
                        example: voice
                      call_request_url:
                        type: string
                        description: >-
                          The URL to make a request to when using the
                          `laml_webhooks` call handler.
                        example: ''
                      call_request_method:
                        type: string
                        description: >-
                          The HTTP method to use when making a request to the
                          `call_request_url`. Possible values are: `POST` or
                          `GET`. Default is `POST`.
                        example: POST
                      call_fallback_url:
                        type: string
                        description: >-
                          The fallback URL to make a request to when using the
                          `laml_webhooks` call handler and the
                          `call_request_url` fails.
                        example: ''
                      call_fallback_method:
                        type: string
                        description: >-
                          The HTTP method to use when making a request to the
                          `call_fallback_url`. Possible values are: `POST` or
                          `GET`. Default is `POST`.
                        example: POST
                      call_status_callback_url:
                        type: string
                        description: >-
                          The URL to make status callbacks to when using the
                          `laml_webhooks` call handler.
                        example: ''
                      call_status_callback_method:
                        type: string
                        description: >-
                          The HTTP method to use when making a request to the
                          `call_status_callback_url`. Possible values are:
                          `POST` or `GET`. Default is `POST`.
                        example: POST
                      call_laml_application_id:
                        type: string
                        description: >-
                          The ID of the LaML Application to use when using the
                          `laml_application` call handler.
                        example: null
                      call_dialogflow_agent_id:
                        type: string
                        description: >-
                          The ID of the Dialogflow Agent to start when using the
                          `dialogflow` call handler.
                        example: null
                      call_relay_topic:
                        type: string
                        description: >-
                          A string representing the Relay topic to
                          forward incoming calls to. This is only used
                          (and required) when `call_handler` is set to
                          `relay_topic`. Alias of
                          `call_relay_application`. If both are sent,
                          `call_relay_application` takes precedence.
                        example: 'office'
                      call_relay_topic_status_callback_url:
                        type: string
                        description: >-
                          A string representing a URL to send status change
                          messages to. This is only used when
                          `call_handler` is set to `relay_topic`.
                        example: "https://myapplication/handle_relay_callbacks"
                      call_relay_script_url:
                        type: string
                        description: >-
                          The URL to make a request to when using the
                          `relay_script` call handler. The URL must respond with a valid [`SWML`](/swml) script.
                        example: https://example.signalwire.com/relay-bins/60e2ba7b-366e-44de-84e3-0c76cfccf1cc
                      call_relay_context:
                        type: string
                        description: >-
                          The name of the Relay Context to send this call to
                          when using the `relay_context` call handler. Alias of
                          `message_relay_application`. If both are sent,
                          `call_relay_application` takes precedence.
                        example: my_relay_app
                      call_relay_context_status_callback_url:
                        type: string
                        description: >-
                          A string representing a URL to send status change
                          messages to. This is only used (and required) when
                          `call_handler` is set to `relay_context`.
                        example: "https://myapplication/handle_relay_callbacks"
                      call_relay_application:
                        type: string
                        description: >-
                          The name of the Relay Application to send this call to
                          when using the `relay_application` call handler. Alias
                          of `call_relay_context`. If both are sent,
                          `call_relay_application` takes precedence.
                        example: my_relay_app
                      call_relay_connector_id:
                        type: string
                        description: >-
                          The ID of the Relay Connector to send this call to
                          when using the `relay_connector` call handler.
                        example: null
                      call_sip_endpoint_id:
                        type: string
                        description: >-
                          The ID of the Relay SIP Endpoint to send this call to
                          when using the `relay_sip_endpoint` call handler.
                        example: null
                      call_verto_resource:
                        type: string
                        description: >-
                          The name of the Verto Relay Endpoint to send this call
                          to when using the `relay_verto_endpoint` call handler.
                        example: ''
                      call_video_room_id:
                        type: string
                        format: uuid
                        description: >-
                          The ID of the Video Room to send this call to when
                          using the `video_room` call handler.
                        example: fe4093d9-58c2-4931-b4b9-5679f82652c6
                      message_handler:
                        type: string
                        description: >-
                          What type of handler you want to run on inbound
                          messages. Possible values are: `relay_context`, `relay_topic`, 
                          `relay_application`, `laml_webhooks`,
                          `laml_application`.
                        example: relay_application
                      message_request_url:
                        type: string
                        description: >-
                          The URL to make a request to when using the
                          `laml_webhooks` message handler.
                        example: ''
                      message_request_method:
                        type: string
                        description: >-
                          The HTTP method to use when making a request to the
                          `message_request_url`. Possible values are: `POST` or
                          `GET`. Default is `POST`.
                        example: POST
                      message_fallback_url:
                        type: string
                        description: >-
                          The fallback URL to make a request to when using the
                          `laml_webhooks` message handler and the
                          `message_request_url` fails.
                        example: ''
                      message_fallback_method:
                        type: string
                        description: >-
                          The HTTP method to use when making a request to the
                          `message_fallback_url`. Possible values are: `POST` or
                          `GET`. Default is `POST`.
                        example: POST
                      message_laml_application_id:
                        type: string
                        description: >-
                          The ID of the LaML Application to use when using the
                          `laml_application` message handler.
                        example: 'null'
                      message_relay_topic:
                        type: string
                        description: >-
                          The name of the Relay Topic to send this
                          message to when using the `relay_topic`
                          message handler. Alias of
                          `message_relay_application`. If both are sent,
                          `message_relay_application` takes precedence.
                      message_relay_context:
                        type: string
                        description: >-
                          The name of the Relay Context to send this message to
                          when using the `relay_context` message handler. Alias
                          of `message_relay_application`. If both are sent,
                          `message_relay_application` takes precedence.
                        example: my_relay_app
                      message_relay_application:
                        type: string
                        description: >-
                          The name of the Relay Application to send this message
                          to when using the `relay_application` message handler.
                          Alias of `message_relay_context`. If both are sent,
                          `message_relay_application` takes precedence.
                        example: my_relay_app
                  - type: object
                    properties:
                      capabilities:
                        type: array
                        items:
                          type: string
                        description: >-
                          A list of communication methods this phone number
                          supports. Possible values are: `voice`, `fax`, `sms`,
                          `mms`.
                        example:
                          - voice
                          - sms
                          - mms
                          - fax
                      number_type:
                        type: string
                        description: >-
                          The type of number this is defined as. Possible values
                          are: `toll-free` or `longcode`.
                        example: toll-free
                      e911_address_id:
                        type: string
                        description: >-
                          A list of communication methods this phone number
                          supports.
                        example: null
                      created_at:
                        type: string
                        description: The date the number was added to your project.
                        format: date-time
                      updated_at:
                        type: string
                        description: The date the number was last updated.
                        format: date-time
                      next_billed_at:
                        type: string
                        description: The next date the number will be billed for.
                        format: date-time
  /phone_numbers/{id}:
    get:
      operationId: retrieve_phone_number
      summary: Retrieve a Phone Number
      description: |
        Retrieves the details of a Phone Number that has been previously
        created.

        #### Permissions
        The API token must include the following scopes: _Numbers_.
      tags:
        - Phone Numbers
      parameters:
        - name: id
          in: path
          description: Unique ID of the phone number
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      id:
                        type: string
                        description: >-
                          The unique identifier of the Phone Number on
                          SignalWire. This can be used to find, update or delete
                          the phone number programmatically.
                        format: uuid
                  - type: object
                    properties:
                      number:
                        type: string
                        description: The phone number in E164 format.
                        example: '+15558675309'
                    required:
                      - number
                  - type: object
                    properties:
                      name:
                        type: string
                        description: >-
                          The name given to the phone number. Helps to
                          distinguish different phone numbers within your
                          project.
                        example: Jenny
                      call_handler:
                        description: >
                          What type of handler you want to run on inbound calls.
                        type: string
                        enum:
                          - relay_script
                          - relay_context
                          - relay_application
                          - laml_webhooks
                          - laml_application
                          - dialogflow
                          - relay_connector
                          - relay_sip_endpoint
                          - relay_verto_endpoint
                          - video_room
                        example: relay_context
                      call_receive_mode:
                        type: string
                        description: >-
                          How do you want to receive the incoming call. Possible
                          values are: `voice` or `fax`. Default is `voice`.
                        example: voice
                      call_request_url:
                        type: string
                        description: >-
                          The URL to make a request to when using the
                          `laml_webhooks` call handler.
                        example: ''
                      call_request_method:
                        type: string
                        description: >-
                          The HTTP method to use when making a request to the
                          `call_request_url`. Possible values are: `POST` or
                          `GET`. Default is `POST`.
                        example: POST
                      call_fallback_url:
                        type: string
                        description: >-
                          The fallback URL to make a request to when using the
                          `laml_webhooks` call handler and the
                          `call_request_url` fails.
                        example: ''
                      call_fallback_method:
                        type: string
                        description: >-
                          The HTTP method to use when making a request to the
                          `call_fallback_url`. Possible values are: `POST` or
                          `GET`. Default is `POST`.
                        example: POST
                      call_status_callback_url:
                        type: string
                        description: >-
                          The URL to make status callbacks to when using the
                          `laml_webhooks` call handler.
                        example: ''
                      call_status_callback_method:
                        type: string
                        description: >-
                          The HTTP method to use when making a request to the
                          `call_status_callback_url`. Possible values are:
                          `POST` or `GET`. Default is `POST`.
                        example: POST
                      call_laml_application_id:
                        type: string
                        description: >-
                          The ID of the LaML Application to use when using the
                          `laml_application` call handler.
                        example: null
                      call_dialogflow_agent_id:
                        type: string
                        description: >-
                          The ID of the Dialogflow Agent to start when using the
                          `dialogflow` call handler.
                        example: null
                      call_relay_topic:
                        type: string
                        description: >-
                          A string representing the Relay topic to
                          forward incoming calls to. This is only used
                          (and required) when `call_handler` is set to
                          `relay_topic`. Alias of
                          `call_relay_application`. If both are sent,
                          `call_relay_application` takes precedence.
                        example: 'office'
                      call_relay_topic_status_callback_url:
                        type: string
                        description: >-
                          A string representing a URL to send status change
                          messages to. This is only used (and required) when
                          `call_handler` is set to `relay_topic`.
                        example: "https://myapplication/handle_relay_callbacks"
                      call_relay_script_url:
                        type: string
                        description: >-
                          The URL to make a request to when using the
                          `relay_script` call handler. The URL must respond with a valid [`SWML`](/swml) script.
                        example: https://example.signalwire.com/relay-bins/60e2ba7b-366e-44de-84e3-0c76cfccf1cc
                      call_relay_context:
                        type: string
                        description: >-
                          The name of the Relay Context to send this call to
                          when using the `relay_context` call handler. Alias of
                          `message_relay_application`. If both are sent,
                          `call_relay_application` takes precedence.
                        example: my_relay_app
                      call_relay_context_status_callback_url:
                        type: string
                        description: >-
                          A string representing a URL to send status change
                          messages to. This is only used (and required) when
                          `call_handler` is set to `relay_context`.
                        example: "https://myapplication/handle_relay_callbacks"
                      call_relay_application:
                        type: string
                        description: >-
                          The name of the Relay Application to send this call to
                          when using the `relay_application` call handler. Alias
                          of `message_relay_context`. If both are sent,
                          `call_relay_application` takes precedence.
                        example: my_relay_app
                      call_relay_connector_id:
                        type: string
                        description: >-
                          The ID of the Relay Connector to send this call to
                          when using the `relay_connector` call handler.
                        example: null
                      call_sip_endpoint_id:
                        type: string
                        description: >-
                          The ID of the Relay SIP Endpoint to send this call to
                          when using the `relay_sip_endpoint` call handler.
                        example: null
                      call_verto_resource:
                        type: string
                        description: >-
                          The name of the Verto Relay Endpoint to send this call
                          to when using the `relay_verto_endpoint` call handler.
                        example: ''
                      call_video_room_id:
                        type: string
                        format: uuid
                        description: >-
                          The ID of the Video Room to send this call to when
                          using the `video_room` call handler.
                        example: fe4093d9-58c2-4931-b4b9-5679f82652c6
                      message_handler:
                        type: string
                        description: >-
                          What type of handler you want to run on inbound
                          messages. Possible values are: `relay_context`,
                          `relay_application`, `laml_webhooks`,
                          `laml_application`.
                        example: relay_application
                      message_request_url:
                        type: string
                        description: >-
                          The URL to make a request to when using the
                          `laml_webhooks` message handler.
                        example: ''
                      message_request_method:
                        type: string
                        description: >-
                          The HTTP method to use when making a request to the
                          `message_request_url`. Possible values are: `POST` or
                          `GET`. Default is `POST`.
                        example: POST
                      message_fallback_url:
                        type: string
                        description: >-
                          The fallback URL to make a request to when using the
                          `laml_webhooks` message handler and the
                          `message_request_url` fails.
                        example: ''
                      message_fallback_method:
                        type: string
                        description: >-
                          The HTTP method to use when making a request to the
                          `message_fallback_url`. Possible values are: `POST` or
                          `GET`. Default is `POST`.
                        example: POST
                      message_laml_application_id:
                        type: string
                        description: >-
                          The ID of the LaML Application to use when using the
                          `laml_application` message handler.
                        example: 'null'
                      message_relay_context:
                        type: string
                        description: >-
                          The name of the Relay Context to send this message to
                          when using the `relay_context` message handler. Alias
                          of `message_relay_application`. If both are sent,
                          `message_relay_application` takes precedence.
                        example: my_relay_app
                      message_relay_application:
                        type: string
                        description: >-
                          The name of the Relay Application to send this message
                          to when using the `relay_application` message handler.
                          Alias of `message_relay_context`. If both are sent,
                          `message_relay_application` takes precedence.
                        example: my_relay_app
                  - type: object
                    properties:
                      capabilities:
                        type: array
                        items:
                          type: string
                        description: >-
                          A list of communication methods this phone number
                          supports. Possible values are: `voice`, `fax`, `sms`,
                          `mms`.
                        example:
                          - voice
                          - sms
                          - mms
                          - fax
                      number_type:
                        type: string
                        description: >-
                          The type of number this is defined as. Possible values
                          are: `toll-free` or `longcode`.
                        example: toll-free
                      e911_address_id:
                        type: string
                        description: >-
                          A list of communication methods this phone number
                          supports.
                        example: null
                      created_at:
                        type: string
                        description: The date the number was added to your project.
                        format: date-time
                      updated_at:
                        type: string
                        description: The date the number was last updated.
                        format: date-time
                      next_billed_at:
                        type: string
                        description: The next date the number will be billed for.
                        format: date-time
    put:
      operationId: update_phone_number
      summary: Update a Phone Number
      description: |
        Updates the specific Phone Number by setting the values of any
        parameters passed in. Any parameters not provided will be unchanged.

        #### Permissions
        The API token must include the following scopes: _Numbers_.
      tags:
        - Phone Numbers
      parameters:
        - name: id
          in: path
          description: Unique ID of the phone number
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              allOf:
                - type: object
                  properties:
                    name:
                      type: string
                      description: >-
                        The name given to the phone number. Helps to distinguish
                        different phone numbers within your project.
                      example: Jenny
                    call_handler:
                      description: >
                        What type of handler you want to run on inbound calls.
                      type: string
                      enum:
                        - relay_script
                        - relay_context
                        - relay_topic
                        - relay_application
                        - laml_webhooks
                        - laml_application
                        - dialogflow
                        - relay_connector
                        - relay_sip_endpoint
                        - relay_verto_endpoint
                        - video_room
                      example: relay_context
                    call_receive_mode:
                      type: string
                      description: >-
                        How do you want to receive the incoming call. Possible
                        values are: `voice` or `fax`. Default is `voice`.
                      example: voice
                    call_request_url:
                      type: string
                      description: >-
                        The URL to make a request to when using the
                        `laml_webhooks` call handler.
                      example: ''
                    call_request_method:
                      type: string
                      description: >-
                        The HTTP method to use when making a request to the
                        `call_request_url`. Possible values are: `POST` or
                        `GET`. Default is `POST`.
                      example: POST
                    call_fallback_url:
                      type: string
                      description: >-
                        The fallback URL to make a request to when using the
                        `laml_webhooks` call handler and the `call_request_url`
                        fails.
                      example: ''
                    call_fallback_method:
                      type: string
                      description: >-
                        The HTTP method to use when making a request to the
                        `call_fallback_url`. Possible values are: `POST` or
                        `GET`. Default is `POST`.
                      example: POST
                    call_status_callback_url:
                      type: string
                      description: >-
                        The URL to make status callbacks to when using the
                        `laml_webhooks` call handler.
                      example: ''
                    call_status_callback_method:
                      type: string
                      description: >-
                        The HTTP method to use when making a request to the
                        `call_status_callback_url`. Possible values are: `POST`
                        or `GET`. Default is `POST`.
                      example: POST
                    call_laml_application_id:
                      type: string
                      description: >-
                        The ID of the LaML Application to use when using the
                        `laml_application` call handler.
                      example: null
                    call_dialogflow_agent_id:
                      type: string
                      description: >-
                        The ID of the Dialogflow Agent to start when using the
                        `dialogflow` call handler.
                      example: null
                    call_relay_topic:
                      type: string
                      description: >-
                        A string representing the Relay topic to
                        forward incoming calls to. This is only used
                        (and required) when `call_handler` is set to
                        `relay_topic`. Alias of
                        `call_relay_application`. If both are sent,
                        `call_relay_application` takes precedence.
                      example: 'office'
                    call_relay_topic_status_callback_url:
                      type: string
                      description: >-
                        A string representing a URL to send status change
                        messages to. This is only used (and required) when
                        `call_handler` is set to `relay_topic`.
                      example: "https://myapplication/handle_relay_callbacks"
                    call_relay_script_url:
                      type: string
                      description: >-
                        The URL to make a request to when using the
                        `relay_script` call handler. The URL must respond with a valid [`SWML`](/swml) script.
                      example: https://example.signalwire.com/relay-bins/60e2ba7b-366e-44de-84e3-0c76cfccf1cc
                    call_relay_context:
                      type: string
                      description: >-
                        This handler type is deprecated. Please use `call_relay_application` or `call_relay_topic` instead.
                      example: my_relay_app
                      deprecated: true
                    call_relay_context_status_callback_url:
                      type: string
                      description: This property is deprecated. Please use `call_relay_topic_status_callback_url` instead.
                      example: "https://myapplication/handle_relay_callbacks"
                      deprecated: true
                    call_relay_application:
                      type: string
                      description: >-
                        The name of the Relay Application to send this call to
                        when using the `relay_application` call handler. Alias
                        of `call_relay_context`. If both are sent,
                        `call_relay_application` takes precedence.
                      example: my_relay_app
                    call_relay_connector_id:
                      type: string
                      description: >-
                        The ID of the Relay Connector to send this call to when
                        using the `relay_connector` call handler.
                      example: null
                    call_sip_endpoint_id:
                      type: string
                      description: >-
                        The ID of the Relay SIP Endpoint to send this call to
                        when using the `relay_sip_endpoint` call handler.
                      example: null
                    call_verto_resource:
                      type: string
                      description: >-
                        The name of the Verto Relay Endpoint to send this call
                        to when using the `relay_verto_endpoint` call handler.
                      example: ''
                    call_video_room_id:
                      type: string
                      format: uuid
                      description: >-
                        The ID of the Video Room to send this call to when using
                        the `video_room` call handler.
                      example: fe4093d9-58c2-4931-b4b9-5679f82652c6
                    message_handler:
                      type: string
                      description: >-
                        What type of handler you want to run on inbound
                        messages. Possible values are: `relay_context`, `relay_topic`,
                        `relay_application`, `laml_webhooks`,
                        `laml_application`.
                      example: relay_application
                    message_request_url:
                      type: string
                      description: >-
                        The URL to make a request to when using the
                        `laml_webhooks` message handler.
                      example: ''
                    message_request_method:
                      type: string
                      description: >-
                        The HTTP method to use when making a request to the
                        `message_request_url`. Possible values are: `POST` or
                        `GET`. Default is `POST`.
                      example: POST
                    message_fallback_url:
                      type: string
                      description: >-
                        The fallback URL to make a request to when using the
                        `laml_webhooks` message handler and the
                        `message_request_url` fails.
                      example: ''
                    message_fallback_method:
                      type: string
                      description: >-
                        The HTTP method to use when making a request to the
                        `message_fallback_url`. Possible values are: `POST` or
                        `GET`. Default is `POST`.
                      example: POST
                    message_laml_application_id:
                      type: string
                      description: >-
                        The ID of the LaML Application to use when using the
                        `laml_application` message handler.
                      example: 'null'
                    message_relay_topic:
                      type: string
                      description: >-
                        The name of the Relay Topic to send this message to
                        when using the `relay_topic` message handler. Alias
                        of `message_relay_application`. If both are sent,
                        `message_relay_application` takes precedence.
                      example: my_relay_app
                    message_relay_context:
                      type: string
                      description: >-
                        This handler type is deprecated. Please use `message_relay_application` or `message_relay_topic` instead.
                      example: my_relay_app
                      deprecated: true
                    message_relay_application:
                      type: string
                      description: >-
                        The name of the Relay Application to send this message
                        to when using the `relay_application` message handler.
                        Alias of `message_relay_context`. If both are sent,
                        `message_relay_application` takes precedence.
                      example: my_relay_app
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      id:
                        type: string
                        description: >-
                          The unique identifier of the Phone Number on
                          SignalWire. This can be used to find, update or delete
                          the phone number programmatically.
                        format: uuid
                  - type: object
                    properties:
                      number:
                        type: string
                        description: The phone number in E164 format.
                        example: '+15558675309'
                    required:
                      - number
                  - type: object
                    properties:
                      name:
                        type: string
                        description: >-
                          The name given to the phone number. Helps to
                          distinguish different phone numbers within your
                          project.
                        example: Jenny
                      call_handler:
                        description: >
                          What type of handler you want to run on inbound calls.
                        type: string
                        enum:
                          - relay_script
                          - relay_context
                          - relay_topic
                          - relay_application
                          - laml_webhooks
                          - laml_application
                          - dialogflow
                          - relay_connector
                          - relay_sip_endpoint
                          - relay_verto_endpoint
                          - video_room
                        example: relay_context
                      call_receive_mode:
                        type: string
                        description: >-
                          How do you want to receive the incoming call. Possible
                          values are: `voice` or `fax`. Default is `voice`.
                        example: voice
                      call_request_url:
                        type: string
                        description: >-
                          The URL to make a request to when using the
                          `laml_webhooks` call handler.
                        example: ''
                      call_request_method:
                        type: string
                        description: >-
                          The HTTP method to use when making a request to the
                          `call_request_url`. Possible values are: `POST` or
                          `GET`. Default is `POST`.
                        example: POST
                      call_fallback_url:
                        type: string
                        description: >-
                          The fallback URL to make a request to when using the
                          `laml_webhooks` call handler and the
                          `call_request_url` fails.
                        example: ''
                      call_fallback_method:
                        type: string
                        description: >-
                          The HTTP method to use when making a request to the
                          `call_fallback_url`. Possible values are: `POST` or
                          `GET`. Default is `POST`.
                        example: POST
                      call_status_callback_url:
                        type: string
                        description: >-
                          The URL to make status callbacks to when using the
                          `laml_webhooks` call handler.
                        example: ''
                      call_status_callback_method:
                        type: string
                        description: >-
                          The HTTP method to use when making a request to the
                          `call_status_callback_url`. Possible values are:
                          `POST` or `GET`. Default is `POST`.
                        example: POST
                      call_laml_application_id:
                        type: string
                        description: >-
                          The ID of the LaML Application to use when using the
                          `laml_application` call handler.
                        example: null
                      call_dialogflow_agent_id:
                        type: string
                        description: >-
                          The ID of the Dialogflow Agent to start when using the
                          `dialogflow` call handler.
                        example: null
                      call_relay_topic:
                        type: string
                        description: >-
                          A string representing the Relay topic to
                          forward incoming calls to. This is only used
                          (and required) when `call_handler` is set to
                          `relay_topic`. Alias of
                          `call_relay_application`. If both are sent,
                          `call_relay_application` takes precedence.
                        example: 'office'
                      call_relay_topic_status_callback_url:
                        type: string
                        description: >-
                          A string representing a URL to send status change
                          messages to. This is only used (and required) when
                          `call_handler` is set to `relay_topic`.
                        example: "https://myapplication/handle_relay_callbacks"
                      call_relay_script_url:
                        type: string
                        description: >-
                          The URL to make a request to when using the
                          `relay_script` call handler. The URL must respond with a valid [`SWML`](/swml) script.
                        example: https://example.signalwire.com/relay-bins/60e2ba7b-366e-44de-84e3-0c76cfccf1cc
                      call_relay_context:
                        type: string
                        description: >-
                          The name of the Relay Context to send this call to
                          when using the `relay_context` call handler. Alias of
                          `message_relay_application`. If both are sent,
                          `call_relay_application` takes precedence.
                        example: my_relay_app
                      call_relay_context_status_callback_url:
                        type: string
                        description: >-
                          A string representing a URL to send status change
                          messages to. This is only used (and required) when
                          `call_handler` is set to `relay_context`.
                        example: "https://myapplication/handle_relay_callbacks"
                      call_relay_application:
                        type: string
                        description: >-
                          The name of the Relay Application to send this call to
                          when using the `relay_application` call handler. Alias
                          of `call_relay_context`. If both are sent,
                          `call_relay_application` takes precedence.
                        example: my_relay_app
                      call_relay_connector_id:
                        type: string
                        description: >-
                          The ID of the Relay Connector to send this call to
                          when using the `relay_connector` call handler.
                        example: null
                      call_sip_endpoint_id:
                        type: string
                        description: >-
                          The ID of the Relay SIP Endpoint to send this call to
                          when using the `relay_sip_endpoint` call handler.
                        example: null
                      call_verto_resource:
                        type: string
                        description: >-
                          The name of the Verto Relay Endpoint to send this call
                          to when using the `relay_verto_endpoint` call handler.
                        example: ''
                      call_video_room_id:
                        type: string
                        format: uuid
                        description: >-
                          The ID of the Video Room to send this call to when
                          using the `video_room` call handler.
                        example: fe4093d9-58c2-4931-b4b9-5679f82652c6
                      message_handler:
                        type: string
                        description: >-
                          What type of handler you want to run on inbound
                          messages. Possible values are: `relay_context`, `relay_topic`,
                          `relay_application`, `laml_webhooks`,
                          `laml_application`.
                        example: relay_application
                      message_request_url:
                        type: string
                        description: >-
                          The URL to make a request to when using the
                          `laml_webhooks` message handler.
                        example: ''
                      message_request_method:
                        type: string
                        description: >-
                          The HTTP method to use when making a request to the
                          `message_request_url`. Possible values are: `POST` or
                          `GET`. Default is `POST`.
                        example: POST
                      message_fallback_url:
                        type: string
                        description: >-
                          The fallback URL to make a request to when using the
                          `laml_webhooks` message handler and the
                          `message_request_url` fails.
                        example: ''
                      message_fallback_method:
                        type: string
                        description: >-
                          The HTTP method to use when making a request to the
                          `message_fallback_url`. Possible values are: `POST` or
                          `GET`. Default is `POST`.
                        example: POST
                      message_laml_application_id:
                        type: string
                        description: >-
                          The ID of the LaML Application to use when using the
                          `laml_application` message handler.
                        example: 'null'
                      message_relay_topic:
                        type: string
                        description: >-
                          The name of the Relay Topic to send this message to
                          when using the `relay_topic` message handler. Alias
                          of `message_relay_application`. If both are sent,
                          `message_relay_application` takes precedence.
                        example: my_relay_app
                      message_relay_context:
                        type: string
                        description: >-
                          The name of the Relay Context to send this message to
                          when using the `relay_context` message handler. Alias
                          of `message_relay_application`. If both are sent,
                          `message_relay_application` takes precedence.
                        example: my_relay_app
                      message_relay_application:
                        type: string
                        description: >-
                          The name of the Relay Application to send this message
                          to when using the `relay_application` message handler.
                          Alias of `message_relay_context`. If both are sent,
                          `message_relay_application` takes precedence.
                        example: my_relay_app
                  - type: object
                    properties:
                      capabilities:
                        type: array
                        items:
                          type: string
                        description: >-
                          A list of communication methods this phone number
                          supports. Possible values are: `voice`, `fax`, `sms`,
                          `mms`.
                        example:
                          - voice
                          - sms
                          - mms
                          - fax
                      number_type:
                        type: string
                        description: >-
                          The type of number this is defined as. Possible values
                          are: `toll-free` or `longcode`.
                        example: toll-free
                      e911_address_id:
                        type: string
                        description: >-
                          A list of communication methods this phone number
                          supports.
                        example: null
                      created_at:
                        type: string
                        description: The date the number was added to your project.
                        format: date-time
                      updated_at:
                        type: string
                        description: The date the number was last updated.
                        format: date-time
                      next_billed_at:
                        type: string
                        description: The next date the number will be billed for.
                        format: date-time
    delete:
      operationId: release_phone_number
      summary: Release a Phone Number
      description: >
        Permanently releases a Phone Number. This cannot be undone. Its existing
        logs will still be available but any new calls or messages will not
        work.


        #### Permissions

        The API token must include the following scopes: _Numbers_.
      tags:
        - Phone Numbers
      parameters:
        - name: id
          in: path
          description: Unique ID of the phone number
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '204':
          description: No Content
  /phone_numbers/search:
    get:
      operationId: search_available_phone_numbers
      summary: Search for available Phone Numbers to Purchase
      description: |
        Returns a list of phone numbers available for purchase that match the
        given search criteria parameters.

        #### Permissions
        The API token must include the following scopes: _Numbers_.
      tags:
        - Phone Numbers
      parameters:
        - name: areacode
          in: query
          description: An areacode to search within.
          required: false
          schema:
            type: string
        - name: number_type
          in: query
          description: >-
            Search for either `local` or `toll-free` numbers. Defaults to
            `local`.
          required: false
          schema:
            type: string
        - name: starts_with
          in: query
          description: >-
            A string of 3 to 7 digits that should be used as the start of a
            number. Cannot be used in combination with `contains` or
            `ends_with`.
          required: false
          schema:
            type: string
        - name: contains
          in: query
          description: >-
            A string of 3 to 7 digits that should appear somewhere in the
            number. Cannot be used in combination with `starts_with` or
            `ends_with`.
          required: false
          schema:
            type: string
        - name: ends_with
          in: query
          description: >-
            A string of 3 to 7 digits that should be used as the end of a
            number. Cannot be used in combination with `starts_with` or
            `contains`.
          required: false
          schema:
            type: string
        - name: max_results
          in: query
          description: >-
            The maximum number of matches to return. Upper limit of 100.
            Defaults to 50.
          required: false
          schema:
            type: number
        - name: region
          in: query
          description: >-
            A region or state to search within. Must be an ISO 3166-2 alpha-2
            code, i.e. `TX` for Texas. Cannot be used in combination with
            `areacode`.
          required: false
          schema:
            type: string
        - name: city
          in: query
          description: >-
            A specific City to search within. Must be used in combination with
            `region`. Cannot be used in combination with `areacode`,
            `starts_with`, `contains`, or `ends_with`.
          required: false
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  links:
                    type: object
                    properties:
                      self:
                        type: string
                      first:
                        type: string
                      next:
                        type: string
                      prev:
                        type: string
                  data:
                    type: array
                    items:
                      allOf:
                        - type: object
                          properties:
                            e164:
                              type: string
                              description: The phone number in E164 format.
                              example: '+15558675309'
                            national_number_formatted:
                              type: string
                              description: The phone number formatted for readability.
                              example: (555) 867-5309
                            international_number_formatted:
                              type: string
                              description: >-
                                The phone number formatted for readability,
                                including the country code.
                              example: +1 555-867-5309
                            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: >-
                                A region or state to search within. Must be an
                                ISO 3166-2 alpha-2 code, i.e. `TX` for Texas.
                              example: TX
                            country_code:
                              type: string
                              description: foo
                              example: US
                            capabilities:
                              type: array
                              items:
                                type: string
                              description: >-
                                A list of communication methods this phone
                                number supports. Possible values are: `voice`,
                                `fax`, `sms`, `mms`.
                              example:
                                - voice
                                - sms
                                - mms
                                - fax
  /lookup/phone_number/{e164_number}:
    get:
      operationId: lookup_phone_number
      summary: Phone Number Lookup
      description: |
        This endpoint allows you to look up validity and formatting
        information about a number. You can optionally lookup additional
        information about the number such as carrier and caller ID data.

        #### Permissions
        The API token must include the following scopes: _Numbers_.
      tags:
        - Phone Number Lookup
      parameters:
        - name: e164_number
          in: path
          description: Number in E.164 format.
          required: true
          schema:
            type: string
          example: '+15551234567'
        - name: include
          in: query
          description: >
            Further number information to include in the response, some of which
            are billable.

            You can specify:
              - `carrier`: Lookup full carrier information for the number.
              - `cnam`: Lookup Caller ID information for the number.

            Separate multiple values with a comma: `include=carrier,cnam`.


            Adding `include=carrier` to your request will do a live lookup to
            determine the current carrier information about this number. This
            includes more accurate information about what type of number as well
            as location. _Only valid for numbers with a +1 country code._


            Adding `include=cnam` to your request will do a live lookup to
            determine the current caller ID information about this number. _Only
            valid for numbers with a +1 country code._
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - carrier
                - cnam
          style: form
          explode: false
          example: carrier,cnam
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  country_code_number:
                    type: number
                    description: The Country code associated with the number
                    example: 1
                  national_number:
                    type: string
                    description: Number in the countries national format.
                    example: '5551234567'
                  possible_number:
                    type: boolean
                    description: >-
                      Whether the number supplied is a possible number. For
                      example, in the United States +15551234567 is a _possible_
                      number, but it is not a _valid_ number.
                    example: true
                  valid_number:
                    type: boolean
                    description: Whether the number supplied is a valid number.
                    example: true
                  national_number_formatted:
                    type: string
                    description: The E164 number formatted in national format.
                    example: (555) 123-4567
                  international_number_formatted:
                    type: string
                    description: The E164 number formatted in international format.
                    example: +1 555-123-4567
                  e164:
                    type: string
                    description: The number in E164 format.
                    example: '+15551234567'
                  location:
                    type: string
                    description: The location of the number based on its area code and NPA.
                    example: Texas
                  country_code:
                    type: string
                    description: >-
                      The ISO3166 alpha 2 country code associated with the
                      number
                    example: US
                  timezones:
                    type: array
                    items:
                      type: string
                    description: The time zones associated with the number
                    example:
                      - America/Austin
                  number_type:
                    type: string
                    description: >-
                      The type of number based on its area code and NPA. For
                      more detailed record of number type, include carrier
                      details in the request.
                    example: Fixed Line or Mobile
                  carrier:
                    type: object
                    description: >
                      Adding `include=carrier` to your request will do a live
                      lookup to determine the current carrier information about
                      this number. This includes more accurate information about
                      what type of number as well as location.
                    properties:
                      lrn:
                        type: string
                        description: The LRN associated with the number
                        example: '15551234567'
                      spid:
                        type: string
                        description: >-
                          The Service Profile Identifier associated with the
                          number
                        example: 683X
                      ocn:
                        type: string
                        description: >-
                          The Operating Company Number associated with the
                          number
                        example: '12345'
                      lata:
                        type: string
                        description: >-
                          The Local Access and Transport Area number associated
                          with the number
                        example: '99999'
                      city:
                        type: string
                        description: The City associated with the number
                        example: Aberdeen
                      state:
                        type: string
                        description: The State/Province/Region associated with the number
                        example: WA
                      jurisdiction:
                        type: string
                        description: The Jurisdiction associated with the number
                        example: indeterminate
                      lec:
                        type: string
                        description: The LEC or Carrier of the number.
                        example: Verizon
                      linetype:
                        type: string
                        description: >-
                          The type of line the number is. Generally either
                          `wireless` or `landline`
                        example: landline
                  cnam:
                    type: object
                    description: >
                      Adding `include=cnam` to your request will do a live
                      lookup to determine the current caller ID information
                      about this number.
                    properties:
                      caller_id:
                        type: string
                        description: The caller ID associated with the number.
                        example: John Smith
  /endpoints/sip:
    get:
      operationId: list_sip_endpoints
      summary: List all SIP Endpoints.
      description: |
        Returns a list of your SIP Endpoints. The endpoints are returned
        sorted by creation date, with the most recent endpoints appearing
        first. The list is filterable by sending in any of the following
        parameters.

        #### Permissions
        The API token must include the following scopes: _Voice_.

      tags:
        - SIP Endpoints
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  links:
                    type: object
                    properties:
                      self:
                        type: string
                      first:
                        type: string
                      next:
                        type: string
                      prev:
                        type: string
                  data:
                    type: array
                    items:
                      allOf:
                        - type: object
                          properties:
                            id:
                              type: string
                              description: >-
                                The unique identifier of the SIP Endpoint on
                                SignalWire. This can be used to update or delete
                                the endpoint programmatically.
                              example: 67075301-69b2-4fc3-8a2c-c95a69a5665e
                        - type: object
                          properties:
                            username:
                              type: string
                              description: >-
                                String representing the username portion of the
                                endpoint. Must be unique across your project and
                                must not container white space characters or
                                `@`.
                              example: c3p0
                          required:
                            - username
                        - type: object
                          properties:
                            caller_id:
                              type: string
                              description: >-
                                Friendly Caller ID used as the `CNAM` when
                                dialing a phone number or the `From` when
                                dialing another SIP Endpoint.
                              example: C-3P0
                            send_as:
                              type: string
                              description: >
                                When dialing a PSTN phone number, you must send
                                it `From` a number you have purchased or
                                verified. `send_as` indicates which number this
                                endpoint has set as its origination. `random`
                                indicates it will randomly choose a purchased or
                                verified number from within the project.


                                Defaults to the project's SIP Settings default
                                send as number.
                              example: random
                            ciphers:
                              type: array
                              items:
                                type: string
                              description: >
                                A list of encryption ciphers this endpoint will
                                support.


                                Currently supported values are:
                                `AEAD_AES_256_GCM_8`, `AES_256_CM_HMAC_SHA1_80`,
                                `AES_CM_128_HMAC_SHA1_80`,
                                `AES_256_CM_HMAC_SHA1_32`,
                                `AES_CM_128_HMAC_SHA1_32`.


                                Defaults to the project's SIP Settings default
                                cipher list. You can unset the custom cipher
                                list and use the project's SIP Settings default
                                cipher list by sending an empty array.
                              example:
                                - AEAD_AES_256_GCM_8
                                - AES_256_CM_HMAC_SHA1_80
                                - AES_CM_128_HMAC_SHA1_80
                                - AES_256_CM_HMAC_SHA1_32
                                - AES_CM_128_HMAC_SHA1_32
                            codecs:
                              type: array
                              items:
                                type: string
                              description: >
                                A list of codecs this endpoint will support.


                                Currently supported values are: `OPUS`, `G722`,
                                `PCMU`, `PCMA`, `VP8`, `H264`.


                                Defaults to the project's SIP Settings default
                                codec list. You can unset the custom codec list
                                and use the project's SIP Settings default codec
                                list by sending an empty array.
                              example:
                                - OPUS
                                - G722
                                - PCMU
                                - PCMA
                                - VP8
                                - H264
                            encryption:
                              type: string
                              description: >
                                A string representing whether connections to
                                this endpoint require encryption or if
                                encryption is optional. Encryption will always
                                be used if possible.


                                Possible values are `default`, `required`,
                                `optional`.


                                Defaults to the project's SIP Settings default.
                              example: required
                            call_handler:
                              type: string
                              description: >
                                What type of handler you want to run on inbound
                                calls. Possible values are: `relay_context`, `relay_topic`,
                                `relay_script`, `laml_webhooks`,
                                `laml_application`, `dialogflow`, `video_room`.
                              example: ai_agent
                            call_request_url:
                              type: string
                              description: >-
                                A string representing the LaML URL to access
                                when a call is received. This is only used (and
                                required) when `call_handler` is set to
                                `laml_webhooks`.
                              example: null
                            call_request_method:
                              type: string
                              description: >-
                                A string representing the HTTP method to use
                                with `call_request_url`. Valid values are `GET`
                                and `POST`. This is only used (and required)
                                when `call_handler` is set to `laml_webhooks`.
                              example: POST
                            call_fallback_url:
                              type: string
                              description: >-
                                A string representing the LaML URL to access
                                when the call to `call_request_url` fails. This
                                is only used (and required) when `call_handler`
                                is set to `laml_webhooks`.
                              example: null
                            call_fallback_method:
                              type: string
                              description: >-
                                A string representing the HTTP method to use
                                with `call_fallback_url`. Valid values are `GET`
                                and `POST`. This is only used (and required)
                                when `call_handler` is set to `laml_webhooks`.
                              example: POST
                            call_status_callback_url:
                              type: string
                              description: >-
                                A string representing a URL to send status
                                change messages to. This is only used (and
                                required) when `call_handler` is set to
                                `laml_webhooks`.
                              example: null
                            call_status_callback_method:
                              type: string
                              description: >-
                                A string representing the HTTP method to use
                                with `call_status_callback_url`. Valid values
                                are `GET` and `POST`. This is only used (and
                                required) when `call_handler` is set to
                                `laml_webhooks`.
                              example: POST
                            call_laml_application_id:
                              type: string
                              description: >-
                                A string representing the ID of the LaML
                                application to forward incoming calls to. This
                                is only used (and required) when `call_handler`
                                is set to `laml_application`.
                              example: ''
                            call_relay_topic:
                              type: string
                              description: >-
                                A string representing the Relay topic to
                                forward incoming calls to. This is only used
                                (and required) when `call_handler` is set to
                                `relay_topic`. Alias of
                                `call_relay_application`. If both are sent,
                                `call_relay_application` takes precedence.
                              example: 'office'
                            call_relay_topic_status_callback_url:
                              type: string
                              description: >-
                                A string representing a URL to send status change
                                messages to. This is only used (and required) when
                                `call_handler` is set to `relay_topic`.
                              example: "https://myapplication/handle_relay_callbacks"
                            call_relay_context:
                              type: string
                              description: >-
                                A string representing the Relay context to
                                forward incoming calls to. This is only used
                                (and required) when `call_handler` is set to
                                `relay_context`. Alias of
                                `call_relay_application`. If both are sent,
                                `call_relay_application` takes precedence.
                              example: ''
                            call_relay_context_status_callback_url:
                              type: string
                              description: >-
                                A string representing a URL to send status change
                                messages to. This is only used (and required) when
                                `call_handler` is set to `relay_context`.
                              example: "https://myapplication/handle_relay_callbacks"
                            call_video_room_id:
                              type: string
                              format: uuid
                              description: >-
                                A string representing the ID of the Video Room
                                to forward incoming calls to. This is only used
                                (and required) when `call_handler` is set to
                                `video_room`.
                              example: ''
                            call_flow_id:
                              type: string
                              format: uuid
                              description: >-
                                A string representing the ID of the Call Flow to
                                forward incoming calls to. This is only used
                                (and required) when `call_handler` is set to
                                `call_flow`.
                              example: ''
                            call_ai_agent_id:
                              type: string
                              format: uuid
                              description: >-
                                A string representing the ID of the Ai Agent to
                                forward incoming calls to. This is only used
                                (and required) when `call_handler` is set to
                                `ai_agent`.
                              example: ''
                            call_relay_script_url:
                              type: string
                              description: >-
                                A string representing a URL of a SWML script to
                                response incoming calls. This is only used (and
                                required) when `call_handler` is set to
                                `relay_script`.
                              example: >-
                                https://dev.signalwire.com/relay-bins/f9d13f68-f71e-4042-95bb-b07b9e2f2f92
    post:
      operationId: create_sip_endpoint
      summary: Create a SIP Endpoint
      description: |
        To create a new SIP Endpoint, you send a `POST` request to the SIP
        Endpoint resource.

        #### Permissions
        The API token must include the following scopes: _Voice_.

      tags:
        - SIP Endpoints
      requestBody:
        required: true
        content:
          application/json:
            schema:
              allOf:
                - allOf:
                    - type: object
                      properties:
                        username:
                          type: string
                          description: >-
                            String representing the username portion of the
                            endpoint. Must be unique across your project and
                            must not container white space characters or `@`.
                          example: c3p0
                      required:
                        - username
                    - type: object
                      properties:
                        password:
                          type: string
                          description: >-
                            A password to authenticate registrations to this
                            endpoint.
                          example: yavinOrBust
                      required:
                        - password
                    - type: object
                      properties:
                        caller_id:
                          type: string
                          description: >-
                            Friendly Caller ID used as the `CNAM` when dialing a
                            phone number or the `From` when dialing another SIP
                            Endpoint.
                          example: C-3P0
                        send_as:
                          type: string
                          description: >
                            When dialing a PSTN phone number, you must send it
                            `From` a number you have purchased or verified.
                            `send_as` indicates which number this endpoint has
                            set as its origination. `random` indicates it will
                            randomly choose a purchased or verified number from
                            within the project.


                            Defaults to the project's SIP Settings default send
                            as number.
                          example: random
                        ciphers:
                          type: array
                          items:
                            type: string
                          description: >
                            A list of encryption ciphers this endpoint will
                            support.


                            Currently supported values are:
                            `AEAD_AES_256_GCM_8`, `AES_256_CM_HMAC_SHA1_80`,
                            `AES_CM_128_HMAC_SHA1_80`,
                            `AES_256_CM_HMAC_SHA1_32`,
                            `AES_CM_128_HMAC_SHA1_32`.


                            Defaults to the project's SIP Settings default
                            cipher list. You can unset the custom cipher list
                            and use the project's SIP Settings default cipher
                            list by sending an empty array.
                          example:
                            - AEAD_AES_256_GCM_8
                            - AES_256_CM_HMAC_SHA1_80
                            - AES_CM_128_HMAC_SHA1_80
                            - AES_256_CM_HMAC_SHA1_32
                            - AES_CM_128_HMAC_SHA1_32
                        codecs:
                          type: array
                          items:
                            type: string
                          description: >
                            A list of codecs this endpoint will support.


                            Currently supported values are: `OPUS`, `G722`,
                            `PCMU`, `PCMA`, `VP8`, `H264`.


                            Defaults to the project's SIP Settings default codec
                            list. You can unset the custom codec list and use
                            the project's SIP Settings default codec list by
                            sending an empty array.
                          example:
                            - OPUS
                            - G722
                            - PCMU
                            - PCMA
                            - VP8
                            - H264
                        encryption:
                          type: string
                          description: >
                            A string representing whether connections to this
                            endpoint require encryption or if encryption is
                            optional. Encryption will always be used if
                            possible.


                            Possible values are `default`, `required`,
                            `optional`.


                            Defaults to the project's SIP Settings default.
                          example: required
                        call_handler:
                          type: string
                          description: >
                            What type of handler you want to run on inbound
                            calls. Possible values are: `relay_context`, `relay_topic`,
                            `relay_script`, `laml_webhooks`, `laml_application`,
                            `dialogflow`, `video_room`.
                          example: ai_agent
                        call_request_url:
                          type: string
                          description: >-
                            A string representing the LaML URL to access when a
                            call is received. This is only used (and required)
                            when `call_handler` is set to `laml_webhooks`.
                          example: null
                        call_request_method:
                          type: string
                          description: >-
                            A string representing the HTTP method to use with
                            `call_request_url`. Valid values are `GET` and
                            `POST`. This is only used (and required) when
                            `call_handler` is set to `laml_webhooks`.
                          example: POST
                        call_fallback_url:
                          type: string
                          description: >-
                            A string representing the LaML URL to access when
                            the call to `call_request_url` fails. This is only
                            used (and required) when `call_handler` is set to
                            `laml_webhooks`.
                          example: null
                        call_fallback_method:
                          type: string
                          description: >-
                            A string representing the HTTP method to use with
                            `call_fallback_url`. Valid values are `GET` and
                            `POST`. This is only used (and required) when
                            `call_handler` is set to `laml_webhooks`.
                          example: POST
                        call_status_callback_url:
                          type: string
                          description: >-
                            A string representing a URL to send status change
                            messages to. This is only used (and required) when
                            `call_handler` is set to `laml_webhooks`.
                          example: null
                        call_status_callback_method:
                          type: string
                          description: >-
                            A string representing the HTTP method to use with
                            `call_status_callback_url`. Valid values are `GET`
                            and `POST`. This is only used (and required) when
                            `call_handler` is set to `laml_webhooks`.
                          example: POST
                        call_laml_application_id:
                          type: string
                          description: >-
                            A string representing the ID of the LaML application
                            to forward incoming calls to. This is only used (and
                            required) when `call_handler` is set to
                            `laml_application`.
                          example: ''
                        call_relay_topic:
                          type: string
                          description: >-
                            A string representing the Relay topic to
                            forward incoming calls to. This is only used
                            (and required) when `call_handler` is set to
                            `relay_topic`. Alias of
                            `call_relay_application`. If both are sent,
                            `call_relay_application` takes precedence.
                          example: 'office'
                        call_relay_topic_status_callback_url:
                          type: string
                          description: >-
                            A string representing a URL to send status change
                            messages to. This is only used (and required) when
                            `call_handler` is set to `relay_topic`.
                          example: "https://myapplication/handle_relay_callbacks"
                        call_relay_context:
                          type: string
                          description: >-
                            A string representing the Relay context to forward
                            incoming calls to. This is only used (and required)
                            when `call_handler` is set to `relay_context`. Alias
                            of `call_relay_application`. If both are sent,
                            `call_relay_application` takes precedence.
                          example: 'office'
                        call_relay_context_status_callback_url:
                          type: string
                          description: >-
                            A string representing a URL to send status change
                            messages to. This is only used (and required) when
                            `call_handler` is set to `relay_context`.
                          example: "https://myapplication/handle_relay_callbacks"
                        call_video_room_id:
                          type: string
                          format: uuid
                          description: >-
                            A string representing the ID of the Video Room to
                            forward incoming calls to. This is only used (and
                            required) when `call_handler` is set to
                            `video_room`.
                          example: ''
                        call_flow_id:
                          type: string
                          format: uuid
                          description: >-
                            A string representing the ID of the Call Flow to
                            forward incoming calls to. This is only used (and
                            required) when `call_handler` is set to `call_flow`.
                          example: ''
                        call_ai_agent_id:
                          type: string
                          format: uuid
                          description: >-
                            A string representing the ID of the Ai Agent to
                            forward incoming calls to. This is only used (and
                            required) when `call_handler` is set to `ai_agent`.
                          example: ''
                        call_relay_script_url:
                          type: string
                          description: >-
                            A string representing a URL of a SWML script to
                            response incoming calls. This is only used (and
                            required) when `call_handler` is set to
                            `relay_script`.
                          example: >-
                            https://dev.signalwire.com/relay-bins/f9d13f68-f71e-4042-95bb-b07b9e2f2f92
      responses:
        '201':
          description: CREATED
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      id:
                        type: string
                        description: >-
                          The unique identifier of the SIP Endpoint on
                          SignalWire. This can be used to update or delete the
                          endpoint programmatically.
                        example: 67075301-69b2-4fc3-8a2c-c95a69a5665e
                  - type: object
                    properties:
                      username:
                        type: string
                        description: >-
                          String representing the username portion of the
                          endpoint. Must be unique across your project and must
                          not container white space characters or `@`.
                        example: c3p0
                    required:
                      - username
                  - type: object
                    properties:
                      caller_id:
                        type: string
                        description: >-
                          Friendly Caller ID used as the `CNAM` when dialing a
                          phone number or the `From` when dialing another SIP
                          Endpoint.
                        example: C-3P0
                      send_as:
                        type: string
                        description: >
                          When dialing a PSTN phone number, you must send it
                          `From` a number you have purchased or verified.
                          `send_as` indicates which number this endpoint has set
                          as its origination. `random` indicates it will
                          randomly choose a purchased or verified number from
                          within the project.


                          Defaults to the project's SIP Settings default send as
                          number.
                        example: random
                      ciphers:
                        type: array
                        items:
                          type: string
                        description: >
                          A list of encryption ciphers this endpoint will
                          support.


                          Currently supported values are: `AEAD_AES_256_GCM_8`,
                          `AES_256_CM_HMAC_SHA1_80`, `AES_CM_128_HMAC_SHA1_80`,
                          `AES_256_CM_HMAC_SHA1_32`, `AES_CM_128_HMAC_SHA1_32`.


                          Defaults to the project's SIP Settings default cipher
                          list. You can unset the custom cipher list and use the
                          project's SIP Settings default cipher list by sending
                          an empty array.
                        example:
                          - AEAD_AES_256_GCM_8
                          - AES_256_CM_HMAC_SHA1_80
                          - AES_CM_128_HMAC_SHA1_80
                          - AES_256_CM_HMAC_SHA1_32
                          - AES_CM_128_HMAC_SHA1_32
                      codecs:
                        type: array
                        items:
                          type: string
                        description: >
                          A list of codecs this endpoint will support.


                          Currently supported values are: `OPUS`, `G722`,
                          `PCMU`, `PCMA`, `VP8`, `H264`.


                          Defaults to the project's SIP Settings default codec
                          list. You can unset the custom codec list and use the
                          project's SIP Settings default codec list by sending
                          an empty array.
                        example:
                          - OPUS
                          - G722
                          - PCMU
                          - PCMA
                          - VP8
                          - H264
                      encryption:
                        type: string
                        description: >
                          A string representing whether connections to this
                          endpoint require encryption or if encryption is
                          optional. Encryption will always be used if possible.


                          Possible values are `default`, `required`, `optional`.


                          Defaults to the project's SIP Settings default.
                        example: required
                      call_handler:
                        type: string
                        description: >
                          What type of handler you want to run on inbound calls.
                          Possible values are: `relay_context`, `relay_topic`, `relay_script`,
                          `laml_webhooks`, `laml_application`, `dialogflow`,
                          `video_room`.
                        example: ai_agent
                      call_request_url:
                        type: string
                        description: >-
                          A string representing the LaML URL to access when a
                          call is received. This is only used (and required)
                          when `call_handler` is set to `laml_webhooks`.
                        example: null
                      call_request_method:
                        type: string
                        description: >-
                          A string representing the HTTP method to use with
                          `call_request_url`. Valid values are `GET` and `POST`.
                          This is only used (and required) when `call_handler`
                          is set to `laml_webhooks`.
                        example: POST
                      call_fallback_url:
                        type: string
                        description: >-
                          A string representing the LaML URL to access when the
                          call to `call_request_url` fails. This is only used
                          (and required) when `call_handler` is set to
                          `laml_webhooks`.
                        example: null
                      call_fallback_method:
                        type: string
                        description: >-
                          A string representing the HTTP method to use with
                          `call_fallback_url`. Valid values are `GET` and
                          `POST`. This is only used (and required) when
                          `call_handler` is set to `laml_webhooks`.
                        example: POST
                      call_status_callback_url:
                        type: string
                        description: >-
                          A string representing a URL to send status change
                          messages to. This is only used (and required) when
                          `call_handler` is set to `laml_webhooks`.
                        example: null
                      call_status_callback_method:
                        type: string
                        description: >-
                          A string representing the HTTP method to use with
                          `call_status_callback_url`. Valid values are `GET` and
                          `POST`. This is only used (and required) when
                          `call_handler` is set to `laml_webhooks`.
                        example: POST
                      call_laml_application_id:
                        type: string
                        description: >-
                          A string representing the ID of the LaML application
                          to forward incoming calls to. This is only used (and
                          required) when `call_handler` is set to
                          `laml_application`.
                        example: ''
                      call_relay_topic:
                        type: string
                        description: >-
                          A string representing the Relay topic to
                          forward incoming calls to. This is only used
                          (and required) when `call_handler` is set to
                          `relay_topic`. Alias of
                          `call_relay_application`. If both are sent,
                          `call_relay_application` takes precedence.
                        example: 'office'
                      call_relay_topic_status_callback_url:
                        type: string
                        description: >-
                          A string representing a URL to send status change
                          messages to. This is only used (and required) when
                          `call_handler` is set to `relay_topic`.
                        example: "https://myapplication/handle_relay_callbacks"
                      call_relay_context:
                        type: string
                        description: >-
                          A string representing the Relay context to forward
                          incoming calls to. This is only used (and required)
                          when `call_handler` is set to `relay_context`. Alias
                          of `call_relay_application`. If both are sent,
                          `call_relay_application` takes precedence.
                        example: 'office'
                      call_relay_context_status_callback_url:
                        type: string
                        description: >-
                          A string representing a URL to send status change
                          messages to. This is only used (and required) when
                          `call_handler` is set to `relay_context`.
                        example: "https://myapplication/handle_relay_callbacks"
                      call_video_room_id:
                        type: string
                        format: uuid
                        description: >-
                          A string representing the ID of the Video Room to
                          forward incoming calls to. This is only used (and
                          required) when `call_handler` is set to `video_room`.
                        example: ''
                      call_flow_id:
                        type: string
                        format: uuid
                        description: >-
                          A string representing the ID of the Call Flow to
                          forward incoming calls to. This is only used (and
                          required) when `call_handler` is set to `call_flow`.
                        example: ''
                      call_ai_agent_id:
                        type: string
                        format: uuid
                        description: >-
                          A string representing the ID of the Ai Agent to
                          forward incoming calls to. This is only used (and
                          required) when `call_handler` is set to `ai_agent`.
                        example: ''
                      call_relay_script_url:
                        type: string
                        description: >-
                          A string representing a URL of a SWML script to
                          response incoming calls. This is only used (and
                          required) when `call_handler` is set to
                          `relay_script`.
                        example: >-
                          https://dev.signalwire.com/relay-bins/f9d13f68-f71e-4042-95bb-b07b9e2f2f92
  /endpoints/sip/{id}:
    get:
      operationId: retrieve_sip_endpoint
      summary: Retrieve a SIP Endpoint
      description: |
        Retrieves the details of a SIP Endpoint that has been previously
        created. Use the unique ID that was returned from your previous
        request to identify the specific SIP Endpoint.

        #### Permissions
        The API token must include the following scopes: _Voice_.

      tags:
        - SIP Endpoints
      parameters:
        - name: id
          in: path
          description: Unique ID of the SIP endpoint
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      id:
                        type: string
                        description: >-
                          The unique identifier of the SIP Endpoint on
                          SignalWire. This can be used to update or delete the
                          endpoint programmatically.
                        example: 67075301-69b2-4fc3-8a2c-c95a69a5665e
                  - type: object
                    properties:
                      username:
                        type: string
                        description: >-
                          String representing the username portion of the
                          endpoint. Must be unique across your project and must
                          not container white space characters or `@`.
                        example: c3p0
                    required:
                      - username
                  - type: object
                    properties:
                      caller_id:
                        type: string
                        description: >-
                          Friendly Caller ID used as the `CNAM` when dialing a
                          phone number or the `From` when dialing another SIP
                          Endpoint.
                        example: C-3P0
                      send_as:
                        type: string
                        description: >
                          When dialing a PSTN phone number, you must send it
                          `From` a number you have purchased or verified.
                          `send_as` indicates which number this endpoint has set
                          as its origination. `random` indicates it will
                          randomly choose a purchased or verified number from
                          within the project.


                          Defaults to the project's SIP Settings default send as
                          number.
                        example: random
                      ciphers:
                        type: array
                        items:
                          type: string
                        description: >
                          A list of encryption ciphers this endpoint will
                          support.


                          Currently supported values are: `AEAD_AES_256_GCM_8`,
                          `AES_256_CM_HMAC_SHA1_80`, `AES_CM_128_HMAC_SHA1_80`,
                          `AES_256_CM_HMAC_SHA1_32`, `AES_CM_128_HMAC_SHA1_32`.


                          Defaults to the project's SIP Settings default cipher
                          list. You can unset the custom cipher list and use the
                          project's SIP Settings default cipher list by sending
                          an empty array.
                        example:
                          - AEAD_AES_256_GCM_8
                          - AES_256_CM_HMAC_SHA1_80
                          - AES_CM_128_HMAC_SHA1_80
                          - AES_256_CM_HMAC_SHA1_32
                          - AES_CM_128_HMAC_SHA1_32
                      codecs:
                        type: array
                        items:
                          type: string
                        description: >
                          A list of codecs this endpoint will support.


                          Currently supported values are: `OPUS`, `G722`,
                          `PCMU`, `PCMA`, `VP8`, `H264`.


                          Defaults to the project's SIP Settings default codec
                          list. You can unset the custom codec list and use the
                          project's SIP Settings default codec list by sending
                          an empty array.
                        example:
                          - OPUS
                          - G722
                          - PCMU
                          - PCMA
                          - VP8
                          - H264
                      encryption:
                        type: string
                        description: >
                          A string representing whether connections to this
                          endpoint require encryption or if encryption is
                          optional. Encryption will always be used if possible.


                          Possible values are `default`, `required`, `optional`.


                          Defaults to the project's SIP Settings default.
                        example: required
                      call_handler:
                        type: string
                        description: >
                          What type of handler you want to run on inbound calls.
                          Possible values are: `relay_context`, `relay_script`,
                          `laml_webhooks`, `laml_application`, `dialogflow`,
                          `video_room`.
                        example: ai_agent
                      call_request_url:
                        type: string
                        description: >-
                          A string representing the LaML URL to access when a
                          call is received. This is only used (and required)
                          when `call_handler` is set to `laml_webhooks`.
                        example: null
                      call_request_method:
                        type: string
                        description: >-
                          A string representing the HTTP method to use with
                          `call_request_url`. Valid values are `GET` and `POST`.
                          This is only used (and required) when `call_handler`
                          is set to `laml_webhooks`.
                        example: POST
                      call_fallback_url:
                        type: string
                        description: >-
                          A string representing the LaML URL to access when the
                          call to `call_request_url` fails. This is only used
                          (and required) when `call_handler` is set to
                          `laml_webhooks`.
                        example: null
                      call_fallback_method:
                        type: string
                        description: >-
                          A string representing the HTTP method to use with
                          `call_fallback_url`. Valid values are `GET` and
                          `POST`. This is only used (and required) when
                          `call_handler` is set to `laml_webhooks`.
                        example: POST
                      call_status_callback_url:
                        type: string
                        description: >-
                          A string representing a URL to send status change
                          messages to. This is only used (and required) when
                          `call_handler` is set to `laml_webhooks`.
                        example: null
                      call_status_callback_method:
                        type: string
                        description: >-
                          A string representing the HTTP method to use with
                          `call_status_callback_url`. Valid values are `GET` and
                          `POST`. This is only used (and required) when
                          `call_handler` is set to `laml_webhooks`.
                        example: POST
                      call_laml_application_id:
                        type: string
                        description: >-
                          A string representing the ID of the LaML application
                          to forward incoming calls to. This is only used (and
                          required) when `call_handler` is set to
                          `laml_application`.
                        example: ''
                      call_relay_topic:
                        type: string
                        description: >-
                          A string representing the Relay topic to
                          forward incoming calls to. This is only used
                          (and required) when `call_handler` is set to
                          `relay_topic`. Alias of
                          `call_relay_application`. If both are sent,
                          `call_relay_application` takes precedence.
                        example: 'office'
                      call_relay_topic_status_callback_url:
                        type: string
                        description: >-
                          A string representing a URL to send status change
                          messages to. This is only used (and required) when
                          `call_handler` is set to `relay_topic`.
                        example: "https://myapplication/handle_relay_callbacks"
                      call_relay_context:
                        type: string
                        description: >-
                          A string representing the Relay context to forward
                          incoming calls to. This is only used (and required)
                          when `call_handler` is set to `relay_context`. Alias
                          of `call_relay_application`. If both are sent,
                          `call_relay_application` takes precedence.
                        example: 'office'
                      call_relay_context_status_callback_url:
                        type: string
                        description: >-
                          A string representing a URL to send status change
                          messages to. This is only used (and required) when
                          `call_handler` is set to `relay_context`.
                        example: "https://myapplication/handle_relay_callbacks"
                      call_video_room_id:
                        type: string
                        format: uuid
                        description: >-
                          A string representing the ID of the Video Room to
                          forward incoming calls to. This is only used (and
                          required) when `call_handler` is set to `video_room`.
                        example: ''
                      call_flow_id:
                        type: string
                        format: uuid
                        description: >-
                          A string representing the ID of the Call Flow to
                          forward incoming calls to. This is only used (and
                          required) when `call_handler` is set to `call_flow`.
                        example: ''
                      call_ai_agent_id:
                        type: string
                        format: uuid
                        description: >-
                          A string representing the ID of the Ai Agent to
                          forward incoming calls to. This is only used (and
                          required) when `call_handler` is set to `ai_agent`.
                        example: ''
                      call_relay_script_url:
                        type: string
                        description: >-
                          A string representing a URL of a SWML script to
                          response incoming calls. This is only used (and
                          required) when `call_handler` is set to
                          `relay_script`.
                        example: >-
                          https://dev.signalwire.com/relay-bins/f9d13f68-f71e-4042-95bb-b07b9e2f2f92
    put:
      operationId: update_sip_endpoint
      summary: Update a SIP Endpoint
      description: |
        Updates the specific SIP Endpoint by setting the values of any
        parameters passed in. Any parameters not provided will be unchanged.

        #### Permissions
        The API token must include the following scopes: _Voice_.

      tags:
        - SIP Endpoints
      parameters:
        - name: id
          in: path
          description: Unique ID of the SIP endpoint
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              allOf:
                - allOf:
                    - type: object
                      properties:
                        username:
                          type: string
                          description: >-
                            String representing the username portion of the
                            endpoint. Must be unique across your project and
                            must not container white space characters or `@`.
                          example: c3p0
                    - type: object
                      properties:
                        password:
                          type: string
                          description: >-
                            A password to authenticate registrations to this
                            endpoint.
                          example: yavinOrBust
                    - type: object
                      properties:
                        caller_id:
                          type: string
                          description: >-
                            Friendly Caller ID used as the `CNAM` when dialing a
                            phone number or the `From` when dialing another SIP
                            Endpoint.
                          example: C-3P0
                        send_as:
                          type: string
                          description: >
                            When dialing a PSTN phone number, you must send it
                            `From` a number you have purchased or verified.
                            `send_as` indicates which number this endpoint has
                            set as its origination. `random` indicates it will
                            randomly choose a purchased or verified number from
                            within the project.


                            Defaults to the project's SIP Settings default send
                            as number.
                          example: random
                        ciphers:
                          type: array
                          items:
                            type: string
                          description: >
                            A list of encryption ciphers this endpoint will
                            support.


                            Currently supported values are:
                            `AEAD_AES_256_GCM_8`, `AES_256_CM_HMAC_SHA1_80`,
                            `AES_CM_128_HMAC_SHA1_80`,
                            `AES_256_CM_HMAC_SHA1_32`,
                            `AES_CM_128_HMAC_SHA1_32`.


                            Defaults to the project's SIP Settings default
                            cipher list. You can unset the custom cipher list
                            and use the project's SIP Settings default cipher
                            list by sending an empty array.
                          example:
                            - AEAD_AES_256_GCM_8
                            - AES_256_CM_HMAC_SHA1_80
                            - AES_CM_128_HMAC_SHA1_80
                            - AES_256_CM_HMAC_SHA1_32
                            - AES_CM_128_HMAC_SHA1_32
                        codecs:
                          type: array
                          items:
                            type: string
                          description: >
                            A list of codecs this endpoint will support.


                            Currently supported values are: `OPUS`, `G722`,
                            `PCMU`, `PCMA`, `VP8`, `H264`.


                            Defaults to the project's SIP Settings default codec
                            list. You can unset the custom codec list and use
                            the project's SIP Settings default codec list by
                            sending an empty array.
                          example:
                            - OPUS
                            - G722
                            - PCMU
                            - PCMA
                            - VP8
                            - H264
                        encryption:
                          type: string
                          description: >
                            A string representing whether connections to this
                            endpoint require encryption or if encryption is
                            optional. Encryption will always be used if
                            possible.


                            Possible values are `default`, `required`,
                            `optional`.


                            Defaults to the project's SIP Settings default.
                          example: required
                        call_handler:
                          type: string
                          description: >
                            What type of handler you want to run on inbound
                            calls. Possible values are: `relay_context`,
                            `relay_script`, `laml_webhooks`, `laml_application`,
                            `dialogflow`, `video_room`.
                          example: ai_agent
                        call_request_url:
                          type: string
                          description: >-
                            A string representing the LaML URL to access when a
                            call is received. This is only used (and required)
                            when `call_handler` is set to `laml_webhooks`.
                          example: null
                        call_request_method:
                          type: string
                          description: >-
                            A string representing the HTTP method to use with
                            `call_request_url`. Valid values are `GET` and
                            `POST`. This is only used (and required) when
                            `call_handler` is set to `laml_webhooks`.
                          example: POST
                        call_fallback_url:
                          type: string
                          description: >-
                            A string representing the LaML URL to access when
                            the call to `call_request_url` fails. This is only
                            used (and required) when `call_handler` is set to
                            `laml_webhooks`.
                          example: null
                        call_fallback_method:
                          type: string
                          description: >-
                            A string representing the HTTP method to use with
                            `call_fallback_url`. Valid values are `GET` and
                            `POST`. This is only used (and required) when
                            `call_handler` is set to `laml_webhooks`.
                          example: POST
                        call_status_callback_url:
                          type: string
                          description: >-
                            A string representing a URL to send status change
                            messages to. This is only used (and required) when
                            `call_handler` is set to `laml_webhooks`.
                          example: null
                        call_status_callback_method:
                          type: string
                          description: >-
                            A string representing the HTTP method to use with
                            `call_status_callback_url`. Valid values are `GET`
                            and `POST`. This is only used (and required) when
                            `call_handler` is set to `laml_webhooks`.
                          example: POST
                        call_laml_application_id:
                          type: string
                          description: >-
                            A string representing the ID of the LaML application
                            to forward incoming calls to. This is only used (and
                            required) when `call_handler` is set to
                            `laml_application`.
                          example: ''
                        call_relay_topic:
                          type: string
                          description: >-
                            A string representing the Relay topic to
                            forward incoming calls to. This is only used
                            (and required) when `call_handler` is set to
                            `relay_topic`. Alias of
                            `call_relay_application`. If both are sent,
                            `call_relay_application` takes precedence.
                          example: 'office'
                        call_relay_topic_status_callback_url:
                          type: string
                          description: >-
                            A string representing a URL to send status change
                            messages to. This is only used (and required) when
                            `call_handler` is set to `relay_topic`.
                          example: "https://myapplication/handle_relay_callbacks"
                        call_relay_context:
                          type: string
                          description: >-
                            A string representing the Relay context to forward
                            incoming calls to. This is only used (and required)
                            when `call_handler` is set to `relay_context`. Alias
                            of `call_relay_application`. If both are sent,
                            `call_relay_application` takes precedence.
                          example: 'office'
                        call_relay_context_status_callback_url:
                          type: string
                          description: >-
                            A string representing a URL to send status change
                            messages to. This is only used (and required) when
                            `call_handler` is set to `relay_context`.
                          example: "https://myapplication/handle_relay_callbacks"
                        call_video_room_id:
                          type: string
                          format: uuid
                          description: >-
                            A string representing the ID of the Video Room to
                            forward incoming calls to. This is only used (and
                            required) when `call_handler` is set to
                            `video_room`.
                          example: ''
                        call_flow_id:
                          type: string
                          format: uuid
                          description: >-
                            A string representing the ID of the Call Flow to
                            forward incoming calls to. This is only used (and
                            required) when `call_handler` is set to `call_flow`.
                          example: ''
                        call_ai_agent_id:
                          type: string
                          format: uuid
                          description: >-
                            A string representing the ID of the Ai Agent to
                            forward incoming calls to. This is only used (and
                            required) when `call_handler` is set to `ai_agent`.
                          example: ''
                        call_relay_script_url:
                          type: string
                          description: >-
                            A string representing a URL of a SWML script to
                            response incoming calls. This is only used (and
                            required) when `call_handler` is set to
                            `relay_script`.
                          example: >-
                            https://dev.signalwire.com/relay-bins/f9d13f68-f71e-4042-95bb-b07b9e2f2f92
      responses:
        '201':
          description: CREATED
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      id:
                        type: string
                        description: >-
                          The unique identifier of the SIP Endpoint on
                          SignalWire. This can be used to update or delete the
                          endpoint programmatically.
                        example: 67075301-69b2-4fc3-8a2c-c95a69a5665e
                  - type: object
                    properties:
                      username:
                        type: string
                        description: >-
                          String representing the username portion of the
                          endpoint. Must be unique across your project and must
                          not container white space characters or `@`.
                        example: c3p0
                    required:
                      - username
                  - type: object
                    properties:
                      caller_id:
                        type: string
                        description: >-
                          Friendly Caller ID used as the `CNAM` when dialing a
                          phone number or the `From` when dialing another SIP
                          Endpoint.
                        example: C-3P0
                      send_as:
                        type: string
                        description: >
                          When dialing a PSTN phone number, you must send it
                          `From` a number you have purchased or verified.
                          `send_as` indicates which number this endpoint has set
                          as its origination. `random` indicates it will
                          randomly choose a purchased or verified number from
                          within the project.


                          Defaults to the project's SIP Settings default send as
                          number.
                        example: random
                      ciphers:
                        type: array
                        items:
                          type: string
                        description: >
                          A list of encryption ciphers this endpoint will
                          support.


                          Currently supported values are: `AEAD_AES_256_GCM_8`,
                          `AES_256_CM_HMAC_SHA1_80`, `AES_CM_128_HMAC_SHA1_80`,
                          `AES_256_CM_HMAC_SHA1_32`, `AES_CM_128_HMAC_SHA1_32`.


                          Defaults to the project's SIP Settings default cipher
                          list. You can unset the custom cipher list and use the
                          project's SIP Settings default cipher list by sending
                          an empty array.
                        example:
                          - AEAD_AES_256_GCM_8
                          - AES_256_CM_HMAC_SHA1_80
                          - AES_CM_128_HMAC_SHA1_80
                          - AES_256_CM_HMAC_SHA1_32
                          - AES_CM_128_HMAC_SHA1_32
                      codecs:
                        type: array
                        items:
                          type: string
                        description: >
                          A list of codecs this endpoint will support.


                          Currently supported values are: `OPUS`, `G722`,
                          `PCMU`, `PCMA`, `VP8`, `H264`.


                          Defaults to the project's SIP Settings default codec
                          list. You can unset the custom codec list and use the
                          project's SIP Settings default codec list by sending
                          an empty array.
                        example:
                          - OPUS
                          - G722
                          - PCMU
                          - PCMA
                          - VP8
                          - H264
                      encryption:
                        type: string
                        description: >
                          A string representing whether connections to this
                          endpoint require encryption or if encryption is
                          optional. Encryption will always be used if possible.


                          Possible values are `default`, `required`, `optional`.


                          Defaults to the project's SIP Settings default.
                        example: required
                      call_handler:
                        type: string
                        description: >
                          What type of handler you want to run on inbound calls.
                          Possible values are: `relay_context`, `relay_script`,
                          `laml_webhooks`, `laml_application`, `dialogflow`,
                          `video_room`.
                        example: ai_agent
                      call_request_url:
                        type: string
                        description: >-
                          A string representing the LaML URL to access when a
                          call is received. This is only used (and required)
                          when `call_handler` is set to `laml_webhooks`.
                        example: null
                      call_request_method:
                        type: string
                        description: >-
                          A string representing the HTTP method to use with
                          `call_request_url`. Valid values are `GET` and `POST`.
                          This is only used (and required) when `call_handler`
                          is set to `laml_webhooks`.
                        example: POST
                      call_fallback_url:
                        type: string
                        description: >-
                          A string representing the LaML URL to access when the
                          call to `call_request_url` fails. This is only used
                          (and required) when `call_handler` is set to
                          `laml_webhooks`.
                        example: null
                      call_fallback_method:
                        type: string
                        description: >-
                          A string representing the HTTP method to use with
                          `call_fallback_url`. Valid values are `GET` and
                          `POST`. This is only used (and required) when
                          `call_handler` is set to `laml_webhooks`.
                        example: POST
                      call_status_callback_url:
                        type: string
                        description: >-
                          A string representing a URL to send status change
                          messages to. This is only used (and required) when
                          `call_handler` is set to `laml_webhooks`.
                        example: null
                      call_status_callback_method:
                        type: string
                        description: >-
                          A string representing the HTTP method to use with
                          `call_status_callback_url`. Valid values are `GET` and
                          `POST`. This is only used (and required) when
                          `call_handler` is set to `laml_webhooks`.
                        example: POST
                      call_laml_application_id:
                        type: string
                        description: >-
                          A string representing the ID of the LaML application
                          to forward incoming calls to. This is only used (and
                          required) when `call_handler` is set to
                          `laml_application`.
                        example: ''
                      call_relay_topic:
                        type: string
                        description: >-
                          A string representing the Relay topic to
                          forward incoming calls to. This is only used
                          (and required) when `call_handler` is set to
                          `relay_topic`. Alias of
                          `call_relay_application`. If both are sent,
                          `call_relay_application` takes precedence.
                        example: 'office'
                      call_relay_topic_status_callback_url:
                        type: string
                        description: >-
                          A string representing a URL to send status change
                          messages to. This is only used (and required) when
                          `call_handler` is set to `relay_topic`.
                        example: "https://myapplication/handle_relay_callbacks"
                      call_relay_context:
                        type: string
                        description: >-
                          A string representing the Relay context to forward
                          incoming calls to. This is only used (and required)
                          when `call_handler` is set to `relay_context`. Alias
                          of `call_relay_application`. If both are sent,
                          `call_relay_application` takes precedence.
                        example: 'office'
                      call_relay_context_status_callback_url:
                        type: string
                        description: >-
                          A string representing a URL to send status change
                          messages to. This is only used (and required) when
                          `call_handler` is set to `relay_context`.
                        example: "https://myapplication/handle_relay_callbacks"
                      call_video_room_id:
                        type: string
                        format: uuid
                        description: >-
                          A string representing the ID of the Video Room to
                          forward incoming calls to. This is only used (and
                          required) when `call_handler` is set to `video_room`.
                        example: ''
                      call_flow_id:
                        type: string
                        format: uuid
                        description: >-
                          A string representing the ID of the Call Flow to
                          forward incoming calls to. This is only used (and
                          required) when `call_handler` is set to `call_flow`.
                        example: ''
                      call_ai_agent_id:
                        type: string
                        format: uuid
                        description: >-
                          A string representing the ID of the Ai Agent to
                          forward incoming calls to. This is only used (and
                          required) when `call_handler` is set to `ai_agent`.
                        example: ''
                      call_relay_script_url:
                        type: string
                        description: >-
                          A string representing a URL of a SWML script to
                          response incoming calls. This is only used (and
                          required) when `call_handler` is set to
                          `relay_script`.
                        example: >-
                          https://dev.signalwire.com/relay-bins/f9d13f68-f71e-4042-95bb-b07b9e2f2f92
    delete:
      operationId: delete_sip_endpoint
      summary: Delete a SIP Endpoint
      description: |
        Permanently deletes a SIP Endpoint. It cannot be undone. Will reject
        any audio or video from currently registered devices and deregister
        any connections.

        #### Permissions
        The API token must include the following scopes: _Voice_.
      tags:
        - SIP Endpoints
      parameters:
        - name: id
          in: path
          description: Unique ID of the SIP endpoint
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '204':
          description: No Content
  /sip_profile:
    get:
      operationId: retrieve_sip_profile
      summary: Retrieve a SIP Profile
      description: |
        Retrieves the details of a SIP Profile that has been previously
        created. Use the current project id that was set by authentication to
        identify the specific SIP Profile.

        #### Permissions
        The API token must include the following scopes: _Voice_.
      tags:
        - SIP Profile
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      domain:
                        type: string
                        description: >-
                          A string representation of the fully qualified domain
                          name for this profile.
                        example: your-space-example.sip.signalwire.com
                  - type: object
                    properties:
                      domain_identifier:
                        type: string
                        description: >-
                          String representing the domain_identifier portion of
                          the profile. Must be unique across your project.
                        example: example
                      default_codecs:
                        type: array
                        items:
                          type: string
                        description: >-
                          A list of codecs this profile will support. Currently
                          supported values are: `OPUS`, `G722`, `PCMU`, `PCMA`,
                          `VP8`, `H264`.
                        example:
                          - OPUS
                      default_ciphers:
                        type: array
                        items:
                          type: string
                        description: >-
                          A list of encryption ciphers this profile will
                          support. Currently supported values are:
                          `AEAD_AES_256_GCM_8`, `AES_256_CM_HMAC_SHA1_80`,
                          `AES_CM_128_HMAC_SHA1_80`, `AES_256_CM_HMAC_SHA1_32`,
                          `AES_CM_128_HMAC_SHA1_32`.
                        example:
                          - AEAD_AES_256_GCM_8
                          - AES_256_CM_HMAC_SHA1_80
                          - AES_CM_128_HMAC_SHA1_80
                          - AES_256_CM_HMAC_SHA1_32
                          - AES_CM_128_HMAC_SHA1_32
                      default_encryption:
                        type: string
                        description: >-
                          A string representing whether connections to an
                          endpoint that uses this profile require encryption or
                          if encryption is optional. Encryption will always be
                          used if possible. Possible values are `required` or
                          `optional`.
                        example: optional
                      default_send_as:
                        type: string
                        description: >-
                          The e164 formatted number you wish to set as the
                          originating number when dialing PSTN phone numbers
                          from a SIP Endpoint that uses this profile. Specify
                          `null` or an empty string to randomly choose a
                          purchased or verified number from within the project.
                        example: '+15551234567'
    put:
      operationId: update_sip_profile
      summary: Update a SIP Profile
      description: |
        Updates the specific SIP Profile by setting the values of any
        parameters passed in. Any parameters not provided will be unchanged.

        #### Permissions
        The API token must include the following scopes: _Voice_.
      tags:
        - SIP Profile
      requestBody:
        required: true
        content:
          application/json:
            schema:
              allOf:
                - allOf:
                    - type: object
                      properties:
                        domain_identifier:
                          type: string
                          description: >-
                            String representing the domain_identifier portion of
                            the profile. Must be unique across your project.
                          example: example
                        default_codecs:
                          type: array
                          items:
                            type: string
                          description: >-
                            A list of codecs this profile will support.
                            Currently supported values are: `OPUS`, `G722`,
                            `PCMU`, `PCMA`, `VP8`, `H264`.
                          example:
                            - OPUS
                        default_ciphers:
                          type: array
                          items:
                            type: string
                          description: >-
                            A list of encryption ciphers this profile will
                            support. Currently supported values are:
                            `AEAD_AES_256_GCM_8`, `AES_256_CM_HMAC_SHA1_80`,
                            `AES_CM_128_HMAC_SHA1_80`,
                            `AES_256_CM_HMAC_SHA1_32`,
                            `AES_CM_128_HMAC_SHA1_32`.
                          example:
                            - AEAD_AES_256_GCM_8
                            - AES_256_CM_HMAC_SHA1_80
                            - AES_CM_128_HMAC_SHA1_80
                            - AES_256_CM_HMAC_SHA1_32
                            - AES_CM_128_HMAC_SHA1_32
                        default_encryption:
                          type: string
                          description: >-
                            A string representing whether connections to an
                            endpoint that uses this profile require encryption
                            or if encryption is optional. Encryption will always
                            be used if possible. Possible values are `required`
                            or `optional`.
                          example: optional
                        default_send_as:
                          type: string
                          description: >-
                            The e164 formatted number you wish to set as the
                            originating number when dialing PSTN phone numbers
                            from a SIP Endpoint that uses this profile. Specify
                            `null` or an empty string to randomly choose a
                            purchased or verified number from within the
                            project.
                          example: '+15551234567'
      responses:
        '201':
          description: CREATED
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      domain:
                        type: string
                        description: >-
                          A string representation of the fully qualified domain
                          name for this profile.
                        example: your-space-example.sip.signalwire.com
                  - type: object
                    properties:
                      domain_identifier:
                        type: string
                        description: >-
                          String representing the domain_identifier portion of
                          the profile. Must be unique across your project.
                        example: example
                      default_codecs:
                        type: array
                        items:
                          type: string
                        description: >-
                          A list of codecs this profile will support. Currently
                          supported values are: `OPUS`, `G722`, `PCMU`, `PCMA`,
                          `VP8`, `H264`.
                        example:
                          - OPUS
                      default_ciphers:
                        type: array
                        items:
                          type: string
                        description: >-
                          A list of encryption ciphers this profile will
                          support. Currently supported values are:
                          `AEAD_AES_256_GCM_8`, `AES_256_CM_HMAC_SHA1_80`,
                          `AES_CM_128_HMAC_SHA1_80`, `AES_256_CM_HMAC_SHA1_32`,
                          `AES_CM_128_HMAC_SHA1_32`.
                        example:
                          - AEAD_AES_256_GCM_8
                          - AES_256_CM_HMAC_SHA1_80
                          - AES_CM_128_HMAC_SHA1_80
                          - AES_256_CM_HMAC_SHA1_32
                          - AES_CM_128_HMAC_SHA1_32
                      default_encryption:
                        type: string
                        description: >-
                          A string representing whether connections to an
                          endpoint that uses this profile require encryption or
                          if encryption is optional. Encryption will always be
                          used if possible. Possible values are `required` or
                          `optional`.
                        example: optional
                      default_send_as:
                        type: string
                        description: >-
                          The e164 formatted number you wish to set as the
                          originating number when dialing PSTN phone numbers
                          from a SIP Endpoint that uses this profile. Specify
                          `null` or an empty string to randomly choose a
                          purchased or verified number from within the project.
                        example: '+15551234567'
  /mfa/sms:
    post:
      operationId: request_mfa_sms
      summary: Request a MFA token via text message
      description: >
        Request a MFA token via text message.


        #### Permissions

        The API token must include one of the following scopes: _Voice_ or
        _Messaging_ or _Fax_.
      tags:
        - Multi-Factor Authentication
      requestBody:
        required: true
        content:
          application/json:
            schema:
              allOf:
                - allOf:
                    - type: object
                      properties:
                        to:
                          type: string
                          description: The E164 number to use as the destination.
                          example: '+14043287382'
                      required:
                        - to
                    - type: object
                      properties:
                        from:
                          type: string
                          description: >
                            The E164 number from your account to use as the
                            origin of the message. SignalWire will use a special
                            verified number if not specified. If using a
                            different caller ID, make sure it is a number you
                            have purchased or have verified on your SignalWire
                            account and ensure it is registered on the Campaign
                            Registry for the best deliverability.
                          example: '+12029167968'
                        message:
                          type: string
                          description: >
                            Specify a custom message to send before the token.
                            The message must fit within one segment; either 160
                            characters or 70 characters when using non-GSM
                            symbols. When using a custom `message`, you must use
                            your own purchased or verified number as the `from`.
                            Defaults to "Your Personal Authorization Code is:"
                          example: Here is your code
                    - type: object
                      properties:
                        token_length:
                          type: number
                          description: >-
                            The number of characters in the token, from 4 to 20.
                            Defaults to 6.
                          example: 6
                        max_attempts:
                          type: number
                          description: >-
                            The number of allowed verification attempts,
                            including the first one, from 1 to 20. Defaults to
                            3.
                          example: 3
                        allow_alphas:
                          type: boolean
                          description: >-
                            Set to `true` or `false`, whether to include letters
                            or just numbers in the token. Defaults to `false`
                            (numbers only).
                          example: false
                        valid_for:
                          type: number
                          description: >-
                            The number of seconds the token is considered valid
                            for. Defaults to 3600, with a maximum of 604800.
                          example: 3600
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    description: The MFA request ID. Save this for verification.
                    format: uuid
                  success:
                    type: boolean
                    description: Whether the request was successfully queued.
                    example: true
                  to:
                    type: string
                    description: The destination of the MFA request.
                    example: '+15554422333'
                  channel:
                    type: string
                    description: >-
                      Can be `sms` for a text message or `call` for a phone
                      call.
                    example: call
  /mfa/call:
    post:
      operationId: request_mfa_call
      summary: Request a MFA token via phone call
      description: >
        Request a MFA token via phone call


        #### Permissions

        The API token must include one of the following scopes: _Voice_ or
        _Messaging_ or _Fax_.
      tags:
        - Multi-Factor Authentication
      requestBody:
        required: true
        content:
          application/json:
            schema:
              allOf:
                - allOf:
                    - type: object
                      properties:
                        to:
                          type: string
                          description: The E164 number to use as the destination.
                          example: '+14043287382'
                      required:
                        - to
                    - type: object
                      properties:
                        from:
                          type: string
                          description: >
                            The E164 number from your account to use as the
                            origin of the call. SignalWire will use a special
                            verified number if not specified. If using a
                            different caller ID, make sure it is a number you
                            have purchased or have verified on your SignalWire
                            account.
                          example: '+12029167968'
                        message:
                          type: string
                          description: >
                            The message to play to the caller before the token
                            is read. The message must be at most 500 characters.
                            Defaults to "Your Personal Authorization Code is".
                          example: Here is your code
                    - type: object
                      properties:
                        token_length:
                          type: number
                          description: >-
                            The number of characters in the token, from 4 to 20.
                            Defaults to 6.
                          example: 6
                        max_attempts:
                          type: number
                          description: >-
                            The number of allowed verification attempts,
                            including the first one, from 1 to 20. Defaults to
                            3.
                          example: 3
                        allow_alphas:
                          type: boolean
                          description: >-
                            Set to `true` or `false`, whether to include letters
                            or just numbers in the token. Defaults to `false`
                            (numbers only).
                          example: false
                        valid_for:
                          type: number
                          description: >-
                            The number of seconds the token is considered valid
                            for. Defaults to 3600, with a maximum of 604800.
                          example: 3600
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    description: The MFA request ID. Save this for verification.
                    format: uuid
                  success:
                    type: boolean
                    description: Whether the request was successfully queued.
                    example: true
                  to:
                    type: string
                    description: The destination of the MFA request.
                    example: '+15554422333'
                  channel:
                    type: string
                    description: >-
                      Can be `sms` for a text message or `call` for a phone
                      call.
                    example: call
  /mfa/{mfa_request_id}/verify:
    post:
      operationId: verify_mfa_token
      summary: Verify a token
      description: >
        Token verification is performed by sending a `POST` request to the

        below endpoint. If the token is not valid, it will return a `false`

        value in the `success` attribute of the JSON response. When

        `max_attempts` are reached, or `valid_for` has expired, or the token

        has already been validated, the endpoint will return a `404 Not Found`

        HTTP code.


        #### Permissions

        The API token must include one of the following scopes: _Voice_ or
        _Messaging_ or _Fax_.
      tags:
        - Multi-Factor Authentication
      parameters:
        - name: mfa_request_id
          in: path
          description: Unique ID of the address
          required: true
          schema:
            type: string
            example: <MFA-REQUEST-ID>
      requestBody:
        required: true
        content:
          application/json:
            schema:
              allOf:
                - type: object
                  properties:
                    token:
                      type: string
                      description: The token to verify
                      example: <TOKEN-TO-CHECK>
                  required:
                    - token
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: >-
                      Whether the token was successfully verified by the API.
                      When `max_attempts` are reached or the request is no
                      longer valid, the endpoint will return a `404 Not Found`.
                    example: true
  /verified_caller_ids:
    post:
      operationId: create_verified_caller_id
      summary: Create a new Verified Caller ID
      description: >
        To send a verification call to a number, you send a `POST` request to
        the Verified Caller ID resource.


        #### Permissions

        The API token must include the following scopes: _Voice_.
      tags:
        - Verified Caller IDs
      requestBody:
        required: true
        content:
          application/json:
            schema:
              allOf:
                - allOf:
                    - type: object
                      properties:
                        name:
                          type: string
                          description: >-
                            String representing the name portion of the caller
                            ID. If not provided, the default will be the
                            formatted number that has been provided.
                          example: C-3P0
                    - type: object
                      properties:
                        name:
                          type: string
                          description: >-
                            String representing the name portion of the caller
                            ID. If not provided, the default will be the
                            formatted number that has been provided.
                          example: C-3P0
                        extension:
                          type: string
                          description: >-
                            String representing the extension of the phone
                            number for the caller ID. This is only used when
                            placing the verification call.
                          example: '1234'
                        number:
                          type: string
                          description: >-
                            String representing the phone number for the caller
                            ID. This must be a valid, routeable phone number in
                            [E.164 format](https://en.wikipedia.org/wiki/E.164)
                            that is able to receive a voice phone call for
                            verification.
                          example: '+15551234567'
                      required:
                        - number
      responses:
        '201':
          description: CREATED
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      type:
                        type: string
                        description: >-
                          The `type` of the returned object, this should be
                          `verified_caller_id`.
                        example: verified_caller_id
                      id:
                        type: string
                        description: >-
                          The unique identifier of the Verified Caller ID on
                          SignalWire.
                        format: uuid
                  - allOf:
                      - type: object
                        properties:
                          name:
                            type: string
                            description: >-
                              String representing the name portion of the caller
                              ID. If not provided, the default will be the
                              formatted number that has been provided.
                            example: C-3P0
                      - type: object
                        properties:
                          name:
                            type: string
                            description: >-
                              String representing the name portion of the caller
                              ID. If not provided, the default will be the
                              formatted number that has been provided.
                            example: C-3P0
                          extension:
                            type: string
                            description: >-
                              String representing the extension of the phone
                              number for the caller ID. This is only used when
                              placing the verification call.
                            example: '1234'
                          number:
                            type: string
                            description: >-
                              String representing the phone number for the
                              caller ID. This must be a valid, routeable phone
                              number in [E.164
                              format](https://en.wikipedia.org/wiki/E.164) that
                              is able to receive a voice phone call for
                              verification.
                            example: '+15551234567'
                        required:
                          - number
                  - type: object
                    properties:
                      verified:
                        type: boolean
                        description: >-
                          A boolean representing whether the number has been
                          verified or not.
                        example: false
                      verified_at:
                        type: string
                        description: >-
                          Nullable DateTime fields representing the date and
                          time that the number was verified. If the number has
                          not been verified, it will be `null`.
                        example: null
                      status:
                        type: string
                        description: >-
                          String representing the verification status for the
                          caller ID. Current values are "Verified" and "Awaiting
                          Verification"
                        example: Awaiting Verification
    get:
      operationId: list_verified_caller_ids
      summary: List all Verified Caller IDs
      description: |
        Returns a list of your Verified Caller IDs. The caller IDs are
        returned sorted by creation date, with the most recent caller IDs
        appearing first. The list is filterable by sending in any of the
        following parameters.

        #### Permissions
        The API token must include the following scopes: _Voice_.
      tags:
        - Verified Caller IDs
      parameters:
        - name: filter_name
          in: query
          description: >-
            String representing the name assigned to the caller ID. Will return
            all Verified Caller IDs containing this value as a substring.
          required: false
          schema:
            type: string
        - name: filter_number
          in: query
          description: >-
            String representing the number assigned to the caller ID. Will
            return all Verified Caller IDs containing this value as a substring.
          required: false
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  links:
                    type: object
                    properties:
                      self:
                        type: string
                      first:
                        type: string
                      next:
                        type: string
                      prev:
                        type: string
                  data:
                    type: array
                    items:
                      allOf:
                        - type: object
                          properties:
                            type:
                              type: string
                              description: >-
                                The `type` of the returned object, this should
                                be `verified_caller_id`.
                              example: verified_caller_id
                            id:
                              type: string
                              description: >-
                                The unique identifier of the Verified Caller ID
                                on SignalWire.
                              format: uuid
                        - allOf:
                            - type: object
                              properties:
                                name:
                                  type: string
                                  description: >-
                                    String representing the name portion of the
                                    caller ID. If not provided, the default will
                                    be the formatted number that has been
                                    provided.
                                  example: C-3P0
                            - type: object
                              properties:
                                name:
                                  type: string
                                  description: >-
                                    String representing the name portion of the
                                    caller ID. If not provided, the default will
                                    be the formatted number that has been
                                    provided.
                                  example: C-3P0
                                extension:
                                  type: string
                                  description: >-
                                    String representing the extension of the
                                    phone number for the caller ID. This is only
                                    used when placing the verification call.
                                  example: '1234'
                                number:
                                  type: string
                                  description: >-
                                    String representing the phone number for the
                                    caller ID. This must be a valid, routeable
                                    phone number in [E.164
                                    format](https://en.wikipedia.org/wiki/E.164)
                                    that is able to receive a voice phone call
                                    for verification.
                                  example: '+15551234567'
                              required:
                                - number
                        - type: object
                          properties:
                            verified:
                              type: boolean
                              description: >-
                                A boolean representing whether the number has
                                been verified or not.
                              example: false
                            verified_at:
                              type: string
                              description: >-
                                Nullable DateTime fields representing the date
                                and time that the number was verified. If the
                                number has not been verified, it will be `null`.
                              example: null
                            status:
                              type: string
                              description: >-
                                String representing the verification status for
                                the caller ID. Current values are "Verified" and
                                "Awaiting Verification"
                              example: Awaiting Verification
  /verified_caller_ids/{id}:
    get:
      operationId: retrieve_verified_caller_id
      summary: Retrieve a Verified Caller ID
      description: |
        To retrieve an existing Verified Caller ID, you send a `GET` request
        to the Verified Caller ID resource. Use the unique ID that was
        returned from your previous request to identify the specific Verified
        Caller ID.

        #### Permissions
        The API token must include the following scopes: _Voice_.
      tags:
        - Verified Caller IDs
      parameters:
        - name: id
          in: path
          description: Unique unique identifier of the Verified Caller ID on SignalWire
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      type:
                        type: string
                        description: >-
                          The `type` of the returned object, this should be
                          `verified_caller_id`.
                        example: verified_caller_id
                      id:
                        type: string
                        description: >-
                          The unique identifier of the Verified Caller ID on
                          SignalWire.
                        format: uuid
                  - allOf:
                      - type: object
                        properties:
                          name:
                            type: string
                            description: >-
                              String representing the name portion of the caller
                              ID. If not provided, the default will be the
                              formatted number that has been provided.
                            example: C-3P0
                      - type: object
                        properties:
                          name:
                            type: string
                            description: >-
                              String representing the name portion of the caller
                              ID. If not provided, the default will be the
                              formatted number that has been provided.
                            example: C-3P0
                          extension:
                            type: string
                            description: >-
                              String representing the extension of the phone
                              number for the caller ID. This is only used when
                              placing the verification call.
                            example: '1234'
                          number:
                            type: string
                            description: >-
                              String representing the phone number for the
                              caller ID. This must be a valid, routeable phone
                              number in [E.164
                              format](https://en.wikipedia.org/wiki/E.164) that
                              is able to receive a voice phone call for
                              verification.
                            example: '+15551234567'
                        required:
                          - number
                  - type: object
                    properties:
                      verified:
                        type: boolean
                        description: >-
                          A boolean representing whether the number has been
                          verified or not.
                        example: false
                      verified_at:
                        type: string
                        description: >-
                          Nullable DateTime fields representing the date and
                          time that the number was verified. If the number has
                          not been verified, it will be `null`.
                        example: null
                      status:
                        type: string
                        description: >-
                          String representing the verification status for the
                          caller ID. Current values are "Verified" and "Awaiting
                          Verification"
                        example: Awaiting Verification
    put:
      operationId: update_verified_caller_id
      summary: Update a Verified Caller ID
      description: |
        To update an existing Verified Caller ID, you send a `PUT request to
        the Verified Caller ID resource. Any parameters not passed in will
        remain unchanged.

        The extension is only used when sending a verification call, if you
        need to update the extension and initiate a new call - use the Create
        a Verified Caller ID endpoint.

        #### Permissions
        The API token must include the following scopes: _Voice_.
      tags:
        - Verified Caller IDs
      parameters:
        - name: id
          in: path
          description: Unique unique identifier of the Verified Caller ID on SignalWire
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              allOf:
                - allOf:
                    - type: object
                      properties:
                        name:
                          type: string
                          description: >-
                            String representing the name portion of the caller
                            ID. If not provided, the default will be the
                            formatted number that has been provided.
                          example: C-3P0
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      type:
                        type: string
                        description: >-
                          The `type` of the returned object, this should be
                          `verified_caller_id`.
                        example: verified_caller_id
                      id:
                        type: string
                        description: >-
                          The unique identifier of the Verified Caller ID on
                          SignalWire.
                        format: uuid
                  - allOf:
                      - type: object
                        properties:
                          name:
                            type: string
                            description: >-
                              String representing the name portion of the caller
                              ID. If not provided, the default will be the
                              formatted number that has been provided.
                            example: C-3P0
                      - type: object
                        properties:
                          name:
                            type: string
                            description: >-
                              String representing the name portion of the caller
                              ID. If not provided, the default will be the
                              formatted number that has been provided.
                            example: C-3P0
                          extension:
                            type: string
                            description: >-
                              String representing the extension of the phone
                              number for the caller ID. This is only used when
                              placing the verification call.
                            example: '1234'
                          number:
                            type: string
                            description: >-
                              String representing the phone number for the
                              caller ID. This must be a valid, routeable phone
                              number in [E.164
                              format](https://en.wikipedia.org/wiki/E.164) that
                              is able to receive a voice phone call for
                              verification.
                            example: '+15551234567'
                        required:
                          - number
                  - type: object
                    properties:
                      verified:
                        type: boolean
                        description: >-
                          A boolean representing whether the number has been
                          verified or not.
                        example: false
                      verified_at:
                        type: string
                        description: >-
                          Nullable DateTime fields representing the date and
                          time that the number was verified. If the number has
                          not been verified, it will be `null`.
                        example: null
                      status:
                        type: string
                        description: >-
                          String representing the verification status for the
                          caller ID. Current values are "Verified" and "Awaiting
                          Verification"
                        example: Awaiting Verification
    delete:
      operationId: delete_verified_caller_id
      summary: Delete a Verified Caller ID
      description: |
        Permanently deletes a Verified Caller ID. You will no longer be able
        to place calls from this phone number.

        #### Permissions
        The API token must include the following scopes: _Voice_.
      tags:
        - Verified Caller IDs
      parameters:
        - name: id
          in: path
          description: Unique unique identifier of the Verified Caller ID on SignalWire
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '204':
          description: No Content
  /verified_caller_ids/{id}/verification:
    put:
      operationId: validate_verification_code
      summary: Validate the Verification Code
      description: |
        Supplies the verification code that was read during the verification
        call.

        #### Restrictions

         - There is a limit of 5 attempts to enter a validation code for a number. Once exhausted, you may request a redial of the verification call to reset the code and try again.

        #### Permissions
        The API token must include the following scopes: _Voice_.
      tags:
        - Verified Caller IDs
      parameters:
        - name: id
          in: path
          description: Unique unique identifier of the Verified Caller ID on SignalWire
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              allOf:
                - type: object
                  properties:
                    verification_code:
                      type: string
                      description: >-
                        String representing the verification code that was read
                        during the verification call.
                      example: '123456'
                  required:
                    - verification_code
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      type:
                        type: string
                        description: >-
                          The `type` of the returned object, this should be
                          `verified_caller_id`.
                        example: verified_caller_id
                      id:
                        type: string
                        description: >-
                          The unique identifier of the Verified Caller ID on
                          SignalWire.
                        format: uuid
                  - allOf:
                      - type: object
                        properties:
                          name:
                            type: string
                            description: >-
                              String representing the name portion of the caller
                              ID. If not provided, the default will be the
                              formatted number that has been provided.
                            example: C-3P0
                      - type: object
                        properties:
                          name:
                            type: string
                            description: >-
                              String representing the name portion of the caller
                              ID. If not provided, the default will be the
                              formatted number that has been provided.
                            example: C-3P0
                          extension:
                            type: string
                            description: >-
                              String representing the extension of the phone
                              number for the caller ID. This is only used when
                              placing the verification call.
                            example: '1234'
                          number:
                            type: string
                            description: >-
                              String representing the phone number for the
                              caller ID. This must be a valid, routeable phone
                              number in [E.164
                              format](https://en.wikipedia.org/wiki/E.164) that
                              is able to receive a voice phone call for
                              verification.
                            example: '+15551234567'
                        required:
                          - number
                  - type: object
                    properties:
                      verified:
                        type: boolean
                        description: >-
                          A boolean representing whether the number has been
                          verified or not.
                        example: false
                      verified_at:
                        type: string
                        description: >-
                          Nullable DateTime fields representing the date and
                          time that the number was verified. If the number has
                          not been verified, it will be `null`.
                        example: null
                      status:
                        type: string
                        description: >-
                          String representing the verification status for the
                          caller ID. Current values are "Verified" and "Awaiting
                          Verification"
                        example: Awaiting Verification
    post:
      operationId: redial_verification_call
      summary: Redial Verification Call
      description: >
        Places the verification call again, this will generate a new code to be
        read.


        #### Restrictions

         - You are limited to 10 redial verification calls to a given number with a one week period.
         - You must wait one minute before each redial verification call attempt.

        #### Permissions

        The API token must include the following scopes: _Voice_.
      tags:
        - Verified Caller IDs
      parameters:
        - name: id
          in: path
          description: Unique unique identifier of the Verified Caller ID on SignalWire
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      type:
                        type: string
                        description: >-
                          The `type` of the returned object, this should be
                          `verified_caller_id`.
                        example: verified_caller_id
                      id:
                        type: string
                        description: >-
                          The unique identifier of the Verified Caller ID on
                          SignalWire.
                        format: uuid
                  - allOf:
                      - type: object
                        properties:
                          name:
                            type: string
                            description: >-
                              String representing the name portion of the caller
                              ID. If not provided, the default will be the
                              formatted number that has been provided.
                            example: C-3P0
                      - type: object
                        properties:
                          name:
                            type: string
                            description: >-
                              String representing the name portion of the caller
                              ID. If not provided, the default will be the
                              formatted number that has been provided.
                            example: C-3P0
                          extension:
                            type: string
                            description: >-
                              String representing the extension of the phone
                              number for the caller ID. This is only used when
                              placing the verification call.
                            example: '1234'
                          number:
                            type: string
                            description: >-
                              String representing the phone number for the
                              caller ID. This must be a valid, routeable phone
                              number in [E.164
                              format](https://en.wikipedia.org/wiki/E.164) that
                              is able to receive a voice phone call for
                              verification.
                            example: '+15551234567'
                        required:
                          - number
                  - type: object
                    properties:
                      verified:
                        type: boolean
                        description: >-
                          A boolean representing whether the number has been
                          verified or not.
                        example: false
                      verified_at:
                        type: string
                        description: >-
                          Nullable DateTime fields representing the date and
                          time that the number was verified. If the number has
                          not been verified, it will be `null`.
                        example: null
                      status:
                        type: string
                        description: >-
                          String representing the verification status for the
                          caller ID. Current values are "Verified" and "Awaiting
                          Verification"
                        example: Awaiting Verification
  /recordings:
    get:
      operationId: Recordings_list
      summary: List Relay Recordings
      parameters: []
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecordingListResponse'
        '401':
          description: Access is unauthorized.
          content:
            application/json:
              schema:
                type: string
                enum:
                  - Unauthorized
        '404':
          description: The server cannot find the requested resource.
          content:
            application/json:
              schema:
                type: string
                enum:
                  - Not Found
      tags:
        - Recordings
  /recordings/{id}:
    get:
      operationId: Recordings_get
      summary: Get Relay Recording
      parameters:
        - $ref: '#/components/parameters/RecordingPathID'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecordingResponse'
        '401':
          description: Access is unauthorized.
          content:
            application/json:
              schema:
                type: string
                enum:
                  - Unauthorized
        '404':
          description: The server cannot find the requested resource.
          content:
            application/json:
              schema:
                type: string
                enum:
                  - Not Found
      tags:
        - Recordings
    delete:
      operationId: Recordings_delete
      summary: Delete Relay Recording
      parameters:
        - $ref: '#/components/parameters/RecordingPathID'
      responses:
        '204':
          description: 'There is no content to send for this request, but the headers may be useful. '
        '401':
          description: Access is unauthorized.
          content:
            application/json:
              schema:
                type: string
                enum:
                  - Unauthorized
        '404':
          description: The server cannot find the requested resource.
          content:
            application/json:
              schema:
                type: string
                enum:
                  - Not Found
      tags:
        - Recordings
  /queues:
    get:
      tags:
        - Queues
      summary: List Queues
      description: Returns a paginated list of queues.
      responses:
        '200':
          description: A list of queues
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueueListResponse'
    post:
      tags:
        - Queues
      summary: Create a Queue
      description: Creates a new queue.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateQueueRequest'
      responses:
        '201':
          description: Queue created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Queue'
        '422':
          $ref: '#/components/responses/422'
        '401':
          description: Access is unauthorized.
          content:
            application/json:
              schema:
                type: string
                enum:
                  - Unauthorized
  /queues/{id}:
    get:
      tags:
        - Queues
      summary: Retrieve a Queue
      description: Returns information about a specific queue.
      parameters:
        - $ref: '#/components/parameters/QueuePathID'
      responses:
        '200':
          description: Queue found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Queue'
        '401':
          description: Access is unauthorized.
          content:
            application/json:
              schema:
                type: string
                enum:
                  - Unauthorized
        '404':
          description: Queue not found
    put:
      tags:
        - Queues
      summary: Update a Queue
      description: Updates the properties of a specific queue.
      parameters:
        - $ref: '#/components/parameters/QueuePathID'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateQueueRequest'
      responses:
        '200':
          description: Queue updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Queue'
        '400':
          $ref: '#/components/responses/400'
        '422':
          $ref: '#/components/responses/422'
        '401':
          description: Access is unauthorized.
          content:
            application/json:
              schema:
                type: string
                enum:
                  - Unauthorized
    delete:
      tags:
        - Queues
      summary: Delete a Queue
      description: Deletes a specific queue.
      parameters:
        - $ref: '#/components/parameters/QueuePathID'
      responses:
        '204':
          $ref: '#/components/responses/204'
        '400':
          $ref: '#/components/responses/400'
        '401':
          description: Access is unauthorized.
          content:
            application/json:
              schema:
                type: string
                enum:
                  - Unauthorized
        '404':
          description: Queue not found
  /queues/{queue_id}/members:
    get:
      operationId: listQueueMembers
      summary: List all members of a queue
      description: |
        Retrieves a list of all members currently in the queue.
        #### Permissions
        The API token must include the following scopes: _Voice_.
      tags:
        - Queue Members
      parameters:
        - name: queue_id
          in: path
          description: The unique identifier (ID) of the queue.
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  links:
                    type: object
                    properties:
                      self:
                        type: string
                        example: "/api/relay/rest/queues/596e2dea-a269-4765-a0b4-01b82d11c120/members?page_number=0&page_size=50"
                      first:
                        type: string
                        example: "/api/relay/rest/queues/596e2dea-a269-4765-a0b4-01b82d11c120/members?page_size=50"
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/QueueMember'
  /queues/{queue_id}/members/{id}:
    get:
      operationId: retrieveQueueMember
      summary: Retrieve a queue member
      description: |
        Retrieves the details of a queue member.
        #### Permissions
        The API token must include the following scopes: _Voice_.
      tags:
        - Queue Members
      parameters:
        - name: queue_id
          in: path
          description: The unique identifier (ID) of the queue.
          required: true
          schema:
            type: string
            format: uuid
        - name: id
          in: path
          description: The unique identifier (ID) of the queue member.
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueueMember'
  /queues/{queue_id}/members/next:
    get:
      operationId: retrieveNextQueueMember
      summary: Retrieve next member on the queue
      description: |
        Retrieves the details of next member on the queue.
        #### Permissions
        The API token must include the following scopes: _Voice_.
      tags:
        - Queue Members
      parameters:
        - name: queue_id
          in: path
          description: The unique identifier (ID) of the queue.
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueueMember'