Gong

Learn how to use Gong with Composio

Overview

SLUG

GONG

Description

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

Authentication Details

generic_api_key
stringRequired
full
string

Tools

SLUG: GONG_RETRIEVE_CALL_DATA_BY_DATE_RANGE_V2_CALLS

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

Action Parameters

cursor
string
fromDateTime
stringRequired
toDateTime
stringRequired
workspaceId
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: GONG_ADD_CALL_MEDIA_V2_CALLS_ID_MEDIA

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

Action Parameters

id
stringRequired
mediaFile
object

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: GONG_ADD_NEW_CALL_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'.

Action Parameters

actualStart
stringRequired
callProviderCode
string
clientUniqueId
stringRequired
context
array
customData
string
direction
stringRequired
disposition
string
downloadMediaUrl
string
duration
integer
languageCode
string
meetingUrl
string
parties
arrayRequired
primaryUser
stringRequired
purpose
string
scheduledEnd
string
scheduledStart
string
speakersTimeline__precise
boolean
speakersTimeline__speechSegments
array
title
string
workspaceId
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: GONG_AGGREGATE_ACTIVITY_BY_PERIOD_VIA_API

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

Action Parameters

aggregationPeriod
stringRequired
cursor
string
filter__createdFromDateTime
string
filter__createdToDateTime
string
filter__fromDate
string
filter__toDate
string
filter__userIds
array

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: GONG_AGGREGATE_USER_ACTIVITY_STATISTICS

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

Action Parameters

cursor
string
filter__createdFromDateTime
string
filter__createdToDateTime
string
filter__fromDate
string
filter__toDate
string
filter__userIds
array

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: GONG_ASSIGN_PROSPECTS_TO_FLOW

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

Action Parameters

crmProspectsIds
arrayRequired
flowId
stringRequired
flowInstanceOwnerEmail
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: GONG_CREATE_ACTIVITY_SCORECARDS_REPORT

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

Action Parameters

cursor
string
filter__callFromDate
string
filter__callToDate
string
filter__reviewFromDate
string
filter__reviewMethod
string
filter__reviewToDate
string
filter__reviewedUserIds
array
filter__scorecardIds
array

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: GONG_CREATE_A_NEW_GONG_MEETING_V2_MEETINGS

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

Action Parameters

endTime
stringRequired
externalId
string
invitees
arrayRequired
organizerEmail
stringRequired
startTime
stringRequired
title
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: GONG_CREATE_PERMISSION_PROFILE_V2_PERMISSION_PROFILE

Create a permission profile in a given workspace.

Action Parameters

account
boolean
activity
boolean
callsAccess__permissionLevel
string
callsAccess__teamLeadIds
array
callsAndSearch
boolean
coaching
boolean
coachingAccess__permissionLevel
string
coachingAccess__teamLeadIds
array
createEditAndDeleteDealsBoards
boolean
crmDataImport
boolean
crmDataInlineEditing
boolean
deals
boolean
dealsAccess__permissionLevel
string
dealsAccess__teamLeadIds
array
dealsInlineEditing
boolean
deleteCalls
boolean
deleteEmails
boolean
description
string
downloadCallMedia
boolean
emailsAccess__permissionLevel
string
emailsAccess__teamLeadIds
array
engageCreateAndManageRulesets
boolean
engageManageCompanySequences
boolean
engageManageCompanyTemplates
boolean
engageSnoozeFlowToDosForOthers
boolean
exportCallsAndCoachingDataToCSV
boolean
forecast
boolean
forecastManage
boolean
forecastPermissions__forecastAccess__permissionLevel
string
forecastPermissions__forecastAccess__teamLeadIds
array
forecastPermissions__forecastEditSubmissions__permissionLevel
string
forecastPermissions__forecastEditSubmissions__teamLeadIds
array
forecastPermissions__forecastEditTargets__permissionLevel
string
forecastPermissions__forecastEditTargets__teamLeadIds
array
id
string
initiatives
boolean
insightsAccess__permissionLevel
string
insightsAccess__teamLeadIds
array
library
boolean
libraryFolderAccess__libraryFolderIds
array
libraryFolderAccess__manageFolderCalls
boolean
libraryFolderAccess__managePublicFolder
boolean
libraryFolderAccess__manageStreams
boolean
libraryFolderAccess__permissionLevel
string
libraryFolderAccess__shareFoldersAndStreams
boolean
listenInCalls
boolean
manageGeneralBusinessSettings
boolean
manageRevenueAnalytics
boolean
manageScorecards
boolean
manuallyScheduleAndUploadCalls
boolean
market
boolean
name
string
overrideScore
boolean
privateCalls
boolean
scoreCalls
boolean
shareCallsWithCustomers
boolean
teamStats
boolean
trimCalls
boolean
usage
boolean
usageAccess__permissionLevel
string
usageAccess__teamLeadIds
array
viewEngageAnalyticsActivity
boolean
viewEngageAnalyticsFlows
boolean
viewEngageAnalyticsPerformance
boolean
viewRevenueAnalytics
boolean
workspaceId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: GONG_DATA_PRIVACY_FOR_PHONE_NUMBER

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

Action Parameters

phoneNumber
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: GONG_DELETE_A_GENERIC_CRM_INTEGRATION_V2_CRM_INTEGRATIONS

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.

Action Parameters

clientRequestId
stringRequired
integrationId
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: GONG_DELETE_A_GONG_MEETING_V2_MEETINGS

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

Action Parameters

meetingId
integerRequired
organizerEmail
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: GONG_DELETE_USERS_FROM_CALL_ACCESS_LIST

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

Action Parameters

callAccessList
array

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: GONG_ERASE_DATA_FOR_EMAIL_ADDRESS

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

Action Parameters

emailAddress
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: GONG_ERASE_DATA_FOR_PHONE_NUMBER

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

Action Parameters

phoneNumber
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: GONG_FETCH_ALL_PERMISSION_PROFILES

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

Action Parameters

workspaceId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: GONG_GET_CRM_INTEGRATION_DETAILS

<style>.public-api-info { background: rgb(222, 235, 255);}.public-api-tip { background: rgb(227, 252, 239);}.public-api-parameter { background: rgba(9,30,66,0.08);}.public-api-note { background: rgb(234, 230, 255);}.public-api-important { background: rgb(255, 250, 230);}.public-api-critical { background: rgb(255, 235, 230);}table, th, td { border: 1px solid gray; border-collapse: collapse;}th, td { padding: 5px;}th { text-align: left;}img { border: 2px solid #d3d5d9;}</style><p>returns the crm integration you set up using the <code>put /v2/crm/integrations</code> endpoint. you can only have one integration at a time. </p><p>when accessed using a bearer token, this endpoint requires the 'api:crm:integrations:read' scope.</p>

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: GONG_GET_CRM_OBJECTS_V2_CRM_ENTITIES

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.

Action Parameters

integrationId
integerRequired
objectType
stringRequired
objectsCrmIds
arrayRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: GONG_GET_PERMISSION_PROFILE

Returns a permission profile.

Action Parameters

profileId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: GONG_GET_REQUEST_STATUS_V2_CRM_REQUEST_STATUS

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.

Action Parameters

clientRequestId
stringRequired
integrationId
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired