# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Number Management Cloud Peering Provider Exchange API
  version: 1.0.0
extends: openapi/zoom-phone-cloud-peering-provider-exchange-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/number_management/carrier/peering_numbers'].get
  update:
    x-apievangelist-phrasing:
      intent: List numbers a carrier pushed to customers
      effect: read
      questions:
      - As a peering carrier, which numbers have I pushed to different Zoom customers?
      - Can I look up one number I pushed through cloud peering?
      instructions:
      - text: List the peering numbers my carrier pushed to customers.
      - text: Find carrier-pushed peering number {phone_number}.
        slots:
          phone_number: query.phone_number
      method: generated
      generated: '2026-10-01'
- target: $.paths['/number_management/peering_numbers'].get
  update:
    x-apievangelist-phrasing:
      intent: List peering numbers provisioned to a customer
      effect: read
      questions:
      - Which numbers has our partner provisioned into this Zoom customer account?
      - Can I filter a customer's provisioned peering numbers by carrier code?
      instructions:
      - text: List peering numbers provisioned to this customer account.
      - text: Show provisioned peering numbers for carrier code {carrier_code}.
        slots:
          carrier_code: query.carrier_code
      method: generated
      generated: '2026-10-01'
- target: $.paths['/number_management/peering_numbers'].post
  update:
    x-apievangelist-phrasing:
      intent: Add peering numbers to a customer account
      effect: write
      questions:
      - How does a provider exchange partner add numbers to a customer's Zoom account?
      - Can I allocate newly added peering numbers to a specific product?
      instructions:
      - text: Add peering numbers {phone_numbers} to the customer account.
        slots:
          phone_numbers: requestBody.phone_numbers
      - text: Add {phone_numbers} under carrier code {carrier_code} allocated to {allocated_product}.
        slots:
          phone_numbers: requestBody.phone_numbers
          carrier_code: requestBody.carrier_code
          allocated_product: requestBody.allocated_product
      method: generated
      generated: '2026-10-01'
- target: $.paths['/number_management/peering_numbers'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove peering numbers from a customer account
      effect: destructive
      questions:
      - How do I pull numbers I previously added back out of a customer's account?
      - Can a partner remove numbers it didn't add itself?
      instructions:
      - text: Remove peering numbers {phone_numbers} from the customer account.
        slots:
          phone_numbers: query.phone_numbers
      - text: Delete {phone_numbers} added under carrier code {carrier_code}.
        slots:
          phone_numbers: query.phone_numbers
          carrier_code: query.carrier_code
      method: generated
      generated: '2026-10-01'
- target: $.paths['/number_management/peering_numbers'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update peering numbers in a customer account
      effect: write
      questions:
      - How do I change the status of numbers I provisioned through cloud peering?
      - Can I reallocate peering numbers to a different product?
      instructions:
      - text: Update peering numbers {phone_numbers} in the customer account.
        slots:
          phone_numbers: requestBody.phone_numbers
      - text: Reallocate {phone_numbers} to {allocated_product}.
        slots:
          phone_numbers: requestBody.phone_numbers
          allocated_product: requestBody.allocated_product
      method: generated
      generated: '2026-10-01'