← Tools Reference

Chorus

Chorus integration (Communication, Data). Imported from open-connector.

API key6 toolshttps://chorus.ai
GET
chorus_get_current_user
Get details about the current Chorus API token user.

/api/v1/users/me

GET
chorus_list_teams
List Chorus teams visible to the connected API token user.

/api/v1/teams

GET
chorus_get_team
Get a specific Chorus team by ID.

/api/v1/teams/{id}

1 parameter
ParamTypeRequiredDescription
idstringrequiredThe Chorus team ID.
GET
chorus_list_engagements
List Chorus engagements with documented v3 filters and continuation pagination.

/v3/engagements

17 parameters
ParamTypeRequiredDescription
compliancestringoptionalFilter by Chorus call recording compliance flag.
continuationKeystringoptionalThe Chorus continuation_key returned by the previous page.
dispositionConnectedbooleanoptionalFilter by Chorus connected disposition.
dispositionGatekeeperbooleanoptionalFilter by Chorus gatekeeper disposition.
dispositionTreebooleanoptionalFilter by Chorus phone tree disposition.
dispositionVoicemailbooleanoptionalFilter by Chorus voicemail disposition.
engagementIdsarrayoptionalOne or more Chorus engagement IDs to retrieve.
engagementTypestringoptionalFilter by Chorus engagement type.
contentTypestringoptionalFilter by Chorus engagement content type.
maxDatestringoptionalOnly include engagements on or before this datetime.
maxDurationnumberoptionalOnly include engagements with duration at or below this number of seconds.
minDatestringoptionalOnly include engagements on or after this datetime.
minDurationnumberoptionalOnly include engagements with duration at or above this number of seconds.
participantsEmailstringoptionalFilter by a participant email address.
teamIdsarrayoptionalOne or more Chorus team IDs for engagement owners.
userIdsarrayoptionalOne or more Chorus user IDs for engagement owners.
withTrackersbooleanoptionalWhether to return tracker information with engagements.
GET
chorus_get_conversation
Get a specific Chorus conversation with optional populated fields.

/api/v1/conversations/{id}

5 parameters
ParamTypeRequiredDescription
idstringrequiredThe Chorus conversation ID to retrieve.
fieldsarrayoptionalChorus conversation fields to populate.
forceRegenerationbooleanoptionalWhether Chorus should regenerate the conversation from latest data.
skipSummaryGenerationbooleanoptionalWhether Chorus should skip summary generation.
includeMeetingMetadatabooleanoptionalWhether Chorus should include meeting metadata such as provider calendar ID and…
GET
chorus_list_scorecards
List Chorus scorecards with documented filters and page pagination.

/api/v1/scorecards

6 parameters
ParamTypeRequiredDescription
recipientIdsarrayoptionalIDs of Chorus users who were scored.
reviewerIdsarrayoptionalIDs of Chorus users who completed scorecards.
initiativeIdintegeroptionalThe Chorus initiative ID that scorecards were completed against.
submittedRangestringoptionalThe submitted datetime range in Chorus format, such as 2021-01-01T00:00:00Z:202…
pageSizeintegeroptionalThe number of scorecards to return per page. Chorus allows 1 to 100.
pageNumberintegeroptionalThe one-indexed page of scorecards to return.