Zendesk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Zendesk Basics API

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

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/api/v2/channels/voice/agents/{agent_id}/tickets/{ticket_id}/display'].post
$.paths['/api/v2/channels/voice/agents/{agent_id}/users/{user_id}/display'].post
$.paths['/api/v2/channels/voice/tickets'].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 Zendesk Basics API
  version: 1.0.0
extends: openapi/zendesk-basics-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 3
- target: $.paths['/api/v2/channels/voice/agents/{agent_id}/tickets/{ticket_id}/display'].post
  update:
    x-apievangelist-phrasing:
      intent: Open a ticket in an agent's browser
      effect: write
      questions:
      - Can a phone system pop a ticket open on an agent's screen?
      - What response do I get if the agent or ticket id is invalid?
      instructions:
      - text: Open this ticket in the agent's browser.
      - text: Pop ticket 42 on the handling agent's screen.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/channels/voice/agents/{agent_id}/users/{user_id}/display'].post
  update:
    x-apievangelist-phrasing:
      intent: Open a user profile in an agent's browser
      effect: write
      questions:
      - Can I show a caller's profile to the agent answering the phone?
      - Is there a screen-pop for user profiles during calls?
      instructions:
      - text: Open this caller's user profile in the agent's browser.
      - text: Pop the customer's profile on the agent's screen.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/channels/voice/tickets'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a call or voicemail ticket
      effect: write
      questions:
      - Can a telephony partner create a ticket from a call or voicemail?
      - Does a voicemail ticket follow the same conventions as a regular ticket?
      instructions:
      - text: Create a voicemail ticket with the recording.
      - text: Log this phone call as a new Talk ticket.
      method: generated
      generated: '2026-09-26'