# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for contact-center-apis Branded Phone Numbers API
  version: 1.0.0
extends: openapi/regal-ai-brandedphonenumbers-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: 4
- target: $.paths['/brandedPhoneNumbers'].get
  update:
    x-apievangelist-phrasing:
      intent: List phone numbers submitted for branding
      effect: read
      questions:
      - Which of my phone numbers have been submitted for caller ID branding or spam remediation?
      - Can I filter my branded numbers by carrier or by remediation status?
      - What branded numbers belong to a particular business profile in Regal?
      instructions:
      - text: List all my numbers submitted for branding and spam remediation.
      - text: Show the branding status of {phoneNumber}.
        slots:
          phoneNumber: query.phoneNumber
      - text: List branded numbers under business profile {businessProfileId} with status {status}.
        slots:
          businessProfileId: query.businessProfileId
          status: query.status
      - text: Show branded numbers in reporting group {reportingGroup}.
        slots:
          reportingGroup: query.reportingGroup
      method: generated
      generated: '2026-09-26'
- target: $.paths['/brandedPhoneNumbers'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit a phone number for branding
      effect: write
      questions:
      - How do I register a new phone number for caller ID branding and spam remediation?
      - Can I set a short and long display name when submitting a number for branding?
      - What do I need to submit a number to carriers for spam flag cleanup?
      instructions:
      - text: Submit {phoneNumber} for branding under business profile {businessProfileId} with carriers {carrierFeatures}.
        slots:
          phoneNumber: requestBody.phoneNumber
          businessProfileId: requestBody.businessProfileId
          carrierFeatures: requestBody.carrierFeatures
      - text: Register new number {phoneNumber} for spam remediation on profile {businessProfileId} with display name {brandingNameShort} on carriers {carrierFeatures}.
        slots:
          phoneNumber: requestBody.phoneNumber
          businessProfileId: requestBody.businessProfileId
          brandingNameShort: requestBody.brandingNameShort
          carrierFeatures: requestBody.carrierFeatures
      method: generated
      generated: '2026-09-26'
- target: $.paths['/brandedPhoneNumbers/{phoneNumber}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a number from branding
      effect: destructive
      questions:
      - How do I take a phone number out of branding and spam remediation?
      - Can I stop branding a number I no longer use?
      instructions:
      - text: Remove {phoneNumber} from branding and spam remediation.
        slots:
          phoneNumber: path.phoneNumber
      - text: Delete branded number {phoneNumber}.
        slots:
          phoneNumber: path.phoneNumber
      method: generated
      generated: '2026-09-26'
- target: $.paths['/brandedPhoneNumbers/{phoneNumber}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a branded phone number
      effect: write
      questions:
      - How do I change the display name on a number that's already branded?
      - Can I move an already-branded number to a different business profile or reporting group?
      - Is it possible to change which carriers an existing branded number is registered with?
      instructions:
      - text: Change the long display name on branded number {phoneNumber} to {brandingNameLong}.
        slots:
          phoneNumber: path.phoneNumber
          brandingNameLong: requestBody.brandingNameLong
      - text: Update the carrier configuration of already-branded {phoneNumber} to {carrierFeatures}.
        slots:
          phoneNumber: path.phoneNumber
          carrierFeatures: requestBody.carrierFeatures
      - text: Rename existing branded number {phoneNumber} internally to {internalName}.
        slots:
          phoneNumber: path.phoneNumber
          internalName: requestBody.internalName
      method: generated
      generated: '2026-09-26'