Fetch conversations
GET/v2/conversations
Fetches multiple conversations. The conversations can be filtered, paged, and sorted according to the respective parameters.
Request
Query Parameters
Filter conversations by title, this validation is an exact match of the title
Filter conversations by title starting with, this validation is a partial match of the title
Returns all matching records that are less than to the provided iso8601 timestamp. The comparison is done using microsecond precision.
Returns all matching records that are less than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.
Returns all matching records that are greater than to the provided iso8601 timestamp. The comparison is done using microsecond precision.
Returns all matching records that are greater than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.
Returns all matching records that are less than to the provided iso8601 timestamp. The comparison is done using microsecond precision.
Returns all matching records that are less than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.
Returns all matching records that are greater than to the provided iso8601 timestamp. The comparison is done using microsecond precision.
Returns all matching records that are greater than or equal to the provided iso8601 timestamp. The comparison is done using microsecond precision.
Returns all matching records that are less than to the provided number of milliseconds.
Returns all matching records that are less than or equal to the provided number of milliseconds.
Returns all matching records that are greater than to the provided number of milliseconds.
Returns all matching records that are greater than or equal to the provided number of milliseconds.
Possible values: [en-AU
, en-AB
, en-GB
, en-IN
, en-IE
, en-NZ
, en-ZA
, en-US
, en-WL
, es-ES
, es-US
, nl-NL
, it-IT
, fr-FR
, fr-CA
, de-DE
, de-CH
]
Filter conversations by language code of the transcription, this is the language of the conversation
Possible values: [bluejeans
, gotomeeting
, joinme
, manual_upload
, ms_teams
, salesloft
, uberconference
, webex
, zoom
, google_meet
, external_audio
]
Filter conversations by the source platform, this is the platform where the conversation was recorded
Filter conversations by owner uuids, this is the user who owns the conversation
Filter conversations by user uuids, this is the user who recorded the conversation
Filter conversations by conversation identifiers. This parameter can be use to get multiple conversations by their identifiers
Filter conversations by account ids, this is the account that the conversation is associated with
Filter conversations by person ids, this is the person that the conversation is associated with
Filter conversations by isAPI, this is the status of the conversation if it was generated by the API. Use string booleans true or false to differentiate it
Possible values: [audio
, video
]
Filter conversations by media type, this is the type of media that the conversation is
Possible values: [asc
, desc
]
Direction to sort in, must be one of: ASC, DESC. Defaults to DESC
Possible values: [created_at
, updated_at
, duration
]
Sort by field, this is the field that the results will be sorted by. Defaults to created_at
How many records to show per page in the range [1, 100]. Defaults to 25
The current page to fetch results from. Defaults to 1
Whether to include total_pages and total_count in the metadata. Defaults to false
Responses
- 200
Success
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
UUID of the Conversation
Duration of the Conversation in milliseconds
Determines if the channel of through this Conversation was processed
Possible values: [bluejeans
, gotomeeting
, joinme
, manual_upload
, ms_teams
, salesloft
, uberconference
, webex
, zoom
, google_meet
, external_audio
]
Source of the Conversation
Possible values: [audio
, video
]
Determines if conversation is video or audio
ID of the Organization
Title of the Conversation
ID of the owner
ID of the user
Starts of the recording in milliseconds
Datetime of when the Conversation ended. The date time ISO-8601 format
Datetime of when the Conversation started. The date time ISO-8601 format
The text's BCP-47 language code, such as "en-US" or "sr-Latn".
Reference: http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
Datetime of Conversation creation. The date time ISO-8601 format
Datetime of the last Conversation update. The date time ISO-8601 format
Id of the call data record
account object
Reference to the Account
person object
Reference to the People
recording object
Reference to the Recording artifact
transcription object
Reference to the transcription
transcription_sentences object
Reference to the transcription sentences
transcription_artifact object
Reference to the transcription artifact
[
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"duration": 0,
"is_api": true,
"platform": "zoom",
"media_type": "audio",
"organization_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"title": "string",
"owner_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"user_guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"started_recording_at": 0,
"event_end_date": "2025-02-13T22:11:57.792Z",
"event_start_date": "2025-02-13T22:11:57.792Z",
"language_code": "string",
"created_at": "2025-02-13T22:11:57.792Z",
"updated_at": "2025-02-13T22:11:57.792Z",
"call_id": "string",
"account": {
"id": "string",
"_href": "string"
},
"person": {
"id": "string",
"_href": "string"
},
"recording": {
"id": "string",
"_href": "string"
},
"transcription": {
"id": "string",
"_href": "string"
},
"transcription_sentences": {
"id": "string",
"_href": "string"
},
"transcription_artifact": {
"id": "string",
"_href": "string"
}
}
]