> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Gong Add Call: Inputs, Cost & CLI Example
> Add new call (/v2/calls). Gong Gong Add Call docs include request fields, response shape, pricing notes, and Deepline CLI examples.
## Run in Enrichment Spreadsheet
Use this function as a column step in `deepline enrich`.
```bash theme={null}
deepline enrich --input leads.csv --output leads.enriched.csv --with 'result=gong_add_call:{"clientUniqueId":"{{clientUniqueId}}","actualStart":"{{actualStart}}","parties":"{{parties}}","direction":"Inbound","primaryUser":"{{primaryUser}}"}' --json
```
Map payload values to spreadsheet columns with `{{column_name}}` placeholders.
## Input Schema
| Name | Type | Required | Default | Description |
| -------------------------- | ------------------------------------------------------ | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `payload.clientUniqueId` | `string` | Yes | | 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. |
| `payload.title` | `string` | No | | The title of the call. This title is available in the Gong system for indexing and search. |
| `payload.purpose` | `string` | No | | The purpose of the call. This optional field is a free text of up to 255 characters. |
| `payload.scheduledStart` | `string` | No | | 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); |
| `payload.scheduledEnd` | `string` | No | | 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); |
| `payload.actualStart` | `string` | Yes | | 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); |
| `payload.duration` | `number` | No | | The actual call duration in seconds. |
| `payload.parties` | `array` | Yes | | A list of the call's participants. A party must be provided for the primaryUser. |
| `payload.direction` | `"Inbound" \| "Outbound" \| "Conference" \| "Unknown"` | Yes | | Whether the call is inbound (someone called the company), outbound (a rep dialed someone outside the company), or a conference call. |
| `payload.disposition` | `string` | No | | The disposition of the call. The disposition is free text of up to 255 characters. |
| `payload.context` | `array` | No | | A list of references to external systems such as CRM, Telephony System, Case Management, etc. |
| `payload.customData` | `string` | No | | Optional metadata associated with the call (represented as text). Gong stores this metadata and it can be used for troubleshooting. |
| `payload.speakersTimeline` | `object` | No | | The audio recording speech segments (who spoke when). Note that speakersTimeline and mediaChannelId are mutually exclusive, when providing speakersTimeline - mediaChannelId will not be used. |
| `payload.meetingUrl` | `string` | No | | The URL of the conference call by which users join the meeting |
| `payload.callProviderCode` | `string` | No | | 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](mailto:help@gong.io) to find the proper value for your system. |
| `payload.downloadMediaUrl` | `string` | No | | 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. |
| `payload.workspaceId` | `string` | No | | Optional workspace identifier. If specified, the call will be placed into this workspace, otherwise, the default algorithm for workspace placement will be applied. |
| `payload.languageCode` | `string` | No | | 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 |
| `payload.flowContext` | `object` | No | | The Id for the task the call should be associated with |
| `payload.primaryUser` | `string` | Yes | | The Gong internal user ID of the team member who hosted the call. |
### Allowed values
| Field | Allowed values |
| ------------------- | ---------------------------------------------- |
| `payload.direction` | `Inbound`, `Outbound`, `Conference`, `Unknown` |
Show raw input schema
### Input JSON Schema
```json theme={null}
{
"type": "object",
"description": "New call metadata",
"properties": {
"clientUniqueId": {
"type": "string",
"description": "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.",
"minLength": 0,
"maxLength": 2048
},
"title": {
"type": "string",
"description": "The title of the call. This title is available in the Gong system for indexing and search."
},
"purpose": {
"type": "string",
"description": "The purpose of the call. This optional field is a free text of up to 255 characters.",
"minLength": 0,
"maxLength": 255
},
"scheduledStart": {
"type": "string",
"description": "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);"
},
"scheduledEnd": {
"type": "string",
"description": "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);"
},
"actualStart": {
"type": "string",
"description": "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);"
},
"duration": {
"type": "number",
"description": "The actual call duration in seconds.",
"format": "float"
},
"parties": {
"type": "array",
"description": "A list of the call's participants. A party must be provided for the primaryUser.",
"minItems": 1,
"maxItems": 2147483647,
"items": {
"type": "object",
"description": "A list of the call's participants. A party must be provided for the primaryUser.",
"properties": {
"phoneNumber": {
"type": "string",
"description": "The phone number of the party, if available."
},
"emailAddress": {
"type": "string",
"description": "The email address of the party, if available."
},
"name": {
"type": "string",
"description": "The name of the party, if available."
},
"partyId": {
"type": "string",
"description": "An identifier that is only required when speakersTimeline is provided. The partyId is used to recognize the speakers within the provided speakersTimeline."
},
"mediaChannelId": {
"type": "integer",
"description": "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)",
"minimum": 0,
"maximum": 1,
"format": "int32"
},
"context": {
"type": "array",
"description": "A list of links to external systems such as CRM, Telephony System, Case Management, etc.",
"items": {
"type": "object",
"description": "Links to external systems such as CRM, Telephony System, Case Management etc. Currently only Salesforce and Generic are supported.",
"properties": {
"system": {
"type": "string",
"description": "External system name. Currently only Salesforce and Generic are supported.",
"enum": [
"Salesforce",
"HubSpot",
"MicrosoftDynamic",
"Generic"
]
},
"objects": {
"type": "array",
"description": "List of objects within the external system",
"items": {
"type": "object",
"description": "External object associated with the party",
"properties": {
"objectType": {
"type": "string",
"description": "Object Type. Valid only for non-company parties. e.g. Lead.",
"enum": [
"Lead",
"Contact",
"Account",
"Opportunity",
"User",
"Lead,Contact"
]
},
"objectId": {
"type": "string",
"description": "Object ID. For Salesforce both case-sensitive and case-insensitive formats are supported."
},
"fields": {
"type": "array",
"description": "Object fields. Intended for future use only.",
"items": {
"type": "object",
"description": "External object data",
"properties": {
"name": {
"type": "string",
"description": "Field name"
},
"value": {
"type": "object",
"description": "Object value"
}
},
"additionalProperties": false
}
}
},
"required": [
"objectId",
"objectType"
],
"additionalProperties": false
}
}
},
"required": [
"system"
],
"additionalProperties": false
}
},
"userId": {
"type": "string",
"description": "The user ID of the participant within the Gong system, if the participant is a user."
}
},
"additionalProperties": false
}
},
"direction": {
"type": "string",
"description": "Whether the call is inbound (someone called the company), outbound (a rep dialed someone outside the company), or a conference call.",
"enum": [
"Inbound",
"Outbound",
"Conference",
"Unknown"
]
},
"disposition": {
"type": "string",
"description": "The disposition of the call. The disposition is free text of up to 255 characters.",
"minLength": 0,
"maxLength": 255
},
"context": {
"type": "array",
"description": "A list of references to external systems such as CRM, Telephony System, Case Management, etc.",
"items": {
"type": "object",
"description": "Links to external systems such as CRM, Telephony System, Case Management etc. Currently only Salesforce and Generic are supported.",
"properties": {
"system": {
"type": "string",
"description": "External system name. Currently only Salesforce and Generic are supported.",
"enum": [
"Salesforce",
"HubSpot",
"MicrosoftDynamic",
"Generic"
]
},
"objects": {
"type": "array",
"description": "List of objects within the external system. Note: Multiple opportunities/deals belonging to the same account are not supported.",
"items": {
"type": "object",
"description": "External object associated with the call",
"properties": {
"objectType": {
"type": "string",
"description": "Object Type. e.g. Account.",
"enum": [
"Opportunity",
"Account",
"Lead",
"Contact",
"User",
"Opportunity,Account"
]
},
"objectId": {
"type": "string",
"description": "Object ID. For Salesforce both case-sensitive and case-insensitive formats are supported."
},
"fields": {
"type": "array",
"description": "Object fields. Intended for future use only.",
"items": {
"type": "object",
"description": "External object data",
"properties": {
"name": {
"type": "string",
"description": "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."
},
"value": {
"type": "object",
"description": "Field value"
}
},
"additionalProperties": false
}
}
},
"required": [
"objectId",
"objectType"
],
"additionalProperties": false
}
}
},
"required": [
"system"
],
"additionalProperties": false
}
},
"customData": {
"type": "string",
"description": "Optional metadata associated with the call (represented as text). Gong stores this metadata and it can be used for troubleshooting."
},
"speakersTimeline": {
"type": "object",
"description": "The audio recording speech segments (who spoke when). Note that speakersTimeline and mediaChannelId are mutually exclusive, when providing speakersTimeline - mediaChannelId will not be used.",
"properties": {
"precise": {
"type": "boolean",
"description": "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."
},
"speechSegments": {
"type": "array",
"description": "The audio recording speech segments (who spoke when).",
"items": {
"type": "object",
"description": "The audio recording speech segments (who spoke when).",
"properties": {
"fromTime": {
"type": "integer",
"description": "The start time of the segment in milliseconds from the beginning of the call.",
"minimum": 0,
"format": "int32"
},
"toTime": {
"type": "integer",
"description": "The end time of the segment in milliseconds from the beginning of the call.",
"minimum": 0,
"format": "int32"
},
"partyIds": {
"type": "array",
"description": "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.",
"items": {
"type": "string",
"description": "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."
}
}
},
"required": [
"fromTime",
"partyIds",
"toTime"
],
"additionalProperties": false
}
}
},
"additionalProperties": false
},
"meetingUrl": {
"type": "string",
"description": "The URL of the conference call by which users join the meeting"
},
"callProviderCode": {
"type": "string",
"description": "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."
},
"downloadMediaUrl": {
"type": "string",
"description": "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."
},
"workspaceId": {
"type": "string",
"description": "Optional workspace identifier. If specified, the call will be placed into this workspace, otherwise, the default algorithm for workspace placement will be applied."
},
"languageCode": {
"type": "string",
"description": "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"
},
"flowContext": {
"type": "object",
"description": "The Id for the task the call should be associated with",
"properties": {
"taskId": {
"type": "string",
"description": "A task identifier"
}
},
"additionalProperties": false
},
"primaryUser": {
"type": "string",
"description": "The Gong internal user ID of the team member who hosted the call."
}
},
"required": [
"actualStart",
"clientUniqueId",
"direction",
"parties",
"primaryUser"
],
"additionalProperties": false
}
```
## Output Schema
| Name | Type | Required | Default | Description |
| ------------- | -------- | -------- | ------- | ---------------------------------------------- |
| `result.data` | `object` | Yes | | Provider response payload. |
| `result.meta` | `object` | No | | Additional response metadata (status, paging). |
Show raw output schema
### Output JSON Schema
```json theme={null}
{
"type": "object",
"description": "Standard tool result payload.",
"properties": {
"data": {
"type": "object",
"description": "Provider response payload.",
"properties": {
"requestId": {
"type": "string",
"description": "A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes."
},
"callId": {
"type": "string",
"description": "New call ID"
}
},
"additionalProperties": false
},
"meta": {
"type": "object",
"description": "Additional response metadata (status, paging).",
"additionalProperties": true
}
},
"required": [
"data"
],
"additionalProperties": false
}
```
## Advanced: Direct CLI
Use direct execution for single payload debugging.
```bash theme={null}
deepline tools execute gong_add_call --payload '{
"clientUniqueId": "string",
"actualStart": "string",
"parties": "array",
"direction": "Inbound",
"primaryUser": "string"
}' --json
```
### CLI flags
| Flag | Description |
| --------------------------- | --------------------------------------------------- |
| `--json` | Print machine-readable output. |
| `--wait` | Wait for terminal provider status when supported. |
| `--debug` | Enable wait mode with additional status/log output. |
| `--wait-timeout SECONDS` | Max seconds to wait in wait mode. |
| `--poll-interval SECONDS` | Polling interval in seconds during wait mode. |
| `--timeout SECONDS` | Request timeout in seconds. |
| `--connect-timeout SECONDS` | Connection timeout in seconds. |
## Cost
* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.
* Billing mode: `no_bill`.