# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Zoom Phone SMS Consent API
  version: 1.0.0
extends: openapi/zoom-phone-sms-consent-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: 9
- target: $.paths['/phone/sms_consent/{consentId}/phone_numbers/opt_status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check opt-in status under an SMS consent policy
      effect: read
      questions:
      - Has a customer opted out of texts from our numbers under a consent policy?
      - Can I check opt status between a consumer number and specific Zoom Phone numbers?
      instructions:
      - text: Check the opt status of {consumer_phone_number} for numbers {zoom_phone_user_numbers} under consent {consentId}.
        slots:
          consentId: path.consentId
          consumer_phone_number: query.consumer_phone_number
          zoom_phone_user_numbers: query.zoom_phone_user_numbers
      - text: Has {consumer_phone_number} opted out of {zoom_phone_user_numbers} in SMS consent {consentId}? Look it up.
        slots:
          consentId: path.consentId
          consumer_phone_number: query.consumer_phone_number
          zoom_phone_user_numbers: query.zoom_phone_user_numbers
      method: generated
      generated: '2026-10-01'
- target: $.paths['/number_management/sms_consent'].get
  update:
    x-apievangelist-phrasing:
      intent: List SMS consent policies
      effect: read
      questions:
      - What SMS consent policies does our account have?
      - Where can I see all our opt-in and opt-out messaging policies?
      instructions:
      - text: List all SMS consent policies.
      - text: List SMS consent policies, {page_size} per page.
        slots:
          page_size: query.page_size
      method: generated
      generated: '2026-10-01'
- target: $.paths['/number_management/sms_consent'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an SMS consent policy
      effect: write
      questions:
      - How do I set up opt-in, opt-out and help messages for business texting?
      - Can a consent policy apply to inbound, outbound or both directions?
      instructions:
      - text: Create SMS consent policy {consent_name} for {in_out_bound} messages with status {status}.
        slots:
          consent_name: requestBody.consent_name
          in_out_bound: requestBody.in_out_bound
          status: requestBody.status
      - text: Create an active consent policy {consent_name} covering {in_out_bound} texts, described as {description}.
        slots:
          consent_name: requestBody.consent_name
          in_out_bound: requestBody.in_out_bound
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/number_management/sms_consent'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete SMS consent policies
      effect: destructive
      questions:
      - How do I delete consent policies we no longer use?
      - Can I remove several SMS consent policies in one request?
      instructions:
      - text: Delete SMS consent policies {consent_ids}.
        slots:
          consent_ids: requestBody.consent_ids
      - text: Remove consent policies {consent_ids} from the account.
        slots:
          consent_ids: requestBody.consent_ids
      method: generated
      generated: '2026-10-01'
- target: $.paths['/number_management/sms_consent/{consentId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an SMS consent policy
      effect: read
      questions:
      - What opt-in and opt-out settings does a particular consent policy have?
      - Can I view one SMS consent policy by its ID?
      instructions:
      - text: Show SMS consent policy {consentId}.
        slots:
          consentId: path.consentId
      - text: Get the configuration of consent policy {consentId}.
        slots:
          consentId: path.consentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/number_management/sms_consent/{consentId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an SMS consent policy
      effect: write
      questions:
      - How do I rename or deactivate an SMS consent policy?
      - Can I change a consent policy from inbound-only to both directions?
      instructions:
      - text: Rename SMS consent policy {consentId} to {consent_name}.
        slots:
          consentId: path.consentId
          consent_name: requestBody.consent_name
      - text: Set consent policy {consentId} status to {status}.
        slots:
          consentId: path.consentId
          status: requestBody.status
      method: generated
      generated: '2026-10-01'
- target: $.paths['/number_management/sms_consent/{consentId}/phone_numbers'].get
  update:
    x-apievangelist-phrasing:
      intent: List numbers under an SMS consent policy
      effect: read
      questions:
      - Which of our phone numbers are covered by a given SMS consent policy?
      - Can I page through the numbers assigned to a consent policy?
      instructions:
      - text: List phone numbers assigned to SMS consent policy {consentId}.
        slots:
          consentId: path.consentId
      - text: Show which numbers use consent policy {consentId}.
        slots:
          consentId: path.consentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/number_management/sms_consent/{consentId}/phone_numbers'].post
  update:
    x-apievangelist-phrasing:
      intent: Assign numbers to an SMS consent policy
      effect: write
      questions:
      - How do I put more of our numbers under an SMS consent policy?
      - Can I attach several phone numbers to a consent policy at once?
      instructions:
      - text: Assign numbers {phone_number_ids} to SMS consent policy {consentId}.
        slots:
          consentId: path.consentId
          phone_number_ids: requestBody.phone_number_ids
      - text: Put {phone_number_ids} under consent policy {consentId}.
        slots:
          consentId: path.consentId
          phone_number_ids: requestBody.phone_number_ids
      method: generated
      generated: '2026-10-01'
- target: $.paths['/number_management/sms_consent/{consentId}/phone_numbers'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unassign numbers from an SMS consent policy
      effect: destructive
      questions:
      - How do I take phone numbers out of an SMS consent policy?
      - Can I detach a few numbers from a consent policy without deleting it?
      instructions:
      - text: Unassign numbers {phone_number_ids} from SMS consent policy {consentId}.
        slots:
          consentId: path.consentId
          phone_number_ids: requestBody.phone_number_ids
      - text: Remove {phone_number_ids} from consent policy {consentId}.
        slots:
          consentId: path.consentId
          phone_number_ids: requestBody.phone_number_ids
      method: generated
      generated: '2026-10-01'