Twilio · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Twilio Messaging Short Codes API

3 actions 3 updates phrasing extends openapi/twilio-short-codes-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 3

$.info
$.paths['/Services/{ServiceSid}/ShortCodes'].get
$.paths['/Services/{ServiceSid}/ShortCodes'].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 Short Codes API
  version: 1.0.0
extends: openapi/twilio-short-codes-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: 2
- target: $.paths['/Services/{ServiceSid}/ShortCodes'].get
  update:
    x-apievangelist-phrasing:
      intent: List short codes on a Messaging Service
      effect: read
      questions:
      - Which short codes are in my Messaging Service's sender pool?
      - Can I check whether a short code is already attached to a service?
      instructions:
      - text: List the short codes on Messaging Service {service}.
        slots:
          service: path.ServiceSid
      - text: Show the short codes that service {service} sends from.
        slots:
          service: path.ServiceSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Services/{ServiceSid}/ShortCodes'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a short code to a Messaging Service
      effect: write
      questions:
      - How do I add my approved short code to a Messaging Service?
      - Can a Messaging Service send high-volume texts from a short code?
      instructions:
      - text: Add short code {short_code} to Messaging Service {service}.
        slots:
          short_code: requestBody.ShortCodeSid
          service: path.ServiceSid
      - text: Put short code {short_code} into the sender pool of service {service}.
        slots:
          short_code: requestBody.ShortCodeSid
          service: path.ServiceSid
      method: generated
      generated: '2026-09-26'