Twilio · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Twilio - Voice Byoc Trunks API

6 actions 6 updates phrasing extends openapi/twilio-byoctrunks-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['/v1/ByocTrunks'].get

$.paths['/v1/ByocTrunks'].post

$.paths['/v1/ByocTrunks/{Sid}'].get

$.paths['/v1/ByocTrunks/{Sid}'].post

$.paths['/v1/ByocTrunks/{Sid}'].delete

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 - Voice Byoc Trunks API
  version: 1.0.0
extends: openapi/twilio-byoctrunks-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['/v1/ByocTrunks'].get
  update:
    x-apievangelist-phrasing:
      intent: List my BYOC trunks
      effect: read
      questions:
      - Which Bring Your Own Carrier trunks do I have configured?
      - What BYOC trunks exist on my account?
      instructions:
      - text: List all my BYOC trunks.
      - text: Show BYOC trunks, {page_size} per page.
        slots:
          page_size: query.PageSize
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/ByocTrunks'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a BYOC trunk
      effect: write
      questions:
      - How do I connect my own carrier to Twilio with a new BYOC trunk?
      - Can I set a voice URL and a fallback URL when creating a BYOC trunk?
      - Is caller name lookup available on a new BYOC trunk?
      instructions:
      - text: Create a BYOC trunk named {name} that sends calls to {voice_url}.
        slots:
          name: requestBody.FriendlyName
          voice_url: requestBody.VoiceUrl
      - text: Create a BYOC trunk using connection policy {policy} with CNAM lookup {cnam}.
        slots:
          policy: requestBody.ConnectionPolicySid
          cnam: requestBody.CnamLookupEnabled
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/ByocTrunks/{Sid}'].get
  update:
    x-apievangelist-phrasing:
      intent: View a BYOC trunk
      effect: read
      questions:
      - What voice URL and connection policy is a BYOC trunk using?
      - Can I pull up the settings of one BYOC trunk by SID?
      instructions:
      - text: Show BYOC trunk {trunk}.
        slots:
          trunk: path.Sid
      - text: Get the voice and status callback settings of trunk {trunk}.
        slots:
          trunk: path.Sid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/ByocTrunks/{Sid}'].post
  update:
    x-apievangelist-phrasing:
      intent: Change a BYOC trunk's settings
      effect: write
      questions:
      - Can I swap the connection policy on a BYOC trunk that already exists?
      - What do I change to point an existing trunk at a new voice webhook?
      instructions:
      - text: Change the voice URL of BYOC trunk {trunk} to {voice_url}.
        slots:
          trunk: path.Sid
          voice_url: requestBody.VoiceUrl
      - text: Switch existing trunk {trunk} to connection policy {policy}.
        slots:
          trunk: path.Sid
          policy: requestBody.ConnectionPolicySid
      - text: Set status callbacks for trunk {trunk} to {status_url}.
        slots:
          trunk: path.Sid
          status_url: requestBody.StatusCallbackUrl
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/ByocTrunks/{Sid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a BYOC trunk
      effect: destructive
      questions:
      - How do I remove a BYOC trunk for a carrier we stopped using?
      - Can I delete a Bring Your Own Carrier trunk entirely?
      instructions:
      - text: Delete BYOC trunk {trunk}.
        slots:
          trunk: path.Sid
      - text: Remove the carrier trunk {trunk} from my account.
        slots:
          trunk: path.Sid
      method: generated
      generated: '2026-09-26'