Zendesk Basics API

openapi: 3.2.0
info:
  title: Zendesk Basics API
  version: '1.0'
  description: 'Operations tagged Basics across 3 of this provider''s published API definitions: channels-openapi-original.yml, tickets-openapi-original.yml, users-openapi-original.yml. Each path carries the servers of the definition it was published in.'
tags:
- name: Basics
paths:
  /api/v2/channels/voice/agents/{agent_id}/tickets/{ticket_id}/display:
    post:
      operationId: OpenTicketInAgentBrowser
      tags:
      - Basics
      summary: Zendesk Post Api V2 Channels Voice Agents Agent_id Tickets Ticket_id Display
      description: 'Allows you to instruct an agent''s browser to open a ticket.


        When the message is successfully delivered to an agent''s browser:


        ```http

        Status: 200 OK

        ```


        When `agent_id` or `ticket_id` is invalid:


        ```http

        Status: 404 Not Found

        ```


        #### Allowed For

        * Agents'
      parameters:
      - $ref: '#/components/parameters/AgentId'
      - $ref: '#/components/parameters/TicketId'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: string
                description: empty
                example: ''
              example: ''
        '404':
          description: When the `agent_id` or `ticket_id` is invalid
          content:
            application/json:
              schema:
                type: string
                description: Invalid attribute
                example: ''
              example: ''
  /api/v2/channels/voice/agents/{agent_id}/users/{user_id}/display:
    post:
      operationId: OpenUsersProfileInAgentBrowser
      tags:
      - Basics
      summary: Zendesk Post Api V2 Channels Voice Agents Agent_id Users User_id Display
      description: 'Allows you to instruct an agent''s browser to open a user''s profile.


        When the message is successfully delivered to an agent''s browser:


        ```http

        Status: 200 OK

        ```


        When `agent_id` or `user_id` is invalid:


        ```http

        Status: 404 Not Found

        ```


        #### Allowed For

        * Agents'
      parameters:
      - $ref: '#/components/parameters/AgentId'
      - $ref: '#/components/parameters/UserId'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: string
                description: empty
                example: ''
              example: ''
        '404':
          description: When the `agent_id` or `user_id` is invalid
          content:
            application/json:
              schema:
                type: string
                description: Invalid attribute
                example: ''
              example: ''
  /api/v2/channels/voice/tickets:
    post:
      operationId: CreateTicketOrVoicemailTicket
      tags:
      - Basics
      summary: Zendesk Post Api V2 Channels Voice Tickets
      description: '#### Allowed For

        * Agents


        ### Creating tickets


        #### Introduction


        Creating tickets using Talk Partner Edition follows the same conventions as the Create Ticket endpoint. See Create Ticket.


        #### Request parameters


        The POST request takes a mandatory `ticket` object that lists the values to set when the ticket is created.

        You may also include an optional `display_to_agent` value such as the ID of the agent that will see the newly created ticket.

        The `display_to_agent` is validated before creating the ticket, returning a 422 error if it is invalid.


        Tickets created using this endpoint must have a `via_id` parameter. See the following

        section for possible values.


        #### Zendesk Talk Integration Via IDs


        Tickets created using this endpoint must have one of the following `via_id` parameters:


        | ID | Description

        | ---------| -------------

        | 44 | Voicemail

        | 45 | Phone call (inbound)

        | 46 | Phone call (outbound)


        ### Creating voicemail tickets

        #### Request parameters


        The POST request takes a mandatory `ticket` object that lists the values to set when the ticket is created.

        The ticket must have a `voice_comment` with the following values:


        | Name | Type | Comment

        | ------------------ | ----------------------| -------

        | from | string | Incoming phone number

        | to | string | Dialed phone number

        | recording_url | string | URL of the recording

        | started_at | date | ISO 8601 timestamp of the call starting time

        | call_duration | integer | Duration in seconds of the call

        | answered_by_id | integer | The agent who answered the call

        | transcription_text | string | Transcription of the call (optional)

        | location | string | Location of the caller (optional)'
      parameters:
      - $ref: '#/components/parameters/AgentId'
      - $ref: '#/components/parameters/TicketId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TicketCreateVoicemailTicketRequest'
            examples:
              default:
                $ref: '#/components/examples/TicketCreateTicketViaTalkRequestExample'
      responses:
        '201':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TicketResponse'
              examples:
                default:
                  $ref: '#/components/examples/TicketResponseExample'
        '404':
          description: When the `ticket_id` is invalid
          content:
            application/json:
              schema:
                type: string
                description: Invalid attribute
                example: ''
              example: ''
        '422':
          description: When the `agent_id` is invalid
          content:
            application/json:
              schema:
                type: string
                description: Invalid attribute
                example: ''
              example: ''
components:
  schemas:
    TicketResponse:
      type: object
      properties:
        ticket:
          $ref: '#/components/schemas/TicketObject'
x-refined-from:
- channels-openapi-original.yml
- tickets-openapi-original.yml
- users-openapi-original.yml