Twilio · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Twilio - Verify Attempts API

4 actions 4 updates phrasing extends openapi/twilio-attempts-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['/v2/Attempts'].get
$.paths['/v2/Attempts/{Sid}'].get
$.paths['/v2/Attempts/Summary'].get

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 Attempts API
  version: 1.0.0
extends: openapi/twilio-attempts-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['/v2/Attempts'].get
  update:
    x-apievangelist-phrasing:
      intent: List verification attempts
      effect: read
      questions:
      - Which verification codes were sent to a particular phone number?
      - Can I find verification attempts that never converted, by country or channel?
      - What attempts did one Verify service make in the last week?
      instructions:
      - text: List verification attempts sent to {to}.
        slots:
          to: query.ChannelData.To
      - text: Show {status} verification attempts over {channel} to {country}.
        slots:
          status: query.Status
          channel: query.Channel
          country: query.Country
      - text: List attempts for Verify service {verify_service_sid} created after {date_created_after}.
        slots:
          verify_service_sid: query.VerifyServiceSid
          date_created_after: query.DateCreatedAfter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/Attempts/{Sid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one verification attempt
      effect: read
      questions:
      - What happened with one specific verification attempt?
      - Can I see the channel and conversion status of a single attempt?
      instructions:
      - text: Get verification attempt {sid}.
        slots:
          sid: path.Sid
      - text: Show whether attempt {sid} was converted.
        slots:
          sid: path.Sid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/Attempts/Summary'].get
  update:
    x-apievangelist-phrasing:
      intent: Summarize verification conversion rates
      effect: read
      questions:
      - What percentage of my verification attempts actually converted?
      - How does conversion compare between SMS, voice and WhatsApp verifications?
      - Are users in one country or phone prefix converting worse than others?
      instructions:
      - text: Summarize verification attempts and conversions for service {verify_service_sid}.
        slots:
          verify_service_sid: query.VerifyServiceSid
      - text: Give me the conversion summary for {channel} attempts to {country}.
        slots:
          channel: query.Channel
          country: query.Country
      - text: Total up attempts and conversions to numbers starting {destination_prefix} since {date_created_after}.
        slots:
          destination_prefix: query.DestinationPrefix
          date_created_after: query.DateCreatedAfter
      method: generated
      generated: '2026-09-26'