Zoom · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Zoom REST Chat API

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

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/chat/get'].post
$.paths['/chat/list'].post

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 Zoom REST Chat API
  version: 1.0.0
extends: openapi/zoom-chat-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-24'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 2
- target: $.paths['/chat/get'].post
  update:
    x-apievangelist-phrasing:
      intent: Get messages from one chat session
      effect: read
      questions:
      - Can I read the actual messages from a chat conversation over a date range?
      - What do I need to pull messages from a specific chat session?
      instructions:
      - text: Get messages in chat session {session_id} from {from} to {to} using token {access_token}.
        slots:
          session_id: requestBody.session_id
          from: requestBody.from
          to: requestBody.to
          access_token: requestBody.access_token
      - text: Read session {session_id}'s messages between {from} and {to}, token {access_token}.
        slots:
          session_id: requestBody.session_id
          from: requestBody.from
          to: requestBody.to
          access_token: requestBody.access_token
      method: generated
      generated: '2026-09-24'
- target: $.paths['/chat/list'].post
  update:
    x-apievangelist-phrasing:
      intent: List chat history sessions for a period
      effect: read
      questions:
      - Which chat conversations happened during a given time period?
      - Can I narrow the chat history list to one user's email?
      instructions:
      - text: List chat history from {from} to {to} using token {access_token}.
        slots:
          from: requestBody.from
          to: requestBody.to
          access_token: requestBody.access_token
      - text: List chat conversations for {email} between {from} and {to}, token {access_token}.
        slots:
          email: requestBody.email
          from: requestBody.from
          to: requestBody.to
          access_token: requestBody.access_token
      method: generated
      generated: '2026-09-24'