Twilio · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Twilio Flex Flex Flows API

6 actions 6 updates phrasing extends openapi/twilio-flex-flows-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Twilio's API. It is a proposal applied on top of the contract, not a document Twilio publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info
$.paths['/FlexFlows'].get
$.paths['/FlexFlows'].post
$.paths['/FlexFlows/{FlexFlowSid}'].get
$.paths['/FlexFlows/{FlexFlowSid}'].post
$.paths['/FlexFlows/{FlexFlowSid}'].delete

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Twilio Flex Flex Flows API
  version: 1.0.0
extends: openapi/twilio-flex-flows-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/FlexFlows'].get
  update:
    x-apievangelist-phrasing:
      intent: List my Flex Flows
      effect: read
      questions:
      - Which Flex Flows decide how inbound contacts reach my agents?
      - Can I find a Flex Flow by its friendly name?
      instructions:
      - text: List all my Flex Flows.
      - text: Find Flex Flows named {name}.
        slots:
          name: query.FriendlyName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/FlexFlows'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Flex Flow
      effect: write
      questions:
      - How do I route a new inbound contact channel into Flex?
      - Can a new Flex Flow hand contacts to a Studio flow or straight to a TaskRouter workflow?
      instructions:
      - text: Create a Flex Flow {name} for {channel_type} on chat service {chat_service}.
        slots:
          name: requestBody.FriendlyName
          channel_type: requestBody.ChannelType
          chat_service: requestBody.ChatServiceSid
      - text: Create Flex Flow {name} for {channel_type} via chat service {chat_service}, handing contacts to Studio flow {studio_flow}.
        slots:
          name: requestBody.FriendlyName
          channel_type: requestBody.ChannelType
          chat_service: requestBody.ChatServiceSid
          studio_flow: requestBody.Integration.FlowSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/FlexFlows/{FlexFlowSid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one Flex Flow
      effect: read
      questions:
      - What channel type and integration does a specific Flex Flow use?
      - Is a given Flex Flow enabled?
      instructions:
      - text: Get Flex Flow {flex_flow}.
        slots:
          flex_flow: path.FlexFlowSid
      - text: Show how Flex Flow {flex_flow} routes inbound contacts.
        slots:
          flex_flow: path.FlexFlowSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/FlexFlows/{FlexFlowSid}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a Flex Flow
      effect: write
      questions:
      - How do I switch an existing Flex Flow to a different Studio flow?
      - Can I disable an existing Flex Flow without deleting it?
      instructions:
      - text: 'Update existing Flex Flow {flex_flow}: name {name}, channel {channel_type}, chat service {chat_service}, enabled {enabled}.'
        slots:
          flex_flow: path.FlexFlowSid
          name: requestBody.FriendlyName
          channel_type: requestBody.ChannelType
          chat_service: requestBody.ChatServiceSid
          enabled: requestBody.Enabled
      - text: Point existing Flex Flow {flex_flow} ({name}, {channel_type}, chat service {chat_service}) at Studio flow {studio_flow}.
        slots:
          flex_flow: path.FlexFlowSid
          name: requestBody.FriendlyName
          channel_type: requestBody.ChannelType
          chat_service: requestBody.ChatServiceSid
          studio_flow: requestBody.Integration.FlowSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/FlexFlows/{FlexFlowSid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Flex Flow
      effect: destructive
      questions:
      - Can I permanently remove a Flex Flow I no longer route contacts through?
      - What if an old channel's Flex Flow should be deleted?
      instructions:
      - text: Delete Flex Flow {flex_flow}.
        slots:
          flex_flow: path.FlexFlowSid
      - text: Permanently remove the Flex Flow {flex_flow}.
        slots:
          flex_flow: path.FlexFlowSid
      method: generated
      generated: '2026-09-26'