The actual date and time when the call started in the ISO-8601 format (e.g., '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC);

The Id of the meeting in Google or Outlook Calendar.

The code identifies the provider conferencing or telephony system. For example: zoom, clearslide, gotomeeting, ringcentral, outreach, insidesales, etc. These values are predefined by Gong, please contact help@gong.io to find the proper value for your system.

A call's unique identifier in the PBX or the recording system. Gong uses this identifier to prevent repeated attempts to upload the same recording.

A list of references to external systems such as CRM, Telephony System, Case Management, etc.

Links to external systems such as CRM, Telephony System, Case Management etc. Currently only Salesforce and Generic are supported.

Optional metadata associated with the call (represented as text). Gong stores this metadata and it can be used for troubleshooting.

Whether the call is inbound (someone called the company), outbound (a rep dialed someone outside the company), or a conference call.

The disposition of the call. The disposition is free text of up to 255 characters.

The URL from which Gong can download the media file.
The URL must be unique, the audio or video file must be a maximum of 1.5GB.
If you provide this URL, you should not perform the 'Add call media' step.

Gong's unique numeric identifier for the call (up to 20 digits).

The language codes (as defined by ISO-639-2B). E.g., eng, fre, spa, ger, and ita. Also used are und (unsupported language), and zxx (not enough speech content for identification).

The language code the call should be transcribed to.
This field is optional as Gong automatically detects the language spoken in the call and transcribes it accordingly. Set this field only if you are sure of the language the call is in.
Valid values are: af-ZA, am-ET, ar-AE, ar-BH, ar-DZ, ar-EG, ar-IL, ar-IQ, ar-JO, ar-KW, ar-LB, ar-MA, ar-MR, ar-OM, ar-PS, ar-QA, ar-SA, ar-TN, ar-YE, az-AZ, bg-BG, bn-BD, bn-IN, bs-BA, ca-ES, cs-CZ, da-DK, de-AT, de-CH, de-DE, el-GR, en-AB, en-AU, en-CA, en-GB, en-IE, en-IN, en-NZ, en-PH, en-SG, en-US, en-WL, en-ZA, es-AR, es-BO, es-CL, es-CO, es-CR, es-DO, es-EC, es-ES, es-GT, es-HN, es-MX, es-NI, es-PA, es-PE, es-PR, es-PY, es-SV, es-US, es-UY, et-EE, eu-ES, fa-IR, fi-FI, fil-PH, fr-BE, fr-CA, fr-CH, fr-FR, gl-ES, gu-IN, he-IL, hi-IN, hr-HR, hu-HU, hy-AM, id-ID, is-IS, it-CH, it-IT, ja-JP, jv-ID, ka-GE, kk-KZ, km-KH, kn-IN, ko-KR, lo-LA, lt-LT, lv-LV, mk-MK, ml-IN, mn-MN, mr-IN, ms-MY, my-MM, ne-NP, nl-BE, nl-NL, no-NO, pa-Guru-IN, pl-PL, pt-BR, pt-PT, ro-RO, ru-RU, si-LK, sk-SK, sl-SI, sq-AL, sr-RS, su-ID, sv-SE, sw-KE, sw-TZ, ta-IN, ta-LK, ta-MY, ta-SG, te-IN, th-TH, tr-TR, uk-UA, ur-IN, ur-PK, uz-UZ, vi-VN, yue-Hant-HK, zh-CN, zh-TW, zu-ZA

The URL of the conference call by which users join the meeting

A list of the call's participants. A party must be provided for the primaryUser.

The Gong internal user ID of the team member who hosted the call.

The primary user ID of the team member who hosted the call.

The purpose of the call. This optional field is a free text of up to 255 characters.

Scheduled date and time of the call in the ISO-8601 format (e.g., '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC).

The date and time the call was scheduled to end in the ISO-8601 format (e.g., '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC);

The date and time the call was scheduled to begin in the ISO-8601 format (e.g., '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC);

The scope of the call: 'internal' if all the participants are from the company, 'external' if some participants are not from the company, or 'unknown' if the scope is unknown.

The audio recording speech segments (who spoke when). Note that speakersTimeline and mediaChannelId are mutually exclusive, when providing speakersTimeline - mediaChannelId will not be used.

Indicates whether the provided speech segments match the media precisely or need further refinement based on the media. "Precisely" here means that segments do not deviate from the actual speech in the media by more than 100ms.

The audio recording speech segments (who spoke when). 

The date and time when the call was recorded in the ISO-8601 format (e.g., '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC).

The system with which the call was carried out (e.g., WebEx, ShoreTel, etc.).

The title of the call. This title is available in the Gong system for indexing and search.

The URL to the page in the Gong web application where the call is available.

Optional workspace identifier. If specified, the call will be placed into this workspace, otherwise, the default algorithm for workspace placement will be applied.

Data

Parameters

Calls

Basic details such as sub-folders, title, etc.

Gong's unique numeric identifier for the user who added the folder.

Gong's unique numeric identifier for a library's folder (up to 20 digits).

Gong's unique numeric identifier for library's parent folder (null for root folder).

Folder's last update time in the ISO-8601 format (e.g., '2020-03-14T05:30:00-08:00').

Library Folders

Attendees the requesting party should add to the invitation, this should support adding email addresses such as coordinator@gong.io for Gong to schedule the recording of the meeting.

The meeting end time in ISO-8601 format (e.g., '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC).

The ID as it is formed on the external system.

A list of email addresses of invitees to the event (not including the organizer).

Gong's unique identifier for the meeting (up to 20 digits).

The Gong URL of the meeting, should be used to enter the meeting.

The email address of the user creating the meeting, the Gong consent page link will be used according to the settings of this user.

A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes.

The meeting start time in ISO-8601 format (e.g., '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC).

Meetings

Transcripts

True if the user is active, false if not.

Creation time in the ISO-8601 format (e.g., '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC);of the Gong user.

List of email address aliases of the Gong user.

Gong's unique numeric identifier for the user (up to 20 digits).

The list of personal meeting URLs of the Gong user.

Languages spoken during calls by the Gong user

The trusted authentication email assigned to the Gong user

Users

A list, in which each item provides a workspace metadata.

Gong's unique numeric identifier for the workspace (up to 20 digits).

Workspaces

Gong

List Calls By Date Range

List calls that took place during a specified date range.

When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:calls:read:basic'.

Retrieve call data by date range (/v2/calls)

When using this endpoint, either provide a downloadMediaUrl or use the returned callId in a follow-up request to /v2/calls/{id}/media to upload the media file.

When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:calls:create'.

Add new call (/v2/calls)

Adds a call media, recorded by a telephony system (PBX) or other media recording facility. Gong accepts call recordings in various audio and video file formats, including WAV, MP3, MP4, MKV and FLAC. If uploading a dual-channel (stereo) file separated by speaker, make sure to specify which channel correspondsto the company team member (rep) in the parties/mediaChannelId parameter of the Add New Call operation.

When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:calls:create'.

Add call media (/v2/calls/{id}/media)

Retrieve data for a specific call.

When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:calls:read:basic'.

Retrieve data for a specific call (/v2/calls/{id})

Lists detailed call data for calls that took place during a specified date range, have specified call IDs or hosted by specified users.

When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:calls:read:extensive'. 
Moreover, clients requesting media download URLs by the contentSelector.exposedFields.media field should also have the scope 'api:calls:read:media-url'.

Retrieve detailed call data by various filters (/v2/calls/extensive)

Permission profile for a given profile Id (/v2/permission-profile)

Update permission profile (/v2/permission-profile)

Create a permission profile in a given workspace.

Create permission profile (/v2/permission-profile)

When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:meetings:user:update'.

Update a Gong Meeting (/v2/meetings/{meetingId})

When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:meetings:user:delete'.

Delete a Gong Meeting (/v2/meetings)

Push engagement events into Gong and display them as events in Gong’s activity timeline, when a content is viewed by an external participant (for example, a contract was “viewed” by the prospect)

When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:engagement-data:write'.

Report event of a content view (/v2/customer-engagement/content/viewed)

Push engagement events into Gong and display them as events in Gong’s activity timeline, when a Gong user shares content with external participants (for example, a contract was “shared” by the account executive with his prospects)

When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:engagement-data:write'.

Report event of a content share (/v2/customer-engagement/content/shared)

Push engagement events into Gong and display them as events in Gong’s activity timeline, when a content is engaged by an external participant (for example, a contract was “signed” by the prospect)

When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:engagement-data:write'.

Report event of a custom action (/v2/customer-engagement/action)

Get Generic CRM integration details (/v2/crm/integrations)

Register a Generic CRM integration (/v2/crm/integrations)

Delete a Generic CRM integration (/v2/crm/integrations)

Register Generic Crm Integration Deprecated

Give individual users access to calls.

If a user already has access (perhaps the call was shared with them, or they have access through their permission profiles) the request will have no effect.

When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:call-user-access:write'.

Give individual users access to calls (/v2/calls/users-access)

Returns a list of users who have received individual access to calls through the API.

This endpoint doesn't cover user that have access for other reasons (such as sharing recipients, or access through permission profiles).

When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:call-user-access:read'.

Retrieve users that have specific individual access to calls (/v2/calls/users-access)

Remove individual user access from calls. The request can only remove access previously given by the /v2/calls/users-access API.

If a given user does not have access to the call, they will be unaffected.

If a given user does have access to the call, but not through the pubic API (for example if the call was shared with the user), the user's access will remain unchanged.

When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:call-user-access:write'.

Remove specific individual users access from calls (/v2/calls/users-access)

List multiple Users.

When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:users:read'.

List users by filter (/v2/users/extensive)

Returns interaction stats for users based on calls that have Whisper turned on.

When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:stats:interaction'.

Retrieve interaction stats for applicable users by date (/v2/stats/interaction)

Retrieve all the answers for the scorecards that were reviewed during a specified date range, for calls that took place during a specified date range, for specific scorecards or for specific reviewed users.

When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:stats:scorecards'.

Retrieve answered scorecards for applicable reviewed users or scorecards for a date range (/v2/stats/activity/scorecards)

Retrieve the daily activity of multiple users within the Gong system for a range of dates. This endpoint returns records including statistics about each user's activity, on the daily level. Records are returned only for users with activity in the range.

When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:stats:user-actions:detailed'.

Retrieve daily activity for applicable users for a date range (/v2/stats/activity/day-by-day)

Lists the activity of multiple users within the Gong system during a defined period. Given the period, this endpoint returns multiple records, one for each user, with an applicable activity during the period. Each record includes statistics about the user's activity.

When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:stats:user-actions'.

Retrieve aggregated activity for defined users by date (/v2/stats/activity/aggregate)

Lists the aggregated activity of multiple users within the Gong system for each time period within the defined date range. This endpoint returns multiple records, one for each user. For each user there are items for every time period in the date range, including statistics about the user's activity. Records are returned only for users with activity in the range.

When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:stats:user-actions'.

Retrieve aggregated activity for defined users by a date range with grouping in time periods (/v2/stats/activity/aggregate-by-period)

When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:meetings:user:create'.

Create a New Gong Meeting (/v2/meetings)

When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:meetings:integration:status'.

Validate Gong meeting Integration (/v2/meetings/integration/status)

Get the Gong Engage flows assigned to the given prospects.

When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:flows:read'.

List assigned flows for the given prospects (/v2/flows/prospects)

Assign a Gong Engage flow to a batch of prospects.

Gong Engage requires 'prospectsCrmIds' to fetch the prospects from the CRM, the chosen 'gongFlowId' to assign to the prospect, and an 'assignToEmail' which is the email address of the Gong user for whom the flow tasks will be created.

The maximum allowed prospects to be assigned in a single request is 200

When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:flows:write'.

Assign a Gong Engage flow to prospects  (/v2/flows/prospects/assign)

When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:digital-interactions:write'.

Post a Digital Interaction (/v2/digital-interaction)

Given a phone number, this endpoint deletes from the Gong system any leads or contacts with a matching phone number or mobile phone number. Email messages sent to or from these leads/contacts are deleted. Calls where the leads/contacts appear are deleted. The deletion is not immediate, and may take several hours to complete.

This endpoint contains a data integrity protection mechanism to prevent the deletion of an abnormal number of objects. If the deletion fails please contact support at help@gong.io

Delete the data from your CRM and email system before performing this operation so that private data is not re-imported into Gong.

When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:data-privacy:delete'.

Delete the phone number, and all associated elements (/v2/data-privacy/erase-data-for-phone-number)

Given an email address, this endpoint deletes from the Gong system any calls or email messages that reference this address. Email messages sent to or from the address are deleted. Calls where the email address appears (as a lead, contact, attendee or speaker) are deleted. Leads or Contacts with the email address are deleted. The deletion is not immediate, and may take several hours to complete.

This endpoint contains a data integrity protection mechanism to prevent the deletion of an abnormal number of objects. If the deletion fails please contact support at help@gong.io

Delete the data from your CRM and email system before performing this operation so that private data is not re-imported into Gong.

When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:data-privacy:delete'.

Delete the email address, and all associated elements (/v2/data-privacy/erase-data-for-email-address)

Upload Stages

Upload Crm Schema Field Deprecated

Upload Crm Data Deprecated

Map Crm Users

List Schema Fields (/v2/crm/entity-schema)

Upload Object Schema (/v2/crm/entity-schema)

Get CRM objects (/v2/crm/entities)

Upload CRM objects (/v2/crm/entities)

Returns transcripts for calls that took place during the specified date period. If call IDs are specified, only transcripts for calls with those IDs that took place during the time period are returned.

When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:calls:read:transcript'.

Retrieve transcripts of calls (/v2/calls/transcript)

Returns a list of all workspaces including their details.

When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:workspaces:read'.

List all company workspaces (/v2/workspaces)

List all of the company's users.

When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:users:read'.

List all users (/v2/users)

Retrieve a specific user.

When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:users:read'.

Retrieve user (/v2/users/{id})

Retrieve a specific user's settings history.

When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:users:read'.

Retrieve user settings history (/v2/users/{id}/settings-history)

Retrieves details of all keyword trackers in the system or in a given workspace.

When accessed through a Bearer token authorization method, this endpoint requires the  'api:settings:trackers:read' scope.

Retrieve tracker details (/v2/settings/trackers)

Retrieve all the scorecards within the Gong system.

When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:settings:scorecards:read'.

Retrieve scorecards details (/v2/settings/scorecards)

Returns a list of all users whose access is controlled by the given permission profile.

When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:users:read'.

List all users attached to a given permission profile (/v2/permission-profile/users)

List log entries that took place during a specified time range.

When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:logs:read'.

Retrieve logs data by type and time range (/v2/logs)

Use this endpoint to retrieve a list of public library folders. We do not allow retrieval of either private or archived folders.

When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:library:read'.

Retrieve Library folders (/v2/library/folders)

Given a folder id, this endpoint retrieves a list of calls in it.

When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:library:read'.

List of calls in a specific folder (/v2/library/folder-content)

Lists all 'COMPANY' flows and optionally 'Personal' flows available for the user to choose from. 

Gong Engage sorts flows by 2 visibility types: 'Personal' and 'Company' 

When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:flows:read'.

List Gong Engage flows (/v2/flows)

Shows the elements in the Gong system that reference the given phone number. Given a phone number, this endpoint returns details of any leads or contacts with this phone number and their associated calls and email messages.

When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:data-privacy:read'.

Retrieve all references to a phone number. (/v2/data-privacy/data-for-phone-number)

Shows the elements in the Gong system that reference the given email address. Given an emails address, this endpoint returns details of all calls and email messages that reference this address, and any leads or contacts with this email address.

When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:data-privacy:read'.

Retrieve all references to an email address. (/v2/data-privacy/data-for-email-address)

Get Request Status (/v2/crm/request-status)

List Crm Schema Fields Deprecated

Get Crm Objects Deprecated

List Generic Crm Integration Deprecated

Returns a list of all calls that were manually associated or re-associated with CRM account and deal/opportunity since a given time.

Actions will be listed in the ascending order of their timing. 

Notice if a call was associated and later re-associated the API will return both events.

When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:crm-calls:manual-association:read'.

List all calls that were manually associated with CRM objects (/v2/calls/manual-crm-associations) in Beta Phase

Returns a list of all permission profiles.

The listing is in the alphabetical order of the profile names.

List all company permission profiles for a given workspace (/v2/all-permission-profiles)

Delete Generic Crm Integration Deprecated

List of user IDs to populate the managers-team permission level

You can retrieve the user ids by using the “Users” API.

User can create/edit/delete deals boards.

User can perform inline editing of crm data.

User can perform inline editing of deals.

User can export calls and coaching metrics data to CSV.

User can manage forecast boards and upload targets.

Unique numeric identifier of the permission profile (up to 20 digits).

List of library folder Ids, if set, "permissionLevel" must not be "none".

A user with this profile can add calls to folders, archive calls, if set, "permissionLevel" must not be "none".

A user with this profile can manage public folder, if set, "permissionLevel" must not be "none".

A user with this profile can manage streams, if set, "permissionLevel" must not be "none".

Library folder permission level - mandatory value.

A user with this profile can share folders and streams from Your Library with other team members, if set, "permissionLevel" must not be "none".

User can manage general business settings.

User can manually schedule and upload calls.

Field Name	API Key	Type
Query	query	object
Profile Id	query.profileId	string
Headers	headers	object

Gong API Integration Profile

Permission profile for a given profile Id (/v2/permission-profile) in Gong API

Build every single integration your customers need with AI

Field Name	API Key	Type	Description
Request Id	requestId	string	A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes.
Profile	profile	object	Permission profile
Id	profile.id	string	Unique numeric identifier of the permission profile (up to 20 digits).
Name	profile.name	string	Permission profile name.
Description	profile.description	string	Permission profile description.