Twilio · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Twilio Flex Web Channels API

5 actions 5 updates phrasing extends openapi/twilio-web-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['/WebChannels'].post
$.paths['/WebChannels/{ChannelSid}'].get
$.paths['/WebChannels/{ChannelSid}'].post
$.paths['/WebChannels/{ChannelSid}'].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 Web Channels API
  version: 1.0.0
extends: openapi/twilio-web-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['/WebChannels'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a Flex web chat channel for a customer
      effect: write
      questions:
      - How do I open a new Flex web chat for a customer from my own site?
      - Can I pass pre-engagement form data when a web chat starts?
      instructions:
      - text: Open a web chat on Flex Flow {flex_flow_sid} for {identity} named {customer_name} with chat title {chat_name}.
        slots:
          flex_flow_sid: requestBody.FlexFlowSid
          identity: requestBody.Identity
          customer_name: requestBody.CustomerFriendlyName
          chat_name: requestBody.ChatFriendlyName
      - text: Start chat {chat_name} for customer {customer_name} ({identity}) on flow {flex_flow_sid} with pre-engagement data {pre_engagement_data}.
        slots:
          chat_name: requestBody.ChatFriendlyName
          customer_name: requestBody.CustomerFriendlyName
          identity: requestBody.Identity
          flex_flow_sid: requestBody.FlexFlowSid
          pre_engagement_data: requestBody.PreEngagementData
      method: generated
      generated: '2026-09-26'
- target: $.paths['/WebChannels/{ChannelSid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a Flex web chat channel
      effect: read
      questions:
      - Can I pull up the details of one web chat channel?
      - Is a given customer's web chat channel still around?
      instructions:
      - text: Fetch web chat channel {channel_sid}.
        slots:
          channel_sid: path.ChannelSid
      - text: Show the details of Flex web channel {channel_sid}.
        slots:
          channel_sid: path.ChannelSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/WebChannels/{ChannelSid}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update the status of a web chat channel
      effect: write
      questions:
      - Can I mark a web chat as inactive once the customer leaves?
      - Can I attach post-engagement survey data to a finished web chat?
      instructions:
      - text: Set the chat status of web channel {channel_sid} to {chat_status}.
        slots:
          channel_sid: path.ChannelSid
          chat_status: requestBody.ChatStatus
      - text: Save post-engagement data {post_engagement_data} on web channel {channel_sid}.
        slots:
          post_engagement_data: requestBody.PostEngagementData
          channel_sid: path.ChannelSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/WebChannels/{ChannelSid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Flex web chat channel
      effect: destructive
      questions:
      - Can I delete a web chat channel after the conversation is over?
      - What's the way to clean up old Flex web chat channels?
      instructions:
      - text: Delete web chat channel {channel_sid}.
        slots:
          channel_sid: path.ChannelSid
      - text: Remove Flex web channel {channel_sid} for good.
        slots:
          channel_sid: path.ChannelSid
      method: generated
      generated: '2026-09-26'