Twilio · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Twilio - Voice Source Ip Mappings API

6 actions 6 updates phrasing extends openapi/twilio-sourceipmappings-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 6

$.info

$.paths['/v1/SourceIpMappings'].get

$.paths['/v1/SourceIpMappings'].post

$.paths['/v1/SourceIpMappings/{Sid}'].get

$.paths['/v1/SourceIpMappings/{Sid}'].post

$.paths['/v1/SourceIpMappings/{Sid}'].delete

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Twilio - Voice Source Ip Mappings API
  version: 1.0.0
extends: openapi/twilio-sourceipmappings-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: 5
- target: $.paths['/v1/SourceIpMappings'].get
  update:
    x-apievangelist-phrasing:
      intent: List source IP mappings
      effect: read
      questions:
      - Which IP records are mapped to which SIP domains on my account?
      - What source IP mappings have I set up for inbound SIP traffic?
      instructions:
      - text: List all my source IP mappings.
      - text: Show source IP mappings, {page_size} per page.
        slots:
          page_size: query.PageSize
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/SourceIpMappings'].post
  update:
    x-apievangelist-phrasing:
      intent: Map an IP record to a SIP domain
      effect: write
      questions:
      - How do I tie traffic from a known IP address to one of my SIP domains?
      - Can I route calls from an IP record straight into a specific SIP domain?
      instructions:
      - text: Map IP record {ip_record} to SIP domain {sip_domain}.
        slots:
          ip_record: requestBody.IpRecordSid
          sip_domain: requestBody.SipDomainSid
      - text: Create a source IP mapping sending {ip_record} traffic to domain {sip_domain}.
        slots:
          ip_record: requestBody.IpRecordSid
          sip_domain: requestBody.SipDomainSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/SourceIpMappings/{Sid}'].get
  update:
    x-apievangelist-phrasing:
      intent: View a source IP mapping
      effect: read
      questions:
      - Which SIP domain does a particular source IP mapping point at?
      - Can I look up one source IP mapping by its SID?
      instructions:
      - text: Show source IP mapping {mapping}.
        slots:
          mapping: path.Sid
      - text: Get the IP record and SIP domain for mapping {mapping}.
        slots:
          mapping: path.Sid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/SourceIpMappings/{Sid}'].post
  update:
    x-apievangelist-phrasing:
      intent: Point a source IP mapping at a new SIP domain
      effect: write
      questions:
      - Can I move an existing IP mapping over to a different SIP domain?
      - What do I change to redirect an already mapped IP to another domain?
      instructions:
      - text: Point source IP mapping {mapping} at SIP domain {sip_domain}.
        slots:
          mapping: path.Sid
          sip_domain: requestBody.SipDomainSid
      - text: Move existing mapping {mapping} to domain {sip_domain}.
        slots:
          mapping: path.Sid
          sip_domain: requestBody.SipDomainSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/SourceIpMappings/{Sid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a source IP mapping
      effect: destructive
      questions:
      - How do I stop an IP record from being mapped to a SIP domain?
      - Can I remove a source IP mapping I no longer need?
      instructions:
      - text: Delete source IP mapping {mapping}.
        slots:
          mapping: path.Sid
      - text: Remove the IP-to-domain mapping {mapping}.
        slots:
          mapping: path.Sid
      method: generated
      generated: '2026-09-26'