Twilio · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Twilio Verify Verifications API

4 actions 4 updates phrasing extends openapi/twilio-verifications-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 4

$.info
$.paths['/Services/{ServiceSid}/Verifications'].post
$.paths['/Services/{ServiceSid}/Verifications/{VerificationSid}'].get
$.paths['/Services/{ServiceSid}/Verifications/{VerificationSid}'].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 Verify Verifications API
  version: 1.0.0
extends: openapi/twilio-verifications-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: 3
- target: $.paths['/Services/{ServiceSid}/Verifications'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a verification code
      effect: write
      questions:
      - How do I text a one-time passcode to a user to confirm their phone number?
      - Can I send the verification code by email or WhatsApp instead of SMS?
      - Can the code message show my app's name or be in another language?
      instructions:
      - text: Send a verification code to {to} by {channel} using Verify service {service}.
        slots:
          to: requestBody.To
          channel: requestBody.Channel
          service: path.ServiceSid
      - text: Start a {channel} verification for {to} on service {service} in locale {locale}.
        slots:
          channel: requestBody.Channel
          to: requestBody.To
          service: path.ServiceSid
          locale: requestBody.Locale
      - text: Send a {channel} code to {to} via service {service}, branded as {friendly_name}.
        slots:
          channel: requestBody.Channel
          to: requestBody.To
          service: path.ServiceSid
          friendly_name: requestBody.CustomFriendlyName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Services/{ServiceSid}/Verifications/{VerificationSid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a verification's status
      effect: read
      questions:
      - Is a verification I started still pending or already approved?
      - Can I look up one verification attempt by its SID?
      instructions:
      - text: Show verification {verification} on Verify service {service}.
        slots:
          verification: path.VerificationSid
          service: path.ServiceSid
      - text: Tell me the current status of verification {verification} in service {service}.
        slots:
          verification: path.VerificationSid
          service: path.ServiceSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Services/{ServiceSid}/Verifications/{VerificationSid}'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel or approve a pending verification
      effect: write
      questions:
      - How do I cancel a verification code I sent so it can't be used?
      - Can I mark a pending verification as approved from my backend?
      instructions:
      - text: Set verification {verification} on service {service} to {status}.
        slots:
          verification: path.VerificationSid
          service: path.ServiceSid
          status: requestBody.Status
      - text: Cancel the pending code {verification} in Verify service {service} by setting status {status}.
        slots:
          verification: path.VerificationSid
          service: path.ServiceSid
          status: requestBody.Status
      method: generated
      generated: '2026-09-26'