SignalWire Call Flows API

openapi: 3.2.0
info:
  title: SignalWire REST Call Flows 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 Call Flows
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: Call Flows
  description: Endpoints related to creating & managing Call Flows
  externalDocs:
    url: https://signalwire.com/docs/apis
    description: Developer documentation on Call Flow, Fabric API endpoints
paths:
  /api/fabric/resources/call_flow/{id}/addresses:
    get:
      operationId: list_call_flow_addresses
      summary: List call flow Addresses
      description: 'This endpoint returns a list of addresses associated with a specific Call Flow.


        #### 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](/docs/platform/your-signalwire-api-space).'
      parameters:
      - $ref: '#/components/parameters/CallFlowAddressPathID'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CallFlowAddressListResponse'
        '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:
      - Call Flows
  /api/fabric/resources/call_flow/{id}/versions:
    get:
      operationId: list_call_flow_versions
      summary: List call flow versions
      description: 'Returns a list of versions of a Call Flow.


        #### 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](/docs/platform/your-signalwire-api-space).'
      parameters:
      - $ref: '#/components/parameters/CallFlowVersionPathID'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CallFlowVersionListResponse'
              examples:
                Call Flow version list:
                  summary: Call Flow version list
                  description: A page containing one compact Call Flow version.
                  value:
                    data:
                    - id: 3fa85f64-5717-4562-b3fc-2c963f66afa6
                      version: 1.0.0
                      created_at: '2024-05-06T12:20:00Z'
                      updated_at: '2024-05-06T12:25:00Z'
                      flow_data: {}
                      relayml:
                        version: 1.0.0
                        sections:
                          main:
                          - play:
                              url: https://cdn.signalwire.com/swml/audio.mp3
                    links:
                      self: https://example.signalwire.com/api/fabric/resources/call_flow/993ed018-9e79-4e50-b97b-984bd5534095/versions?page_number=0&page_size=50
                      first: https://example.signalwire.com/api/fabric/resources/call_flow/993ed018-9e79-4e50-b97b-984bd5534095/versions?page_number=0&page_size=50
                      next: https://example.signalwire.com/api/fabric/resources/call_flow/993ed018-9e79-4e50-b97b-984bd5534095/versions?page_number=1&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:
      - Call Flows
    post:
      operationId: deploy_call_flow_version
      summary: Deploy call flow version
      description: 'Deploys a specific version of a Call Flow.


        #### 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](/docs/platform/your-signalwire-api-space).'
      parameters:
      - $ref: '#/components/parameters/CallFlowVersionPathID'
      responses:
        '201':
          description: The request has succeeded and a new resource has been created as a result.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CallFlowVersionDeployResponse'
              examples:
                Deploy by document version:
                  summary: Deploy by document version
                  description: Deploy version 2 of a Call Flow.
                  value:
                    id: 3fa85f64-5717-4562-b3fc-2c963f66afa6
                    created_at: '2024-05-06T12:20:00Z'
                    updated_at: '2024-05-06T12:25:00Z'
                    document_version: 2
                    flow_data: {}
                    relayml:
                      version: 1.0.0
                      sections:
                        main:
                        - play:
                            url: https://cdn.signalwire.com/swml/audio.mp3
        '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'
        '422':
          description: The request contains invalid parameters. See errors for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode422'
        '500':
          description: An internal server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode500'
      tags:
      - Call Flows
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CallFlowVersionDeployRequest'
            examples:
              Deploy by document version:
                summary: Deploy by document version
                description: Deploy version 2 of a Call Flow.
                value:
                  document_version: 2
  /api/fabric/resources/call_flows:
    get:
      operationId: list_call_flows
      summary: List call flows
      description: 'A list of Call Flows


        #### 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](/docs/platform/your-signalwire-api-space).'
      parameters: []
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CallFlowListResponse'
              examples:
                Call flow list:
                  summary: Call flow list
                  description: A page containing one Call Flow.
                  value:
                    links:
                      self: https://example.signalwire.com/api/fabric/resources/call_flows?page_number=0&page_size=50
                      first: https://example.signalwire.com/api/fabric/resources/call_flows?page_number=0&page_size=50
                    data:
                    - id: 993ed018-9e79-4e50-b97b-984bd5534095
                      project_id: 1313fe58-5e14-4c11-bbe7-6fdfa11fe780
                      display_name: Welcome Call Flow
                      type: call_flow
                      created_at: '2024-05-06T12:20:00Z'
                      updated_at: '2024-05-06T12:25:00Z'
                      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
        '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:
      - Call Flows
    post:
      operationId: create_call_flow
      summary: Create call flow
      description: 'Creates a Call Flow


        #### 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](/docs/platform/your-signalwire-api-space).'
      parameters: []
      responses:
        '201':
          description: The request has succeeded and a new resource has been created as a result.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CallFlowResponse'
              examples:
                Welcome Call Flow:
                  summary: Welcome Call Flow
                  description: Create a Call Flow that plays a single audio file.
                  value:
                    id: 993ed018-9e79-4e50-b97b-984bd5534095
                    project_id: 1313fe58-5e14-4c11-bbe7-6fdfa11fe780
                    display_name: Welcome Call Flow
                    type: call_flow
                    created_at: '2024-05-06T12:20:00Z'
                    updated_at: '2024-05-06T12:25:00Z'
                    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
        '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'
        '422':
          description: The request contains invalid parameters. See errors for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CallFlowCreateStatusCode422'
        '500':
          description: An internal server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode500'
      tags:
      - Call Flows
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CallFlowCreateRequest'
            examples:
              Welcome Call Flow:
                summary: Welcome Call Flow
                description: Create a Call Flow that plays a single audio file.
                value:
                  title: Welcome Call Flow
                  flow_data: {}
                  relayml:
                    version: 1.0.0
                    sections:
                      main:
                      - play:
                          url: https://cdn.signalwire.com/swml/audio.mp3
  /api/fabric/resources/call_flows/{id}:
    get:
      operationId: get_call_flow
      summary: Get call flow
      description: 'Returns a Call Flow 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](/docs/platform/your-signalwire-api-space).'
      parameters:
      - $ref: '#/components/parameters/CallFlowPathID'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CallFlowResponse'
              examples:
                Call flow:
                  summary: Call flow
                  description: A Call Flow with a compact SWML document.
                  value:
                    id: 993ed018-9e79-4e50-b97b-984bd5534095
                    project_id: 1313fe58-5e14-4c11-bbe7-6fdfa11fe780
                    display_name: Welcome Call Flow
                    type: call_flow
                    created_at: '2024-05-06T12:20:00Z'
                    updated_at: '2024-05-06T12:25:00Z'
                    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
        '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:
      - Call Flows
    put:
      operationId: update_call_flow
      summary: Update call flow
      description: 'Updates a Call Flow 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](/docs/platform/your-signalwire-api-space).'
      parameters:
      - $ref: '#/components/parameters/CallFlowPathID'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CallFlowResponse'
              examples:
                Update a Call Flow:
                  summary: Update a Call Flow
                  description: Update a Call Flow with its next document revision.
                  value:
                    id: 993ed018-9e79-4e50-b97b-984bd5534095
                    project_id: 1313fe58-5e14-4c11-bbe7-6fdfa11fe780
                    display_name: Welcome Call Flow
                    type: call_flow
                    created_at: '2024-05-06T12:20:00Z'
                    updated_at: '2024-05-06T12:25:00Z'
                    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
        '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'
        '422':
          description: The request contains invalid parameters. See errors for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CallFlowUpdateStatusCode422'
        '500':
          description: An internal server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode500'
      tags:
      - Call Flows
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CallFlowUpdateRequest'
            examples:
              Update a Call Flow:
                summary: Update a Call Flow
                description: Update a Call Flow with its next document revision.
                value:
                  title: Updated Welcome Call Flow
                  document_version: 2
                  flow_data: {}
                  relayml:
                    version: 1.0.0
                    sections:
                      main:
                      - play:
                          url: https://cdn.signalwire.com/swml/audio.mp3
    delete:
      operationId: delete_call_flow
      summary: Delete call flow
      description: 'Deletes a Call Flow 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](/docs/platform/your-signalwire-api-space).'
      parameters:
      - $ref: '#/components/parameters/CallFlowPathID'
      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:
      - Call Flows
components:
  schemas:
    Types.StatusCodes.StatusCode401:
      type: object
      required:
      - error
      properties:
        error:
          type: string
          enum:
          - Unauthorized
      unevaluatedProperties:
        not: {}
      description: Access is unauthorized.
    CallFlowVersionsPaginationResponse:
      type: object
      required:
      - self
      - first
      - next
      properties:
        self:
          type: string
          format: uri
          description: Link of the current page
          examples:
          - https://example.signalwire.com/api/fabric/call_flows/versions?page_number=0&page_size=50&type=call_flow
        first:
          type: string
          format: uri
          description: Link to the first page
          examples:
          - https://example.signalwire.com/api/fabric/call_flows/versions?page_number=0&page_size=50&type=call_flow
        next:
          type: string
          format: uri
          description: Link to the next page
          examples:
          - https://example.signalwire.com/api/fabric/call_flows/versions?page_number=1&page_size=50&page_token=PAbff61159-faab-48b3-959a-3021a8f5beca&type=call_flow
        prev:
          type: string
          format: uri
          description: Link to the previous page
          examples:
          - https://example.signalwire.com/api/fabric/call_flows/versions?page_number=0&page_size=50&page_token=PAbff61159-faab-48b3-959a-3021a8f5beca&type=call_flow
      unevaluatedProperties:
        not: {}
    CallFlowCreateStatusCode422:
      type: object
      required:
      - errors
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Types.StatusCodes.RestApiErrorItem'
          description: List of validation errors.
      unevaluatedProperties:
        not: {}
      description: The request contains invalid parameters. See errors for details.
      examples:
      - statusCode: 422
        errors:
        - type: validation_error
          code: missing_required_parameter
          message: title is required
          attribute: title
          url: https://signalwire.com/docs/apis/error-codes
    CallFlowAddressPaginationResponse:
      type: object
      required:
      - self
      - first
      properties:
        self:
          type: string
          format: uri
          description: Link of the current page
          examples:
          - https://example.signalwire.com/api/fabric/resources/016e5773-c197-4446-bcc2-9c48f14e2d0a/addresses?page_number=0&page_size=50&type=call_flow
        first:
          type: string
          format: uri
          description: Link to the first page
          examples:
          - https://example.signalwire.com/api/fabric/resources/016e5773-c197-4446-bcc2-9c48f14e2d0a/addresses?page_number=0&page_size=50&type=call_flow
        next:
          type: string
          format: uri
          description: Link to the next page
          examples:
          - https://example.signalwire.com/api/fabric/resources/016e5773-c197-4446-bcc2-9c48f14e2d0a/addresses?page_number=1&page_size=50&page_token=PA6581c1fa-d985-4c8f-b53e-2fee11b579ad&type=call_flow
        prev:
          type: string
          format: uri
          description: Link to the previous page
          examples:
          - https://example.signalwire.com/api/fabric/resources/016e5773-c197-4446-bcc2-9c48f14e2d0a/addresses?page_number=0&page_size=50&page_token=PA6581c1fa-d985-4c8f-b53e-2fee11b579ad&type=call_flow
      unevaluatedProperties:
        not: {}
    AddressChannel:
      anyOf:
      - $ref: '#/components/schemas/AudioChannel'
      - $ref: '#/components/schemas/MessagingChannel'
      - $ref: '#/components/schemas/VideoChannel'
    VideoChannel:
      type: object
      required:
      - video
      properties:
        video:
          type: string
          description: Video Channel of Fabric Address
          examples:
          - /external/resource_name?channel=video
      unevaluatedProperties:
        not: {}
    CallFlowListResponse:
      type: object
      required:
      - links
      - data
      properties:
        links:
          allOf:
          - $ref: '#/components/schemas/CallFlowAddressPaginationResponse'
          description: Object containing pagination links
        data:
          type: array
          items:
            $ref: '#/components/schemas/CallFlowResponse'
          description: An array of objects containing the CallFlow listing response
      unevaluatedProperties:
        not: {}
    AudioChannel:
      type: object
      required:
      - audio
      properties:
        audio:
          type: string
          description: Audio Channel of Fabric Address
          examples:
          - /external/resource_name?channel=audio
      unevaluatedProperties:
        not: {}
    uuid:
      type: string
      format: uuid
      description: Universal Unique Identifier.
    Types.StatusCodes.StatusCode404:
      type: object
      required:
      - error
      properties:
        error:
          type: string
          enum:
          - Not Found
      unevaluatedProperties:
        not: {}
      description: The server cannot find the requested resource.
    Types.StatusCodes.StatusCode500:
      type: object
      required:
      - error
      properties:
        error:
          type: string
          enum:
          - Internal Server Error
      unevaluatedProperties:
        not: {}
      description: An internal server error occurred.
    CallFlowCreateRequest:
      type: object
      required:
      - title
      properties:
        title:
          type: string
          description: The name of the Call Flow
          examples:
          - Booking Assistant
        flow_data:
          type: object
          unevaluatedProperties: {}
          description: Call Flow Builder state, stored as an opaque JSON object. Optional but must be paired with `relayml` — provide both fields together or omit both. When both are omitted, SignalWire creates a starter Call Flow.
          examples:
          - {}
        relayml:
          type: object
          unevaluatedProperties: {}
          description: The calling SWML document this Call Flow should execute. Uses [calling SWML methods](/docs/swml/reference/calling). Optional but must be paired with `flow_data` — provide both fields together or omit both. When both are omitted, SignalWire creates a starter SWML document.
          examples:
          - version: 1.0.0
            sections:
              main:
              - play:
                  url: https://cdn.signalwire.com/swml/audio.mp3
      unevaluatedProperties:
        not: {}
    Types.StatusCodes.StatusCode422:
      type: object
      required:
      - errors
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Types.StatusCodes.RestApiErrorItem'
          description: List of validation errors.
      unevaluatedProperties:
        not: {}
      description: The request contains invalid parameters. See errors for details.
    CallFlowResponse:
      type: object
      required:
      - id
      - project_id
      - display_name
      - type
      - created_at
      - updated_at
      - call_flow
      properties:
        id:
          allOf:
          - $ref: '#/components/schemas/uuid'
          description: Unique ID of the Call Flow.
          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 Call Flow Fabric Resource
          examples:
          - Booking Assistant
        type:
          type: string
          enum:
          - call_flow
          description: Type of the Fabric Resource
          examples:
          - call_flow
        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'
        call_flow:
          allOf:
          - $ref: '#/components/schemas/CallFlow'
          description: Call Flow data.
      unevaluatedProperties:
        not: {}
    CallFlowVersionListResponse:
      type: object
      required:
      - data
      - links
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/CallFlowVersion'
          description: List of Call Flow Versions
        links:
          $ref: '#/components/schemas/CallFlowVersionsPaginationResponse'
      unevaluatedProperties:
        not: {}
    CallFlowVersionDeployByDocumentVersion:
      type: object
      required:
      - document_version
      properties:
        document_version:
          type: integer
          format: int32
          description: The current revision of the call flow.
          examples:
          - 2
      unevaluatedProperties:
        not: {}
      title: Deploy by document version
    MessagingChannel:
      type: object
      required:
      - messaging
      properties:
        messaging:
          type: string
          description: Messaging Channel of Fabric Address
          examples:
          - /external/resource_name?channel=messaging
      unevaluatedProperties:
        not: {}
    CallFlow:
      type: object
      required:
      - id
      - title
      properties:
        id:
          allOf:
          - $ref: '#/components/schemas/uuid'
          description: Unique ID of a Call Flow.
          examples:
          - 3fa85f64-5717-4562-b3fc-2c963f66afa6
        title:
          type: string
          description: The name of the Call Flow
          examples:
          - Booking Assistant
        flow_data:
          type: object
          unevaluatedProperties: {}
          description: Call Flow Builder state, stored as an opaque JSON object. Produced and consumed by the SignalWire Call Flow Builder UI; not used by SWML execution.
          examples:
          - {}
        relayml:
          type: object
          unevaluatedProperties: {}
          description: The calling SWML document this Call Flow executes. Uses [calling SWML methods](/docs/swml/reference/calling).
          examples:
          - version: 1.0.0
            sections:
              main:
              - play:
                  url: https://cdn.signalwire.com/swml/audio.mp3
        document_version:
          type: integer
          format: int32
          description: The current revision of the call flow. Every update must increase this number.
          examples:
          - 1
      unevaluatedProperties:
        not: {}
    CallFlowAddressListResponse:
      type: object
      required:
      - data
      - links
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/FabricAddressApp'
          description: An array of objects containing a list of Call Flow Addresses
        links:
          allOf:
          - $ref: '#/components/schemas/CallFlowAddressPaginationResponse'
          description: Object containing pagination links
      unevaluatedProperties:
        not: {}
    CallFlowVersionDeployByVersionId:
      type: object
      required:
      - call_flow_version_id
      properties:
        call_flow_version_id:
          allOf:
   

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