SignalWire Resources API

openapi: 3.2.0
info:
  title: SignalWire REST Resources API
  version: 1.0.0
  contact:
    name: SignalWire
    url: https://support.signalwire.com/portal/en/newticket?departmentId=1029313000000006907&layoutId=1029313000000074011
    email: support@signalwire.com
  license:
    name: MIT
    url: https://github.com/signalwire/docs/blob/main/LICENSE
  termsOfService: https://signalwire.com/legal/signalwire-cloud-agreement
  description: Endpoints related to creating & managing Resources
servers:
- url: https://{space_name}.signalwire.com
  description: SignalWire API
  variables:
    space_name:
      default: '{Your_Space_Name}'
      description: Your SignalWire Space name
security:
- SignalWireBasicAuth: []
tags:
- name: Resources
  description: Endpoints related to creating & managing Resources
  externalDocs:
    url: https://signalwire.com/docs/apis
    description: Developer documentation on Resource, Fabric API endpoints
paths:
  /api/fabric/resources:
    get:
      operationId: list_resources
      summary: List Resources
      description: 'A list of Fabric Resources


        #### Permissions


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


        Learn more about API scopes.'
      parameters: []
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceListResponse'
              examples:
                Resource list:
                  summary: Resource list
                  description: A page containing one compact AI Agent resource.
                  value:
                    data:
                    - id: 993ed018-9e79-4e50-b97b-984bd5534095
                      project_id: 1313fe58-5e14-4c11-bbe7-6fdfa11fe780
                      display_name: Support Assistant
                      created_at: '2024-05-06T12:20:00Z'
                      updated_at: '2024-05-06T12:25:00Z'
                      type: ai_agent
                      ai_agent:
                        prompt:
                          text: You are a helpful customer support assistant.
                        agent_id: a87db7ed-8ebe-42e4-829f-8ba5a4152f54
                        name: Support Assistant
                    links:
                      self: https://example.signalwire.com/api/fabric/resources?page_number=0&page_size=50
                      first: https://example.signalwire.com/api/fabric/resources?page_number=0&page_size=50
        '401':
          description: Access is unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode401'
        '404':
          description: The server cannot find the requested resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode404'
        '500':
          description: An internal server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode500'
      tags:
      - Resources
  /api/fabric/resources/{id}:
    get:
      operationId: get_resource
      summary: Get Resource
      description: 'Returns a Resource by ID


        #### Permissions


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


        Learn more about API scopes.'
      parameters:
      - $ref: '#/components/parameters/ResourcePathID'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceResponse'
              examples:
                Messaging script:
                  summary: Messaging script
                  description: A compact Messaging SWML Script resource.
                  value:
                    id: 3fa85f64-5717-4562-b3fc-2c963f66afa6
                    project_id: 1313fe58-5e14-4c11-bbe7-6fdfa11fe780
                    display_name: Reply Bot
                    created_at: '2024-05-06T12:20:00Z'
                    updated_at: '2024-05-06T12:25:00Z'
                    type: swml_script
                    swml_script:
                      id: 3fa85f64-5717-4562-b3fc-2c963f66afa6
                      display_name: Reply Bot
                      script_type: messaging
                      request_url: https://example.com/swml_script
                      contents:
                        version: 1.0.0
                        sections:
                          main:
                          - reply: Thanks for your message!
                Calling script:
                  summary: Calling script
                  description: A compact Calling SWML Script resource.
                  value:
                    id: 993ed018-9e79-4e50-b97b-984bd5534095
                    project_id: 1313fe58-5e14-4c11-bbe7-6fdfa11fe780
                    display_name: Welcome Script
                    created_at: '2024-05-06T12:20:00Z'
                    updated_at: '2024-05-06T12:25:00Z'
                    type: swml_script
                    swml_script:
                      id: 993ed018-9e79-4e50-b97b-984bd5534095
                      display_name: Welcome Script
                      script_type: calling
                      request_url: https://example.com/swml_script
                      contents:
                        version: 1.0.0
                        sections:
                          main:
                          - play:
                              url: https://cdn.signalwire.com/swml/audio.mp3
                Call Flow:
                  summary: Call Flow
                  description: A Call Flow with compact SWML content.
                  value:
                    id: 993ed018-9e79-4e50-b97b-984bd5534095
                    project_id: 1313fe58-5e14-4c11-bbe7-6fdfa11fe780
                    display_name: Welcome Call Flow
                    created_at: '2024-05-06T12:20:00Z'
                    updated_at: '2024-05-06T12:25:00Z'
                    type: call_flow
                    call_flow:
                      id: 993ed018-9e79-4e50-b97b-984bd5534095
                      title: Welcome Call Flow
                      flow_data: {}
                      relayml:
                        version: 1.0.0
                        sections:
                          main:
                          - play:
                              url: https://cdn.signalwire.com/swml/audio.mp3
                      document_version: 1
                AI Agent:
                  summary: AI Agent
                  description: An AI Agent Fabric resource.
                  value:
                    id: 993ed018-9e79-4e50-b97b-984bd5534095
                    project_id: 1313fe58-5e14-4c11-bbe7-6fdfa11fe780
                    display_name: Support Assistant
                    created_at: '2024-05-06T12:20:00Z'
                    updated_at: '2024-05-06T12:25:00Z'
                    type: ai_agent
                    ai_agent:
                      prompt:
                        text: You are a helpful customer support assistant.
                      agent_id: a87db7ed-8ebe-42e4-829f-8ba5a4152f54
                      name: Support Assistant
        '401':
          description: Access is unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode401'
        '404':
          description: The server cannot find the requested resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode404'
        '500':
          description: An internal server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode500'
      tags:
      - Resources
    delete:
      operationId: delete_resource
      summary: Delete Resource
      description: 'Deletes a Resource by ID


        #### Permissions


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


        Learn more about API scopes.'
      parameters:
      - $ref: '#/components/parameters/ResourcePathID'
      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:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode401'
        '404':
          description: The server cannot find the requested resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode404'
        '500':
          description: An internal server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode500'
      tags:
      - Resources
components:
  schemas:
    ResourceResponseCXMLScript:
      type: object
      required:
      - id
      - project_id
      - display_name
      - created_at
      - updated_at
      - type
      - cxml_script
      properties:
        id:
          allOf:
          - $ref: '#/components/schemas/uuid'
          description: Unique ID of the Resource.
          examples:
          - 993ed018-9e79-4e50-b97b-984bd5534095
        project_id:
          allOf:
          - $ref: '#/components/schemas/uuid'
          description: Unique ID of the Project.
          examples:
          - 1313fe58-5e14-4c11-bbe7-6fdfa11fe780
        display_name:
          type: string
          description: Display name of the Resource
          examples:
          - My Resource
        created_at:
          type: string
          format: date-time
          description: Date and time when the resource was created.
          examples:
          - '2024-05-06T12:20:00Z'
        updated_at:
          type: string
          format: date-time
          description: Date and time when the resource was updated.
          examples:
          - '2024-05-06T12:20:00Z'
        type:
          type: string
          enum:
          - cxml_script
          description: The type of Resource
          examples:
          - cxml_script
        cxml_script:
          allOf:
          - $ref: '#/components/schemas/CXMLScript'
          description: An object containing the response data of the cXML Script
      unevaluatedProperties:
        not: {}
      title: cXML Script
    ResourceResponseAI:
      type: object
      required:
      - id
      - project_id
      - display_name
      - created_at
      - updated_at
      - type
      - ai_agent
      properties:
        id:
          allOf:
          - $ref: '#/components/schemas/uuid'
          description: Unique ID of the Resource.
          examples:
          - 993ed018-9e79-4e50-b97b-984bd5534095
        project_id:
          allOf:
          - $ref: '#/components/schemas/uuid'
          description: Unique ID of the Project.
          examples:
          - 1313fe58-5e14-4c11-bbe7-6fdfa11fe780
        display_name:
          type: string
          description: Display name of the Resource
          examples:
          - My Resource
        created_at:
          type: string
          format: date-time
          description: Date and time when the resource was created.
          examples:
          - '2024-05-06T12:20:00Z'
        updated_at:
          type: string
          format: date-time
          description: Date and time when the resource was updated.
          examples:
          - '2024-05-06T12:20:00Z'
        type:
          type: string
          enum:
          - ai_agent
          description: The type of Resource
          examples:
          - ai_agent
        ai_agent:
          allOf:
          - $ref: '#/components/schemas/AIAgent'
          description: An object containing the response data of the AI Agent
      unevaluatedProperties:
        not: {}
      title: AI Agent
    CallingSwmlScript:
      type: object
      required:
      - id
      - display_name
      - script_type
      - request_url
      - contents
      properties:
        id:
          allOf:
          - $ref: '#/components/schemas/uuid'
          description: Unique ID of a SWML Script.
          examples:
          - 3fa85f64-5717-4562-b3fc-2c963f66afa6
        display_name:
          type: string
          description: The displayed name of the SWML script.
          examples:
          - Booking Assistant
        script_type:
          type: string
          enum:
          - calling
          description: Set to `calling` for SWML Scripts that handle inbound or outbound calls.
          examples:
          - calling
        request_url:
          type: string
          format: uri
          description: URL where this SWML Script is hosted.
          examples:
          - https://example.com/swml_script
        contents:
          type: object
          unevaluatedProperties: {}
          description: The calling SWML document executed when this script runs. Uses [calling SWML methods](/docs/swml/reference/calling).
          examples:
          - version: 1.0.0
            sections:
              main:
              - play:
                  url: https://cdn.signalwire.com/swml/audio.mp3
        status_callback_url:
          type: string
          format: uri
          description: URL that receives status callbacks for messages sent or calls made by this script.
          examples:
          - https://website.com/status
        status_callback_method:
          type: string
          enum:
          - POST
          description: HTTP method used for status callbacks.
          examples:
          - POST
      unevaluatedProperties:
        not: {}
      description: A SWML Script that handles inbound or outbound calls. The `contents` field carries a [calling SWML document](/docs/swml/reference/calling).
      title: Calling Script
    Subscriber:
      type: object
      required:
      - id
      - email
      - first_name
      - last_name
      - display_name
      - job_title
      - timezone
      - country
      - company_name
      properties:
        id:
          allOf:
          - $ref: '#/components/schemas/uuid'
          description: Unique ID of the Subscriber.
          examples:
          - d369a402-7b43-4512-8735-9d5e1f387814
        email:
          type: string
          description: Email of the Subscriber.
          examples:
          - johndoe@example.com
        first_name:
          type: string
          description: First name of the Subscriber.
          examples:
          - John
        last_name:
          type: string
          description: Last name of the Subscriber.
          examples:
          - Doe
        display_name:
          type: string
          description: Display name of the Subscriber.
          examples:
          - John Doe
        job_title:
          type: string
          description: Job title of the Subscriber.
          examples:
          - Software Engineer
        timezone:
          type: string
          description: Timezone of the Subscriber.
          examples:
          - America/New_York
        country:
          type: string
          description: Country of the Subscriber.
          examples:
          - United States
        company_name:
          type: string
          description: Company name of the Subscriber.
          examples:
          - SignalWire
      unevaluatedProperties:
        not: {}
    ResourceResponseSWMLWebhook:
      type: object
      required:
      - id
      - project_id
      - display_name
      - created_at
      - updated_at
      - type
      - swml_webhook
      properties:
        id:
          allOf:
          - $ref: '#/components/schemas/uuid'
          description: Unique ID of the Resource.
          examples:
          - 993ed018-9e79-4e50-b97b-984bd5534095
        project_id:
          allOf:
          - $ref: '#/components/schemas/uuid'
          description: Unique ID of the Project.
          examples:
          - 1313fe58-5e14-4c11-bbe7-6fdfa11fe780
        display_name:
          type: string
          description: Display name of the Resource
          examples:
          - My Resource
        created_at:
          type: string
          format: date-time
          description: Date and time when the resource was created.
          examples:
          - '2024-05-06T12:20:00Z'
        updated_at:
          type: string
          format: date-time
          description: Date and time when the resource was updated.
          examples:
          - '2024-05-06T12:20:00Z'
        type:
          type: string
          enum:
          - swml_webhook
          description: The type of Resource
          examples:
          - swml_webhook
        swml_webhook:
          allOf:
          - $ref: '#/components/schemas/SWMLWebhook'
          description: An object containing the response data of the SWML Webhook
      unevaluatedProperties:
        not: {}
      title: SWML Webhook
    CXMLScript:
      type: object
      required:
      - id
      - contents
      - request_count
      - last_accessed_at
      - request_url
      - script_type
      - display_name
      properties:
        id:
          allOf:
          - $ref: '#/components/schemas/uuid'
          description: Unique ID of a cXML Script.
          examples:
          - 3fa85f64-5717-4562-b3fc-2c963f66afa6
        contents:
          type: string
          description: The cXML script contents
          examples:
          - <?xml version="1.0" encoding="UTF-8"?><Response><Say>Hello World</Say></Response>
        request_count:
          type: integer
          format: int32
          description: The amout of times the cXML script has been requested
          examples:
          - 5
        last_accessed_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          description: The date and time when the cXML script was last accessed
          examples:
          - '2023-10-01T12:00:00Z'
        request_url:
          type: string
          format: uri
          description: The URL where the cXML script can be accessed
          examples:
          - https://example.signalwire.com/laml-bins/2537c89e-2606-48c2-b3c2-bb601d863d1e
        script_type:
          type: string
          enum:
          - calling
          - messaging
          description: The script type the cXML Script is used for
          examples:
          - calling
        display_name:
          type: string
          description: Display name of the cXML Script Fabric Resource
          examples:
          - Booking Assistant Script
        status_callback_url:
          anyOf:
          - type: string
            format: uri
          - type: 'null'
          description: The url that will send status updates for the cXML Script
          examples:
          - https://example.com/cxml/status
        status_callback_method:
          allOf:
          - $ref: '#/components/schemas/RequestUrlMethodType'
          description: HTTP method for status callback URL
          examples:
          - POST
      unevaluatedProperties:
        not: {}
    ResourceResponseFSConnector:
      type: object
      required:
      - id
      - project_id
      - display_name
      - created_at
      - updated_at
      - type
      - freeswitch_connector
      properties:
        id:
          allOf:
          - $ref: '#/components/schemas/uuid'
          description: Unique ID of the Resource.
          examples:
          - 993ed018-9e79-4e50-b97b-984bd5534095
        project_id:
          allOf:
          - $ref: '#/components/schemas/uuid'
          description: Unique ID of the Project.
          examples:
          - 1313fe58-5e14-4c11-bbe7-6fdfa11fe780
        display_name:
          type: string
          description: Display name of the Resource
          examples:
          - My Resource
        created_at:
          type: string
          format: date-time
          description: Date and time when the resource was created.
          examples:
          - '2024-05-06T12:20:00Z'
        updated_at:
          type: string
          format: date-time
          description: Date and time when the resource was updated.
          examples:
          - '2024-05-06T12:20:00Z'
        type:
          type: string
          enum:
          - freeswitch_connector
          description: The type of Resource
          examples:
          - freeswitch_connector
        freeswitch_connector:
          allOf:
          - $ref: '#/components/schemas/FreeswitchConnector'
          description: An object containing the response data of the FreeSWITCH Connector
      unevaluatedProperties:
        not: {}
      title: FreeSWITCH Connector
    SipGateway:
      type: object
      required:
      - id
      - uri
      - name
      - ciphers
      - codecs
      - encryption
      properties:
        id:
          allOf:
          - $ref: '#/components/schemas/uuid'
          description: Unique ID of the SIP Gateway.
          examples:
          - cce59cad-104d-4c28-ada4-98cfd102ae09
        uri:
          type: string
          description: The URI for the SIP Gateway.
          examples:
          - user3@domain.com
        name:
          type: string
          description: Display name of the SIP Gateway.
          examples:
          - My SIP Gateway
        ciphers:
          type: array
          items:
            $ref: '#/components/schemas/Ciphers'
          description: List of supported SIP ciphers.
          examples:
          - - AEAD_AES_256_GCM_8
        codecs:
          type: array
          items:
            $ref: '#/components/schemas/Codecs'
          description: List of supported codecs.
          examples:
          - - OPUS
        encryption:
          allOf:
          - $ref: '#/components/schemas/Encryption'
          description: Specifies the encryption requirement.
          examples:
          - required
      unevaluatedProperties:
        not: {}
    FabricSipEndpoint:
      type: object
      required:
      - id
      - username
      - caller_id
      - send_as
      - ciphers
      - codecs
      - encryption
      - call_handler
      - calling_handler_resource_id
      properties:
        id:
          allOf:
          - $ref: '#/components/schemas/uuid'
          description: The id of the Sip Endpoint
          examples:
          - 993ed018-9e79-4e50-b97b-984bd5534095
        username:
          type: string
          description: The username of the Sip Endpoint
          examples:
          - User
        caller_id:
          type: string
          description: The caller ID that will showup when dialing from this Sip Endpoint
          examples:
          - '123456789'
        send_as:
          type: string
          description: The Sip username that will show up on the calle's side. Overrides the username.
          examples:
          - Support
        ciphers:
          type: array
          items:
            $ref: '#/components/schemas/Ciphers'
          description: Ciphers that can be enabled for calls on this Sip Endpoint.
          examples:
          - - AEAD_AES_256_GCM_8
            - AES_256_CM_HMAC_SHA1_32
        codecs:
          type: array
          items:
            $ref: '#/components/schemas/Codecs'
          description: Codecs that can be enabled for calls on this Sip Endpoint.
          examples:
          - - G722
            - PCMA
            - PCMU
            - VP8
        encryption:
          allOf:
          - $ref: '#/components/schemas/Encryption'
          description: The set encryption type on the Sip Endpoint.
          examples:
          - default
          default: default
        call_handler:
          allOf:
          - $ref: '#/components/schemas/CallHandlerType'
          description: 'Specify how the SIP endpoint will handle outbound calls.

            - **default**: The SIP endpoint will pull the outbound policy setting from the [SIP Profile Settings](https://my.signalwire.com?page=sip_profile/edit). This allows centralized management of outbound call behavior across multiple endpoints from a single configuration.

            - **passthrough**: The SIP endpoint will be allowed to dial PSTN numbers. This permits outbound calling to traditional phone numbers without restrictions.

            - **block-pstn**: The SIP endpoint will be blocked from dialing PSTN numbers. Use this to restrict the endpoint from initiating calls to the public telephone network.

            - **resource**: Outbound calls from this SIP endpoint will dial the specified resource and execute its instructions. Requires setting `calling_handler_resource_id` to a valid resource. This enables custom call handling workflows for outbound calls.'
          examples:
          - default
        calling_handler_resource_id:
          anyOf:
          - $ref: '#/components/schemas/uuid'
          - type: 'null'
          description: If `call_handler` is set to `resource`, this field expects the id of the set resouce. Will be `null` otherwise.
          examples:
          - 993ed018-9e79-4e50-b97b-984bd5534095
      unevaluatedProperties:
        not: {}
    Types.StatusCodes.StatusCode401:
      type: object
      required:
      - error
      properties:
        error:
          type: string
          enum:
          - Unauthorized
      unevaluatedProperties:
        not: {}
      description: Access is unauthorized.
    ResourceResponseCXMLApplication:
      type: object
      required:
      - id
      - project_id
      - display_name
      - created_at
      - updated_at
      - type
      - cxml_application
      properties:
        id:
          allOf:
          - $ref: '#/components/schemas/uuid'
          description: Unique ID of the Resource.
          examples:
          - 993ed018-9e79-4e50-b97b-984bd5534095
        project_id:
          allOf:
          - $ref: '#/components/schemas/uuid'
          description: Unique ID of the Project.
          examples:
          - 1313fe58-5e14-4c11-bbe7-6fdfa11fe780
        display_name:
          type: string
          description: Display name of the Resource
          examples:
          - My Resource
        created_at:
          type: string
          format: date-time
          description: Date and time when the resource was created.
          examples:
          - '2024-05-06T12:20:00Z'
        updated_at:
          type: string
          format: date-time
          description: Date and time when the resource was updated.
          examples:
          - '2024-05-06T12:20:00Z'
        type:
          type: string
          enum:
          - cxml_application
          description: The type of Resource
          examples:
          - cxml_application
        cxml_application:
          allOf:
          - $ref: '#/components/schemas/CxmlApplication'
          description: An object containing the response data of the cXML Application
      unevaluatedProperties:
        not: {}
      title: cXML Application
    Ciphers:
      type: string
      enum:
      - 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
    CxmlApplication:
      type: object
      required:
      - id
      - project_id
      - friendly_name
      - voice_url
      - voice_method
      - voice_fallback_url
      - voice_fallback_method
      - status_callback
      - status_callback_method
      - sms_url
      - sms_method
      - sms_fallback_url
      - sms_fallback_method
      - sms_status_callback
      - sms_status_callback_method
      properties:
        id:
          allOf:
          - $ref: '#/components/schemas/uuid'
          description: Unique ID of the cXML Application.
          examples:
          - 1313fe58-5e14-4c11-bbe7-6fdfa11fe780
        project_id:
          allOf:
          - $ref: '#/components/schemas/uuid'
          description: Project ID for the cXML Application
          examples:
          - 1313fe58-5e14-4c11-bbe7-6fdfa11fe780
        friendly_name:
          type: string
          description: Display name of the cXML Application
          examples:
          - Reception App
        voice_url:
          anyOf:
          - type: string
          - type: 'null'
          description: URL to handle incoming calls
          examples:
          - https://example.com/voice/incoming
        voice_method:
          allOf:
          - $ref: '#/components/schemas/RequestUrlMethodType'
          description: HTTP method for voice URL
          examples:
          - GET
        voice_fallback_url:
          anyOf:
          - type: string
          - type: 'null'
          description: Fallback URL for voice errors
          examples:
          - https://example.com/voice/fallback
        voice_fallback_method:
          allOf:
          - $ref: '#/components/schemas/RequestUrlMethodType'
          description: HTTP method for voice fallback URL
          examples:
          - GET
        status_callback:
          anyOf:
          - type: string
            format: uri
          - type: 'null'
          description: URL to receive status callbacks
          examples:
          - https://example.com/voice/status
        status_callback_method:
          allOf:
          - $ref: '#/components/schemas/RequestUrlMethodType'
          description: HTTP method for status callbacks
          examples:
          - GET
        sms_url:
          anyOf:
          - type: string
          - type: 'null'
          description: URL to handle incoming messages
          examples:
          - https://example.com/message/incoming
        sms_method:
          allOf:
          - $ref: '#/components/schemas/RequestUrlMethodType'
          description: HTTP method for SMS URL
          examples:
          - GET
        sms_fallback_url:
          anyOf:
          - type: string
          - type: 'null'
          description: Fallback URL for SMS errors
          examples:
          - https://example.com/message/fallback
        sms_fallback_method:
          allOf:
          - $ref: '#/components/schemas/RequestUrlMethodType'
          description: HTTP method for SMS fallback URL
          examples:
          - GET
        sms_status_callback:
          anyOf:
          - type: string
          - type: 'null'
          description: URL to receive SMS status callbacks
          examples:
          - https://example.com/message/status
        sms_status_callback_method:
          allOf:
          - $ref: '#/components/schemas/RequestUrlMethodType'
          description: HTTP method for SMS status callbacks
          examples:
          - GET
      unevaluatedProperties:
        not: {}
    FreeswitchConnector:
      type: object
      required:
      - id
      properties:
        id:
          allOf:
          - $ref: '#/components/schemas/uuid'
          description: Unique ID of a FreeSWITCH Connector.
          examples:
          - 3fa85f64-5717-4562-b3fc-2c963f66afa6
        name:
          type: string
          description: Name of the FreeSWITCH Connector
          examples:
          - Booking Assistant
        caller_id:
          anyOf:
          - type: string
          - type: 'null'
          description: Caller ID for the connector
          examples:
          - '123456'
        send_as:
          anyOf:
          - type: string
          - type: 'null'
          description: Send as identifier
          examples:
          - '123456'
      unevaluatedProperties:
        not: {}
    RequestUrlMethodType:
      type: string
      enum:
      - GET
      - POST
      description: The method type to use for the URL
    ResourceResponseSWMLScript:
      type: object
      required:
      - id
      - project_id
      - display_name
      - created_at
      - updated_at
      - type
      - swml_script
      properties:
        id:
          allOf:
          - $

# --- truncated at 32 KB (69 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/signalwire/refs/heads/main/openapi/signalwire-resources-api-openapi.yml