Twilio · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Twilio Flex Interactions API

6 actions 6 updates phrasing extends openapi/twilio-interactions-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['/Interactions'].post

$.paths['/Interactions/{InteractionSid}'].get

$.paths['/Interactions/{InteractionSid}/Channels'].get

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

$.paths['/Interactions/{InteractionSid}/Channels/{ChannelSid}'].post

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 Interactions API
  version: 1.0.0
extends: openapi/twilio-interactions-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['/Interactions'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a customer interaction in Flex
      effect: write
      questions:
      - How do I open a new customer interaction and route it to an agent?
      - Can one interaction follow a customer across several channels?
      instructions:
      - text: Create an interaction on channel {channel} routed with {routing}.
        slots:
          channel: requestBody.channel
          routing: requestBody.routing
      - text: Start a new customer engagement over {channel} and send it to the queue in {routing}.
        slots:
          channel: requestBody.channel
          routing: requestBody.routing
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Interactions/{InteractionSid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one customer interaction
      effect: read
      questions:
      - What is the current state of a particular customer interaction?
      - Can I look up an interaction record by its SID?
      instructions:
      - text: Get interaction {interaction_sid}.
        slots:
          interaction_sid: path.InteractionSid
      - text: Show the details of customer interaction {interaction_sid}.
        slots:
          interaction_sid: path.InteractionSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Interactions/{InteractionSid}/Channels'].get
  update:
    x-apievangelist-phrasing:
      intent: List channels in an interaction
      effect: read
      questions:
      - Which channels has a customer used within one interaction?
      - Did this customer interaction span both voice and chat?
      instructions:
      - text: List the channels of interaction {interaction_sid}.
        slots:
          interaction_sid: path.InteractionSid
      - text: Show every channel attached to customer interaction {interaction_sid}.
        slots:
          interaction_sid: path.InteractionSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Interactions/{InteractionSid}/Channels/{ChannelSid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one channel of an interaction
      effect: read
      questions:
      - What status is a single channel within an interaction in?
      - Can I inspect one interaction channel on its own?
      instructions:
      - text: Get channel {channel_sid} of interaction {interaction_sid}.
        slots:
          channel_sid: path.ChannelSid
          interaction_sid: path.InteractionSid
      - text: Show the status of interaction channel {channel_sid} in {interaction_sid}.
        slots:
          channel_sid: path.ChannelSid
          interaction_sid: path.InteractionSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Interactions/{InteractionSid}/Channels/{ChannelSid}'].post
  update:
    x-apievangelist-phrasing:
      intent: Change an interaction channel's status or routing
      effect: write
      questions:
      - How do I close out one channel of a customer interaction?
      - Can I re-route an interaction channel to a different queue or agent?
      instructions:
      - text: Set channel {channel_sid} of interaction {interaction_sid} to status {status}.
        slots:
          channel_sid: path.ChannelSid
          interaction_sid: path.InteractionSid
          status: requestBody.status
      - text: Re-route interaction channel {channel_sid} in {interaction_sid} using {routing}.
        slots:
          channel_sid: path.ChannelSid
          interaction_sid: path.InteractionSid
          routing: requestBody.routing
      method: generated
      generated: '2026-09-26'