Chorus Recordings & Transcripts API
Upload recordings, retrieve media files, transcripts and AI-generated insights, and build coaching moments, playlists and scorecards. A capability area of the single published Chorus API contract.
OpenAPI Specification
components:
parameters: {}
responses:
BadRequest:
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/Error'
description: Bad request
Conflict:
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/Error'
description: Conflict
NotFound:
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/Error'
description: Not found
schemas:
AnyValue:
description: Can be any value.
BulkProcessConversationsRequest:
properties:
create:
items:
properties:
attributes:
properties:
activity_type:
nullable: true
type: string
content:
nullable: true
type: string
crm:
nullable: true
properties:
account_name:
type: string
ext_id:
nullable: true
type: string
ext_type:
nullable: true
type: string
match_reason:
nullable: true
type: string
opportunity_id:
nullable: true
type: string
required:
- account_name
type: object
duration:
nullable: true
type: number
end_time:
example: '2021-01-01T00:00:00Z'
nullable: true
type: string
external_id:
nullable: true
type: string
external_url:
nullable: true
type: string
named_tags:
nullable: true
properties: {}
type: object
owner:
nullable: true
properties:
company:
nullable: true
type: string
company_domain:
nullable: true
type: string
email:
nullable: true
type: string
first_name:
nullable: true
type: string
force_auto_provision:
nullable: true
type: boolean
id:
nullable: true
type: integer
last_name:
nullable: true
type: string
name:
nullable: true
type: string
phone:
nullable: true
type: string
role:
nullable: true
type: string
title:
nullable: true
type: string
zi_company_id:
nullable: true
type: string
zi_person_id:
nullable: true
type: string
type: object
participants:
items:
properties:
company:
nullable: true
type: string
company_domain:
nullable: true
type: string
email:
nullable: true
type: string
first_name:
nullable: true
type: string
force_auto_provision:
nullable: true
type: boolean
id:
nullable: true
type: integer
last_name:
nullable: true
type: string
name:
nullable: true
type: string
phone:
nullable: true
type: string
role:
nullable: true
type: string
title:
nullable: true
type: string
zi_company_id:
nullable: true
type: string
zi_person_id:
nullable: true
type: string
type: object
nullable: true
type: array
related_conversation:
nullable: true
type: string
related_external_id:
nullable: true
type: string
related_meeting:
nullable: true
type: string
related_start_time:
example: '2021-01-01T00:00:00Z'
nullable: true
type: string
source:
type: string
start_time:
example: '2021-01-01T00:00:00Z'
type: string
status:
nullable: true
type: string
subject:
nullable: true
type: string
tags:
items:
type: string
nullable: true
type: array
required:
- source
- start_time
type: object
type:
description: The type of resource.
enum:
- activity
- email
- form
- recording
example: activity
title: Type
type: string
required:
- attributes
- type
type: object
nullable: true
type: array
delete:
items:
type: string
nullable: true
type: array
meta:
nullable: true
properties:
force_delete:
nullable: true
type: boolean
type: object
type: object
BulkProcessConversationsResponse:
properties:
create:
items:
properties:
attributes:
properties:
status:
readOnly: true
type: string
required:
- status
type: object
id:
description: The unique ID of the task.
example: '123'
title: ID
type: string
type:
description: The type of resource.
enum:
- task
example: task
title: Type
type: string
required:
- attributes
- type
- id
type: object
nullable: true
type: array
delete:
items:
properties:
attributes:
properties:
status:
readOnly: true
type: string
required:
- status
type: object
id:
description: The unique ID of the task.
example: '123'
title: ID
type: string
type:
description: The type of resource.
enum:
- task
example: task
title: Type
type: string
required:
- attributes
- type
- id
type: object
nullable: true
type: array
type: object
Conversation:
properties:
attributes:
properties:
_created_at:
example: '2021-01-01T00:00:00Z'
nullable: true
readOnly: true
type: string
_modified_at:
example: '2021-01-01T00:00:00Z'
nullable: true
readOnly: true
type: string
account:
properties:
ext_id:
nullable: true
type: string
id:
type: integer
name:
type: string
type:
nullable: true
type: string
zi_company_id:
nullable: true
type: string
required:
- id
- name
type: object
action_items:
items:
type: string
nullable: true
type: array
company_name:
nullable: true
type: string
custom_questions:
items:
$ref: '#/components/schemas/AnyValue'
nullable: true
type: array
custom_summaries:
items:
$ref: '#/components/schemas/AnyValue'
nullable: true
type: array
deal:
properties:
close_date:
example: '2021-01-01T00:00:00Z'
nullable: true
type: string
current_stage:
nullable: true
type: string
engaged:
nullable: true
type: string
follow_up:
nullable: true
properties:
doc_type:
type: string
id:
type: string
start_time:
example: '2021-01-01T00:00:00Z'
type: string
thread_id:
$ref: '#/components/schemas/AnyValue'
nullable: true
required:
- doc_type
- id
- start_time
type: object
id:
nullable: true
type: string
initial_amount:
nullable: true
type: number
initial_stage:
nullable: true
type: string
name:
nullable: true
type: string
on_stage_since:
example: '2021-01-01T00:00:00Z'
nullable: true
type: string
size:
nullable: true
type: integer
size_increased_amount:
$ref: '#/components/schemas/AnyValue'
nullable: true
stage_advancement:
nullable: true
type: string
type: object
disposition:
nullable: true
properties:
Task___CallDisposition:
$ref: '#/components/schemas/AnyValue'
nullable: true
connected:
$ref: '#/components/schemas/AnyValue'
nullable: true
gatekeeper:
$ref: '#/components/schemas/AnyValue'
nullable: true
tree:
$ref: '#/components/schemas/AnyValue'
nullable: true
voicemail:
$ref: '#/components/schemas/AnyValue'
nullable: true
type: object
generated_subject:
nullable: true
type: string
language:
nullable: true
type: string
meeting:
nullable: true
properties:
calendar_id:
nullable: true
type: string
ical_uid:
nullable: true
type: string
id:
type: string
meeting_url:
nullable: true
type: string
required:
- id
type: object
meta:
nullable: true
properties:
offset:
type: integer
viewed:
example: '2021-01-01T00:00:00Z'
type: string
required:
- viewed
- offset
type: object
metrics:
items:
properties:
name:
type: string
value:
type: number
required:
- name
- value
type: object
nullable: true
type: array
name:
nullable: true
type: string
owner:
properties:
email:
type: string
name:
type: string
person_id:
type: integer
user_id:
type: integer
required:
- email
- name
- person_id
- user_id
type: object
participants:
items:
properties:
company_name:
nullable: true
type: string
email:
nullable: true
type: string
is_my_team:
nullable: true
type: boolean
name:
type: string
person_id:
type: integer
picture:
nullable: true
type: string
title:
nullable: true
type: string
type:
type: string
user_id:
nullable: true
type: integer
zi_person_id:
nullable: true
type: integer
required:
- name
- person_id
- type
type: object
nullable: true
type: array
private:
nullable: true
type: boolean
recap:
items:
type: string
nullable: true
type: array
source:
nullable: true
type: string
status:
default: unknown
enum:
- done
- live
- no show
- processing
- unknown
- scheduled
example: done
type: string
summary:
nullable: true
type: string
summary_error:
nullable: true
type: string
tracker_match:
nullable: true
type: string
user_company_name:
nullable: true
type: string
required:
- account
- deal
- owner
- status
type: object
id:
description: The unique ID of the conversation.
example: 423295C52B954F5D09E23D7A014546F6
title: ID
type: string
type:
description: The type of resource.
enum:
- conversation
example: conversation
title: Type
type: string
required:
- attributes
- type
- id
type: object
ConversationDoc:
properties:
data:
$ref: '#/components/schemas/Conversation'
required:
- data
type: object
Email:
properties:
attributes:
properties:
_created_at:
example: '2021-01-01T00:00:00Z'
nullable: true
readOnly: true
type: string
_modified_at:
example: '2021-01-01T00:00:00Z'
nullable: true
readOnly: true
type: string
account:
properties:
ext_id:
nullable: true
type: string
id:
type: integer
name:
type: string
type:
nullable: true
type: string
zi_company_id:
nullable: true
type: string
required:
- id
- name
type: object
action_items:
items:
type: string
nullable: true
type: array
company_name:
nullable: true
type: string
custom_questions:
items:
$ref: '#/components/schemas/AnyValue'
nullable: true
type: array
custom_summaries:
items:
$ref: '#/components/schemas/AnyValue'
nullable: true
type: array
deal:
properties:
close_date:
example: '2021-01-01T00:00:00Z'
nullable: true
type: string
current_stage:
nullable: true
type: string
engaged:
nullable: true
type: string
follow_up:
nullable: true
properties:
doc_type:
type: string
id:
type: string
start_time:
example: '2021-01-01T00:00:00Z'
type: string
thread_id:
$ref: '#/components/schemas/AnyValue'
nullable: true
required:
- doc_type
- id
- start_time
type: object
id:
nullable: true
type: string
initial_amount:
nullable: true
type: number
initial_stage:
nullable: true
type: string
name:
nullable: true
type: string
on_stage_since:
example: '2021-01-01T00:00:00Z'
nullable: true
type: string
size:
nullable: true
type: integer
size_increased_amount:
$ref: '#/components/schemas/AnyValue'
nullable: true
stage_advancement:
nullable: true
type: string
type: object
disposition:
nullable: true
properties:
Task___CallDisposition:
$ref: '#/components/schemas/AnyValue'
nullable: true
connected:
$ref: '#/components/schemas/AnyValue'
nullable: true
gatekeeper:
$ref: '#/components/schemas/AnyValue'
nullable: true
tree:
$ref: '#/components/schemas/AnyValue'
nullable: true
voicemail:
$ref: '#/components/schemas/AnyValue'
nullable: true
type: object
email:
properties:
body:
type: string
initiator:
properties:
email:
type: string
name:
type: string
required:
- name
- email
type: object
sent_time:
example: '2021-01-01T00:00:00Z'
type: string
thread:
type: string
required:
- sent_time
- body
- initiator
- thread
type: object
generated_subject:
nullable: true
type: string
language:
nullable: true
type: string
meeting:
nullable: true
properties:
calendar_id:
nullable: true
type: string
ical_uid:
nullable: true
type: string
id:
type: string
meeting_url:
nullable: true
type: string
required:
- id
type: object
meta:
nullable: true
properties:
offset:
type: integer
viewed:
example: '2021-01-01T00:00:00Z'
type: string
required:
- viewed
- offset
type: object
metrics:
items:
properties:
name:
type: string
value:
type: number
required:
- name
- value
type: object
nullable: true
type: array
name:
nullable: true
type: string
owner:
properties:
email:
type: string
name:
type: string
person_id:
type: integer
user_id:
type: integer
required:
- email
- name
- person_id
- user_id
type: object
participants:
items:
properties:
company_name:
nullable: true
type: string
email:
nullable: true
type: string
is_my_team:
nullable: true
type: boolean
name:
type: string
person_id:
type: integer
picture:
nullable: true
type: string
title:
nullable: true
type: string
type:
type: string
user_id:
nullable: true
type: integer
zi_person_id:
nullable: true
type: integer
required:
- name
- person_id
- type
type: object
nullable: true
type: array
private:
nullable: true
type: boolean
recap:
items:
type: string
nullable: true
type: array
source:
nullable: true
type: string
status:
default: unknown
enum:
- done
- live
- no show
- processing
- unknown
- scheduled
example: done
type: string
summary:
nullable: true
type: string
summary_error:
nullable: true
type: string
tracker_match:
nullable: true
type: string
user_company_name:
nullable: true
type: string
required:
- account
- deal
- owner
- status
- email
type: object
id:
description: The unique ID of the email.
example: '123'
title: ID
type: string
type:
description: The type of resource.
enum:
- email
example: email
title: Type
type: string
required:
- attributes
- type
- id
type: object
EmailDoc:
properties:
data:
$ref: '#/components/schemas/Email'
required:
- data
type: object
EmailThread:
properties:
attributes:
properties:
deleted:
default: false
type: boolean
deleted_at:
example: '2021-01-01T00:00:00Z'
nullable: true
type: string
deleted_by:
nullable: true
properties:
name:
type: string
person_id:
type: integer
user_id:
type: integer
required:
- name
- person_id
- user_id
type: object
private:
default: false
type: boolean
required:
- private
- deleted
type: object
id:
description: The unique ID of the email thread.
example: '123'
title: ID
type: string
type:
description: The type of resource.
enum:
- email_thread
example: email_thread
title: Type
type: string
required:
- attributes
- type
- id
type: object
EmailThreadDoc:
properties:
data:
$ref: '#/components/schemas/EmailThread'
required:
- data
type: object
EngagementFilter:
properties:
attributes:
properties:
field_type:
type: string
filter_name:
type: string
filter_type:
type: string
filter_values:
default: 'null'
nullable: true
type: string
required:
- filter_name
- filter_type
- field_type
type: object
id:
description: The unique ID of the engagement filter.
example: '123'
title: ID
type: string
type:
description: The type of resource.
enum:
- engagement_filter
example: engagement_filter
title: Type
type: string
required:
- attributes
- type
- id
type: object
EngagementFilterDoc:
properties:
data:
$ref: '#/components/schemas/EngagementFilter'
required:
- data
type: object
EngagementFilterEdit:
properties:
attributes:
properties:
field_type:
nullable: true
type: string
filter_name:
nullable: true
type: string
filter_type:
nullable: true
type: string
filter_values:
nullable: true
type: string
type: object
id:
description: The unique ID of the engagement filter edit.
example: '123'
title: ID
type: string
type:
description: The type of resource.
enum:
- engagement_filter_edit
example: engagement_filter_edit
title: Type
type: string
required:
- attributes
- type
- id
type: object
EngagementFilterEditDoc:
properties:
data:
$ref: '#/components/schemas/EngagementFilterEdit'
required:
- data
type: object
EngagementFilterForCreate:
properties:
attributes:
properties:
field_type:
type: string
filter_name:
type: string
filter_type:
type: string
filter_values:
default: 'null'
nullable: true
type: string
required:
- filter_name
- filter_type
- field_type
type: object
type:
description: The type of resource.
enum:
- engagement_filter
example: engagement_filter
title: Type
type: string
required:
- attributes
- type
type: object
EngagementFilterForCreateDoc:
properties:
data:
$ref: '#/components/schemas/EngagementFilterForCreate'
required:
- data
type: object
EngagementFiltersDoc:
properties:
data:
items:
$ref: '#/components/schemas/EngagementFilter'
type: array
required:
- data
type: object
Error:
properties:
errors:
items:
properties:
code:
nullable: true
type: string
detail:
nullable: true
type: string
id:
nullable: true
type: string
source:
nullable: true
properties:
cookie:
nullable: true
type: string
header:
nullable: true
type: string
parameter:
nullable: true
type: string
path:
nullable: true
type: string
pointer:
nullable: true
type: string
type: object
status:
nullable: true
type: string
title:
nullable: true
type: string
type: object
type: array
required:
- errors
type: object
ExportScorecardsBody:
properties:
notify:
default: true
type: boolean
required:
- notify
type: object
FrameworkConfiguration:
properties:
attributes:
properties:
fields:
items:
properties:
display_name:
type: string
id:
type: string
mapping:
nullable: true
type: string
order:
type: integer
write_back:
# --- truncated at 32 KB (182 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/chorus-ai/refs/heads/main/openapi/chorus-ai-openapi.yml