Gong

gong

Gong is a platform for video meetings, call recording, and team collaboration.

Analytics AI Sales Tools Web del proveedor

Acciones

Triggers

Autenticación

—

OAuth gestionado

Sí

Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (53)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Add call media v2 calls id mediaGONG_ADD_CALL_MEDIA_V2_CALLS_ID_MEDIAAcción

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'.

Parámetros de entrada

idstringObligatorio
callId returned from "Add New Call" request
mediaFileobjectbinary
Mediafile

Parámetros de salida

dataobjectObligatorio
The response schema
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add new call v2 callsGONG_ADD_NEW_CALL_V2_CALLSAcción

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'.

Parámetros de entrada

titlestring
The title of the call. This title is available in the Gong system for indexing and search.
contextobject[]
A list of references to external systems such as CRM, Telephony System, Case Management, etc.
partiesobject[]Obligatorio
A list of the call"s participants. A party must be provided for the primaryUser.
purposestring
The purpose of the call. This optional field is a free text of up to 255 characters.
durationinteger
The actual call duration in seconds.
directionstringObligatorioenum
Whether the call is inbound (someone called the company), outbound (a rep dialed someone outside the company), or a conference call.
ConferenceInboundOutboundUnknown
customDatastring
Optional metadata associated with the call (represented as text). Gong stores this metadata and it can be used for troubleshooting.
meetingUrlstring
The URL of the conference call by which users join the meeting
actualStartstringObligatorio
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);
dispositionstring
The disposition of the call. The disposition is free text of up to 255 characters.
primaryUserstringObligatorio
The Gong internal user ID of the team member who hosted the call.
workspaceIdstring
Optional workspace identifier. If specified, the call will be placed into this workspace, otherwise, the default algorithm for workspace placement will be applied.
languageCodestring
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
scheduledEndstring
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);
clientUniqueIdstringObligatorio
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.
scheduledStartstring
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);
callProviderCodestring
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.
downloadMediaUrlstring
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. The content-type must either start with "audio" or "video," or should be "application/octet-stream" or "binary/octet-stream" followed by a subtype that specifies a supported file type (WAV, MP3, MP4, MKV and FLAC). If you provide this URL, you should not perform the "Add call media" step.
speakersTimeline__preciseboolean
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.
speakersTimeline__speechSegmentsobject[]
The audio recording speech segments (who spoke when).

Parámetros de salida

dataobjectObligatorio
The response schema
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Aggregate activity by period via apiGONG_AGGREGATE_ACTIVITY_BY_PERIOD_VIA_APIAcción

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'.

Parámetros de entrada

cursorstring
When paging is needed, provide the value supplied by the previous API call to bring the following page of records.
filter__toDatestring
The date (in the company"s time zone) until which to list a user"s activity. This value is exclusive. This value should not exceed the current day. The date should be specified in the following format: YYYY-MM-DD.
filter__userIdsstring[]
Set of Gong"s unique numeric identifiers for the users (up to 20 digits).
filter__fromDatestring
The date (in the company"s time zone) from which to list a user"s activity. This value is inclusive. The date should be specified in the following format: YYYY-MM-DD.
aggregationPeriodstringObligatorioenum
Calendar time period for aggregating data. Note: First day of the week is Monday.
DAYMONTHQUARTERWEEKYEAR
filter__createdToDateTimestringdate-time
Createdtodatetime
filter__createdFromDateTimestringdate-time
Createdfromdatetime

Parámetros de salida

dataobjectObligatorio
The response schema
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Aggregate user activity statisticsGONG_AGGREGATE_USER_ACTIVITY_STATISTICSAcción

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'.

Parámetros de entrada

cursorstring
When paging is needed, provide the value supplied by the previous API call to bring the following page of records.
filter__toDatestring
The date (in the company"s time zone) until which to list a user"s activity. This value is exclusive. This value should not exceed the current day. The date should be specified in the following format: YYYY-MM-DD.
filter__userIdsstring[]
Set of Gong"s unique numeric identifiers for the users (up to 20 digits).
filter__fromDatestring
The date (in the company"s time zone) from which to list a user"s activity. This value is inclusive. The date should be specified in the following format: YYYY-MM-DD.
filter__createdToDateTimestringdate-time
Createdtodatetime
filter__createdFromDateTimestringdate-time
Createdfromdatetime

Parámetros de salida

dataobjectObligatorio
The response schema
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Assign prospects to flowGONG_ASSIGN_PROSPECTS_TO_FLOWAcción

Use this endpoint to assign a number of prospects to a flow. prospects can be contacts or leads in your crm. generate a list of comma separated crm ids of the prospects you want to add to a flow. the flowinstanceowneremail parameter is the email address of the gong user who set up the flow instance and owns the flow to-dos. you can assign up to 200 prospects to a flow in a single request. when accessed through a bearer token authorization method, this endpoint requires the scope 'api:flows:write'.

Parámetros de entrada

flowIdstringObligatorio
The Engage Flow ID to assign the contacts to.
crmProspectsIdsstring[]Obligatorio
The CRM IDs of the contact or lead that should be assigned to a flow
flowInstanceOwnerEmailstringObligatorio
The email of the Gong user who owns the flow to-dos.

Parámetros de salida

dataobjectObligatorio
The response schema
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create activity scorecards reportGONG_CREATE_ACTIVITY_SCORECARDS_REPORTAcción

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'.

Parámetros de entrada

cursorstring
When paging is needed, provide the value supplied by the previous API call to bring the following page of records.
filter__callToDatestring
The date (in the company"s time zone) of the call until when to list calls. This value is exclusive. The date should be specified in the following format: YYYY-MM-DD; if not specified, it ends with the latest recorded call.
filter__callFromDatestring
The date (in the company"s time zone) of the call from when to list calls. This value is inclusive. The date should be specified in the following format: YYYY-MM-DD; if not specified, it starts with the earliest recorded call.
filter__reviewMethodstringenum
Select whether to return scorecards that have been reviewed manually, automatically, or both. Default value: MANUAL
AUTOMATICBOTHMANUAL
filter__reviewToDatestring
The review date (in the company"s time zone) until when to list calls. This value is exclusive. The date should be specified in the following format: YYYY-MM-DD; if not specified, it ends with the latest reviewed call.
filter__scorecardIdsstring[]
List of scorecards Ids. If not specified, it returns all answered scorecards in the corresponding filter.
filter__reviewFromDatestring
The review date (in the company"s time zone) from when to list calls. This value is inclusive. The date should be specified in the following format: YYYY-MM-DD; if not specified, it starts with the earliest reviewed call.
filter__reviewedUserIdsstring[]
List of user Ids of the team members being reviewed. If not specified, it returns all answered scorecards in the corresponding filter.

Parámetros de salida

dataobjectObligatorio
The response schema
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create a new gong meeting v2 meetingsGONG_CREATE_A_NEW_GONG_MEETING_V2_MEETINGSAcción

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

Parámetros de entrada

titlestring
Title of the event.
endTimestringObligatorio
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).
inviteesobject[]Obligatorio
A list of email addresses of invitees to the event (not including the organizer).
startTimestringObligatorio
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).
externalIdstring
The ID as it is formed on the external system.
organizerEmailstringObligatorio
The email address of the user creating the meeting, the Gong consent page link will be used according to the settings of this user.

Parámetros de salida

dataobjectObligatorio
The response schema
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create permission profile v2 permission profileGONG_CREATE_PERMISSION_PROFILE_V2_PERMISSION_PROFILEAcción

Create a permission profile in a given workspace.

Parámetros de entrada

idstring
Unique numeric identifier of the permission profile (up to 20 digits).
namestring
Permission profile name.
dealsboolean
User can view deals pages.
usageboolean
User can view usage pages.
marketboolean
User can view market page.
accountboolean
User can view account pages.
libraryboolean
User can view library pages.
activityboolean
User can view activity pages.
coachingboolean
User can view coaching pages.
forecastboolean
User can view forecast pages.
teamStatsboolean
User can view team stats page.
trimCallsboolean
User can trim calls.
scoreCallsboolean
User can score calls.
deleteCallsboolean
User can delete calls.
descriptionstring
Permission profile description.
initiativesboolean
User can view initiatives page.
workspaceIdstringObligatorio
Workspace identifier. You can retrieve the workspace using the "workspaces" (under "Settings") API.
deleteEmailsboolean
User can delete emails.
privateCallsboolean
User can set their own calls as private.
crmDataImportboolean
User can perform import of crm data.
listenInCallsboolean
User can listen in calls.
overrideScoreboolean
User can override someone else score.
callsAndSearchboolean
User can view and search calls.
forecastManageboolean
User can manage forecast boards and upload targets.
manageScorecardsboolean
User can manage scorecards.
downloadCallMediaboolean
User can download call media.
dealsInlineEditingboolean
User can perform inline editing of deals.
crmDataInlineEditingboolean
User can perform inline editing of crm data.
viewRevenueAnalyticsboolean
User can view dashboards page.
manageRevenueAnalyticsboolean
User can manage revenue analytics.
shareCallsWithCustomersboolean
User can share calls with customers.
callsAccess__teamLeadIdsstring[]
List of user IDs to populate the managers-team permission level You can retrieve the user ids by using the “Users” API.
dealsAccess__teamLeadIdsstring[]
List of user IDs to populate the managers-team permission level You can retrieve the user ids by using the “Users” API.
usageAccess__teamLeadIdsstring[]
List of user IDs to populate the managers-team permission level You can retrieve the user ids by using the “Users” API.
viewEngageAnalyticsFlowsboolean
User can view engage analytics flows page.
emailsAccess__teamLeadIdsstring[]
List of user IDs to populate the managers-team permission level You can retrieve the user ids by using the “Users” API.
coachingAccess__teamLeadIdsstring[]
List of user IDs to populate the managers-team permission level You can retrieve the user ids by using the “Users” API.
insightsAccess__teamLeadIdsstring[]
List of user IDs to populate the managers-team permission level You can retrieve the user ids by using the “Users” API.
viewEngageAnalyticsActivityboolean
User can view engage analytics activity page.
callsAccess__permissionLevelstringenum
Permission access scope.
allall / managers-team / report-to-them / own / nonemanagers-teamnoneownreport-to-them
dealsAccess__permissionLevelstringenum
Permission access scope.
allall / managers-team / report-to-them / own / nonemanagers-teamnoneownreport-to-them
engageManageCompanySequencesboolean
User can manage company sequences.
engageManageCompanyTemplatesboolean
User can manage company email templates.
usageAccess__permissionLevelstringenum
Permission access scope.
allall / managers-team / report-to-them / own / nonemanagers-teamnoneownreport-to-them
emailsAccess__permissionLevelstringenum
Permission access scope.
allall / managers-team / report-to-them / own / nonemanagers-teamnoneownreport-to-them
engageCreateAndManageRulesetsboolean
User can create and manage rulesets.
manageGeneralBusinessSettingsboolean
User can manage general business settings.
createEditAndDeleteDealsBoardsboolean
User can create/edit/delete deals boards.
engageSnoozeFlowToDosForOthersboolean
User can snooze flow in to dos for others
manuallyScheduleAndUploadCallsboolean
User can manually schedule and upload calls.
viewEngageAnalyticsPerformanceboolean
User can view engage analytics performance page.
coachingAccess__permissionLevelstringenum
Permission access scope.
allall / managers-team / report-to-them / own / nonemanagers-teamnoneownreport-to-them
exportCallsAndCoachingDataToCSVboolean
User can export calls and coaching metrics data to CSV.
insightsAccess__permissionLevelstringenum
Permission access scope.
allall / managers-team / report-to-them / own / nonemanagers-teamnoneownreport-to-them
libraryFolderAccess__manageStreamsboolean
A user with this profile can manage streams, if set, "permissionLevel" must not be "none".
libraryFolderAccess__permissionLevelstringenum
Library folder permission level - mandatory value.
allnonenone, all, specific-foldersspecific-folders
libraryFolderAccess__libraryFolderIdsstring[]
List of library folder Ids, if set, "permissionLevel" must not be "none".
libraryFolderAccess__manageFolderCallsboolean
A user with this profile can add calls to folders, archive calls, if set, "permissionLevel" must not be "none".
libraryFolderAccess__managePublicFolderboolean
A user with this profile can manage public folder, if set, "permissionLevel" must not be "none".
libraryFolderAccess__shareFoldersAndStreamsboolean
A user with this profile can share folders and streams from Your Library with other team members, if set, "permissionLevel" must not be "none".
forecastPermissions__forecastAccess__teamLeadIdsstring[]
List of user IDs to populate the managers-team permission level You can retrieve the user ids by using the “Users” API.
forecastPermissions__forecastAccess__permissionLevelstringenum
Permission access scope.
allall / managers-team / report-to-them / own / nonemanagers-teamnoneownreport-to-them
forecastPermissions__forecastEditTargets__teamLeadIdsstring[]
List of user IDs to populate the managers-team permission level You can retrieve the user ids by using the “Users” API.
forecastPermissions__forecastEditSubmissions__teamLeadIdsstring[]
List of user IDs to populate the managers-team permission level You can retrieve the user ids by using the “Users” API.
forecastPermissions__forecastEditTargets__permissionLevelstringenum
Permission access scope.
allall / managers-team / report-to-them / own / nonemanagers-teamnoneownreport-to-them
forecastPermissions__forecastEditSubmissions__permissionLevelstringenum
Permission access scope.
allall / managers-team / report-to-them / own / nonemanagers-teamnoneownreport-to-them

Parámetros de salida

dataobjectObligatorio
The response schema
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Data privacy for phone numberGONG_DATA_PRIVACY_FOR_PHONE_NUMBERAcción

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'.

Parámetros de entrada

phoneNumberstringObligatorio
The phone number. This number must start with a + (plus) sign followed by the country code, area code, and local phone number. All other non-digits are ignored. The following are examples of permitted phone numbers: +1 425 555 2671, +1-425-555-2671, +1 425 5552671, +14255552671, +1 425 555 26 71, +1(425) 555-2671, etc. Note: This parameter should be URL-encoded.

Parámetros de salida

dataobjectObligatorio
The response schema
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete a generic crm integration v2 crm integrationsGONG_DELETE_A_GENERIC_CRM_INTEGRATION_V2_CRM_INTEGRATIONSAcción

Deletes an existing crm integration from the gong platform. this endpoint should be used when you want to disconnect or remove a previously established integration between gong and a crm system, such as hubspot. it's particularly useful when you need to change crm providers, stop syncing data between gong and a specific crm, or troubleshoot integration issues by removing and re-adding the connection. the deletion is likely permanent, so use this endpoint with caution. it's important to note that this operation may affect data synchronization and potentially impact existing analytics or reports that rely on the integrated crm data.

Parámetros de entrada

integrationIdintegerObligatorio
The ID of the integration to delete
clientRequestIdstringObligatorio
A unique identifier generated and sent by you to allow troubleshooting. Valid characters are letters, numbers, dashes and underscores.

Parámetros de salida

dataobjectObligatorio
The response schema
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete a gong meeting v2 meetingsGONG_DELETE_A_GONG_MEETING_V2_MEETINGSAcción

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

Parámetros de entrada

meetingIdintegerObligatorio
Gong"s unique identifier for the meeting (up to 20 digits).
organizerEmailstring
The email address of the user who created the meeting.

Parámetros de salida

dataobjectObligatorio
The response schema
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete users from call access listGONG_DELETE_USERS_FROM_CALL_ACCESS_LISTAcción

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'.

Parámetros de entrada

callAccessListobject[]
A list, in which each item specifies a call and a list of users to be removed from the call.

Parámetros de salida

dataobjectObligatorio
The response schema
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Erase data for email addressGONG_ERASE_DATA_FOR_EMAIL_ADDRESSAcción

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'.

Parámetros de entrada

emailAddressstringObligatorio
The email address.

Parámetros de salida

dataobjectObligatorio
The response schema
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Erase data for phone numberGONG_ERASE_DATA_FOR_PHONE_NUMBERAcción

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'.

Parámetros de entrada

phoneNumberstringObligatorio
The phone number. This number must start with a + (plus) sign followed by the country code, area code, and local phone number. All other non-digits are ignored. The following are examples of permitted phone numbers: +1 425 555 2671, +1-425-555-2671, +1 425 5552671, +14255552671, +1 425 555 26 71, +1(425) 555-2671, etc. Note: This parameter should be URL-encoded.

Parámetros de salida

dataobjectObligatorio
The response schema
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Fetch all permission profilesGONG_FETCH_ALL_PERMISSION_PROFILESAcción

Returns a list of all permission profiles. the listing is in the alphabetical order of the profile names.

Parámetros de entrada

workspaceIdstringObligatorio
Workspace identifier, the API will return only the profiles belonging to this workspace. You can retrieve the workspace using the "workspaces" (under "Settings") API.

Parámetros de salida

dataobjectObligatorio
The response schema
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Crm Integration DetailsGONG_GET_CRM_INTEGRATION_DETAILSAcción

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
The response schema
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get crm objects v2 crm entitiesGONG_GET_CRM_OBJECTS_V2_CRM_ENTITIESAcción

Retrieves crm entities from the gong platform. this endpoint allows users to fetch various crm objects such as accounts, deals, and contacts that have been integrated with gong's revenue intelligence system. it provides a way to access and utilize crm data within the context of gong's conversation analysis and insights. use this endpoint when you need to synchronize crm data with gong or when you want to retrieve the latest crm entity information for analysis or reporting purposes. the endpoint does not modify any data and is intended for read-only operations. note that the specific fields and structure of the returned entities may vary based on the crm system integrated with gong.

Parámetros de entrada

objectTypestringObligatorioenum
Requested objects type
ACCOUNTCONTACTDEALLEAD
integrationIdintegerObligatorio
Integration ID generated when creating the integration
objectsCrmIdsstring[]Obligatorio
<b>Request Body:</b> The requested objects crm ids (should be sent in the request body)

Parámetros de salida

dataobjectObligatorio
The response schema
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get permission profileGONG_GET_PERMISSION_PROFILEAcción

Returns a permission profile.

Parámetros de entrada

profileIdstringObligatorio
Permission profile identifier.

Parámetros de salida

dataobjectObligatorio
The response schema
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get request status v2 crm request statusGONG_GET_REQUEST_STATUS_V2_CRM_REQUEST_STATUSAcción

The getcrmrequeststatus endpoint retrieves the current status of crm integration requests in the gong platform. it allows users to check the progress and outcome of operations related to crm data uploads, synchronization, or other crm-related processes. this endpoint is particularly useful for monitoring the health and progress of crm integrations, troubleshooting issues, and ensuring data consistency between gong and connected crm systems. it should be used when you need to verify if a crm integration request has been completed, is still in progress, or has encountered any errors. the endpoint does not modify any data and is intended for status checking only. note that the specific details returned may vary depending on the type and complexity of the crm integration request being queried.

Parámetros de entrada

integrationIdintegerObligatorio
Integration ID generated when creating the integration
clientRequestIdstringObligatorio
The client request ID used in the asynchronous endpoint you want to get a status for

Parámetros de salida

dataobjectObligatorio
The response schema
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List all coaching metrics v2 coachingGONG_LIST_ALL_COACHING_METRICS_V2_COACHINGAcción

List all of the coaching metrics of a manager. when accessed through a bearer token authorization method, this endpoint requires the scope 'api:coaching:read'.

Parámetros de entrada

tostringObligatorio
Association time filter - only the associations made after that time will be listed. The time is 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); if not specified all association events will be listed.
fromstringObligatorio
Association time filter - only the associations made after that time will be listed. The time is 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); if not specified all association events will be listed.
manager__idintegerObligatorio
Manager Id
workspace__idintegerObligatorio
Workspace Id

Parámetros de salida

dataobjectObligatorio
The response schema
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List all company workspaces v2 workspacesGONG_LIST_ALL_COMPANY_WORKSPACES_V2_WORKSPACESAcción

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'.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
The response schema
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List all users v2 usersGONG_LIST_ALL_USERS_V2_USERSAcción

List all of the company's users. when accessed through a bearer token authorization method, this endpoint requires the scope 'api:users:read'.

Parámetros de entrada

cursorstring
When paging is needed, provide the value supplied by the previous API call to bring the following page of records.
includeAvatarsboolean
Avatars are synthetic users representing Gong employees (CSMs and support providers) when they access your instance. References to avatars" IDs may be found in the outputs of other API endpoints. This parameter is optional, if not provided avatars will not be included in the results.

Parámetros de salida

dataobjectObligatorio
The response schema
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List flows for crm prospectsGONG_LIST_FLOWS_FOR_CRM_PROSPECTSAcción

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'.

Parámetros de entrada

crmProspectsIdsstring[]Obligatorio
The CRM IDs of the prospects to list assigned flows for

Parámetros de salida

dataobjectObligatorio
The response schema
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Folder CallsGONG_LIST_FOLDER_CALLSAcción

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'.

Parámetros de entrada

folderIdstring
Gong"s unique numeric identifier for the folder (up to 20 digits).

Parámetros de salida

dataobjectObligatorio
The response schema
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List gong engage flows v2 flowsGONG_LIST_GONG_ENGAGE_FLOWS_V2_FLOWSAcción

Engage flows have the following visibility types: * company: visible to everyone in the company, can only be edited by users with edit permissions. * personal: reps can set up their own flows which are only available to them. * shared: reps can share a flow with other reps. those reps can then add leads to the flow. this endpoint returns all company flows, together with personal flows and flows shared with the user specified in the flowemailowner parameter. when accessed through a bearer token authorization method, use the 'api:flows:read' scope.

Parámetros de entrada

cursorstring
When paging is needed, provide the value supplied by the previous API call to bring the following page of records.
workspaceIdstring
Optional Workspace identifier, if supplied the API will return only the flows belonging to this workspace.
flowOwnerEmailstringObligatorio
Email of the Gong user whose personal flows and flows shared with the user you want to return.

Parámetros de salida

dataobjectObligatorio
The response schema
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List schema fields v2 crm entity schemaGONG_LIST_SCHEMA_FIELDS_V2_CRM_ENTITY_SCHEMAAcción

Retrieves the comprehensive schema of crm entities in the gong platform. this endpoint provides detailed metadata about the structure, attributes, and relationships of entities within the customer relationship management (crm) system. it is particularly useful for developers integrating with gong's api who need to understand the data model of the crm entities. the endpoint returns a complete view of all crm entity schemas, which can be used for data mapping, validation, or building dynamic forms. note that this endpoint does not accept any parameters, meaning it returns the full schema without filtering options. while powerful, be mindful of potential performance implications when dealing with large, complex crm structures.

Parámetros de entrada

objectTypestringObligatorioenum
Type of object to retrieve the schema fields for (case-sensitive). <br>Omitting this parameter returns the schema for all object types.
ACCOUNTCONTACTDEALLEAD
integrationIdintegerObligatorio
Integration ID generated when creating the integration

Parámetros de salida

dataobjectObligatorio
The response schema
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List users by filter v2 users extensiveGONG_LIST_USERS_BY_FILTER_V2_USERS_EXTENSIVEAcción

List multiple users. when accessed through a bearer token authorization method, this endpoint requires the scope 'api:users:read'.

Parámetros de entrada

cursorstring
When paging is needed, provide the value supplied by the previous API call to bring the following page of records.
filter__userIdsstring[]
Set of Gong"s unique numeric identifiers for the users (up to 20 digits).
filter__includeAvatarsboolean
Avatars are synthetic users representing Gong employees (CSMs and support providers) when they access your instance. References to avatars" IDs may be found in the outputs of other API endpoints. This parameter is optional, if not provided avatars will not be included in the results.
filter__createdToDateTimestring
An optional user creation time upper limit, if supplied the API will return only the users created before this time. The filed is 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).
filter__createdFromDateTimestring
An optional user creation time lower limit, if supplied the API will return only the users created at or after this time. The filed is 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).

Parámetros de salida

dataobjectObligatorio
The response schema
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Manage user call accessGONG_MANAGE_USER_CALL_ACCESSAcción

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'.

Parámetros de entrada

filter__callIdsstring[]
Array of Gong"s unique numeric call IDs.

Parámetros de salida

dataobjectObligatorio
The response schema
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Post a digital interaction v2 digital interactionGONG_POST_A_DIGITAL_INTERACTION_V2_DIGITAL_INTERACTIONAcción

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

Parámetros de entrada

devicestringenum
The device used during the event
MOBILEPC
eventIdstringObligatorio
The provider"s unique identifier for the event used for deduplication
eventTypestringObligatorio
The type of the event, explaining the content and action performed. Values may be partner-aligned, for example, "link clicked", "page viewed"
sessionIdstring
The identifier for the session, useful for tying related events together
timestampstringObligatoriodate-time
The date and time of the event in ISO 8601 format
trackingIdstring
The ID used for tracking the person who did the event. Must be null if a person is sent instead.
customFieldsobject[]
Include additional custom data about the event
person__namestring
The name of the person
person__emailstring
The email address of the person. Used for business context association
person__personIdstring
A unique person identifier in the partner system. Mandatory for anonymous person, when the name, email, phoneNumber and personBusinessContext are empty
sourceSystemNamestring
When integrating via IPaaS, the name of the technology partner the customer set up a Gong integration with via an IPaaS. When integrating directly with Gong: the name of the company setting up the integration with Gong
content__contentIdstring
A unique identifier for the content in the partner"s system
content__contentUrlstring
The URL for the content the person looked at
person__phoneNumberstring
The phone number of the person. Used for business context association
content__contentLabelstring[]
A list of tags defined for the content
content__contentTitlestring
The title of the content
person__company__namestring
The name of the company
person__location__citystring
The city of the person
person__company__domainstring
The domain of the person"s company. Used to associate the person with the company ("acme.com"). Mandatory for anonymous person, when the name, email, phoneNumber and personBusinessContext are empty
person__location__statestring
The state of the person in ISO 3166-2. If not available in ISO 3166-2, then send as string
person__location__regionstring
The region of the person in ISO 3166-2. If not available in ISO 3166-2, then send as string
person__location__countrystring
The country of the person in ISO 3166. If not available in ISO 3166, then send as string
person__company__companyIdstring
The company ID in the partner"s source system
person__personCustomFieldsobject[]
Include additional custom data about the person
content__contentCustomFieldsobject[]
Include additional custom data about the content
content__contentAdditionalInfoUrlstring
The URL for additional details provided by the website or external app, such as analysis of the content viewed
content__searchObjectDetails__urlstring
The URL of the entity in the partner system
content__searchObjectDetails__namestring
The name of the entity the person searched for
content__stepContentDetails__valuestring
The current step the person is in, in the process
content__searchObjectDetails__domainstring
The domain of the entity
content__numericContentDetails__valueinteger
The numeric value for the content
content__searchObjectDetails__objectIdstring
The ID of the entity in the partner system
content__numericContentDetails__rangeTointeger
The highest value that can be given to the content
person__personBusinessContext__objectIdstring
The ID of the object in the external system
content__searchObjectDetails__objectTypestringenum
The type of the entity the person searched for
CATEGORYPRODUCTVENDOR
person__company__companyBusinessContextsobject[]
The company"s details in an external system such as the CRM. If the domain is empty, to enable association, send the crmAccountId or crmOpportunityId
content__numericContentDetails__rangeFrominteger
The lowest value that can be given to the content
person__personBusinessContext__objectTypestringenum
The object type in the external system
CONTACTLEAD
person__personBusinessContext__systemNamestring
The name of the external system
content__numericContentDetails__numericTypestringenum
The type of numeric value
NPSOTHERPERCENTAGERATING
content__stepContentDetails__availableStepsstring[]
A list of all available steps in the process

Parámetros de salida

dataobjectObligatorio
The response schema
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Post day by day activity statsGONG_POST_DAY_BY_DAY_ACTIVITY_STATSAcción

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'.

Parámetros de entrada

cursorstring
When paging is needed, provide the value supplied by the previous API call to bring the following page of records.
filter__toDatestring
The date (in the company"s time zone) until which to list a user"s activity. This value is exclusive. This value should not exceed the current day. The date should be specified in the following format: YYYY-MM-DD.
filter__userIdsstring[]
Set of Gong"s unique numeric identifiers for the users (up to 20 digits).
filter__fromDatestring
The date (in the company"s time zone) from which to list a user"s activity. This value is inclusive. The date should be specified in the following format: YYYY-MM-DD.
filter__createdToDateTimestringdate-time
Createdtodatetime
filter__createdFromDateTimestringdate-time
Createdfromdatetime

Parámetros de salida

dataobjectObligatorio
The response schema
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Post interaction filter statsGONG_POST_INTERACTION_FILTER_STATSAcción

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'.

Parámetros de entrada

cursorstring
When paging is needed, provide the value supplied by the previous API call to bring the following page of records.
filter__toDatestring
The date (in the company"s time zone) until which to list a user"s activity. This value is exclusive. This value should not exceed the current day. The date should be specified in the following format: YYYY-MM-DD.
filter__userIdsstring[]
Set of Gong"s unique numeric identifiers for the users (up to 20 digits).
filter__fromDatestring
The date (in the company"s time zone) from which to list a user"s activity. This value is inclusive. The date should be specified in the following format: YYYY-MM-DD.
filter__createdToDateTimestringdate-time
Createdtodatetime
filter__createdFromDateTimestringdate-time
Createdfromdatetime

Parámetros de salida

dataobjectObligatorio
The response schema
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Post meeting integration statusGONG_POST_MEETING_INTEGRATION_STATUSAcción

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

Parámetros de entrada

emailsstring[]
String array of emails of users (max 100)

Parámetros de salida

dataobjectObligatorio
The response schema
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Updates an existing crm integration in the gong platform. this endpoint allows you to modify the details of a previously set up integration between gong and your customer relationship management (crm) system. it's primarily used for changing the integration's name or reassigning the ownership to a different team member. this operation is crucial for maintaining accurate and up-to-date integration configurations, especially when there are changes in your organization's structure or integration strategies. note that this endpoint only updates the integration metadata and does not affect the actual data synchronization between gong and your crm.

Parámetros de entrada

namestringObligatorio
The name of the integration
ownerEmailstringObligatorio
Email address of the person responsible for the integration

Parámetros de salida

dataobjectObligatorio
The response schema
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Report content viewed eventGONG_REPORT_CONTENT_VIEWED_EVENTAcción

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'.

Parámetros de entrada

eventIdstring
The original id of the event as designated in the reporting system.
shareIdstring
The id of the share action that corresponds to this view event, in case there can be more than one share per content.
contentIdstringObligatorio
The id of the content that was viewed in the reporting system.
userAgentstring
"User-Agent" header value for browser based interaction
actionNamestring
Actionname
contentUrlstringObligatorio
The url of the content that was viewed in the reporting system. This is the url that is was accessed by the viewer.
crmContextobject[]
A list of references to external systems such as CRM, Telephony System, Case Management, etc.
sharer__idstring
The user id in Gong, if available.
trackingIdstring
The ID used for tracking the person who did the event. Must be null if a viewer is sent instead.
mobileAppIdstring
The application identification string in case of interaction via mobile application (bundle identifier or package name).
moreInfoUrlstring
Moreinfourl
viewInfoUrlstring
The link to a page that presents additional information about this event.
workspaceIdstring
Optional workspace identifier. If specified, the event will be placed into this workspace, otherwise, the default algorithm for workspace placement will be applied.
contentTitlestringObligatorio
Human readable title of the content.
sharer__namestring
The name of the person, if available.
viewer__namestring
The name of the person, if available.
agentPlatformstringenum
Platform on which the interaction was made
Windows, Linux, MacOS, iOS, Android
sharer__emailstring
The email address of the person, if available.
viewer__emailstring
The email address of the person, if available.
viewer__titlestring
The title of the person, if available.
eventTimestampstringObligatorio
The date and time when the event happened in the ISO-8601 format (e.g., "2021-08-01T02:30:00+05:00" or "2021-08-01T08:00:00Z", where Z stands for UTC);
eventPropertiesobject[]
A list of additional properties for the event
reportingSystemstringObligatorio
The unique identifier of the reporting system. It is the same value in all events originating from the same system.
viewActionTitlestring
The name of the action like "Document Viewed" or "Presentation Opened".
viewer__contextobject[]
A list of links to external systems such as CRM, Telephony System, Case Management, etc.
contentPropertiesobject[]
A list of additional properties for the content
sharingMessageBodystring
Sharingmessagebody
sharingMessageSubjectstring
Sharingmessagesubject
nonCompanyParticipantsobject[]
Noncompanyparticipants

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Report Custom Engagement EventGONG_REPORT_CUSTOM_ENGAGEMENT_EVENTAcción

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'.

Parámetros de entrada

eventIdstring
The original id of the event as designated in the reporting system.
shareIdstring
Shareid
contentIdstring
The id of the content that was viewed in the reporting system.
userAgentstring
"User-Agent" header value for browser based interaction
actionNamestring
The name of the action like "Document Viewed" or "Presentation Opened".
contentUrlstring
The url of the content that was viewed in the reporting system. This is the url that is was accessed by the viewer.
crmContextobject[]
A list of references to external systems such as CRM, Telephony System, Case Management, etc.
sharer__idstring
The user id in Gong, if available.
trackingIdstring
Trackingid
actor__namestring
The name of the person, if available.
mobileAppIdstring
The application identification string in case of interaction via mobile application (bundle identifier or package name).
moreInfoUrlstring
Moreinfourl
workspaceIdstring
Optional workspace identifier. If specified, the event will be placed into this workspace, otherwise, the default algorithm for workspace placement will be applied.
actor__emailstring
The email address of the person, if available.
actor__titlestring
The title of the person, if available.
contentTitlestring
Human readable title of the content.
eventInfoUrlstring
The link to a page that presents additional information about this event.
sharer__namestring
The name of the person, if available.
agentPlatformstringenum
Platform on which the interaction was made
Windows, Linux, MacOS, iOS, Android
sharer__emailstring
The email address of the person, if available.
actor__contextobject[]
A list of links to external systems such as CRM, Telephony System, Case Management, etc.
eventTimestampstringObligatorio
The date and time when the event happened in the ISO-8601 format (e.g., "2021-08-01T02:30:00+05:00" or "2021-08-01T08:00:00Z", where Z stands for UTC);
eventPropertiesobject[]
A list of additional properties for the event
reportingSystemstringObligatorio
The unique identifier of the reporting system. It is the same value in all events originating from the same system.
contentPropertiesobject[]
A list of additional properties for the content
sharingMessageBodystring
Sharingmessagebody
sharingMessageSubjectstring
Sharingmessagesubject
nonCompanyParticipantsobject[]
Noncompanyparticipants

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve call data by date range v2 callsGONG_RETRIEVE_CALL_DATA_BY_DATE_RANGE_V2_CALLSAcción

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'.

Parámetros de entrada

cursorstring
When paging is needed, provide the value supplied by the previous API call to bring the following page of records.
toDateTimestringObligatorio
Date and time (in ISO-8601 format: "2018-02-18T02:30:00-07:00" or "2018-02-18T08:00:00Z", where Z stands for UTC) until which to list recorded calls. Returns calls that started up to but excluding specified date and time. If not provided, list ends with most recent call. For web-conference calls recorded by Gong, the date denotes its scheduled time, otherwise, it denotes its actual start time.
workspaceIdstring
Optional Workspace identifier, if supplied the API will return only the calls belonging to this workspace.
fromDateTimestringObligatorio
Date and time (in ISO-8601 format: "2018-02-18T02:30:00-07:00" or "2018-02-18T08:00:00Z", where Z stands for UTC) from which to list recorded calls. Returns calls that started on or after the specified date and time. If not provided, list starts with earliest call. For web-conference calls recorded by Gong, the date denotes its scheduled time, otherwise, it denotes its actual start time.

Parámetros de salida

dataobjectObligatorio
The response schema
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve data for a specific call v2 calls idGONG_RETRIEVE_DATA_FOR_A_SPECIFIC_CALL_V2_CALLS_IDAcción

Retrieve data for a specific call. when accessed through a bearer token authorization method, this endpoint requires the scope 'api:calls:read:basic'.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
The response schema
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve data privacy info for email addressGONG_RETRIEVE_DATA_PRIVACY_INFO_FOR_EMAIL_ADDRESSAcción

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'.

Parámetros de entrada

emailAddressstringObligatorio
The email address.

Parámetros de salida

dataobjectObligatorio
The response schema
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve filtered call detailsGONG_RETRIEVE_FILTERED_CALL_DETAILSAcción

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'.

Parámetros de entrada

cursorstring
When paging is needed, provide the value supplied by the previous API call to bring the following page of records.
filter__callIdsstring[]
List of calls Ids to be filtered. If not supplied, returns all calls between fromDateTime and toDateTime.
filter__toDateTimestring
Date and time (in ISO-8601 format: "2018-02-18T02:30:00-07:00" or "2018-02-18T08:00:00Z", where Z stands for UTC) until which to list recorded calls. Returns calls that started up to but excluding specified date and time. If not provided, list ends with most recent call. The date applies to call start time.
filter__workspaceIdstring
Optional Workspace identifier, if supplied the API will return only the calls belonging to this workspace.
filter__fromDateTimestring
Date and time (in ISO-8601 format: "2018-02-18T02:30:00-07:00" or "2018-02-18T08:00:00Z", where Z stands for UTC) from which to list recorded calls. Returns calls that started on or after the specified date and time. If not provided, list starts with earliest call. The date applies to call start time.
filter__primaryUserIdsstring[]
An optional list of user identifiers, if supplied the API will return only the calls hosted by the specified users. The identifiers in this field match the primaryUserId field of the calls.
contentSelector__contextstringenum
If "Basic", add links to external systems (context objects) such as CRM, Telephony System, Case Management. If "Extended" include also data (context fields) for these links. Default value "None"
BasicExtendedNone
contentSelector__contextTimingstring[]
Timing for the context data. The field is optional and can contain either "Now" or "TimeOfCall" or both. The default value is ["Now"]. Can be provided only when the context field is set to "Extended"
contentSelector__exposedFields__mediaboolean
If true and exist, add audio url and video url of the call. The urls will be available for 8 hours.
contentSelector__exposedFields__partiesboolean
If true, add information about the parties of the call
contentSelector__exposedFields__content__briefboolean
When true, returns the spotlight call brief.
contentSelector__exposedFields__content__topicsboolean
If true, add duration of call topics
contentSelector__exposedFields__content__outlineboolean
When true, returns the call outline.
contentSelector__exposedFields__content__trackersboolean
If true, returns smart tracker and keyword tracker information for the call.
contentSelector__exposedFields__content__keyPointsboolean
When true, returns the key points of the call.
contentSelector__exposedFields__content__structureboolean
If true, add call agenda, if available
contentSelector__exposedFields__interaction__videoboolean
If true, add video statistics
contentSelector__exposedFields__content__highlightsboolean
When true, returns the call highlights.
contentSelector__exposedFields__content__callOutcomeboolean
When true, returns the outcome of the call.
contentSelector__exposedFields__interaction__speakersboolean
If true, add the time each participant spoke.
contentSelector__exposedFields__interaction__questionsboolean
If true, add question counts
contentSelector__exposedFields__content__pointsOfInterestboolean
If true, add call points of interest
contentSelector__exposedFields__content__trackerOccurrencesboolean
If true, the API will return the timing and speaker ID of each occurrence of a tracker (in addition to other tracker data). This functionality must be used in combination with the "trackers" field. The occurrence data is available only for the calls recorded since Jan 1, 2023, contact Gong support if a backfill of this data is required.
contentSelector__exposedFields__collaboration__publicCommentsboolean
If true, add public comments made for this call
contentSelector__exposedFields__interaction__personInteractionStatsboolean
If true, add statistics for the host of the call.

Parámetros de salida

dataobjectObligatorio
The response schema
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve library folders v2 library foldersGONG_RETRIEVE_LIBRARY_FOLDERS_V2_LIBRARY_FOLDERSAcción

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'.

Parámetros de entrada

workspaceIdstring
Workspace identifier. We will retrieve folders which are related to this specific workspace.

Parámetros de salida

dataobjectObligatorio
The response schema
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve logs data by type and time range v2 logsGONG_RETRIEVE_LOGS_DATA_BY_TYPE_AND_TIME_RANGE_V2_LOGSAcción

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'.

Parámetros de entrada

cursorstring
When paging is needed, provide the value supplied by the previous API call to bring the following page of records.
logTypestringObligatorioenum
Type of logs requested.
AccessLogExternallySharedCallAccessExternallySharedCallPlayUserActivityLogUserCallPlay
toDateTimestring
The time until which to retrieve log records, 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); if not specified, the logs end with the latest recorded log.
fromDateTimestringObligatorio
The time from which to retrieve log records, 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).

Parámetros de salida

dataobjectObligatorio
The response schema
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve manual crm call associationsGONG_RETRIEVE_MANUAL_CRM_CALL_ASSOCIATIONSAcción

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'.

Parámetros de entrada

cursorstring
When paging is needed, provide the value supplied by the previous API call to bring the following page of records.
fromDateTimestring
Association time filter - only the associations made after that time will be listed. The time is 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); if not specified all association events will be listed.

Parámetros de salida

dataobjectObligatorio
The response schema
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve scorecards details v2 settings scorecardsGONG_RETRIEVE_SCORECARDS_DETAILS_V2_SETTINGS_SCORECARDSAcción

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'.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
The response schema
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve tracker details v2 settings trackersGONG_RETRIEVE_TRACKER_DETAILS_V2_SETTINGS_TRACKERSAcción

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.

Parámetros de entrada

workspaceIdstring
The ID of the workspace the keyword trackers are in. When empty, all trackers in all workspaces are returned.

Parámetros de salida

dataobjectObligatorio
The response schema
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve transcripts of calls v2 calls transcriptGONG_RETRIEVE_TRANSCRIPTS_OF_CALLS_V2_CALLS_TRANSCRIPTAcción

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'.

Parámetros de entrada

cursorstring
When paging is needed, provide the value supplied by the previous API call to bring the following page of records.
filter__callIdsstring[]
List of calls Ids to be filtered. If not supplied, returns all calls between fromDateTime and toDateTime.
filter__toDateTimestring
Date and time (in ISO-8601 format: "2018-02-18T02:30:00-07:00" or "2018-02-18T08:00:00Z", where Z stands for UTC) until which to list recorded calls. Returns calls that started up to but excluding specified date and time. If not provided, list ends with most recent call. The date applies to call start time.
filter__workspaceIdstring
Optional Workspace identifier, if supplied the API will return only the calls belonging to this workspace.
filter__fromDateTimestring
Date and time (in ISO-8601 format: "2018-02-18T02:30:00-07:00" or "2018-02-18T08:00:00Z", where Z stands for UTC) from which to list recorded calls. Returns calls that started on or after the specified date and time. If not provided, list starts with earliest call. The date applies to call start time.

Parámetros de salida

dataobjectObligatorio
The response schema
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve User Settings HistoryGONG_RETRIEVE_USER_SETTINGS_HISTORYAcción

Retrieve a specific user's settings history. when accessed through a bearer token authorization method, this endpoint requires the scope 'api:users:read'.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
The response schema
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve users from permission profileGONG_RETRIEVE_USERS_FROM_PERMISSION_PROFILEAcción

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'.

Parámetros de entrada

profileIdstringObligatorio
Permission profile identifier.

Parámetros de salida

dataobjectObligatorio
The response schema
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve user v2 users idGONG_RETRIEVE_USER_V2_USERS_IDAcción

Retrieve a specific user. when accessed through a bearer token authorization method, this endpoint requires the scope 'api:users:read'.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
The response schema
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Set User Call AccessGONG_SET_USER_CALL_ACCESSAcción

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'.

Parámetros de entrada

callAccessListobject[]
A list, in which each item specifies a call and a list of users to be given access to this call.

Parámetros de salida

dataobjectObligatorio
The response schema
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update a gong meeting v2 meetings meetingidGONG_UPDATE_A_GONG_MEETING_V2_MEETINGS_MEETING_IDAcción

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

Parámetros de entrada

titlestring
Title of the event.
endTimestringObligatorio
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).
inviteesobject[]Obligatorio
A list of email addresses of invitees to the event (not including the organizer).
meetingIdintegerObligatorio
Gong"s unique identifier for the meeting (up to 20 digits).
startTimestringObligatorio
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).
externalIdstring
The ID as it is formed on the external system.
organizerEmailstringObligatorio
The email address of the user who created the meeting.

Parámetros de salida

dataobjectObligatorio
The response schema
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update permission profile v2 permission profileGONG_UPDATE_PERMISSION_PROFILE_V2_PERMISSION_PROFILEAcción

Update a permission profile.

Parámetros de entrada

idstring
Unique numeric identifier of the permission profile (up to 20 digits).
namestring
Permission profile name.
dealsboolean
User can view deals pages.
usageboolean
User can view usage pages.
marketboolean
User can view market page.
accountboolean
User can view account pages.
libraryboolean
User can view library pages.
activityboolean
User can view activity pages.
coachingboolean
User can view coaching pages.
forecastboolean
User can view forecast pages.
profileIdstringObligatorio
Permission profile identifier.
teamStatsboolean
User can view team stats page.
trimCallsboolean
User can trim calls.
scoreCallsboolean
User can score calls.
deleteCallsboolean
User can delete calls.
descriptionstring
Permission profile description.
initiativesboolean
User can view initiatives page.
deleteEmailsboolean
User can delete emails.
privateCallsboolean
User can set their own calls as private.
crmDataImportboolean
User can perform import of crm data.
listenInCallsboolean
User can listen in calls.
overrideScoreboolean
User can override someone else score.
callsAndSearchboolean
User can view and search calls.
forecastManageboolean
User can manage forecast boards and upload targets.
manageScorecardsboolean
User can manage scorecards.
downloadCallMediaboolean
User can download call media.
dealsInlineEditingboolean
User can perform inline editing of deals.
crmDataInlineEditingboolean
User can perform inline editing of crm data.
viewRevenueAnalyticsboolean
User can view dashboards page.
manageRevenueAnalyticsboolean
User can manage revenue analytics.
shareCallsWithCustomersboolean
User can share calls with customers.
callsAccess__teamLeadIdsstring[]
List of user IDs to populate the managers-team permission level You can retrieve the user ids by using the “Users” API.
dealsAccess__teamLeadIdsstring[]
List of user IDs to populate the managers-team permission level You can retrieve the user ids by using the “Users” API.
usageAccess__teamLeadIdsstring[]
List of user IDs to populate the managers-team permission level You can retrieve the user ids by using the “Users” API.
viewEngageAnalyticsFlowsboolean
User can view engage analytics flows page.
emailsAccess__teamLeadIdsstring[]
List of user IDs to populate the managers-team permission level You can retrieve the user ids by using the “Users” API.
coachingAccess__teamLeadIdsstring[]
List of user IDs to populate the managers-team permission level You can retrieve the user ids by using the “Users” API.
insightsAccess__teamLeadIdsstring[]
List of user IDs to populate the managers-team permission level You can retrieve the user ids by using the “Users” API.
viewEngageAnalyticsActivityboolean
User can view engage analytics activity page.
callsAccess__permissionLevelstringenum
Permission access scope.
allall / managers-team / report-to-them / own / nonemanagers-teamnoneownreport-to-them
dealsAccess__permissionLevelstringenum
Permission access scope.
allall / managers-team / report-to-them / own / nonemanagers-teamnoneownreport-to-them
engageManageCompanySequencesboolean
User can manage company sequences.
engageManageCompanyTemplatesboolean
User can manage company email templates.
usageAccess__permissionLevelstringenum
Permission access scope.
allall / managers-team / report-to-them / own / nonemanagers-teamnoneownreport-to-them
emailsAccess__permissionLevelstringenum
Permission access scope.
allall / managers-team / report-to-them / own / nonemanagers-teamnoneownreport-to-them
engageCreateAndManageRulesetsboolean
User can create and manage rulesets.
manageGeneralBusinessSettingsboolean
User can manage general business settings.
createEditAndDeleteDealsBoardsboolean
User can create/edit/delete deals boards.
engageSnoozeFlowToDosForOthersboolean
User can snooze flow in to dos for others
manuallyScheduleAndUploadCallsboolean
User can manually schedule and upload calls.
viewEngageAnalyticsPerformanceboolean
User can view engage analytics performance page.
coachingAccess__permissionLevelstringenum
Permission access scope.
allall / managers-team / report-to-them / own / nonemanagers-teamnoneownreport-to-them
exportCallsAndCoachingDataToCSVboolean
User can export calls and coaching metrics data to CSV.
insightsAccess__permissionLevelstringenum
Permission access scope.
allall / managers-team / report-to-them / own / nonemanagers-teamnoneownreport-to-them
libraryFolderAccess__manageStreamsboolean
A user with this profile can manage streams, if set, "permissionLevel" must not be "none".
libraryFolderAccess__permissionLevelstringenum
Library folder permission level - mandatory value.
allnonenone, all, specific-foldersspecific-folders
libraryFolderAccess__libraryFolderIdsstring[]
List of library folder Ids, if set, "permissionLevel" must not be "none".
libraryFolderAccess__manageFolderCallsboolean
A user with this profile can add calls to folders, archive calls, if set, "permissionLevel" must not be "none".
libraryFolderAccess__managePublicFolderboolean
A user with this profile can manage public folder, if set, "permissionLevel" must not be "none".
libraryFolderAccess__shareFoldersAndStreamsboolean
A user with this profile can share folders and streams from Your Library with other team members, if set, "permissionLevel" must not be "none".
forecastPermissions__forecastAccess__teamLeadIdsstring[]
List of user IDs to populate the managers-team permission level You can retrieve the user ids by using the “Users” API.
forecastPermissions__forecastAccess__permissionLevelstringenum
Permission access scope.
allall / managers-team / report-to-them / own / nonemanagers-teamnoneownreport-to-them
forecastPermissions__forecastEditTargets__teamLeadIdsstring[]
List of user IDs to populate the managers-team permission level You can retrieve the user ids by using the “Users” API.
forecastPermissions__forecastEditSubmissions__teamLeadIdsstring[]
List of user IDs to populate the managers-team permission level You can retrieve the user ids by using the “Users” API.
forecastPermissions__forecastEditTargets__permissionLevelstringenum
Permission access scope.
allall / managers-team / report-to-them / own / nonemanagers-teamnoneownreport-to-them
forecastPermissions__forecastEditSubmissions__permissionLevelstringenum
Permission access scope.
allall / managers-team / report-to-them / own / nonemanagers-teamnoneownreport-to-them

Parámetros de salida

dataobjectObligatorio
The response schema
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update shared content eventGONG_UPDATE_SHARED_CONTENT_EVENTAcción

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'.

Parámetros de entrada

eventIdstring
The original id of the event as designated in the reporting system.
shareIdstring
The id of the share action, in case there can be more than one share per content.
contentIdstringObligatorio
The id of the content that was shared in the reporting system.
userAgentstring
Useragent
actionNamestring
The name of the action like "Document Sent" or "Presentation Shared".
contentUrlstringObligatorio
The url of the content that was shared in the reporting system. This is the url that is was accessed by the viewer.
crmContextobject[]
A list of references to external systems such as CRM, Telephony System, Case Management, etc.
recipientsobject[]
array of objects with name + email of recipients. Email is required.
sharer__idstring
The user id in Gong, if available.
trackingIdstring
Trackingid
mobileAppIdstring
Mobileappid
moreInfoUrlstring
Moreinfourl
workspaceIdstring
Optional workspace identifier. If specified, the event will be placed into this workspace, otherwise, the default algorithm for workspace placement will be applied.
contentTitlestringObligatorio
Human readable title of the content.
shareInfoUrlstring
The link to a page that presents additional information about this event.
sharer__namestring
The name of the person, if available.
agentPlatformstring
Agentplatform
sharer__emailstring
The email address of the person, if available.
eventTimestampstringObligatorio
The date and time when the event happened in the ISO-8601 format (e.g., "2021-08-01T02:30:00+05:00" or "2021-08-01T08:00:00Z", where Z stands for UTC);
eventPropertiesobject[]
A list of additional properties for the event
reportingSystemstringObligatorio
The unique identifier of the reporting system. It is the same value in all events originating from the same system.
contentPropertiesobject[]
A list of additional properties for the content
sharingMessageBodystring
The share message body. Can contain HTML and will be cleaned when it is presented.
sharingMessageSubjectstring
The subject of share email / message.
nonCompanyParticipantsobject[]
Noncompanyparticipants

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Upload crm objects v2 crm entitiesGONG_UPLOAD_CRM_OBJECTS_V2_CRM_ENTITIESAcción

Uploads crm data files to the gong platform for integration and analysis. this endpoint allows users to send large crm data files (up to 200mb) using a multipart/form-data request. it should be used when integrating crm systems with gong's revenue intelligence platform to provide up-to-date customer interaction data. the endpoint is specifically designed for file uploads and does not support other operations like querying or modifying existing data. ensure that the uploaded file contains properly structured crm data compatible with gong's system for successful integration and subsequent analysis.

Parámetros de entrada

dataFileobjectbinary
Datafile

Parámetros de salida

dataobjectObligatorio
The response schema
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not