When using this endpoint, either provide a downloadMediaUrl or use the returned callId in a follow-up request to /v2/calls//media to upload the media file.
Required authorizaton scope: 'api:calls:create'.
New call metadata
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.
The title of the call. This title is used for indexing and search.
The purpose of the call.
The date and time the call was scheduled to begin in ISO-8601 format (Use UTC (Z) or a timezone offset (-07:00)
The date and time the call was scheduled to end in ISO-8601 format (Use UTC (Z) or a timezone offset (-07:00)
The actual date and time the call started in ISO-8601 format (Use UTC (Z) or a timezone offset (-07:00)
The call duration in seconds.
A list of the call's participants. A party must be provided for the primaryUser.
A list of the call's participants. A party must be provided for the primaryUser.
The phone number of the party, if available.
The email address of the party, if available.
The name of the party, if available.
An identifier that is only required when speakersTimeline is provided. The partyId is used to recognize the speakers within the provided speakersTimeline.
The audio channel corresponding to the company team member (rep) used when the uploaded media file is multi-channel (stereo). The channel id is either 0 or 1 (representing left or right respectively)
A list of links to external systems such as CRM, Telephony System, Case Management, etc.
Links to external systems such as CRM, Telephony System, Case Management etc. Currently only Salesforce and Generic are supported.
External system name. Currently only Salesforce and Generic are supported.
List of objects within the external system
External object associated with the party
Object Type. Valid only for non-company parties. e.g. Lead.
Object ID. For Salesforce both case-sensitive and case-insensitive formats are supported.
Object fields. Intended for future use only.
External object data
Field name
Object value
The user ID of the participant within the Gong system, if the participant is a user.
Whether the call is inbound (someone called the company), outbound (a rep dialed someone outside the company), or a conference call.
The disposition of the call. The disposition is free text of up to 255 characters.
A list of references to external systems such as CRM, Telephony System, Case Management, etc.
Links to external systems such as CRM, Telephony System, Case Management etc. Currently only Salesforce and Generic are supported.
External system name. Currently only Salesforce and Generic are supported.
List of objects within the external system. Note: Multiple opportunities/deals belonging to the same account are not supported.
External object associated with the call
Object Type. e.g. Account.
Object ID. For Salesforce both case-sensitive and case-insensitive formats are supported.
Object fields. Intended for future use only.
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
Optional metadata associated with the call (represented as text). Gong stores this metadata and it can be used for troubleshooting.
The audio recording speech segments (who spoke when). Note that speakersTimeline and mediaChannelId are mutually exclusive, when providing speakersTimeline - mediaChannelId will not be used.
Indicates whether the provided speech segments match the media precisely or need further refinement based on the media. "Precisely" here means that segments do not deviate from the actual speech in the media by more than 100ms.
The audio recording speech segments (who spoke when).
The audio recording speech segments (who spoke when).
The start time of the segment in milliseconds from the beginning of the call.
The end time of the segment in milliseconds from the beginning of the call.
The speaking parties in the segment, each must have a correlating partyId within 'parties'. It is allowed to provide overlapping segments, i.e. you can either specify multiple speakers in a segment or send several overlapping segments each marked with one speaker.
The URL of the conference call by which users join the meeting
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.
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.
Optional workspace identifier. If specified, the call will be placed into this workspace, otherwise, the default algorithm for workspace placement will be applied.
The language code the call should be transcribed to. This field is optional as Gong automatically detects the language spoken in the call and transcribes it accordingly. Set this field only if you are sure of the language the call is in. Valid values are: af-ZA, am-ET, ar-AE, ar-BH, ar-DZ, ar-EG, ar-IL, ar-IQ, ar-JO, ar-KW, ar-LB, ar-MA, ar-MR, ar-OM, ar-PS, ar-QA, ar-SA, ar-TN, ar-YE, az-AZ, bg-BG, bn-BD, bn-IN, bs-BA, ca-ES, cs-CZ, da-DK, de-AT, de-CH, de-DE, el-GR, en-AB, en-AU, en-CA, en-GB, en-IE, en-IN, en-NZ, en-PH, en-SG, en-US, en-WL, en-ZA, es-AR, es-BO, es-CL, es-CO, es-CR, es-DO, es-EC, es-ES, es-GT, es-HN, es-MX, es-NI, es-PA, es-PE, es-PR, es-PY, es-SV, es-US, es-UY, et-EE, eu-ES, fa-IR, fi-FI, fil-PH, fr-BE, fr-CA, fr-CH, fr-FR, gl-ES, gu-IN, he-IL, hi-IN, hr-HR, hu-HU, hy-AM, id-ID, is-IS, it-CH, it-IT, ja-JP, jv-ID, ka-GE, kk-KZ, km-KH, kn-IN, ko-KR, lo-LA, lt-LT, lv-LV, mk-MK, ml-IN, mn-MN, mr-IN, ms-MY, my-MM, ne-NP, nl-BE, nl-NL, no-NO, pa-Guru-IN, pl-PL, pt-BR, pt-PT, ro-RO, ru-RU, si-LK, sk-SK, sl-SI, sq-AL, sr-RS, su-ID, sv-SE, sw-KE, sw-TZ, ta-IN, ta-LK, ta-MY, ta-SG, te-IN, th-TH, tr-TR, uk-UA, ur-IN, ur-PK, uz-UZ, vi-VN, yue-Hant-HK, zh-CN, zh-TW, zu-ZA
The Id for the task the call should be associated with
A task identifier
The Gong internal user ID of the team member who hosted the call.
Successful response
A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes.
New call ID
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.
Conflict, e.g. recording is not enabled for the primary user
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.