Zoom Phone · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Phone External Contacts API

6 actions 6 updates phrasing extends openapi/zoom-phone-external-contacts-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 6

$.info

$.paths['/phone/external_contacts'].get

$.paths['/phone/external_contacts'].post

$.paths['/phone/external_contacts/{externalContactId}'].get

$.paths['/phone/external_contacts/{externalContactId}'].delete

$.paths['/phone/external_contacts/{externalContactId}'].patch

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Phone External Contacts API
  version: 1.0.0
extends: openapi/zoom-phone-external-contacts-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['/phone/external_contacts'].get
  update:
    x-apievangelist-phrasing:
      intent: List external contacts
      effect: read
      questions:
      - Which external contacts are saved on our phone account?
      - Is there a list of all outside contacts in the phone directory?
      instructions:
      - text: List all external contacts.
      - text: Show {page_size} external contacts per page.
        slots:
          page_size: query.page_size
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/external_contacts'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an external contact
      effect: write
      questions:
      - How do I add an outside vendor to the phone directory?
      - Can an external contact get an internal extension?
      instructions:
      - text: Add an external contact named {name}.
        slots:
          name: requestBody.name
      - text: Add external contact {name} with email {email} and numbers {phone_numbers}.
        slots:
          name: requestBody.name
          email: requestBody.email
          phone_numbers: requestBody.phone_numbers
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/external_contacts/{externalContactId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an external contact
      effect: read
      questions:
      - What numbers and email are stored for one external contact?
      - Where can I look up a single outside contact?
      instructions:
      - text: Show external contact {externalContactId}.
        slots:
          externalContactId: path.externalContactId
      - text: Get the phone numbers of external contact {externalContactId}.
        slots:
          externalContactId: path.externalContactId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/external_contacts/{externalContactId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an external contact
      effect: destructive
      questions:
      - Can I remove an outside contact from the directory?
      - What deletes one external contact?
      instructions:
      - text: Delete external contact {externalContactId}.
        slots:
          externalContactId: path.externalContactId
      - text: Remove outside contact {externalContactId}.
        slots:
          externalContactId: path.externalContactId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/phone/external_contacts/{externalContactId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an external contact
      effect: write
      questions:
      - How do I change an external contact's phone numbers or email?
      - Can I turn on auto call recording for an external contact?
      instructions:
      - text: Update the email of external contact {externalContactId} to {email}.
        slots:
          externalContactId: path.externalContactId
          email: requestBody.email
      - text: Set the phone numbers of external contact {externalContactId} to {phone_numbers}.
        slots:
          externalContactId: path.externalContactId
          phone_numbers: requestBody.phone_numbers
      method: generated
      generated: '2026-10-01'