Twilio · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Twilio - Messaging Tollfree API

6 actions 6 updates phrasing extends openapi/twilio-tollfree-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/Tollfree/Verifications/{Sid}'].get
$.paths['/v1/Tollfree/Verifications/{Sid}'].post
$.paths['/v1/Tollfree/Verifications/{Sid}'].delete
$.paths['/v1/Tollfree/Verifications'].get
$.paths['/v1/Tollfree/Verifications'].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 - Messaging Tollfree API
  version: 1.0.0
extends: openapi/twilio-tollfree-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/Tollfree/Verifications/{Sid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one toll-free verification
      effect: read
      questions:
      - Has my toll-free number's verification been approved yet?
      - Can I see the full submission for one toll-free verification request?
      instructions:
      - text: Get toll-free verification {sid}.
        slots:
          sid: path.Sid
      - text: Show the status of toll-free verification request {sid}.
        slots:
          sid: path.Sid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Tollfree/Verifications/{Sid}'].post
  update:
    x-apievangelist-phrasing:
      intent: Edit a toll-free verification request
      effect: write
      questions:
      - My toll-free verification was rejected because the website was down; can I edit and resubmit it?
      - How do I change the business contact on a toll-free verification I already filed?
      instructions:
      - text: Update the website on toll-free verification {sid} to {business_website} because {edit_reason}.
        slots:
          sid: path.Sid
          business_website: requestBody.BusinessWebsite
          edit_reason: requestBody.EditReason
      - text: Change the sample message on existing toll-free verification {sid} to {production_message_sample}.
        slots:
          sid: path.Sid
          production_message_sample: requestBody.ProductionMessageSample
      - text: Set the business contact email on verification {sid} to {business_contact_email}.
        slots:
          sid: path.Sid
          business_contact_email: requestBody.BusinessContactEmail
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Tollfree/Verifications/{Sid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a toll-free verification
      effect: destructive
      questions:
      - Can I withdraw a toll-free verification request entirely?
      - Is deleting a toll-free verification record permanent?
      instructions:
      - text: Delete toll-free verification {sid}.
        slots:
          sid: path.Sid
      - text: Withdraw and remove toll-free verification request {sid}.
        slots:
          sid: path.Sid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Tollfree/Verifications'].get
  update:
    x-apievangelist-phrasing:
      intent: List toll-free verifications
      effect: read
      questions:
      - Which of my toll-free numbers are still waiting on verification?
      - Can I find the verification request filed for a specific toll-free number?
      instructions:
      - text: List my toll-free verifications with status {status}.
        slots:
          status: query.Status
      - text: Find the verification request for toll-free number {tollfree_phone_number_sid}.
        slots:
          tollfree_phone_number_sid: query.TollfreePhoneNumberSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Tollfree/Verifications'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit a toll-free number for verification
      effect: write
      questions:
      - How do I get my toll-free number verified so I can send text messages from it?
      - What does a toll-free verification need, like an opt-in screenshot and expected monthly volume?
      instructions:
      - text: Submit toll-free number {tollfree_phone_number_sid} for verification as {business_name} ({business_website}), notifying {notification_email}.
        slots:
          tollfree_phone_number_sid: requestBody.TollfreePhoneNumberSid
          business_name: requestBody.BusinessName
          business_website: requestBody.BusinessWebsite
          notification_email: requestBody.NotificationEmail
      - text: 'File verification for {tollfree_phone_number_sid}: use case {use_case_summary}, sample {production_message_sample}, volume {message_volume}.'
        slots:
          tollfree_phone_number_sid: requestBody.TollfreePhoneNumberSid
          use_case_summary: requestBody.UseCaseSummary
          production_message_sample: requestBody.ProductionMessageSample
          message_volume: requestBody.MessageVolume
      method: generated
      generated: '2026-09-26'