Impact · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Brand Phone Numbers API

3 actions 3 updates phrasing extends openapi/impact-phone-numbers-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Impact's API. It is a proposal applied on top of the contract, not a document Impact publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/Advertisers/{AccountSID}/PhoneNumbers'].get
$.paths['/Advertisers/{AccountSID}/PhoneNumbers/{PhoneNumberId}'].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 Brand Phone Numbers API
  version: 1.0.0
extends: openapi/impact-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: 2
- target: $.paths['/Advertisers/{AccountSID}/PhoneNumbers'].get
  update:
    x-apievangelist-phrasing:
      intent: List tracking phone numbers
      effect: read
      questions:
      - What call tracking phone numbers does my account have?
      - Can I find a phone number record by the number itself?
      instructions:
      - text: List phone numbers in account {sid}.
        slots:
          sid: path.AccountSID
      - text: Find the phone number record for {number}.
        slots:
          number: query.Number
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Advertisers/{AccountSID}/PhoneNumbers/{PhoneNumberId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a tracking phone number's details
      effect: read
      questions:
      - When was a specific tracking number last assigned or released?
      - Can I look up one phone number by its ID?
      instructions:
      - text: Get phone number {phone} in account {sid}.
        slots:
          sid: path.AccountSID
          phone: path.PhoneNumberId
      - text: Show assignment history of phone number {phone}.
        slots:
          phone: path.PhoneNumberId
      method: generated
      generated: '2026-09-26'