Twilio Web Channels API

Manage web chat channels

Operations 4

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /WebChannels Start a Flex web chat channel for a customer · Twilio Create a Web Channel #
Ask an LLM
“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?”
Tell an agent
Open a web chat on Flex Flow {flex_flow_sid} for {identity} named {customer_name} with chat title {chat_name}.
Start chat {chat_name} for customer {customer_name} ({identity}) on flow {flex_flow_sid} with pre-engagement data {pre_engagement_data}.
GET /WebChannels/{ChannelSid} Look up a Flex web chat channel · Twilio Fetch a Web Channel #
Ask an LLM
“Can I pull up the details of one web chat channel?”
“Is a given customer's web chat channel still around?”
Tell an agent
Fetch web chat channel {channel_sid}.
Show the details of Flex web channel {channel_sid}.
POST /WebChannels/{ChannelSid} Update the status of a web chat channel · Twilio Update a Web Channel #
Ask an LLM
“Can I mark a web chat as inactive once the customer leaves?”
“Can I attach post-engagement survey data to a finished web chat?”
Tell an agent
Set the chat status of web channel {channel_sid} to {chat_status}.
Save post-engagement data {post_engagement_data} on web channel {channel_sid}.
DELETE /WebChannels/{ChannelSid} Delete a Flex web chat channel · Twilio Delete a Web Channel #
Ask an LLM
“Can I delete a web chat channel after the conversation is over?”
“What's the way to clean up old Flex web chat channels?”
Tell an agent destructive · confirm first
Delete web chat channel {channel_sid}.
Remove Flex web channel {channel_sid} for good.

Documentation

Specifications

Other Resources

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/twilio-web-channels-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

twilio-web-channels-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Twilio Flex Web Channels API
  description: Programmable digital engagement center API for building customized omnichannel contact center solutions. Manage Flex configuration, channels, flows, interactions, plugins, and worker insights for customer communication across voice, SMS, chat, WhatsApp, and more.
  version: '2.0'
  contact:
    name: Twilio Support
    url: https://support.twilio.com
    email: support@twilio.com
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  termsOfService: https://www.twilio.com/legal/tos
servers:
- url: https://flex-api.twilio.com/v1
  description: Twilio Flex API v1
- url: https://flex-api.twilio.com/v2
  description: Twilio Flex API v2
security:
- accountSid_authToken: []
tags:
- name: Web Channels
  description: Manage web chat channels
paths:
  /WebChannels:
    post:
      operationId: createWebChannel
      summary: Twilio Create a Web Channel
      description: Create a new web chat channel for customer interaction.
      tags:
      - Web Channels
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              required:
              - FlexFlowSid
              - Identity
              - CustomerFriendlyName
              - ChatFriendlyName
              properties:
                FlexFlowSid:
                  type: string
                Identity:
                  type: string
                CustomerFriendlyName:
                  type: string
                ChatFriendlyName:
                  type: string
                ChatUniqueName:
                  type: string
                PreEngagementData:
                  type: string
                  description: JSON string with pre-engagement form data
      responses:
        '201':
          description: Web channel created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebChannel'
  /WebChannels/{ChannelSid}:
    get:
      operationId: fetchWebChannel
      summary: Twilio Fetch a Web Channel
      tags:
      - Web Channels
      parameters:
      - name: ChannelSid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Web channel details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebChannel'
    post:
      operationId: updateWebChannel
      summary: Twilio Update a Web Channel
      tags:
      - Web Channels
      parameters:
      - name: ChannelSid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                ChatStatus:
                  type: string
                  enum:
                  - inactive
                PostEngagementData:
                  type: string
      responses:
        '200':
          description: Web channel updated
    delete:
      operationId: deleteWebChannel
      summary: Twilio Delete a Web Channel
      tags:
      - Web Channels
      parameters:
      - name: ChannelSid
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Web channel deleted
components:
  schemas:
    WebChannel:
      type: object
      properties:
        sid:
          type: string
        account_sid:
          type: string
          pattern: ^AC[0-9a-fA-F]{32}$
        flex_flow_sid:
          type: string
        url:
          type: string
          format: uri
        date_created:
          type: string
          format: date-time
        date_updated:
          type: string
          format: date-time
  securitySchemes:
    accountSid_authToken:
      type: http
      scheme: basic
      description: Use your Twilio Account SID as the username and Auth Token as the password for HTTP Basic authentication.
externalDocs:
  description: Twilio Flex API Documentation
  url: https://www.twilio.com/docs/flex