Twilio · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Twilio Flex Channels API

5 actions 5 updates phrasing extends openapi/twilio-channels-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 5

$.info

$.paths['/Channels'].get

$.paths['/Channels'].post

$.paths['/Channels/{ChannelSid}'].get

$.paths['/Channels/{ChannelSid}'].delete

OpenAPI Overlay

# 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 Channels API
  version: 1.0.0
extends: openapi/twilio-channels-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: 4
- target: $.paths['/Channels'].get
  update:
    x-apievangelist-phrasing:
      intent: List Flex channels
      effect: read
      questions:
      - Which Flex chat channels are open for customer conversations?
      - Can I page through my Flex channels a few at a time?
      instructions:
      - text: List my Flex channels.
      - text: List Flex channels, {page_size} per page.
        slots:
          page_size: query.PageSize
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Channels'].post
  update:
    x-apievangelist-phrasing:
      intent: Open a Flex channel for a customer
      effect: write
      questions:
      - How do I start a new Flex chat channel when a customer reaches out?
      - Can I pass pre-engagement data and task attributes when opening a Flex channel?
      - Is there a way to make a Flex channel long-lived instead of closing after the task?
      instructions:
      - text: Create a Flex channel on flow {flex_flow} for customer {identity} named {user_name} in chat {chat_name}.
        slots:
          flex_flow: requestBody.FlexFlowSid
          identity: requestBody.Identity
          user_name: requestBody.ChatUserFriendlyName
          chat_name: requestBody.ChatFriendlyName
      - text: Open a long-lived Flex channel on flow {flex_flow} for {identity} ({user_name}) in chat {chat_name} with long-lived {long_lived}.
        slots:
          flex_flow: requestBody.FlexFlowSid
          identity: requestBody.Identity
          user_name: requestBody.ChatUserFriendlyName
          chat_name: requestBody.ChatFriendlyName
          long_lived: requestBody.LongLived
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Channels/{ChannelSid}'].get
  update:
    x-apievangelist-phrasing:
      intent: View a Flex channel
      effect: read
      questions:
      - What flow and task is a particular Flex channel attached to?
      - Can I look up one Flex channel by its SID?
      instructions:
      - text: Show Flex channel {channel}.
        slots:
          channel: path.ChannelSid
      - text: Get the details of customer channel {channel}.
        slots:
          channel: path.ChannelSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Channels/{ChannelSid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Flex channel
      effect: destructive
      questions:
      - How do I remove a Flex channel once the conversation is over?
      - Can I delete a stale Flex chat channel?
      instructions:
      - text: Delete Flex channel {channel}.
        slots:
          channel: path.ChannelSid
      - text: Remove the finished customer channel {channel}.
        slots:
          channel: path.ChannelSid
      method: generated
      generated: '2026-09-26'