# 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 SMS Campaigns API
  version: 1.0.0
extends: openapi/zoom-phone-sms-campaigns-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: 4
- target: $.paths['/number_management/sms_campaigns'].get
  update:
    x-apievangelist-phrasing:
      intent: List SMS campaigns
      effect: read
      questions:
      - Which 10DLC SMS campaigns are registered on my account?
      - Can I page through all of the account's SMS campaigns?
      instructions:
      - text: List all SMS campaigns in my account.
      - text: Show the next page of SMS campaigns after {next_page_token}.
        slots:
          next_page_token: query.next_page_token
      method: generated
      generated: '2026-10-01'
- target: $.paths['/number_management/sms_campaigns/{smsCampaignId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an SMS campaign
      effect: read
      questions:
      - What is the status and phone number list of a specific SMS campaign?
      - Can I look up one 10DLC campaign by its ID?
      instructions:
      - text: Get SMS campaign {smsCampaignId}.
        slots:
          smsCampaignId: path.smsCampaignId
      - text: Show the details of 10DLC campaign {smsCampaignId}.
        slots:
          smsCampaignId: path.smsCampaignId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/number_management/sms_campaigns/{smsCampaignId}/phone_numbers'].post
  update:
    x-apievangelist-phrasing:
      intent: Assign phone numbers to an SMS campaign
      effect: write
      questions:
      - How do I attach our business numbers to a 10DLC campaign so they can text?
      - Who has to be named as the authorizing person when adding numbers to a campaign?
      instructions:
      - text: Assign numbers {phone_number_ids} to campaign {smsCampaignId}, authorized by {loa_authorizing_person} ({title}, {contact_number}).
        slots:
          phone_number_ids: requestBody.phone_number_ids
          smsCampaignId: path.smsCampaignId
          loa_authorizing_person: requestBody.loa_authorizing_person
          title: requestBody.title
          contact_number: requestBody.contact_number
      - text: Add numbers {phone_number_ids} to SMS campaign {smsCampaignId}; LOA {loa_authorizing_person}, {title}, {contact_number}, emails {contact_emails}.
        slots:
          phone_number_ids: requestBody.phone_number_ids
          smsCampaignId: path.smsCampaignId
          loa_authorizing_person: requestBody.loa_authorizing_person
          title: requestBody.title
          contact_number: requestBody.contact_number
          contact_emails: requestBody.contact_emails
      method: generated
      generated: '2026-10-01'
- target: $.paths['/number_management/sms_campaigns/{smsCampaignId}/phone_numbers'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unassign phone numbers from an SMS campaign
      effect: destructive
      questions:
      - Can I pull a phone number out of a 10DLC campaign?
      - What happens to texting on a number once it's removed from its campaign?
      instructions:
      - text: Unassign numbers {phone_number_ids} from SMS campaign {smsCampaignId}.
        slots:
          phone_number_ids: query.phone_number_ids
          smsCampaignId: path.smsCampaignId
      - text: Remove number {phone_number_ids} from campaign {smsCampaignId}.
        slots:
          phone_number_ids: query.phone_number_ids
          smsCampaignId: path.smsCampaignId
      method: generated
      generated: '2026-10-01'