Sign in
latestOpenAPI 3.0.32026-08-208185259.4 KB

f00047222b8f

Conversations

Get conversations

Get conversations matching the specified criteria.

get/v3/engagements

Query parameters

compliance'COMPLIANT' | 'NON-COMPLIANT' | 'UNKNOWN'

Call recording compliance flag

continuation_keystring

Continuation key for pagination

disposition_connectedboolean

Chorus disposition - connected

disposition_gatekeeperboolean

Chorus disposition - gatekeeper

disposition_treeboolean

Chorus disposition - phone tree

disposition_voicemailboolean

Chorus disposition - voicemail

engagement_idstring

Comma-separated list of engagement ids

engagement_type'meeting' | 'dialer' | 'email' | 'content_viewed' | 'unrecorded_meeting'

Type of engagement

content_type'activity' | 'email_clicked' | 'email_opened' | 'email_unsubscribed' | 'email_failed' | 'form' | 'g2' | 'highspot' | 'loom' | 'seismic' | 'showpad' | 'hellolink_viewed' | 'technology_advice' | 'trustradius' | 'netline' | 'vidyard' | 'websights_visit' | 'zi_chat' | 'unrecorded_dialer_call' | 'missed_dialer_call' | 'navattic' | 'contract_sent' | 'contract_signed' | 'contract_viewed' | 'sourceforge' | 'email_replied'

Type of engagement

max_datestring date-time

Max date of engagement

max_durationnumber float

Max duration of meeting (in seconds)

min_datestring date-time

Min date of engagement

min_durationnumber float

Min duration of meeting (in seconds)

participants_emailstring

The email address of a participant

team_idstring

Comma-separated list of Team ID(s) for engagement owner

user_idstring

Comma-separated list of User ID(s) for engagement owner

with_trackersboolean

Return tracker information with results

additional_parametersobject

Additional query parameters may be specified here as a JSON object. Note: while these parameters are specified here as a JSON object, they will end up getting passed to the API as a series of independent query parameters.

{
  "filter[foo]": "bar"
}

Response

Success