Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.blinkops.com/llms.txt

Use this file to discover all available pages before exploring further.

List conversations matching the specified criteria. Returns all conversation if no criteria provided. Note, Responses may time out if no criteria are specified. To prevent this, you can adjust the timeout using the Timeout feature in the action’s settings.
External DocumentationTo learn more, visit the Chorus documentation.

​
Basic Parameters

ParameterDescription
Engagement IDsA comma-separated list of Engagement ID(s) to filter by.
Engagement TypeThe type of engagements to retrieve. If not specified, both types of conversations will return.
Max DateMax date of engagement to filter by.
Min DateMin date of engagement to filter by.
Participants EmailA single email address of a participant to filter by.
Return All PagesAutomatically fetch all resources, page by page.
Team IDsA comma-separated list of Team ID(s) for engagement owner to filter by.
User IDsA comma-separated list of User ID(s) for engagement owner to filter by.
With TrackersSelect to return trackers information with the results.

​
Advanced Parameters

ParameterDescription
Continuation KeyContinuation key for pagination.
Disposition ConnectedSelect to include conversations where the call was connected.
Disposition GatekeeperSelect to include conversations where the call reached a gatekeeper.
Disposition TreeSelect to include conversations where the call encountered a phone tree.
Disposition VoicemailSelect to include conversations where the call resulted in voicemail.

​
Example Output

{
	"continuation_key": "<string>",
	"engagements": [
		{
			"account_id": "<string>",
			"account_name": "<string>",
			"action_items": [
				"<string>",
				"<string>"
			],
			"compliance": "<string>",
			"date_time": 1700611861,
			"disposition_connected": null,
			"disposition_gatekeeper": null,
			"disposition_tree": null,
			"disposition_voicemail": null,
			"duration": 1590,
			"engagement_id": "<string>",
			"engagement_type": "<string>",
			"initiator": null,
			"is_video_audio": "<string>",
			"language": "<string>",
			"meeting_summary": "<string>",
			"no_show": false,
			"num_cust_questions": 8,
			"num_engaging_questions": 2,
			"opportunity_id": "<string>",
			"opportunity_name": "<string>",
			"participants": [
				{
					"company_name": "<string>",
					"email": "<string>",
					"name": "<string>",
					"person_id": 140127544,
					"title": "<string>",
					"type": "<string>",
					"user_id": 1215764
				},
				{
					"company_name": "<string>",
					"email": "<string>",
					"name": "<string>",
					"person_id": 201442668,
					"title": "<string>",
					"type": "<string>",
					"user_id": 1478347
				}
			],
			"processing_state": "<string>",
			"subject": "<string>",
			"thread_id": null,
			"url": "<string>",
			"user_email": "<string>",
			"user_id": 568499,
			"user_name": "<string>"
		},
		{
			"account_id": "<string>",
			"account_name": "<string>",
			"action_items": [
				"<string>"
			],
			"compliance": "<string>",
			"date_time": 213645864,
			"disposition_connected": null,
			"disposition_gatekeeper": null,
			"disposition_tree": null,
			"disposition_voicemail": null,
			"duration": 256,
			"engagement_id": "<string>",
			"engagement_type": "<string>",
			"initiator": null,
			"is_video_audio": "<string>",
			"language": "<string>",
			"meeting_summary": "<string>",
			"no_show": false,
			"num_cust_questions": 2,
			"num_engaging_questions": 2,
			"opportunity_id": "<string>",
			"opportunity_name": "<string>",
			"participants": [
				{
					"company_name": "<string>",
					"email": "<string>",
					"name": "<string>",
					"person_id": 93879904,
					"title": "<string>",
					"type": "<string>",
					"user_id": 456359
				},
				{
					"company_name": "<string>",
					"email": "<string>",
					"name": "<string>",
					"person_id": 158747038,
					"title": "<string>",
					"type": "<string>",
					"user_id": null
				}
			],
			"processing_state": "<string>",
			"subject": "<string>",
			"thread_id": null,
			"url": "<string>",
			"user_email": "<string>",
			"user_id": 181905,
			"user_name": "<string>"
		}
	]
}

​
Workflow Library Example

List Conversations with Chorus and Send Results Via Email
Workflow LibraryPreview this Workflow on desktop