Lists detailed call data for calls that took place during a specified date range, have specified call IDs or hosted by specified users.
Required authorizaton 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'.
When paging is needed, provide the value supplied by the previous API call to bring the following page of records.
Filter parameters.
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.
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.
Optional Workspace identifier, if supplied the API will return only the calls belonging to this workspace.
List of calls Ids to be filtered. If not supplied, returns all calls between fromDateTime and toDateTime.
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.
The content selector identifies which data components, if any, are needed, by the caller
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'
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'
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'
The exposed fields identifies which field, if any, are returned in the response object
If true, add information about the parties of the call
The content of the call
If true, add call agenda, if available
If true, add duration of call topics
If true, returns smart tracker and keyword tracker information for the call.
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.
deprecated.
When true, returns the spotlight call brief.
When true, returns the call outline.
When true, returns the call highlights.
When true, returns the outcome of the call.
When true, returns the key points of the call.
The interaction data of the call
If true, add the time each participant spoke.
If true, add video statistics
If true, add statistics for the host of the call.
If true, add question counts
Call collaboration
If true, add public comments made for this call
If true and exist, add audio url and video url of the call. The urls will be available for 8 hours.
Successful response
A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes.
Information about the number of records that match the requested filter.
Total number of records.
Number of records in the current page.
Current page number.
Returned only when there are more records to be retrieved. Repeat the API call and pass this cursor value in the request to retrieve the next page of records.
A list with one entry per call.
A list with one entry per call.
call's metadata.
Gong's unique numeric identifier for the call (up to 20 digits).
The URL to the page in the Gong web application where the call is available.
The title of the call.
Scheduled date and time of the call in the ISO-8601 format (e.g., '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC).
The date and time when the call was recorded in the ISO-8601 format (e.g., '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC).
The duration of the call, in seconds.
The primary user ID of the team member who hosted the call.
Call direction.
The system with which the call was carried out (e.g., WebEx, ShoreTel, etc.).
The scope of the call: 'internal' if all the participants are from the company, 'external' if some participants are not from the company, or 'unknown' if the scope is unknown.
Media type
The language codes (as defined by ISO-639-2B). E.g., eng, fre, spa, ger, and ita. Also used are und (unsupported language), and zxx (not enough speech content for identification).
Gong's unique numeric identifier for the call's workspace (up to 20 digits).
The SDR disposition of the call. This can be an automated value provided by the provider, or manually entered by the rep.
The call's unique identifier in the origin recording system (typically a telephony recording system). The identifier is provided to Gong during the call creation via the Public API or through telephony systems integrations.
Metadata as was provided to Gong during the call creation via the Public API.
The purpose of the call.
The meeting provider URL on which the web conference was recorded.
If the call is private.
The Id of the meeting in Google or Outlook Calendar.
A list of the agenda of each part of the call.
Links to external systems such as CRM, Dialer, Case Management etc
External system name. e.g. Salesforce
List of objects within the external system
External Object
Object Type. e.g Opportunity.
Object ID
External object data
Field name. For Account supported fields are: Name, Website, Industry and all the custom fields. For Opportunity supported fields are Name, LeadSource, Type, StageName, Probability, Amount, CloseDate and all the custom fields.
Field value
Timing of object
A list of the call's participants
Unique ID of the participant in the call.
Email address.
The name of the participant.
The job title of the participant
The user ID of the participant within the Gong system, if the participant exists in the system.
Unique ID of a participant that spoke in the call. References to this id will appear in the '/v2/calls/transcript' endpoint response.
A list of links to external systems such as CRM, Dialer, Case Management, etc.
Links to external systems such as CRM, Dialer, Case Management etc
External system name. e.g. Salesforce
List of objects within the external system
External Object
Object Type. e.g. Lead
Object ID
Object fields
External object data
Field name. All custom fields are supported.
Object value
Timing of object
Whether the participant is from the company or not.
The phone number of the participant.
Whether the participant was invited to the meeting or only attended the call.
Whether the participant was invited to the meeting or only attended the call.
Analysis of the interaction content.
A list of the agenda of each part of the call.
Agenda of the current part of the call
The agenda name
The duration of this part of the call
The unique ID of the Tracker.
The name of the Tracker (e.g., Stores).
The number of times words in this Tracker occurred in the call.
The type of the tracker - Keyword or Smart.
Details when the smart or keyword tracker term came up in the call. The list does not specify each phrase defined in the tracker, rather it lists when any term relevant to the tracker was mentioned. Empty when keyword trackers are set to display each term in the tracker separately.
The number of seconds from the beginning of the call when the tracker phrase was captured.
Unique ID of the speaker in the call who said the tracker term. Same as the speakerID in the "parties" field and in the transcript.
Details when each specific phrase defined in the keyword tracker came up in the call. Smart trackers are not listed.
The number of times this phrase was mentioned in the call.
Lists when each keyword tracker phrase was mentioned in the call.
The number of seconds from the beginning of the call when the tracker phrase was captured.
Unique ID of the speaker in the call who said the tracker term. Same as the speakerID in the "parties" field and in the transcript.
The specific phrase within the tracker (e.g., Walmart).
The name of the topic (e.g., Pricing).
The total time, in seconds, spent on this topic within the call.
The brief of the call. Returned when it is available and contentSelector.exposedFields.content.brief = true.
Outline of the call, divided into sections. Returned when it is available and contentSelector.exposedFields.content.outline = true.
The name of this section of the call.
The starting time of this section, in seconds, from the start of the call.
The duration of this section, in seconds.
List of items of this section.
The text of this section item.
The starting time of this section item, in seconds from the start of the call.
List of highlights of the call. Returned when it is available and contentSelector.exposedFields.content.highlights = true.
The title of the highlights section.
List of highlight items of the call in this section.
The text of the highlights section item.
List of starting times of the highlights section item, in seconds from the start of the call.
The outcome of the call, as automatically set by Gong AI. Returned when it is available and contentSelector.exposedFields.content.callOutcome = true.
The ID of the call outcome, as automatically set by Gong AI
The category of the call outcome, as automatically set by Gong AI
The name of the call outcome, as automatically set by Gong AI
List of key points of the call. Returned when it is available and contentSelector.exposedFields.content.keyPoints = true.
The text of the key point.
Metrics collected around the interaction during the call.
A list of the talk duration per speaker.
Talking duration
Unique ID of the participant in the call.
User Id within the Gong system
Talk duration in seconds
A list of interaction statistics. Applicable values: 'Talk Ratio', 'Longest Monologue', 'Longest Customer Story', 'Interactivity', 'Patience'.
Interaction statistics
Stat name
Stat measurement
A list of video statistics about what's presented and for how long.
Video statistics
Video segment type. Can have the values: 'Browser', 'Presentation', 'WebcamPrimaryUser', 'WebcamNonCompany', and 'Webcam'.
'Browser': When the video segment shows a web browser.
'Presentation': When the video segment shows a presentation (such as PowerPoint).
'WebcamPrimaryUser': When the video segment shows the webcam of the primary user.
'WebcamNonCompany': When the video segment shows webcam speakers that gong has identified as being non-company.
'Webcam': When the video segment shows any webcam.
Total video segments duration in seconds.
Question counts of the call.
The number of questions asked by company speakers.
The number of questions asked by non-company speakers.
Collaboration information added to the call
A list of public comments.
Unique identifier of the comment within the Gong's system.
The number of seconds from the beginning of the call that the comment start refers to.
The number of seconds from the beginning of the call that the comment ends refers to.
Unique identifier of the user who wrote the comment.
The comment itself. The comment may contains person tagging in this format @[user name](user Id)
The date and time in the ISO-8601 format (e.g., '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC); in which the comment was posted.
The unique identifier of the original comment in case the current comment is a reply to the original one.
True if the comment was written during the call, false if it was posted after the call.
The media urls of the call.
If true and exist, add audio url of the call. The url will be available for 8 hours.
If true and exist, add video url of the call. The url will be available for 8 hours.
Malformed request
A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes.
Error messages.
Access denied
A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes.
Error messages.
No calls found for the specified period
A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes.
Error messages.
API request limit exceeded
A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes.
Error messages.
Failed to complete the operation due to an unexpected error
A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes.
Error messages.