Twilio · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Twilio Configuration API

12 actions 12 updates phrasing extends openapi/twilio-configuration-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 12

$.info
$.paths['/v1/Configuration'].get
$.paths['/v1/Configuration'].post
$.paths['/v1/Configuration/Addresses'].get
$.paths['/v1/Configuration/Addresses'].post
$.paths['/v1/Configuration/Addresses/{Sid}'].get
$.paths['/v1/Configuration/Addresses/{Sid}'].post
$.paths['/v1/Configuration/Addresses/{Sid}'].delete
$.paths['/v1/Configuration/Webhooks'].get
$.paths['/v1/Configuration/Webhooks'].post
$.paths['/Configuration'].get
$.paths['/Configuration'].post

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 Configuration API
  version: 1.0.0
extends: openapi/twilio-configuration-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: 11
- target: $.paths['/v1/Configuration'].get
  update:
    x-apievangelist-phrasing:
      intent: Get account-wide Conversations settings
      effect: read
      questions:
      - What are the default Conversations settings on my account?
      - Which conversation service and inactivity timers are my conversations using by default?
      instructions:
      - text: Show my account's global Conversations configuration.
      - text: Get the default conversation service and timers for Conversations.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Configuration'].post
  update:
    x-apievangelist-phrasing:
      intent: Change default Conversations settings
      effect: write
      questions:
      - Can I make conversations go inactive automatically after a period of silence?
      - How do I change which conversation service new conversations are created in by default?
      - Is there a minimum time before a conversation can be closed automatically?
      instructions:
      - text: Set the default Conversations service to {default_chat_service_sid}.
        slots:
          default_chat_service_sid: requestBody.DefaultChatServiceSid
      - text: Mark conversations inactive after {default_inactive_timer} and close them after {default_closed_timer}.
        slots:
          default_inactive_timer: requestBody.DefaultInactiveTimer
          default_closed_timer: requestBody.DefaultClosedTimer
      - text: Use messaging service {default_messaging_service_sid} as the Conversations default.
        slots:
          default_messaging_service_sid: requestBody.DefaultMessagingServiceSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Configuration/Addresses'].get
  update:
    x-apievangelist-phrasing:
      intent: List Conversations address configurations
      effect: read
      questions:
      - Which phone numbers and WhatsApp addresses are set up to auto-create conversations?
      - Can I list only my WhatsApp address configurations?
      instructions:
      - text: List all my Conversations address configurations.
      - text: Show address configurations of type {type}.
        slots:
          type: query.Type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Configuration/Addresses'].post
  update:
    x-apievangelist-phrasing:
      intent: Configure an address for Conversations
      effect: write
      questions:
      - How do I make incoming SMS to a number start a new conversation automatically?
      - Can new messages to a WhatsApp address trigger a Studio flow or webhook?
      instructions:
      - text: Configure {type} address {address} for Conversations.
        slots:
          type: requestBody.Type
          address: requestBody.Address
      - text: Set up {type} address {address} to auto-create conversations and post to webhook {webhook_url}.
        slots:
          type: requestBody.Type
          address: requestBody.Address
          webhook_url: requestBody.AutoCreation.WebhookUrl
      - text: Route new messages on {type} address {address} to Studio flow {studio_flow_sid}.
        slots:
          type: requestBody.Type
          address: requestBody.Address
          studio_flow_sid: requestBody.AutoCreation.StudioFlowSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Configuration/Addresses/{Sid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one address configuration
      effect: read
      questions:
      - How is auto-creation set up for one particular phone number or WhatsApp address?
      - Can I look up an address configuration by the address itself instead of its SID?
      instructions:
      - text: Get address configuration {sid}.
        slots:
          sid: path.Sid
      - text: Show the Conversations setup for address {sid}.
        slots:
          sid: path.Sid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Configuration/Addresses/{Sid}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update an address configuration
      effect: write
      questions:
      - Can I turn off automatic conversation creation for an address I already configured?
      - How do I point an existing address configuration at a different webhook URL?
      instructions:
      - text: Set auto-creation enabled to {enabled} on address configuration {sid}.
        slots:
          enabled: requestBody.AutoCreation.Enabled
          sid: path.Sid
      - text: Change the auto-creation webhook on existing address configuration {sid} to {webhook_url}.
        slots:
          sid: path.Sid
          webhook_url: requestBody.AutoCreation.WebhookUrl
      - text: Rename address configuration {sid} to {friendly_name}.
        slots:
          sid: path.Sid
          friendly_name: requestBody.FriendlyName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Configuration/Addresses/{Sid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an address configuration
      effect: destructive
      questions:
      - Can I stop an address from being handled by Conversations by deleting its configuration?
      - Is removing an address configuration permanent?
      instructions:
      - text: Delete address configuration {sid}.
        slots:
          sid: path.Sid
      - text: Remove the Conversations setup for address {sid}.
        slots:
          sid: path.Sid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Configuration/Webhooks'].get
  update:
    x-apievangelist-phrasing:
      intent: Get account-level Conversations webhooks
      effect: read
      questions:
      - Where are my Conversations pre-event and post-event webhooks currently pointed?
      - Which conversation events are firing my account-level webhook?
      instructions:
      - text: Show my Conversations webhook configuration.
      - text: Get the current pre- and post-event webhook URLs for Conversations.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Configuration/Webhooks'].post
  update:
    x-apievangelist-phrasing:
      intent: Set account-level Conversations webhooks
      effect: write
      questions:
      - How do I get notified whenever a message is added to any conversation?
      - Can I choose which conversation events trigger my webhook?
      instructions:
      - text: Send Conversations post-event webhooks to {post_webhook_url}.
        slots:
          post_webhook_url: requestBody.PostWebhookUrl
      - text: Set the Conversations pre-event webhook to {pre_webhook_url} using {method}.
        slots:
          pre_webhook_url: requestBody.PreWebhookUrl
          method: requestBody.Method
      - text: Only fire Conversations webhooks for events {filters}.
        slots:
          filters: requestBody.Filters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Configuration'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the Flex configuration
      effect: read
      questions:
      - What UI attributes and enabled channels does my Flex contact center have?
      - Can I see the Flex configuration for a specific UI version?
      instructions:
      - text: Show my Flex configuration.
      - text: Get the Flex configuration for UI version {ui_version}.
        slots:
          ui_version: query.UiVersion
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Configuration'].post
  update:
    x-apievangelist-phrasing:
      intent: Update the Flex configuration
      effect: write
      questions:
      - How do I change the language of the Flex agent interface?
      - Can I pin my Flex UI to a particular version?
      instructions:
      - text: Set the Flex UI language to {ui_language}.
        slots:
          ui_language: requestBody.ui_language
      - text: Update Flex to UI version {ui_version} with attributes {ui_attributes}.
        slots:
          ui_version: requestBody.ui_version
          ui_attributes: requestBody.ui_attributes
      - text: Change the Flex runtime domain to {runtime_domain}.
        slots:
          runtime_domain: requestBody.runtime_domain
      method: generated
      generated: '2026-09-26'