Gong Outcomes API

openapi: 3.2.0
info:
  title: Gong Outcomes API
  description: 'Overview


    The Gong API allows you to:


    Receive the following information from Gong:


    Your company''s calls in Gong


    Your company''s users in Gong


    Your company''s user stats in Gong


    Your company''s user settings in Gong


    Your company''s libraries in Gong


    Upload new or

    update

    call recordings in Gong, in order to support cases where you have an internal system that records

    calls or obtains them from a third-party entity.


    Data Privacy:

    Delete users and all their associated elements.


    Upload CRM data into Gong.


    Check here what''s your base URL for all API calls.


    Authentication


    There are two ways to retrieve credentials to the Gong Public API:


    Retrieve Manually:


    In the Gong API Page (you

    must be a technical administrator in Gong), click "Create" to receive an Access Key

    and an Access Key Secret.


    Use the Basic Authorization HTTP header (as per RFC)

    to access the Public API as shown below:


    Authorization: Basic <token>


    To create the basic token, combine the Access Key and the Access Key Secret with

    colon (:) and then encode in Base64 as following:


    Base64(<accessKey> : <accessKeySecret>)


    Retrieve through OAuth


    To obtain the Bearer token, follow the steps described in the Gong OAuth Guide.


    After obtaining the token, use the Bearer Authorization HTTP header

    (as per RFC)

    to access the Public API as shown below:


    Authorization: Bearer <token>


    Limits


    By default Gong limits your company''s access to the service to 3 API calls per second, and 10,000 API calls per day.


    When the rate of API calls exceeds these limits an HTTP status code 429 is returned and a Retry-After header indicates

    how many seconds to wait before making a new request.


    If required, contact help.gong.io to change these limits.


    Cursors


    Some API calls that return a list are limited in the amount of records they may return, so multiple API calls may be

    required to bring all records. Such an API call also returns a records field, which contains the number of records

    in the current page, the current page number and the total number of records.


    In cases where the total number of records exceeds the number of records thus far retrieved, the records field will also

    contain a cursor field which can be used to access the next page of records. To retrieve the next page, repeat the API call with

    the cursor value as supplied by the previous API call. All other request inputs should remain the same.


    Forward Compatibility


    When coding a system to accept Gong data, take into account that Gong may, without prior warning, add fields to the JSON output.

    It is recommended to future proof your code so that it disregards all JSON fields you don''t actually use.'
  version: V2
servers:
- url: https://127.0.0.1:8443
  description: Generated server url
tags:
- name: Outcomes
paths:
  /v2/call-outcomes:
    get:
      tags:
      - Outcomes
      summary: List call outcomes (/v2/call-outcomes)
      description: 'Use this endpoint to retrieve the list of available call outcomes defined in Gong.

        Call outcomes are used to categorize the result of a call (e.g., "Connected", "No Answer") and are set in the Dialer setup page.


        When accessed through a Bearer token authorization method, this endpoint requires the scope ''api:call-outcomes:read''.'
      operationId: listCallOutcomes
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CallOutcomesResponse'
                exampleSetFlag: false
              exampleSetFlag: false
        '403':
          description: Access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                exampleSetFlag: false
              exampleSetFlag: false
        '429':
          description: API request limit exceeded
          headers:
            Retry-After:
              description: Number of seconds to wait before making a new request.
              style: SIMPLE
              explode: false
              schema:
                type: integer
                format: int32
                exampleSetFlag: false
                types:
                - integer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                exampleSetFlag: false
              exampleSetFlag: false
        '500':
          description: Failed to complete the operation due to an unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                exampleSetFlag: false
              exampleSetFlag: false
components:
  schemas:
    CallOutcomesResponse:
      type: object
      properties:
        requestId:
          type: string
          description: A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes.
          example: 4al018gzaztcr8nbukw
          exampleSetFlag: true
          types:
          - string
        outcomes:
          uniqueItems: true
          type: array
          description: The call outcomes of the company
          exampleSetFlag: false
          items:
            $ref: '#/components/schemas/CallOutcomeDto'
            exampleSetFlag: false
          types:
          - array
      exampleSetFlag: false
      types:
      - object
    CallOutcomeDto:
      type: object
      properties:
        callOutcome:
          type: string
          description: The call outcome name
          example: Connected
          exampleSetFlag: true
          types:
          - string
        displayOrder:
          type: integer
          description: The display order when selecting a call outcome at the end of a call
          format: int32
          example: 1
          exampleSetFlag: true
          types:
          - integer
        connectStatus:
          type: string
          description: 'Indicates whether the call was connected or not. Possible values: Connected, Not connected'
          exampleSetFlag: false
          types:
          - string
          enum:
          - CONNECTED
          - NOT_CONNECTED
        sentiment:
          type: string
          description: The sentiment associated with the outcome (negative, positive, neutral)
          exampleSetFlag: false
          types:
          - string
          enum:
          - POSITIVE
          - NEGATIVE
          - NEUTRAL
        todoAction:
          type: string
          description: Specifies how to handle to-do items for the call when this outcome is selected.
          exampleSetFlag: false
          types:
          - string
          enum:
          - COMPLETE
          - COMPLETE_AND_REMOVE
        automation:
          type: string
          description: Specifies the automation to run when this outcome is selected.
          exampleSetFlag: false
          types:
          - string
          enum:
          - MARK_AS_OPT_OUT
        category:
          type: string
          description: The outcome category (example - answered vs not answered)
          exampleSetFlag: false
          types:
          - string
          enum:
          - ANSWERED
          - NOT_ANSWERED
      description: The call outcomes of the company
      exampleSetFlag: false
      types:
      - object
    ErrorResponse:
      type: object
      properties:
        requestId:
          type: string
          description: A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes.
          example: 4al018gzaztcr8nbukw
          exampleSetFlag: true
          types:
          - string
        errors:
          type: array
          description: Error messages.
          example:
          - An error has occurred
          exampleSetFlag: true
          items:
            type: string
            exampleSetFlag: false
            types:
            - string
          types:
          - array
      exampleSetFlag: false
      types:
      - object
x-provenance:
  method: harvested
  publisher: Gong
  source: https://app.gong.io/ajax/settings/api/documentation/specs?version=
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)