Twilio · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Twilio Phone Numbers API

4 actions 4 updates phrasing extends openapi/twilio-phone-numbers-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['/PhoneNumbers/{PhoneNumber}'].get
$.paths['/Services/{ServiceSid}/PhoneNumbers'].get
$.paths['/Services/{ServiceSid}/PhoneNumbers'].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 Phone Numbers API
  version: 1.0.0
extends: openapi/twilio-phone-numbers-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['/PhoneNumbers/{PhoneNumber}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up information about a phone number
      effect: read
      questions:
      - Is this a mobile, landline or VoIP number, and who is the caller?
      - Can I check whether a phone number's SIM was recently swapped?
      - How do I verify that a phone number belongs to the person who gave it to me?
      instructions:
      - text: Look up {phone_number} and return {fields}.
        slots:
          phone_number: path.PhoneNumber
          fields: query.Fields
      - text: Validate national-format number {phone_number} for country {country}.
        slots:
          phone_number: path.PhoneNumber
          country: query.CountryCode
      - text: Run an identity match on {phone_number} for {first_name} {last_name}, born {dob}.
        slots:
          phone_number: path.PhoneNumber
          first_name: query.FirstName
          last_name: query.LastName
          dob: query.DateOfBirth
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Services/{ServiceSid}/PhoneNumbers'].get
  update:
    x-apievangelist-phrasing:
      intent: List phone numbers in a Messaging Service
      effect: read
      questions:
      - Which phone numbers are in my Messaging Service sender pool?
      - What numbers does a messaging service send from?
      instructions:
      - text: List the phone numbers in Messaging Service {service}.
        slots:
          service: path.ServiceSid
      - text: Show the sender pool numbers of messaging service {service}.
        slots:
          service: path.ServiceSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Services/{ServiceSid}/PhoneNumbers'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a phone number to a Messaging Service
      effect: write
      questions:
      - How do I add one of my numbers to a Messaging Service's sender pool?
      - Can I send messages from an extra number through my messaging service?
      instructions:
      - text: Add phone number {phone_number_sid} to Messaging Service {service}.
        slots:
          phone_number_sid: requestBody.PhoneNumberSid
          service: path.ServiceSid
      - text: Put number {phone_number_sid} into the sender pool of service {service}.
        slots:
          phone_number_sid: requestBody.PhoneNumberSid
          service: path.ServiceSid
      method: generated
      generated: '2026-09-26'