Zoom Phone · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Phone Shared Line Group API

23 actions 23 updates phrasing extends openapi/zoom-phone-shared-line-group-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Zoom Phone's API. It is a proposal applied on top of the contract, not a document Zoom Phone publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 23 · first 16 shown; the file carries all of them

$.info
$.paths['/phone/shared_line_groups'].get
$.paths['/phone/shared_line_groups'].post
$.paths['/phone/shared_line_groups/{sharedLineGroupId}'].get
$.paths['/phone/shared_line_groups/{sharedLineGroupId}/call_handling/settings'].get
$.paths['/phone/shared_line_groups/{sharedLineGroupId}/call_handling/settings/{hourType}'].patch
$.paths['/phone/shared_line_groups/{sharedLineGroupId}/policies'].get
$.paths['/phone/shared_line_groups/{sharedLineGroupId}/policies'].patch
$.paths['/phone/shared_line_groups/{sharedLineGroupId}/settings'].get
$.paths['/phone/shared_line_groups/{sharedLineGroupId}/settings/{settingType}'].post
$.paths['/phone/shared_line_groups/{sharedLineGroupId}/settings/{settingType}'].delete
$.paths['/phone/shared_line_groups/{sharedLineGroupId}/settings/{settingType}'].patch
$.paths['/phone/shared_line_groups/{slgId}'].delete
$.paths['/phone/shared_line_groups/{slgId}'].patch
$.paths['/phone/shared_line_groups/{slgId}/members'].post
$.paths['/phone/shared_line_groups/{slgId}/members'].delete

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Phone Shared Line Group API
  version: 1.0.0
extends: openapi/zoom-phone-shared-line-group-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: 22
- target: $.paths['/phone/shared_line_groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List shared line groups
      effect: read
      questions:
      - Which shared line groups are set up on our Zoom Phone account?
      - How do I see every group that shares a phone number and extension?
      instructions:
      - text: List all shared line groups.
      - text: Show shared line groups, {page_size} per page.
        slots:
          page_size: query.page_size
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/shared_line_groups'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a shared line group
      effect: write
      questions:
      - How do I set up a shared line so a team can answer one phone number together?
      - Can I give a new shared line group its own extension and site?
      instructions:
      - text: Create a shared line group named {display_name}.
        slots:
          display_name: requestBody.display_name
      - text: Create shared line group {display_name} with extension {extension_number} at site {site_id}.
        slots:
          display_name: requestBody.display_name
          extension_number: requestBody.extension_number
          site_id: requestBody.site_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/shared_line_groups/{sharedLineGroupId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a shared line group's details
      effect: read
      questions:
      - What members and numbers belong to a particular shared line group?
      - Can I look up one shared line group by its ID?
      instructions:
      - text: Show the details of shared line group {sharedLineGroupId}.
        slots:
          sharedLineGroupId: path.sharedLineGroupId
      - text: Get shared line group {sharedLineGroupId} and its members.
        slots:
          sharedLineGroupId: path.sharedLineGroupId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/shared_line_groups/{sharedLineGroupId}/call_handling/settings'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a shared line group's call handling
      effect: read
      questions:
      - How are calls routed to a shared line group after business hours?
      - What call handling does a shared line group use during a holiday?
      instructions:
      - text: Show the call handling setting of shared line group {sharedLineGroupId}.
        slots:
          sharedLineGroupId: path.sharedLineGroupId
      - text: Get shared line group {sharedLineGroupId} call handling for {hour_type} hours.
        slots:
          sharedLineGroupId: path.sharedLineGroupId
          hour_type: query.hour_type
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/shared_line_groups/{sharedLineGroupId}/call_handling/settings/{hourType}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a shared line group's call handling
      effect: write
      questions:
      - How do I change where a shared line group's calls go during closed hours?
      - Can I change the ring distribution for a shared line group's business hours?
      instructions:
      - text: Update call handling for shared line group {sharedLineGroupId} for {hourType} hours.
        slots:
          sharedLineGroupId: path.sharedLineGroupId
          hourType: path.hourType
      - text: Set shared line group {sharedLineGroupId} {hourType} call distribution to {call_distribution_setting}.
        slots:
          sharedLineGroupId: path.sharedLineGroupId
          hourType: path.hourType
          call_distribution_setting: requestBody.call_distribution_setting
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/shared_line_groups/{sharedLineGroupId}/policies'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a shared line group's policy
      effect: read
      questions:
      - What policy settings apply to a shared line group, like voicemail access?
      - Can members of a shared line group check its voicemail over the phone?
      instructions:
      - text: Show the policy settings of shared line group {sharedLineGroupId}.
        slots:
          sharedLineGroupId: path.sharedLineGroupId
      - text: Get shared line group {sharedLineGroupId}'s voicemail policy.
        slots:
          sharedLineGroupId: path.sharedLineGroupId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/shared_line_groups/{sharedLineGroupId}/policies'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a shared line group's policy
      effect: write
      questions:
      - How do I let members check a shared line group's voicemail by phone?
      - Can I turn off phone-based voicemail checking for a shared line group?
      instructions:
      - text: Turn {check_voicemails_over_phone} checking voicemail over the phone for shared line group {sharedLineGroupId}.
        slots:
          sharedLineGroupId: path.sharedLineGroupId
          check_voicemails_over_phone: requestBody.check_voicemails_over_phone
      - text: Update the policy of shared line group {sharedLineGroupId}.
        slots:
          sharedLineGroupId: path.sharedLineGroupId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/shared_line_groups/{sharedLineGroupId}/settings'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a shared line group's settings
      effect: read
      questions:
      - What settings are configured on a shared line group, by setting type?
      - Where do I see a shared line group's general settings?
      instructions:
      - text: List every configured setting on shared line group {sharedLineGroupId}.
        slots:
          sharedLineGroupId: path.sharedLineGroupId
      - text: Get shared line group {sharedLineGroupId} settings of type {setting_type}.
        slots:
          sharedLineGroupId: path.sharedLineGroupId
          setting_type: query.setting_type
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/shared_line_groups/{sharedLineGroupId}/settings/{settingType}'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a setting to a shared line group
      effect: write
      questions:
      - How do I add a new setting of a given type to a shared line group?
      - Can I add a setting entry to a shared line group that doesn't have one yet?
      instructions:
      - text: Add a {settingType} setting to shared line group {sharedLineGroupId}.
        slots:
          sharedLineGroupId: path.sharedLineGroupId
          settingType: path.settingType
      - text: Create the {settingType} setting on shared line group {sharedLineGroupId}.
        slots:
          sharedLineGroupId: path.sharedLineGroupId
          settingType: path.settingType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/shared_line_groups/{sharedLineGroupId}/settings/{settingType}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a setting from a shared line group
      effect: destructive
      questions:
      - How do I remove a setting of a particular type from a shared line group?
      - Can I delete a holiday-hours setting from a shared line group?
      instructions:
      - text: Delete the {settingType} setting from shared line group {sharedLineGroupId}.
        slots:
          sharedLineGroupId: path.sharedLineGroupId
          settingType: path.settingType
      - text: Remove shared line group {sharedLineGroupId} {settingType} setting for holiday {holiday_hour_id}.
        slots:
          sharedLineGroupId: path.sharedLineGroupId
          settingType: path.settingType
          holiday_hour_id: query.holiday_hour_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/shared_line_groups/{sharedLineGroupId}/settings/{settingType}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a setting on a shared line group
      effect: write
      questions:
      - Can I change an existing shared line group setting of a given type?
      - How do I edit a setting that's already on a shared line group?
      instructions:
      - text: Update the {settingType} setting on shared line group {sharedLineGroupId}.
        slots:
          sharedLineGroupId: path.sharedLineGroupId
          settingType: path.settingType
      - text: Change shared line group {sharedLineGroupId}'s existing {settingType} setting.
        slots:
          sharedLineGroupId: path.sharedLineGroupId
          settingType: path.settingType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/shared_line_groups/{slgId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a shared line group
      effect: destructive
      questions:
      - How do I get rid of a shared line group we no longer use?
      - What happens to members when a shared line group is deleted?
      instructions:
      - text: Delete shared line group {slgId}.
        slots:
          slgId: path.slgId
      - text: Remove the shared line group {slgId} entirely.
        slots:
          slgId: path.slgId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/shared_line_groups/{slgId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a shared line group's profile
      effect: write
      questions:
      - How do I rename a shared line group or change its extension?
      - Can I change a shared line group's primary number, time zone or recording storage location?
      instructions:
      - text: Rename shared line group {slgId} to {display_name}.
        slots:
          slgId: path.slgId
          display_name: requestBody.display_name
      - text: Set the primary number of shared line group {slgId} to {primary_number}.
        slots:
          slgId: path.slgId
          primary_number: requestBody.primary_number
      - text: Change shared line group {slgId} time zone to {timezone}.
        slots:
          slgId: path.slgId
          timezone: requestBody.timezone
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/shared_line_groups/{slgId}/members'].post
  update:
    x-apievangelist-phrasing:
      intent: Add members to a shared line group
      effect: write
      questions:
      - How do I add users or common areas to a shared line group?
      - Can a common area phone be a member of a shared line group?
      instructions:
      - text: Add {members} to shared line group {slgId}.
        slots:
          slgId: path.slgId
          members: requestBody.members
      - text: Add a user to shared line group {slgId}.
        slots:
          slgId: path.slgId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/shared_line_groups/{slgId}/members'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove all members from a shared line group
      effect: destructive
      questions:
      - How do I clear out every member of a shared line group at once?
      - Is there a way to unassign all users from a shared line group in one call?
      instructions:
      - text: Unassign all members from shared line group {slgId}.
        slots:
          slgId: path.slgId
      - text: Empty the membership of shared line group {slgId}.
        slots:
          slgId: path.slgId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/shared_line_groups/{slgId}/members/{memberId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove one member from a shared line group
      effect: destructive
      questions:
      - How do I take a single person out of a shared line group?
      - Can I remove one common area from a shared line group without affecting others?
      instructions:
      - text: Remove member {memberId} from shared line group {slgId}.
        slots:
          slgId: path.slgId
          memberId: path.memberId
      - text: Unassign {memberId} from shared line group {slgId}.
        slots:
          slgId: path.slgId
          memberId: path.memberId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/shared_line_groups/{slgId}/phone_numbers'].post
  update:
    x-apievangelist-phrasing:
      intent: Assign phone numbers to a shared line group
      effect: write
      questions:
      - How do I give a shared line group a direct phone number?
      - Can a shared line group have more than one direct number?
      instructions:
      - text: Assign {phone_numbers} to shared line group {slgId}.
        slots:
          slgId: path.slgId
          phone_numbers: requestBody.phone_numbers
      - text: Give shared line group {slgId} a new direct phone number.
        slots:
          slgId: path.slgId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/shared_line_groups/{slgId}/phone_numbers'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unassign all phone numbers from a shared line group
      effect: destructive
      questions:
      - How do I strip every phone number off a shared line group?
      - Can I release all of a shared line group's direct numbers at once?
      instructions:
      - text: Unassign all phone numbers from shared line group {slgId}.
        slots:
          slgId: path.slgId
      - text: Release every direct number held by shared line group {slgId}.
        slots:
          slgId: path.slgId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/shared_line_groups/{slgId}/phone_numbers/{phoneNumberId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unassign one number from a shared line group
      effect: destructive
      questions:
      - How do I remove just one direct number from a shared line group?
      - Can I take back a single phone number a shared line group is using?
      instructions:
      - text: Unassign phone number {phoneNumberId} from shared line group {slgId}.
        slots:
          slgId: path.slgId
          phoneNumberId: path.phoneNumberId
      - text: Remove number {phoneNumberId} from shared line group {slgId}.
        slots:
          slgId: path.slgId
          phoneNumberId: path.phoneNumberId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/shared_line_groups/{slgId}/policies/{policyType}'].post
  update:
    x-apievangelist-phrasing:
      intent: Add shared voicemail access to a shared line group
      effect: write
      questions:
      - How do I give extra people access to a shared line group's voicemail?
      - Can I add a policy sub-setting such as shared access members to a shared line group?
      instructions:
      - text: Add {voicemail_access_members} as voicemail access members on shared line group {slgId} {policyType} policy.
        slots:
          slgId: path.slgId
          voicemail_access_members: requestBody.voicemail_access_members
          policyType: path.policyType
      - text: Add a {policyType} policy sub-setting to shared line group {slgId}.
        slots:
          slgId: path.slgId
          policyType: path.policyType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/shared_line_groups/{slgId}/policies/{policyType}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove shared access members from a shared line group
      effect: destructive
      questions:
      - How do I revoke someone's shared voicemail access on a shared line group?
      - Can I remove specific shared access members from a shared line group policy?
      instructions:
      - text: Remove shared access {shared_ids} from shared line group {slgId} {policyType} policy.
        slots:
          slgId: path.slgId
          shared_ids: query.shared_ids
          policyType: path.policyType
      - text: Delete the {policyType} policy sub-setting entries {shared_ids} on shared line group {slgId}.
        slots:
          slgId: path.slgId
          shared_ids: query.shared_ids
          policyType: path.policyType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/shared_line_groups/{slgId}/policies/{policyType}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update shared access members on a shared line group
      effect: write
      questions:
      - Can I change what an existing shared access member can do with a shared line group's voicemail?
      - How do I edit the voicemail access list already on a shared line group?
      instructions:
      - text: Update voicemail access members on shared line group {slgId} {policyType} policy to {voicemail_access_members}.
        slots:
          slgId: path.slgId
          policyType: path.policyType
          voicemail_access_members: requestBody.voicemail_access_members
      - text: Edit the existing {policyType} policy sub-setting on shared line group {slgId}.
        slots:
          slgId: path.slgId
          policyType: path.policyType
      method: generated
      generated: '2026-10-01'