Twilio · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Twilio - Voice Connection Policies API

11 actions 11 updates phrasing extends openapi/twilio-connectionpolicies-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 11

$.info
$.paths['/v1/ConnectionPolicies'].get
$.paths['/v1/ConnectionPolicies'].post
$.paths['/v1/ConnectionPolicies/{Sid}'].get
$.paths['/v1/ConnectionPolicies/{Sid}'].post
$.paths['/v1/ConnectionPolicies/{Sid}'].delete
$.paths['/v1/ConnectionPolicies/{ConnectionPolicySid}/Targets'].get
$.paths['/v1/ConnectionPolicies/{ConnectionPolicySid}/Targets'].post
$.paths['/v1/ConnectionPolicies/{ConnectionPolicySid}/Targets/{Sid}'].get
$.paths['/v1/ConnectionPolicies/{ConnectionPolicySid}/Targets/{Sid}'].post
$.paths['/v1/ConnectionPolicies/{ConnectionPolicySid}/Targets/{Sid}'].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 - Voice Connection Policies API
  version: 1.0.0
extends: openapi/twilio-connectionpolicies-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: 10
- target: $.paths['/v1/ConnectionPolicies'].get
  update:
    x-apievangelist-phrasing:
      intent: List connection policies
      effect: read
      questions:
      - Which connection policies have I set up for routing calls to my SIP infrastructure?
      - What connection policies exist on my account right now?
      instructions:
      - text: List all my connection policies.
      - text: Show my connection policies, {page_size} per page.
        slots:
          page_size: query.PageSize
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/ConnectionPolicies'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a connection policy
      effect: write
      questions:
      - How do I start a new connection policy for sending calls to my own SIP servers?
      - Can I give a new connection policy a friendly name when I create it?
      instructions:
      - text: Create a new connection policy named {name}.
        slots:
          name: requestBody.FriendlyName
      - text: Create an empty connection policy.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/ConnectionPolicies/{Sid}'].get
  update:
    x-apievangelist-phrasing:
      intent: View a connection policy
      effect: read
      questions:
      - What are the details of one particular connection policy?
      - Can I look up a connection policy by its SID?
      instructions:
      - text: Show connection policy {policy}.
        slots:
          policy: path.Sid
      - text: Get the name and dates of connection policy {policy}.
        slots:
          policy: path.Sid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/ConnectionPolicies/{Sid}'].post
  update:
    x-apievangelist-phrasing:
      intent: Rename a connection policy
      effect: write
      questions:
      - Can I change the friendly name of a connection policy I already have?
      - Is it possible to relabel an existing connection policy?
      instructions:
      - text: Rename connection policy {policy} to {name}.
        slots:
          policy: path.Sid
          name: requestBody.FriendlyName
      - text: Change the label on existing connection policy {policy} to {name}.
        slots:
          policy: path.Sid
          name: requestBody.FriendlyName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/ConnectionPolicies/{Sid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a connection policy
      effect: destructive
      questions:
      - How do I remove a connection policy I no longer use?
      - Can I delete a whole connection policy including its targets?
      instructions:
      - text: Delete connection policy {policy}.
        slots:
          policy: path.Sid
      - text: Remove the unused connection policy {policy} from my account.
        slots:
          policy: path.Sid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/ConnectionPolicies/{ConnectionPolicySid}/Targets'].get
  update:
    x-apievangelist-phrasing:
      intent: List the targets of a connection policy
      effect: read
      questions:
      - Which SIP endpoints does a connection policy send calls to?
      - What targets, priorities and weights are on one of my connection policies?
      instructions:
      - text: List the targets on connection policy {policy}.
        slots:
          policy: path.ConnectionPolicySid
      - text: Show every SIP target configured under policy {policy}.
        slots:
          policy: path.ConnectionPolicySid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/ConnectionPolicies/{ConnectionPolicySid}/Targets'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a SIP target to a connection policy
      effect: write
      questions:
      - How do I add a SIP address as a new target on a connection policy?
      - Can I set priority and weight when adding a target so calls fail over or load balance?
      instructions:
      - text: Add target {target} to connection policy {policy}.
        slots:
          target: requestBody.Target
          policy: path.ConnectionPolicySid
      - text: Add target {target} to policy {policy} with priority {priority} and weight {weight}.
        slots:
          target: requestBody.Target
          policy: path.ConnectionPolicySid
          priority: requestBody.Priority
          weight: requestBody.Weight
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/ConnectionPolicies/{ConnectionPolicySid}/Targets/{Sid}'].get
  update:
    x-apievangelist-phrasing:
      intent: View one connection policy target
      effect: read
      questions:
      - What SIP address, priority and weight does a single policy target have?
      - Is a specific target on my connection policy enabled?
      instructions:
      - text: Show target {target} on connection policy {policy}.
        slots:
          target: path.Sid
          policy: path.ConnectionPolicySid
      - text: Check whether target {target} in policy {policy} is enabled.
        slots:
          target: path.Sid
          policy: path.ConnectionPolicySid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/ConnectionPolicies/{ConnectionPolicySid}/Targets/{Sid}'].post
  update:
    x-apievangelist-phrasing:
      intent: Change a connection policy target
      effect: write
      questions:
      - Can I temporarily disable one SIP target without deleting it?
      - What do I change to shift more traffic to one existing target?
      instructions:
      - text: Disable target {target} on connection policy {policy} by setting enabled to {enabled}.
        slots:
          target: path.Sid
          policy: path.ConnectionPolicySid
          enabled: requestBody.Enabled
      - text: Change the weight of existing target {target} in policy {policy} to {weight}.
        slots:
          target: path.Sid
          policy: path.ConnectionPolicySid
          weight: requestBody.Weight
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/ConnectionPolicies/{ConnectionPolicySid}/Targets/{Sid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a target from a connection policy
      effect: destructive
      questions:
      - How do I take a decommissioned SIP server out of a connection policy?
      - Can I delete a single target and keep the rest of the policy?
      instructions:
      - text: Remove target {target} from connection policy {policy}.
        slots:
          target: path.Sid
          policy: path.ConnectionPolicySid
      - text: Delete policy target {target} under {policy}.
        slots:
          target: path.Sid
          policy: path.ConnectionPolicySid
      method: generated
      generated: '2026-09-26'