{ "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": { "enum": [ "APPEND", "OVERWRITE" ], "example": "APPEND", "nullable": true, "type": "string" } }, "required": [ "display_name", "id", "order" ], "type": "object" }, "type": "array" }, "is_active": { "type": "boolean" } }, "required": [ "is_active", "fields" ], "type": "object" }, "id": { "description": "The unique ID of the sales qualification configuration.", "example": "123", "title": "ID", "type": "string" }, "type": { "description": "The type of resource.", "enum": [ "sales_qualification_configuration" ], "example": "sales_qualification_configuration", "title": "Type", "type": "string" } }, "required": [ "attributes", "type", "id" ], "type": "object" }, "FrameworkConfigurationDoc": { "properties": { "data": { "$ref": "#/components/schemas/FrameworkConfiguration" } }, "required": [ "data" ], "type": "object" }, "FrameworkConfigurationsDoc": { "properties": { "data": { "items": { "$ref": "#/components/schemas/FrameworkConfiguration" }, "type": "array" } }, "required": [ "data" ], "type": "object" }, "MeetingAutojoin": { "properties": { "attributes": { "properties": { "autojoin": { "type": "boolean" }, "autojoin_reason": { "nullable": true, "type": "string" }, "recordable": { "type": "boolean" } }, "required": [ "autojoin", "recordable" ], "type": "object" }, "id": { "description": "The unique ID of the meeting autojoin.", "example": "123", "title": "ID", "type": "string" }, "type": { "description": "The type of resource.", "enum": [ "meeting_autojoin" ], "example": "meeting_autojoin", "title": "Type", "type": "string" } }, "required": [ "attributes", "type", "id" ], "type": "object" }, "MeetingAutojoinDoc": { "properties": { "data": { "$ref": "#/components/schemas/MeetingAutojoin" } }, "required": [ "data" ], "type": "object" }, "MeetingValidation": { "properties": { "details": { "example": "Please ensure your computer or mobile", "nullable": true, "type": "string" }, "id": { "example": "iakjvi1fjfff", "type": "string" }, "link": { "example": "https://zoominfo.zoom.us/j/95944577110", "type": "string" }, "location": { "example": "The Office", "nullable": true, "type": "string" }, "participants": { "example": [ "first@participant.com", "second@other.com" ], "items": { "type": "string" }, "type": "array" }, "start_time": { "example": "2021-01-31T00:00:00Z", "type": "string" }, "subject": { "example": "Gameplan on extension", "type": "string" } }, "required": [ "id", "subject", "participants", "link", "start_time" ], "type": "object" }, "Moment": { "properties": { "attributes": { "properties": { "account": { "nullable": true, "properties": { "id": { "nullable": true, "type": "string" }, "name": { "nullable": true, "type": "string" } }, "type": "object" }, "asr": { "nullable": true, "type": "string" }, "conversation": { "nullable": true, "type": "string" }, "creator": { "nullable": true, "properties": { "company": { "nullable": true, "type": "string" }, "id": { "nullable": true, "type": "string" }, "name": { "nullable": true, "type": "string" }, "picture": { "nullable": true, "type": "string" } }, "type": "object" }, "duration": { "nullable": true, "type": "number" }, "expiration_date": { "example": "2021-01-01T00:00:00Z", "nullable": true, "type": "string" }, "internal_only": { "default": false, "nullable": true, "type": "boolean" }, "link": { "nullable": true, "type": "string" }, "logo": { "nullable": true, "type": "string" }, "logo_bg": { "nullable": true, "type": "string" }, "note": { "nullable": true, "type": "string" }, "opportunity": { "nullable": true, "properties": { "amount": { "nullable": true, "type": "number" }, "close_date": { "example": "2021-01-01T00:00:00Z", "nullable": true, "type": "string" }, "id": { "nullable": true, "type": "string" }, "initial_amount": { "nullable": true, "type": "number" }, "name": { "nullable": true, "type": "string" }, "on_stage_since": { "example": "2021-01-01T00:00:00Z", "nullable": true, "type": "string" }, "owner_name": { "nullable": true, "type": "string" }, "stage": { "nullable": true, "type": "string" } }, "type": "object" }, "password": { "nullable": true, "type": "string" }, "read_receipts": { "default": false, "nullable": true, "type": "boolean" }, "recording_duration": { "nullable": true, "type": "number" }, "share_email_address_required": { "default": true, "nullable": true, "type": "boolean" }, "shared_on": { "example": "2021-01-01T00:00:00Z", "nullable": true, "type": "string" }, "speaker": { "nullable": true, "properties": { "email": { "nullable": true, "type": "string" }, "id": { "nullable": true, "type": "string" }, "name": { "nullable": true, "type": "string" }, "type": { "nullable": true, "type": "string" } }, "type": "object" }, "start": { "nullable": true, "type": "number" }, "start_time": { "example": "2021-01-01T00:00:00Z", "nullable": true, "type": "string" }, "subject": { "nullable": true, "type": "string" }, "thumbnail_link": { "nullable": true, "type": "string" }, "time": { "example": "2021-01-01T00:00:00Z", "nullable": true, "type": "string" }, "url_string": { "nullable": true, "type": "string" }, "user": { "nullable": true, "properties": { "email": { "nullable": true, "type": "string" }, "id": { "nullable": true, "type": "string" }, "name": { "nullable": true, "type": "string" }, "picture": { "nullable": true, "type": "string" } }, "type": "object" }, "video_link": { "nullable": true, "type": "string" }, "video_upload_time": { "example": "2021-01-01T00:00:00Z", "nullable": true, "type": "string" } }, "type": "object" }, "id": { "description": "The unique ID of the moment.", "example": "123", "title": "ID", "type": "string" }, "type": { "description": "The type of resource.", "enum": [ "moment" ], "example": "moment", "title": "Type", "type": "string" } }, "required": [ "attributes", "type", "id" ], "type": "object" }, "MomentCreateRequestForCreate": { "properties": { "attributes": { "properties": { "callid": { "type": "string" }, "expiration_date": { "example": "2021-01-01T00:00:00Z", "nullable": true, "type": "string" }, "moment_duration": { "type": "number" }, "moment_time": { "type": "number" }, "note": { "default": "", "nullable": true, "type": "string" }, "password": { "nullable": true, "type": "string" }, "subject": { "default": "", "nullable": true, "type": "string" }, "url_string": { "default": "", "nullable": true, "type": "string" } }, "required": [ "callid", "moment_time", "moment_duration" ], "type": "object" }, "type": { "description": "The type of resource.", "enum": [ "moment_create_request" ], "example": "moment_create_request", "title": "Type", "type": "string" } }, "required": [ "attributes", "type" ], "type": "object" }, "MomentCreateRequestForCreateDoc": { "properties": { "data": { "$ref": "#/components/schemas/MomentCreateRequestForCreate" } }, "required": [ "data" ], "type": "object" }, "MomentDoc": { "properties": { "data": { "$ref": "#/components/schemas/Moment" } }, "required": [ "data" ], "type": "object" }, "MomentEditRequest": { "properties": { "attributes": { "properties": { "expiration_date": { "example": "2021-01-01T00:00:00Z", "nullable": true, "type": "string" }, "moment_duration": { "nullable": true, "type": "number" }, "moment_time": { "nullable": true, "type": "number" }, "note": { "default": "", "nullable": true, "type": "string" }, "password": { "nullable": true, "type": "string" }, "subject": { "default": "", "nullable": true, "type": "string" }, "url_string": { "default": "", "nullable": true, "type": "string" } }, "type": "object" }, "id": { "description": "The unique ID of the moment edit request.", "example": "123", "title": "ID", "type": "string" }, "type": { "description": "The type of resource.", "enum": [ "moment_edit_request" ], "example": "moment_edit_request", "title": "Type", "type": "string" } }, "required": [ "attributes", "type", "id" ], "type": "object" }, "MomentEditRequestDoc": { "properties": { "data": { "$ref": "#/components/schemas/MomentEditRequest" } }, "required": [ "data" ], "type": "object" }, "MomentForPatch": { "properties": { "attributes": { "properties": { "description": { "nullable": true, "type": "string" }, "playlist": { "nullable": true, "type": "integer" } }, "type": "object" }, "id": { "description": "The unique ID of the playlist moment.", "example": "123", "title": "ID", "type": "string" }, "type": { "description": "The type of resource.", "enum": [ "playlist_moment" ], "example": "playlist_moment", "title": "Type", "type": "string" } }, "required": [ "attributes", "type", "id" ], "type": "object" }, "MomentForPatchDoc": { "properties": { "data": { "$ref": "#/components/schemas/MomentForPatch" } }, "required": [ "data" ], "type": "object" }, "MomentsDoc": { "properties": { "data": { "items": { "$ref": "#/components/schemas/Moment" }, "type": "array" } }, "required": [ "data" ], "type": "object" }, "Playlist": { "properties": { "attributes": { "properties": { "_created_at": { "example": "2021-01-01T00:00:00Z", "readOnly": true, "type": "string" }, "_modified_at": { "example": "2021-01-01T00:00:00Z", "nullable": true, "readOnly": true, "type": "string" }, "_modified_by": { "nullable": true, "readOnly": true, "type": "integer" }, "child_count": { "readOnly": true, "type": "integer" }, "description": { "nullable": true, "type": "string" }, "name": { "type": "string" }, "owner": { "nullable": true, "properties": { "name": { "readOnly": true, "type": "string" }, "person_id": { "readOnly": true, "type": "integer" }, "user_id": { "type": "integer" } }, "required": [ "name", "person_id", "user_id" ], "type": "object" }, "parent": { "nullable": true, "type": "integer" }, "path": { "items": { "properties": { "id": { "readOnly": true, "type": "string" }, "name": { "readOnly": true, "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "nullable": true, "type": "array" }, "private": { "readOnly": true, "type": "boolean" }, "size": { "readOnly": true, "type": "integer" } }, "required": [ "child_count", "_created_at", "name", "private", "size" ], "type": "object" }, "id": { "description": "The unique ID of the playlist.", "example": "123", "title": "ID", "type": "string" }, "type": { "description": "The type of resource.", "enum": [ "playlist" ], "example": "playlist", "title": "Type", "type": "string" } }, "required": [ "attributes", "type", "id" ], "type": "object" }, "PlaylistDoc": { "properties": { "data": { "$ref": "#/components/schemas/Playlist" } }, "required": [ "data" ], "type": "object" }, "PlaylistForCreating": { "properties": { "attributes": { "properties": { "description": { "example": "My first playlist description.", "nullable": true, "type": "string" }, "name": { "example": "My first playlist", "type": "string" }, "parent": { "nullable": true, "type": "integer" } }, "required": [ "name" ], "type": "object" }, "type": { "description": "The type of resource.", "enum": [ "playlist" ], "example": "playlist", "title": "Type", "type": "string" } }, "required": [ "attributes", "type" ], "type": "object" }, "PlaylistForCreatingDoc": { "properties": { "data": { "$ref": "#/components/schemas/PlaylistForCreating" } }, "required": [ "data" ], "type": "object" }, "PlaylistMoment": { "properties": { "attributes": { "properties": { "_created_at": { "example": "2021-01-01T00:00:00Z", "readOnly": true, "type": "string" }, "_created_by": { "readOnly": true, "type": "integer" }, "account": { "properties": { "id": { "type": "integer" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "call_id": { "type": "string" }, "date_time": { "example": "2021-01-01T00:00:00Z", "type": "string" }, "description": { "type": "string" }, "meta": { "properties": { "is_new": { "type": "boolean" }, "was_played": { "type": "boolean" } }, "required": [ "is_new", "was_played" ], "type": "object" }, "moment_duration": { "type": "integer" }, "recording": { "properties": { "duration": { "type": "number" }, "owner": { "type": "integer" } }, "required": [ "duration", "owner" ], "type": "object" }, "snippet_time": { "type": "integer" }, "subject": { "type": "string" }, "user_name": { "type": "string" } }, "required": [ "account", "call_id", "_created_by", "_created_at", "date_time", "description", "meta", "moment_duration", "recording", "snippet_time", "subject", "user_name" ], "type": "object" }, "id": { "description": "The unique ID of the playlist moment.", "example": "123", "title": "ID", "type": "string" }, "type": { "description": "The type of resource.", "enum": [ "playlist_moment" ], "example": "playlist_moment", "title": "Type", "type": "string" } }, "required": [ "attributes", "type", "id" ], "type": "object" }, "PlaylistMomentDoc": { "properties": { "data": { "$ref": "#/components/schemas/PlaylistMoment" } }, "required": [ "data" ], "type": "object" }, "PlaylistMomentRequestForCreate": { "properties": { "attributes": { "properties": { "callid": { "type": "string" }, "description": { "nullable": true, "type": "string" }, "moment_duration": { "type": "number" }, "moment_time": { "nullable": true, "type": "number" }, "playlist": { "type": "integer" } }, "required": [ "callid", "moment_duration", "playlist" ], "type": "object" }, "type": { "description": "The type of resource.", "enum": [ "playlist_moment_request" ], "example": "playlist_moment_request", "title": "Type", "type": "string" } }, "required": [ "attributes", "type" ], "type": "object" }, "PlaylistMomentRequestForCreateDoc": { "properties": { "data": { "$ref": "#/components/schemas/PlaylistMomentRequestForCreate" } }, "required": [ "data" ], "type": "object" }, "PlaylistsDoc": { "properties": { "data": { "items": { "$ref": "#/components/schemas/Playlist" }, "type": "array" } }, "required": [ "data" ], "type": "object" }, "Recording": { "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" }, "recording": { "properties": { "audio_only": { "type": "boolean" }, "autojoin": { "type": "boolean" }, "autojoin_reason": { "type": "string" }, "clusters": { "items": { "properties": { "company_name": { "nullable": true, "type": "string" }, "display_name": { "nullable": true, "type": "string" }, "id": { "type": "integer" }, "match_method": { "enum": [ "guess", "user", "video", "voice", "guessed_by_zoom" ], "example": "guess", "type": "string" }, "participant": { "nullable": true, "type": "integer" }, "ranges": { "items": { "properties": { "length": { "type": "number" }, "start": { "type": "number" }, "talk_time": { "type": "number" } }, "required": [ "length", "start", "talk_time" ], "type": "object" }, "type": "array" }, "speaker_name": { "type": "string" }, "title": { "nullable": true, "type": "string" }, "type": { "enum": [ "cust", "rep", "unknown" ], "example": "cust", "type": "string" }, "user_id": { "nullable": true, "type": "integer" } }, "required": [ "id", "match_method", "ranges", "speaker_name", "type" ], "type": "object" }, "type": "array" }, "duration": { "type": "number" }, "end_reason": { "type": "string" }, "has_meeting_summary": { "type": "boolean" }, "recordable": { "type": "boolean" }, "schedule_end_time": { "example": "2021-01-01T00:00:00Z", "type": "string" }, "schedule_start_time": { "example": "2021-01-01T00:00:00Z", "type": "string" }, "start_time": { "example": "2021-01-01T00:00:00Z", "type": "string" }, "thumbnails": { "items": { "properties": { "duration": { "nullable": true, "type": "integer" }, "id": { "$ref": "#/components/schemas/AnyValue" }, "keyframe_type": { "enum": [ "deck", "demo" ], "example": "deck", "nullable": true, "type": "string" }, "offset_end": { "type": "integer" }, "offset_start": { "type": "integer" }, "type": { "enum": [ "keyframe", "thumbnail" ], "example": "keyframe", "type": "string" } }, "required": [ "id", "offset_end", "offset_start", "type" ], "type": "object" }, "type": "array" }, "trackers": { "items": { "properties": { "count": { "default": 0, "type": "integer" }, "id": { "type": "string" }, "mentions": { "items": { "properties": { "offset": { "type": "integer" }, "utterance": { "type": "integer" } }, "required": [ "offset", "utterance" ], "type": "object" }, "type": "array" }, "name": { "type": "string" }, "owner_id": { "type": "integer" }, "source": { "type": "string" }, "team_ids": { "items": { "type": "integer" }, "nullable": true, "type": "array" }, "type": { "type": "string" } }, "required": [ "count", "id", "mentions", "name", "owner_id", "source", "type" ], "type": "object" }, "type": "array" }, "unrecorded_reason": { "type": "string" }, "utterances": { "items": { "properties": { "date_time": { "example": "2021-01-01T00:00:00Z", "type": "string" }, "engaging": { "type": "boolean" }, "expired": { "type": "boolean" }, "id": { "type": "string" }, "index": { "type": "integer" }, "participant": { "type": "integer" }, "snippet": { "type": "string" }, "snippet_length": { "type": "number" }, "snippet_time": { "type": "number" }, "snippet_word_count": { "type": "integer" }, "speaker_id": { "nullable": true, "type": "integer" }, "speaker_name": { "nullable": true, "type": "string" }, "speaker_type": { "nullable": true, "type": "string" } }, "required": [ "date_time", "engaging", "expired", "id", "index", "participant", "snippet", "snippet_length", "snippet_time", "snippet_word_count" ], "type": "object" }, "type": "array" } }, "required": [ "audio_only", "autojoin", "autojoin_reason", "unrecorded_reason", "clusters", "duration", "end_reason", "has_meeting_summary", "recordable", "schedule_end_time", "schedule_start_time", "start_time", "thumbnails", "trackers", "utterances" ], "type": "object" }, "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", "recording" ], "type": "object" }, "id": { "description": "The unique ID of the recording.", "example": "423295C52B954F5EA9023D7A014546F6", "title": "ID", "type": "string" }, "type": { "description": "The type of resource.", "enum": [ "recording" ], "example": "recording", "title": "Type", "type": "string" } }, "required": [ "attributes", "type", "id" ], "type": "object" }, "RecordingDoc": { "properties": { "data": { "$ref": "#/components/schemas/Recording" } }, "required": [ "data" ], "type": "object" }, "ReplaceAllEngagementFilters": { "properties": { "filter_type": { "type": "string" }, "filters": { "items": { "properties": { "field_type": { "type": "string" }, "filter_name": { "type": "string" }, "filter_values": { "default": "null", "nullable": true, "type": "string" } }, "required": [ "filter_name", "field_type" ], "type": "object" }, "type": "array" }, "type": { "default": "engagement_filter", "type": "string" } }, "required": [ "filter_type", "filters", "type" ], "type": "object" }, "ReportExportActionBody": { "properties": { "active_users_only": { "nullable": true, "type": "boolean" }, "call_ids": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "end": { "example": "2021-01-01T00:00:00Z", "nullable": true, "type": "string" }, "start": { "example": "2021-01-01T00:00:00Z", "nullable": true, "type": "string" }, "teams": { "items": { "type": "integer" }, "nullable": true, "type": "array" } }, "type": "object" }, "ResetDefaultBody": { "properties": { "type": { "default": "FILTER", "enum": [ "FILTER", "PLAYLIST", "PIPELINE_VIEW" ], "example": "FILTER", "type": "string" } }, "required": [ "type" ], "type": "object" }, "SalesQualificationAnalysis": { "properties": { "attributes": { "properties": { "conversation_duration": { "type": "integer" }, "customer_id": { "type": "integer" }, "generated_at": { "type": "string" }, "meeting_notes": { "properties": { "next_steps": { "properties": { "change_type": { "enum": [ "ADDED", "UPDATED", "NO_CHANGE" ], "example": "ADDED", "type": "string" }, "field_id": { "type": "string" }, "field_name": { "type": "string" }, "new_value": { "nullable": true, "type": "string" }, "previous_value": { "nullable": true, "type": "string" }, "supporting_quote": { "nullable": true, "type": "string" } }, "required": [ "field_id", "field_name", "change_type" ], "type": "object" }, "notes": { "properties": { "change_type": { "enum": [ "ADDED", "UPDATED", "NO_CHANGE" ], "example": "ADDED", "type": "string" }, "field_id": { "type": "string" }, "field_name": { "type": "string" }, "new_value": { "nullable": true, "type": "string" }, "previous_value": { "nullable": true, "type": "string" }, "supporting_quote": { "nullable": true, "type": "string" } }, "required": [ "field_id", "field_name", "change_type" ], "type": "object" } }, "required": [ "notes", "next_steps" ], "type": "object" }, "opportunity_id": { "nullable": true, "type": "string" }, "recording_id": { "type": "string" }, "sqf_analysis": { "items": { "properties": { "change_type": { "enum": [ "ADDED", "UPDATED", "NO_CHANGE" ], "example": "ADDED", "type": "string" }, "field_id": { "type": "string" }, "field_name": { "type": "string" }, "new_value": { "nullable": true, "type": "string" }, "previous_value": { "nullable": true, "type": "string" }, "supporting_quote": { "nullable": true, "type": "string" } }, "required": [ "field_id", "field_name", "change_type" ], "type": "object" }, "type": "array" }, "sqf_name": { "enum": [ "MEDDIC", "MEDDPICC", "BANT", "SPIN" ], "example": "MEDDIC", "type": "string" }, "user_id": { "type": "integer" } }, "required": [ "generated_at", "user_id", "customer_id", "recording_id", "sqf_name", "sqf_analysis", "conversation_duration", "meeting_notes" ], "type": "object" }, "id": { "description": "The unique ID of the sales qualification analysis.", "example": "123", "title": "ID", "type": "string" }, "type": { "description": "The type of resource.", "enum": [ "sales_qualification_analysis" ], "example": "sales_qualification_analysis", "title": "Type", "type": "string" } }, "required": [ "attributes", "type", "id" ], "type": "object" }, "SalesQualificationAnalysisDoc": { "properties": { "data": { "$ref": "#/components/schemas/SalesQualificationAnalysis" } }, "required": [ "data" ], "type": "object" }, "SalesQualificationAnalysisRequestForCreate": { "properties": { "attributes": { "properties": { "recording_id": { "type": "string" } }, "required": [ "recording_id" ], "type": "object" }, "type": { "description": "The type of resource.", "enum": [ "sales_qualifications" ], "example": "sales_qualifications", "title": "Type", "type": "string" } }, "required": [ "attributes", "type" ], "type": "object" }, "SalesQualificationAnalysisRequestForCreateDoc": { "properties": { "data": { "$ref": "#/components/schemas/SalesQualificationAnalysisRequestForCreate" } }, "required": [ "data" ], "type": "object" }, "SalesQualificationCrmWriteBackRequestForCreate": { "properties": { "attributes": { "properties": { "crm_changes": { "items": { "properties": { "field_name": { "type": "string" }, "new_value": { "$ref": "#/components/schemas/AnyValue", "nullable": true }, "previous_value": { "$ref": "#/components/schemas/AnyValue", "nullable": true } }, "required": [ "field_name" ], "type": "object" }, "type": "array" }, "meeting_id": { "type": "string" }, "object_type": { "default": "Opportunity", "nullable": true, "type": "string" }, "opportunity_id": { "nullable": true, "type": "string" } }, "required": [ "meeting_id", "crm_changes" ], "type": "object" }, "type": { "description": "The type of resource.", "enum": [ "crm-field-update" ], "example": "crm-field-update", "title": "Type", "type": "string" } }, "required": [ "attributes", "type" ], "type": "object" }, "SalesQualificationCrmWriteBackRequestForCreateDoc": { "properties": { "data": { "$ref": "#/components/schemas/SalesQualificationCrmWriteBackRequestForCreate" } }, "required": [ "data" ], "type": "object" }, "SalesQualificationValues": { "properties": { "attributes": { "properties": { "fields": { "items": { "properties": { "display_name": { "type": "string" }, "id": { "type": "string" }, "mapping": { "nullable": true, "type": "string" }, "order": { "type": "integer" }, "value": { "$ref": "#/components/schemas/AnyValue", "nullable": true }, "write_back": { "enum": [ "APPEND", "OVERWRITE" ], "example": "APPEND", "nullable": true, "type": "string" } }, "required": [ "display_name", "id", "order" ], "type": "object" }, "type": "array" }, "framework_id": { "type": "string" } }, "required": [ "framework_id", "fields" ], "type": "object" }, "id": { "description": "The unique ID of the sales qualification values.", "example": "123", "title": "ID", "type": "string" }, "type": { "description": "The type of resource.", "enum": [ "sales_qualification_values" ], "example": "sales_qualification_values", "title": "Type", "type": "string" } }, "required": [ "attributes", "type", "id" ], "type": "object" }, "SalesQualificationValuesDoc": { "properties": { "data": { "$ref": "#/components/schemas/SalesQualificationValues" } }, "required": [ "data" ], "type": "object" }, "SavedSearch": { "properties": { "attributes": { "properties": { "_created_at": { "example": "2021-01-01T00:00:00Z", "readOnly": true, "type": "string" }, "_created_by": { "readOnly": true, "type": "integer" }, "_modified_at": { "example": "2021-01-01T00:00:00Z", "readOnly": true, "type": "string" }, "last_accessed_at": { "example": "2021-01-01T00:00:00Z", "nullable": true, "type": "string" }, "name": { "type": "string" }, "private": { "type": "boolean" }, "run": { "properties": {}, "type": "object" }, "search_type": { "type": "string" }, "show": { "properties": {}, "type": "object" }, "system_default": { "nullable": true, "type": "boolean" }, "tell": { "properties": {}, "type": "object" }, "user": { "type": "integer" }, "user_default": { "nullable": true, "type": "boolean" } }, "required": [ "_created_at", "_created_by", "_modified_at", "name", "run", "show", "tell", "user", "private", "search_type" ], "type": "object" }, "id": { "description": "The unique ID of the saved search.", "example": "123", "title": "ID", "type": "string" }, "type": { "description": "The type of resource.", "enum": [ "saved_search" ], "example": "saved_search", "title": "Type", "type": "string" } }, "required": [ "attributes", "type", "id" ], "type": "object" }, "SavedSearchDoc": { "properties": { "data": { "$ref": "#/components/schemas/SavedSearch" } }, "required": [ "data" ], "type": "object" }, "Scorecard": { "properties": { "attributes": { "properties": { "engagement": { "type": "string" }, "initiative": { "properties": { "description": { "type": "string" }, "id": { "type": "integer" }, "name": { "type": "string" }, "url": { "type": "string" } }, "required": [ "description", "id", "name", "url" ], "type": "object" }, "recipient": { "properties": { "name": { "type": "string" }, "person_id": { "type": "integer" }, "user_id": { "type": "integer" } }, "required": [ "name", "person_id", "user_id" ], "type": "object" }, "reviewer": { "properties": { "name": { "type": "string" }, "person_id": { "type": "integer" }, "user_id": { "type": "integer" } }, "required": [ "name", "person_id", "user_id" ], "type": "object" }, "scores": { "items": { "properties": { "comment": { "properties": { "text": { "type": "string" }, "time": { "type": "integer" } }, "required": [ "text", "time" ], "type": "object" }, "question": { "properties": { "id": { "type": "integer" }, "text": { "type": "string" } }, "required": [ "id", "text" ], "type": "object" }, "score": { "type": "integer" } }, "required": [ "comment", "question", "score" ], "type": "object" }, "type": "array" }, "seen": { "type": "boolean" }, "submitted": { "example": "2021-01-01T00:00:00Z", "type": "string" }, "url": { "type": "string" } }, "required": [ "engagement", "initiative", "seen", "scores", "url", "recipient", "reviewer", "submitted" ], "type": "object" }, "id": { "description": "The unique ID of the scorecard.", "example": "123", "title": "ID", "type": "string" }, "type": { "description": "The type of resource.", "enum": [ "scorecard" ], "example": "scorecard", "title": "Type", "type": "string" } }, "required": [ "attributes", "type", "id" ], "type": "object" }, "ScorecardsDoc": { "properties": { "data": { "items": { "$ref": "#/components/schemas/Scorecard" }, "type": "array" } }, "required": [ "data" ], "type": "object" }, "Session": { "properties": { "attributes": { "properties": { "active": { "type": "boolean" }, "customer_id": { "nullable": true, "type": "integer" }, "person_id": { "nullable": true, "type": "integer" }, "status": { "type": "string" }, "user_id": { "nullable": true, "type": "integer" } }, "required": [ "active", "status" ], "type": "object" }, "id": { "description": "The unique ID of the session.", "example": "123", "title": "ID", "type": "string" }, "type": { "description": "The type of resource.", "enum": [ "session" ], "example": "session", "title": "Type", "type": "string" } }, "required": [ "attributes", "type", "id" ], "type": "object" }, "SessionDoc": { "properties": { "data": { "$ref": "#/components/schemas/Session" } }, "required": [ "data" ], "type": "object" }, "SignedRequestForCreate": { "properties": { "attributes": { "properties": { "client_id": { "type": "string" }, "redirect": { "type": "boolean" }, "signed_request": { "type": "string" } }, "required": [ "client_id", "signed_request", "redirect" ], "type": "object" }, "type": { "description": "The type of resource.", "enum": [ "signed_request" ], "example": "signed_request", "title": "Type", "type": "string" } }, "required": [ "attributes", "type" ], "type": "object" }, "SignedRequestForCreateDoc": { "properties": { "data": { "$ref": "#/components/schemas/SignedRequestForCreate" } }, "required": [ "data" ], "type": "object" }, "SignedRequestResponse": { "properties": { "attributes": { "properties": { "expiry": { "type": "integer" }, "url": { "type": "string" } }, "required": [ "url", "expiry" ], "type": "object" }, "id": { "description": "The unique ID of the signed request response.", "example": "123", "title": "ID", "type": "string" }, "type": { "description": "The type of resource.", "enum": [ "signed_request_response" ], "example": "signed_request_response", "title": "Type", "type": "string" } }, "required": [ "attributes", "type", "id" ], "type": "object" }, "SignedRequestResponseDoc": { "properties": { "data": { "$ref": "#/components/schemas/SignedRequestResponse" } }, "required": [ "data" ], "type": "object" }, "SmartPlaylist": { "properties": { "attributes": { "properties": { "_created_at": { "example": "2021-01-01T00:00:00Z", "readOnly": true, "type": "string" }, "_modified_at": { "example": "2021-01-01T00:00:00Z", "nullable": true, "readOnly": true, "type": "string" }, "_modified_by": { "nullable": true, "readOnly": true, "type": "integer" }, "child_count": { "readOnly": true, "type": "integer" }, "custom_search": { "properties": { "run": { "properties": { "filters": { "properties": { "account_ids": { "items": { "type": "integer" }, "nullable": true, "type": "array" }, "extra_data.StageName": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "extra_data.initial_StageName": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "team_ids": { "items": { "type": "integer" }, "nullable": true, "type": "array" }, "user_ids": { "items": { "type": "integer" }, "nullable": true, "type": "array" } }, "type": "object" }, "searches": { "items": { "properties": { "type": { "enum": [ "blueprint", "competitor", "text", "topics", "autotopics", "competitors", "facade" ], "example": "blueprint", "type": "string" }, "value": { "type": "string" } }, "required": [ "type", "value" ], "type": "object" }, "nullable": true, "type": "array" }, "tracker_operation": { "enum": [ "and", "or" ], "example": "and", "type": "string" } }, "required": [ "filters", "tracker_operation" ], "type": "object" }, "show": { "items": { "properties": { "account_id": { "nullable": true, "type": "integer" }, "company": { "$ref": "#/components/schemas/AnyValue", "nullable": true }, "disabled": { "nullable": true, "type": "boolean" }, "exists": { "nullable": true, "type": "boolean" }, "id": { "nullable": true, "type": "string" }, "name": { "nullable": true, "type": "string" }, "type": { "nullable": true, "type": "string" }, "url": { "nullable": true, "type": "string" } }, "type": "object" }, "nullable": true, "type": "array" } }, "required": [ "run" ], "type": "object" }, "description": { "nullable": true, "type": "string" }, "name": { "type": "string" }, "owner": { "nullable": true, "properties": { "name": { "readOnly": true, "type": "string" }, "person_id": { "readOnly": true, "type": "integer" }, "user_id": { "type": "integer" } }, "required": [ "name", "person_id", "user_id" ], "type": "object" }, "parent": { "nullable": true, "type": "integer" }, "path": { "items": { "properties": { "id": { "readOnly": true, "type": "string" }, "name": { "readOnly": true, "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "nullable": true, "type": "array" }, "private": { "readOnly": true, "type": "boolean" }, "size": { "readOnly": true, "type": "integer" } }, "required": [ "child_count", "_created_at", "name", "private", "size", "custom_search" ], "type": "object" }, "id": { "description": "The unique ID of the smart playlist.", "example": "123", "title": "ID", "type": "string" }, "type": { "description": "The type of resource.", "enum": [ "smart_playlist" ], "example": "smart_playlist", "title": "Type", "type": "string" } }, "required": [ "attributes", "type", "id" ], "type": "object" }, "SmartPlaylistDoc": { "properties": { "data": { "$ref": "#/components/schemas/SmartPlaylist" } }, "required": [ "data" ], "type": "object" }, "SmartPlaylistForCreating": { "properties": { "attributes": { "properties": { "custom_search": { "properties": { "run": { "properties": { "filters": { "properties": { "account_ids": { "items": { "type": "integer" }, "nullable": true, "type": "array" }, "extra_data.StageName": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "extra_data.initial_StageName": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "team_ids": { "items": { "type": "integer" }, "nullable": true, "type": "array" }, "user_ids": { "items": { "type": "integer" }, "nullable": true, "type": "array" } }, "type": "object" }, "searches": { "items": { "properties": { "type": { "enum": [ "blueprint", "competitor", "text", "topics", "autotopics", "competitors", "facade" ], "example": "blueprint", "type": "string" }, "value": { "type": "string" } }, "required": [ "type", "value" ], "type": "object" }, "nullable": true, "type": "array" }, "tracker_operation": { "enum": [ "and", "or" ], "example": "and", "type": "string" } }, "required": [ "filters", "tracker_operation" ], "type": "object" }, "show": { "items": { "properties": { "account_id": { "nullable": true, "type": "integer" }, "company": { "$ref": "#/components/schemas/AnyValue", "nullable": true }, "disabled": { "nullable": true, "type": "boolean" }, "exists": { "nullable": true, "type": "boolean" }, "id": { "nullable": true, "type": "string" }, "name": { "nullable": true, "type": "string" }, "type": { "nullable": true, "type": "string" }, "url": { "nullable": true, "type": "string" } }, "type": "object" }, "nullable": true, "type": "array" } }, "required": [ "run" ], "type": "object" }, "description": { "example": "My first playlist description.", "nullable": true, "type": "string" }, "name": { "example": "My first playlist", "type": "string" }, "parent": { "nullable": true, "type": "integer" } }, "required": [ "name", "custom_search" ], "type": "object" }, "type": { "description": "The type of resource.", "enum": [ "smart_playlist" ], "example": "smart_playlist", "title": "Type", "type": "string" } }, "required": [ "attributes", "type" ], "type": "object" }, "SmartPlaylistForCreatingDoc": { "properties": { "data": { "$ref": "#/components/schemas/SmartPlaylistForCreating" } }, "required": [ "data" ], "type": "object" }, "Task": { "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" }, "TaskDoc": { "properties": { "data": { "$ref": "#/components/schemas/Task" } }, "required": [ "data" ], "type": "object" }, "Team": { "properties": { "attributes": { "properties": { "default": { "nullable": true, "type": "boolean" }, "description": { "nullable": true, "type": "string" }, "include_descendant_teams": { "nullable": true, "type": "boolean" }, "language": { "type": "string" }, "manager": { "nullable": true, "type": "integer" }, "name": { "type": "string" }, "parent_team": { "nullable": true, "readOnly": true, "type": "integer" }, "users": { "items": { "type": "integer" }, "type": "array" } }, "required": [ "language", "name", "users" ], "type": "object" }, "id": { "description": "The unique ID of the team.", "example": "123", "title": "ID", "type": "string" }, "type": { "description": "The type of resource.", "enum": [ "team" ], "example": "team", "title": "Type", "type": "string" } }, "required": [ "attributes", "type", "id" ], "type": "object" }, "TeamDoc": { "properties": { "data": { "$ref": "#/components/schemas/Team" } }, "required": [ "data" ], "type": "object" }, "TeamsDoc": { "properties": { "data": { "items": { "$ref": "#/components/schemas/Team" }, "type": "array" } }, "required": [ "data" ], "type": "object" }, "TokenDeregistration": { "properties": { "token": { "type": "string" }, "type": { "enum": [ "MOBILE_PUSH" ], "example": "MOBILE_PUSH", "type": "string" } }, "required": [ "token", "type" ], "type": "object" }, "TokenRegistration": { "properties": { "device_os": { "type": "string" }, "device_type": { "type": "string" }, "token": { "type": "string" }, "type": { "enum": [ "MOBILE_PUSH" ], "example": "MOBILE_PUSH", "type": "string" } }, "required": [ "device_os", "device_type", "token", "type" ], "type": "object" }, "User": { "properties": { "attributes": { "properties": { "allowed_access": { "type": "integer" }, "autojoin": { "type": "integer" }, "biometric_policy": { "type": "boolean" }, "created_on": { "example": "2021-01-01T00:00:00Z", "type": "string" }, "default_meeting_link": { "example": "https://acme.zoom.us/j/123456789", "type": "string" }, "domain": { "type": "string" }, "email": { "example": "john.smith@email.com", "type": "string" }, "fingerprint_state": { "example": "automatically_created", "type": "string" }, "first_name": { "example": "John", "type": "string" }, "internal": { "type": "boolean" }, "invalidated": { "type": "boolean" }, "is_email_linked": { "type": "boolean" }, "language": { "type": "string" }, "last_login_at": { "example": "2021-01-01T00:00:00Z", "type": "string" }, "last_name": { "example": "Smith", "type": "string" }, "license_type": { "enum": [ "LISTENER", "RECORDER" ], "example": "LISTENER", "type": "string" }, "linkedin": { "type": "string" }, "location": { "type": "string" }, "manager_id": { "type": "integer" }, "meta": { "properties": { "sf_record_id": { "nullable": true, "type": "string" } }, "type": "object" }, "name": { "example": "John Smith", "type": "string" }, "onboarding_status": { "enum": [ "HIDE_ONBOARDING", "ONBOARDED", "REQUIRES_ONBOARDING" ], "example": "HIDE_ONBOARDING", "type": "string" }, "permission_role_id": { "type": "integer" }, "person_id": { "type": "integer" }, "picture": { "type": "string" }, "primary_team": { "type": "integer" }, "privacy_policy": { "type": "boolean" }, "provisioning_type": { "example": "manual", "type": "string" }, "role": { "type": "string" }, "seniority": { "type": "string" }, "sub_role": { "type": "string" }, "sync_calendar": { "type": "integer" }, "team_ids": { "items": { "type": "integer" }, "type": "array" }, "terms_and_conditions": { "type": "boolean" }, "terms_conditions": { "type": "integer" }, "tier": { "type": "string" }, "title": { "type": "string" }, "type": { "example": "Sales Rep", "type": "string" }, "utc_offset": { "type": "number" } }, "required": [ "allowed_access", "autojoin", "biometric_policy", "created_on", "default_meeting_link", "domain", "email", "fingerprint_state", "first_name", "internal", "invalidated", "is_email_linked", "language", "last_login_at", "last_name", "license_type", "linkedin", "location", "manager_id", "meta", "name", "onboarding_status", "person_id", "permission_role_id", "picture", "privacy_policy", "provisioning_type", "role", "seniority", "sub_role", "sync_calendar", "team_ids", "primary_team", "terms_and_conditions", "terms_conditions", "tier", "title", "type", "utc_offset" ], "type": "object" }, "id": { "description": "The unique ID of the user.", "example": "123", "title": "ID", "type": "string" }, "type": { "description": "The type of resource.", "enum": [ "user" ], "example": "user", "title": "Type", "type": "string" } }, "required": [ "attributes", "type", "id" ], "type": "object" }, "UserDoc": { "properties": { "data": { "$ref": "#/components/schemas/User" } }, "required": [ "data" ], "type": "object" }, "UserSettings": { "properties": { "attributes": { "properties": { "mobile_push.comments": { "type": "boolean" }, "mobile_push.mentions": { "type": "boolean" } }, "required": [ "mobile_push.comments", "mobile_push.mentions" ], "type": "object" }, "id": { "description": "The unique ID of the user settings.", "example": "123", "title": "ID", "type": "string" }, "type": { "description": "The type of resource.", "enum": [ "user_settings" ], "example": "user_settings", "title": "Type", "type": "string" } }, "required": [ "attributes", "type", "id" ], "type": "object" }, "UserSettingsDoc": { "properties": { "data": { "$ref": "#/components/schemas/UserSettings" } }, "required": [ "data" ], "type": "object" }, "VerifyCalendarServiceAccount": { "properties": { "emails": { "items": { "type": "string" }, "type": "array" } }, "required": [ "emails" ], "type": "object" }, "VideoConference": { "properties": { "attributes": { "properties": { "provider": { "enum": [ "8X8", "GOOGLE_MEET", "MSTEAMS", "WEBEX", "ZOOM" ], "example": "8X8", "type": "string" } }, "required": [ "provider" ], "type": "object" }, "id": { "description": "The unique ID of the video conference.", "example": "123", "title": "ID", "type": "string" }, "type": { "description": "The type of resource.", "enum": [ "video_conference" ], "example": "video_conference", "title": "Type", "type": "string" } }, "required": [ "attributes", "type", "id" ], "type": "object" }, "VideoConferenceDoc": { "properties": { "data": { "$ref": "#/components/schemas/VideoConference" } }, "required": [ "data" ], "type": "object" }, "VideoConferenceForCreate": { "properties": { "attributes": { "properties": { "provider": { "enum": [ "8X8", "GOOGLE_MEET", "MSTEAMS", "WEBEX", "ZOOM" ], "example": "8X8", "type": "string" } }, "required": [ "provider" ], "type": "object" }, "type": { "description": "The type of resource.", "enum": [ "video_conference" ], "example": "video_conference", "title": "Type", "type": "string" } }, "required": [ "attributes", "type" ], "type": "object" }, "VideoConferenceForCreateDoc": { "properties": { "data": { "$ref": "#/components/schemas/VideoConferenceForCreate" } }, "required": [ "data" ], "type": "object" }, "VideoConferenceForPatch": { "properties": { "attributes": { "properties": { "duration": { "type": "integer" }, "start_time": { "example": "2021-01-01T00:00:00+00:00", "format": "date-time", "type": "string" }, "subject": { "nullable": true, "type": "string" } }, "required": [ "duration", "start_time" ], "type": "object" }, "id": { "description": "The unique ID of the video conference.", "example": "123", "title": "ID", "type": "string" }, "type": { "description": "The type of resource.", "enum": [ "video_conference" ], "example": "video_conference", "title": "Type", "type": "string" } }, "required": [ "attributes", "type", "id" ], "type": "object" }, "VideoConferenceForPatchDoc": { "properties": { "data": { "$ref": "#/components/schemas/VideoConferenceForPatch" } }, "required": [ "data" ], "type": "object" } }, "securitySchemes": { "basic": { "description": "HTTP basic authentication (for those APIs that support it).", "scheme": "basic", "type": "http" }, "bearer-token": { "description": "A Chorus token or a signed JWT.", "scheme": "bearer", "type": "http" }, "x-ziaccesstoken": { "description": "A ZoomInfo access token.", "in": "header", "name": "x-ziaccesstoken", "type": "apiKey" } } }, "info": { "description": "The Chorus API is a REST API that enables you to retrieve information from and perform actions in Chorus. The Chorus API supports the following use cases:\n\n1. Retrieve data about your users in Chorus\n2. Retrieve data about your engagements (meetings and dialer calls)\n3. Upload new recordings into Chorus\n4. Delete recordings from Chorus\n\n# Authentication\nThe Chorus API uses API tokens to authenticate requests. API tokens can be generated for each Chorus user, and is managed via the Personal Settings page within the Chorus application. For users to be able to create API token(s), their role as defined in Chorus must be permitted access to the Chorus API via roles & permissions settings. \nAuthentication is performed using the Authorization header, as in the the following example:\n\n```\ncurl -H \"Authorization:abcdefghijklmnopqrstuvwxyz0123456789\" https://chorus.ai/v3/engagements\n```\n\nAn API token must be associated with a registered user in Chorus to ensure control over data access and permissions, and to ensure traceability. During the early access period, please contact your Chorus customer success manager to obtain your personal API token.\n\n# Privacy and Data Access Control\n\nThe following controls apply when retrieving data or performing an action via the Chorus API.\n\n1. Recordings marked as private are not returned in API response. \n2. If enabled, data access control settings configured for the access key user applies to access via API. This means that in order to retrieve data on all recordings within Chorus, the users associated with the API token must also have access to all recordings.\n3. Permissions on actions a user may perform within the Chorus application as specified in roles & permissions settings also apply to actions performed via API.", "termsOfService": "https://www.chorus.ai/terms", "title": "Chorus API", "version": "26.35.09" }, "openapi": "3.0.3", "paths": { "/api/auth/signed_request": { "post": { "deprecated": false, "description": "This API returns a signed request authentication response based on the HMAC authentication flow", "operationId": "post-api-auth-signed_request", "parameters": [], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/SignedRequestForCreateDoc" } } }, "required": true }, "responses": { "201": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/SignedRequestResponseDoc" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/BadRequest" }, "409": { "$ref": "#/components/responses/Conflict" } }, "summary": "Signed request authentication flow", "tags": [ "Auth" ] } }, "/api/pagerduty/event": { "post": { "deprecated": false, "description": "PagerDuty webhook for incoming CI", "operationId": "post-api-pagerduty-event", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "required": true }, "responses": { "202": { "description": "Success" }, "400": { "$ref": "#/components/responses/BadRequest" }, "409": { "$ref": "#/components/responses/Conflict" } }, "summary": "PagerDuty webhook for incoming CI", "tags": [ "Event" ] } }, "/api/v1/conversations/live": { "get": { "deprecated": false, "description": "Get details about a live conversation.", "operationId": "get-api-v1-conversations-live", "parameters": [ { "description": "The list of fields to populate. Value must be a comma-delimited list. Each item must be one of the following: account, company_name, _created_at, _modified_at, deal, disposition, language, metrics, meeting.id, name, owner, owner.email, participants, private, recording, recording.audio_only, recording.autojoin, recording.autojoin_reason, recording.clusters, recording.duration, recording.end_reason, recording.recordable, recording.schedule_end_time, recording.schedule_start_time, recording.start_time, recording.thumbnails, recording.trackers, recording.utterances, source, status, user_company_name", "in": "query", "name": "fields", "required": false, "schema": { "type": "string" } }, { "description": "The list of conversation fields to populate. This parameter is deprecated. Use `fields`, instead. Value must be a comma-delimited list.", "in": "query", "name": "fields[conversations]", "required": false, "schema": { "type": "string" } }, { "description": "The recording-related fields to populate. This parameter is deprecated. Use `fields`, instead. Value must be a comma-delimited list.", "in": "query", "name": "fields[recordings]", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RecordingDoc" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/NotFound" } }, "summary": "Fetch a LIVE conversation using meeting uuid or user id", "tags": [ "Conversations" ] } }, "/api/v1/conversations/{id}": { "delete": { "deprecated": false, "description": "Makes an asynchronous request to delete a conversation record such as an e-mail or recording.", "operationId": "delete-api-v1-conversations-id", "parameters": [ { "description": "id", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "description": "Applicable to recordings only; delete associated playlist moments with the recording", "in": "query", "name": "force_delete", "required": false, "schema": { "default": false, "type": "boolean" } } ], "responses": { "202": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/TaskDoc" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/NotFound" } }, "summary": "Delete a conversation record", "tags": [ "Conversations" ] }, "get": { "deprecated": false, "description": "This API fetches the conversation with the given ID.", "operationId": "get-api-v1-conversations-id", "parameters": [ { "description": "id", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "description": "The list of fields to populate. Value must be a comma-delimited list. Each item must be one of the following: account, company_name, _created_at, _modified_at, deal, disposition, language, metrics, meeting.id, name, owner, owner.email, participants, private, recording, recording.audio_only, recording.autojoin, recording.autojoin_reason, recording.clusters, recording.duration, recording.end_reason, recording.recordable, recording.schedule_end_time, recording.schedule_start_time, recording.start_time, recording.thumbnails, recording.trackers, recording.utterances, source, status, user_company_name", "in": "query", "name": "fields", "required": false, "schema": { "type": "string" } }, { "description": "The list of conversation fields to populate. This parameter is deprecated. Use `fields`, instead. Value must be a comma-delimited list.", "in": "query", "name": "fields[conversations]", "required": false, "schema": { "type": "string" } }, { "description": "The recording-related fields to populate. This parameter is deprecated. Use `fields`, instead. Value must be a comma-delimited list.", "in": "query", "name": "fields[recordings]", "required": false, "schema": { "type": "string" } }, { "description": "Specify true to force the conversation to be regenerated based on the latest information.", "in": "query", "name": "force_regeneration", "required": false, "schema": { "default": false, "type": "boolean" } }, { "description": "Specify true to skip summary generation.", "in": "query", "name": "skip_summary_generation", "required": false, "schema": { "default": false, "type": "boolean" } }, { "description": "Whether to include meeting metadata including provider calendar id and meeting url", "in": "query", "name": "include_meeting_metadata", "required": false, "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/RecordingDoc" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/NotFound" } }, "summary": "Fetch a specific conversation", "tags": [ "Conversations" ] } }, "/api/v1/conversations/{id}/actions/disconnect": { "post": { "deprecated": false, "description": "This API disconnects a live call.", "operationId": "post-api-v1-conversations-id-actions-disconnect", "parameters": [ { "description": "id", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "required": true }, "responses": { "204": { "description": "Success" }, "400": { "$ref": "#/components/responses/BadRequest" }, "409": { "$ref": "#/components/responses/Conflict" } }, "summary": "Disconnect a live conversation", "tags": [ "Conversations" ] } }, "/api/v1/conversations/{id}/media": { "get": { "deprecated": false, "description": "Download conversation media file (video or audio). If both video and audio files exist, the video file is returned by default. If video does not exist, will use the audio file. The API supports two response modes: direct redirect to the media file or a JSON response containing metadata and a download link.", "operationId": "get-api-v1-conversations-id-media", "parameters": [ { "description": "id", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "info", "required": false, "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnyValue" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/NotFound" } }, "summary": "Download media file or metadata", "tags": [ "Conversations" ] } }, "/api/v1/conversations:bulk": { "post": { "deprecated": false, "description": "Bulk-upload and/or delete conversations.", "operationId": "post-api-v1-conversations:bulk", "parameters": [], "requestBody": { "content": { "application/vnd.chorus.bulk+json": { "schema": { "$ref": "#/components/schemas/BulkProcessConversationsRequest" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkProcessConversationsResponse" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/BadRequest" }, "409": { "$ref": "#/components/responses/Conflict" } }, "summary": "Bulk process conversations", "tags": [ "Conversations" ] } }, "/api/v1/conversations:export": { "post": { "deprecated": false, "description": "Schedule a task to have conversations matching the specified criteria emailed to you. Exports include downloadable links to audio/video of recordings plus metadata.", "operationId": "post-conversations-export", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "properties": { "add_usage": { "default": false, "description": "Whether to include usage information in export", "nullable": true, "type": "boolean" }, "callback_url": { "description": "URL to which to post the completed link", "nullable": true, "type": "string" }, "email_on_complete": { "default": true, "description": "Whether to email when export is complete", "nullable": true, "type": "boolean" }, "end": { "description": "End timestamp for export range (epoch milliseconds)", "example": 1612051200000, "format": "int64", "nullable": true, "type": "integer" }, "start": { "description": "Start timestamp for export range (epoch milliseconds)", "example": 1609459200000, "format": "int64", "nullable": true, "type": "integer" } }, "type": "object" } } }, "required": true }, "responses": { "202": { "content": { "application/json": {} }, "description": "Success" } }, "summary": "Export recordings", "tags": [ "Conversations" ] } }, "/api/v1/conversations:validate": { "post": { "deprecated": false, "description": "Validates if an upcoming meeting, which has not been saved in any way, will be automatically recorded.", "operationId": "post-api-v1-conversations:validate", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MeetingValidation" } } }, "required": true }, "responses": { "201": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/MeetingAutojoinDoc" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/BadRequest" }, "409": { "$ref": "#/components/responses/Conflict" } }, "summary": "Create a new conversations:validate$", "tags": [ "Conversations" ] } }, "/api/v1/email_threads/{id}": { "delete": { "deprecated": false, "description": "Delete all emails in a thread.", "operationId": "delete-api-v1-email_threads-id", "parameters": [ { "description": "id", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "202": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/EmailThreadDoc" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/NotFound" } }, "summary": "Delete email thread", "tags": [ "Emails" ] }, "get": { "deprecated": false, "description": "Get details about an email thread.", "operationId": "get-api-v1-email_threads-id", "parameters": [ { "description": "id", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/EmailThreadDoc" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/NotFound" } }, "summary": "Get email thread", "tags": [ "Emails" ] } }, "/api/v1/emails": { "get": { "deprecated": false, "description": "Get emails matching the specified criteria.", "operationId": "get-api-v1-emails", "parameters": [ { "description": "The date range in which to search for e-mails that were sent. Value must be two ISO 8601-formatted dates separated by a colon (e.g. `2021-01-01T00:00:00Z:2021-01-31T00:00:00Z`). An asterisk may be used as a placeholder to represent no minimum (e.g. `*:2021-01-31T00:00:00Z`). An asterisk may be used as a placeholder to represent no maximum (e.g. `2021-01-01T00:00:00Z:*`).", "in": "query", "name": "filter[email.sent]", "required": false, "schema": { "type": "string" } }, { "description": "A string used to perform an exact case-insensitive partial match against the e-mails' subjects", "in": "query", "name": "filter[name]", "required": false, "schema": { "type": "string" } }, { "description": "The identifier of the e-mails belonging to the same e-mail thread", "in": "query", "name": "filter[thread]", "required": false, "schema": { "type": "string" } }, { "description": "Select specific e-mails using e-mail identifiers. Value must be a comma-delimited list.", "in": "query", "name": "filter[ids]", "required": false, "schema": { "type": "string" } }, { "description": "The case-insensitive name of the sender of an e-mail; examples: \"Julius Caesar\", \"julius\", and \"CAESAR\"", "in": "query", "name": "filter[owner.name]", "required": false, "schema": { "type": "string" } }, { "description": "The case-insensitive e-mail address of the sender of an e-mail; examples: \"julius.caesar@rome.gov\", \"JULIUS.CAESAR\", and \"@rome.gov\"", "in": "query", "name": "filter[owner.email]", "required": false, "schema": { "type": "string" } }, { "description": "The case-insensitive names of the participants of an e-mail; adding more participants will broaden the search. Value must be a comma-delimited list.", "in": "query", "name": "filter[participants.name]", "required": false, "schema": { "type": "string" } }, { "description": "The case-insensitive e-mail addresses of the participants of an e-mail; adding more participants will broaden the search. Value must be a comma-delimited list.", "in": "query", "name": "filter[participants.email]", "required": false, "schema": { "type": "string" } }, { "description": "The maximum number of e-mails to return per page; if the number of matching e-mails is greater than the page size, the number of results returned is not guaranteed to be equal to the page size. The minimum value that may be specified is `1`. The maximum value that may be specified is `100`.", "in": "query", "name": "page[size]", "required": false, "schema": { "default": 20, "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "page[after]", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/vnd.api+json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/BadRequest" } }, "summary": "Get emails", "tags": [ "Emails" ] } }, "/api/v1/emails/{id}": { "get": { "deprecated": false, "description": "Get an e-mail using the e-mail's identifier.", "operationId": "get-api-v1-emails-id", "parameters": [ { "description": "id", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/EmailDoc" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/NotFound" } }, "summary": "Get email", "tags": [ "Emails" ] } }, "/api/v1/filters": { "get": { "deprecated": false, "description": "Fetch all the customer's engagement_filter", "operationId": "get-api-v1-filters", "parameters": [ { "in": "query", "name": "filter[filter_name]", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "filter[filter_type]", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "filter[field_type]", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/EngagementFiltersDoc" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/BadRequest" } }, "summary": "Fetch all the customer's engagement_filter", "tags": [ "Engagement filter" ] }, "post": { "deprecated": false, "description": "This API is used to create new engagement filter.", "operationId": "post-api-v1-filters", "parameters": [], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "field_type": "picklist", "filter_name": "test6", "filter_type": "TrustRadius", "filter_values": "{\"ZoomInfo SalesOS\": \"zi-sales\", \"Chorus\": \"chorus-ai\"}" }, "type": "engagement_filter" } }, "schema": { "$ref": "#/components/schemas/EngagementFilterForCreateDoc" } } }, "required": true }, "responses": { "201": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/EngagementFilterDoc" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/BadRequest" }, "409": { "$ref": "#/components/responses/Conflict" } }, "summary": "Create engagement filter", "tags": [ "Engagement filter" ] } }, "/api/v1/filters/actions/replace": { "post": { "deprecated": false, "description": "Replace all engagement_filters.", "operationId": "post-api-v1-filters-actions-replace", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReplaceAllEngagementFilters" } } }, "required": true }, "responses": { "204": { "description": "Success" }, "400": { "$ref": "#/components/responses/BadRequest" }, "409": { "$ref": "#/components/responses/Conflict" } }, "summary": "Replace all engagement_filters", "tags": [ "Engagement filter" ] } }, "/api/v1/filters/{id}": { "delete": { "deprecated": false, "description": "Deletes an engagement filter permanently", "operationId": "delete-api-v1-filters-id", "parameters": [ { "description": "id", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success" }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/NotFound" } }, "summary": "Delete an engagement filter", "tags": [ "Engagement filter" ] }, "get": { "deprecated": false, "description": "Fetch one engagement_filter.", "operationId": "get-api-v1-filters-id", "parameters": [ { "description": "id", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/EngagementFilterDoc" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/NotFound" } }, "summary": "Fetch one engagement_filter", "tags": [ "Engagement filter" ] }, "put": { "deprecated": false, "description": "Update one engagement_filter.", "operationId": "put-api-v1-filters-id", "parameters": [ { "description": "id", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/EngagementFilterEditDoc" } } }, "required": true }, "responses": { "200": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/EngagementFilterEditDoc" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/NotFound" } }, "summary": "Update one engagement_filter", "tags": [ "Engagement filter" ] } }, "/api/v1/integrations/google_authms/actions/connect": { "get": { "deprecated": false, "description": "This API is used to \"connect\" the user to Google using auth connectors", "operationId": "get-api-v1-integrations-google_authms-actions-connect", "parameters": [], "responses": { "302": { "description": "Success" }, "400": { "$ref": "#/components/responses/BadRequest" } }, "summary": "Connect Google", "tags": [ "Integrations Email" ] } }, "/api/v1/integrations/google_calendar/actions/connect": { "get": { "deprecated": false, "description": "This API is used to \"connect\" the customer to Google Calendar service account", "operationId": "get-api-v1-integrations-google_calendar-actions-connect", "parameters": [], "responses": { "200": { "description": "Success" }, "400": { "$ref": "#/components/responses/BadRequest" } }, "summary": "Connect Google Calendar service account", "tags": [ "Integrations Calendar" ] } }, "/api/v1/integrations/google_calendar/actions/verify": { "post": { "deprecated": false, "description": "This API is used to verify an email service account.\n- At least two \"accessible\" emails must be provided.\n- A `204 No Content` will be returned if the verification is successful and a `400 Bad Request` will be returned, along withrelevant details, if it is not.", "operationId": "post-api-v1-integrations-google_calendar-actions-verify", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "emails": [ "john.smith@acme.com", "bill.jones@acme.com" ] }, "schema": { "$ref": "#/components/schemas/VerifyCalendarServiceAccount" } } }, "required": true }, "responses": { "204": { "description": "Success" }, "400": { "$ref": "#/components/responses/BadRequest" }, "409": { "$ref": "#/components/responses/Conflict" } }, "summary": "Verify calendar service account", "tags": [ "Integrations Calendar" ] } }, "/api/v1/integrations/google_email/actions/connect": { "get": { "deprecated": false, "description": "This API is used to \"connect\" the customer to Google Email service account", "operationId": "get-api-v1-integrations-google_email-actions-connect", "parameters": [], "responses": { "200": { "description": "Success" }, "400": { "$ref": "#/components/responses/BadRequest" } }, "summary": "Connect Google Email service account", "tags": [ "Integrations Email" ] } }, "/api/v1/integrations/google_meet/actions/connect": { "get": { "deprecated": false, "description": "This API is used to \"connect\" the customer to Google Meet service account", "operationId": "get-api-v1-integrations-google_meet-actions-connect", "parameters": [], "responses": { "200": { "description": "Success" }, "400": { "$ref": "#/components/responses/BadRequest" } }, "summary": "Connect Google Meet service account", "tags": [ "Integrations Meet" ] } }, "/api/v1/integrations/microsoft_teams/actions/connect": { "get": { "deprecated": false, "description": "Connect to Microsoft Teams Messaging", "operationId": "get-api-v1-integrations-microsoft_teams-actions-connect", "parameters": [], "responses": { "307": { "description": "Success" }, "400": { "$ref": "#/components/responses/BadRequest" } }, "summary": "Connect Microsoft Teams Messaging", "tags": [ "Integrations Meet" ] } }, "/api/v1/integrations/microsoft_teams_postcall/actions/connect": { "get": { "deprecated": false, "description": "This API is used to \"connect\" the customer to MSTeams service account", "operationId": "get-api-v1-integrations-microsoft_teams_postcall-actions-connect", "parameters": [], "responses": { "302": { "description": "Success" }, "400": { "$ref": "#/components/responses/BadRequest" } }, "summary": "Connect MSTeams service account", "tags": [ "Integrations Meet" ] } }, "/api/v1/integrations/msteams_authms/actions/connect": { "get": { "deprecated": false, "description": "Connect to AuthMS", "operationId": "get-api-v1-integrations-msteams_authms-actions-connect", "parameters": [], "responses": { "307": { "description": "Success" }, "400": { "$ref": "#/components/responses/BadRequest" } }, "summary": "Connect AuthMS", "tags": [ "Integrations Meet" ] } }, "/api/v1/integrations/office365_authms/actions/connect": { "get": { "deprecated": false, "description": "This API is used to \"connect\" the user to Office365 using auth connectors", "operationId": "get-api-v1-integrations-office365_authms-actions-connect", "parameters": [], "responses": { "302": { "description": "Success" }, "400": { "$ref": "#/components/responses/BadRequest" } }, "summary": "Connect Office365", "tags": [ "Integrations Email" ] } }, "/api/v1/integrations/office365_calendar/actions/connect": { "get": { "deprecated": false, "description": "This API is used to \"connect\" the customer to Office365 Calendar service account", "operationId": "get-api-v1-integrations-office365_calendar-actions-connect", "parameters": [], "responses": { "302": { "description": "Success" }, "400": { "$ref": "#/components/responses/BadRequest" } }, "summary": "Connect Office365 Calendar service account", "tags": [ "Integrations Calendar" ] } }, "/api/v1/integrations/office365_calendar/actions/verify": { "post": { "deprecated": false, "description": "This API is used to verify an email service account.\n- At least two \"accessible\" emails must be provided.\n- A `204 No Content` will be returned if the verification is successful and a `400 Bad Request` will be returned, along withrelevant details, if it is not.", "operationId": "post-api-v1-integrations-office365_calendar-actions-verify", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "emails": [ "john.smith@acme.com", "bill.jones@acme.com" ] }, "schema": { "$ref": "#/components/schemas/VerifyCalendarServiceAccount" } } }, "required": true }, "responses": { "204": { "description": "Success" }, "400": { "$ref": "#/components/responses/BadRequest" }, "409": { "$ref": "#/components/responses/Conflict" } }, "summary": "Verify calendar service account", "tags": [ "Integrations Calendar" ] } }, "/api/v1/integrations/office365_email/actions/connect": { "get": { "deprecated": false, "description": "This API is used to \"connect\" the customer to Office365 Email service account", "operationId": "get-api-v1-integrations-office365_email-actions-connect", "parameters": [], "responses": { "302": { "description": "Success" }, "400": { "$ref": "#/components/responses/BadRequest" } }, "summary": "Connect Office365 Email service account", "tags": [ "Integrations Email" ] } }, "/api/v1/integrations/unie/actions/connect": { "get": { "deprecated": false, "description": "This API is used to \"connect\" the customer to OAuth2 Unie CRM login", "operationId": "get-api-v1-integrations-unie-actions-connect", "parameters": [ { "description": "The customer's vendor instance URL.", "in": "query", "name": "resource", "required": false, "schema": { "type": "string" } }, { "description": "The requested crm provider.", "in": "query", "name": "provider", "required": true, "schema": { "enum": [ "DYNAMICS", "HUBSPOT", "SALESFORCE", "MARKETO" ], "type": "string" } } ], "responses": { "307": { "description": "Success" }, "400": { "$ref": "#/components/responses/BadRequest" } }, "summary": "Connect customer to Unie", "tags": [ "Integrations CRM" ] } }, "/api/v1/integrations/webex_authms/actions/connect": { "get": { "deprecated": false, "description": "Connect to AuthMS", "operationId": "get-api-v1-integrations-webex_authms-actions-connect", "parameters": [], "responses": { "307": { "description": "Success" }, "400": { "$ref": "#/components/responses/BadRequest" } }, "summary": "Connect AuthMS", "tags": [ "Integrations Meet" ] } }, "/api/v1/integrations/zoom_authms/actions/connect": { "get": { "deprecated": false, "description": "Connect to AuthMS", "operationId": "get-api-v1-integrations-zoom_authms-actions-connect", "parameters": [], "responses": { "307": { "description": "Success" }, "400": { "$ref": "#/components/responses/BadRequest" } }, "summary": "Connect AuthMS", "tags": [ "Integrations Meet" ] } }, "/api/v1/join": { "post": { "deprecated": false, "description": "This API may be used to join a live call by posting the plain text you would otherwise use to invite someone to join a call.", "operationId": "post-api-v1-join", "parameters": [], "requestBody": { "content": { "text/plain": { "example": "Hi please join me using this link https://chorus.zoom.us/j/12345678901", "schema": { "type": "string" } } }, "required": true }, "responses": { "201": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ConversationDoc" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/BadRequest" }, "409": { "$ref": "#/components/responses/Conflict" } }, "summary": "Join a live call", "tags": [ "Conversations" ] } }, "/api/v1/moments": { "get": { "deprecated": false, "description": "This API fetches all moments.", "operationId": "get-api-v1-moments", "parameters": [ { "description": "A date range. Value must be two ISO 8601-formatted dates separated by a colon (e.g. `2021-01-01T00:00:00Z:2021-01-31T00:00:00Z`). An asterisk may be used as a placeholder to represent no minimum (e.g. `*:2021-01-31T00:00:00Z`). An asterisk may be used as a placeholder to represent no maximum (e.g. `2021-01-01T00:00:00Z:*`). The maximum range that may be specified is `365 days, 0:00:00`.", "in": "query", "name": "filter[shared_on]", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/MomentsDoc" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/BadRequest" } }, "summary": "Fetch moments", "tags": [ "External Moments" ] }, "post": { "deprecated": false, "description": "This API creates a new moment.", "operationId": "post-api-v1-moments", "parameters": [], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "callid": "call_id_12345", "moment_duration": 7, "moment_time": 0.0, "note": "", "subject": "", "url_string": "" }, "type": "moment_create_request" } }, "schema": { "$ref": "#/components/schemas/MomentCreateRequestForCreateDoc" } } }, "required": true }, "responses": { "201": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/MomentDoc" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/BadRequest" }, "409": { "$ref": "#/components/responses/Conflict" } }, "summary": "Add a new moment", "tags": [ "Public External Moments" ] } }, "/api/v1/moments/{id}": { "delete": { "deprecated": false, "description": "This API deletes the moment with the given ID.", "operationId": "delete-api-v1-moments-id", "parameters": [ { "description": "id", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success" }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/NotFound" } }, "summary": "Delete a moment", "tags": [ "External Moments" ] }, "put": { "deprecated": false, "description": "Updates a moment with the specified ID.", "operationId": "put-api-v1-moments-id", "parameters": [ { "description": "id", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "moment_time": 3.0, "note": "", "subject": "", "url_string": "" }, "id": "11111", "type": "moment_edit_request" } }, "schema": { "$ref": "#/components/schemas/MomentEditRequestDoc" } } }, "required": true }, "responses": { "200": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/MomentDoc" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/NotFound" } }, "summary": "Updates a moment by ID.", "tags": [ "Public External Moments" ] } }, "/api/v1/playlists": { "get": { "deprecated": false, "description": "This API fetches all playlists.", "operationId": "get-api-v1-playlists", "parameters": [ { "description": "If specified, only playlists containing moments from the specified conversation will be returned.", "in": "query", "name": "filter[conversation]", "required": false, "schema": { "type": "string" } }, { "description": "Used in conjunction with ``filter[parent]``, specifies whether the playlist referenced by ``filter[parent]`` should also be returned.", "in": "query", "name": "include_parent", "required": false, "schema": { "type": "boolean" } }, { "description": "The name of the playlist.", "in": "query", "name": "filter[name]", "required": false, "schema": { "type": "string" } }, { "description": "The playlist parent.", "in": "query", "name": "filter[parent]", "required": false, "schema": { "type": "integer" } }, { "description": "Used in conjunction with ``filter[parent]``, specifies whether all children should be returned (recursively) or only direct children.", "in": "query", "name": "recursive", "required": false, "schema": { "type": "boolean" } }, { "description": "Specify true to return only playlists you are currently subscribed to.", "in": "query", "name": "filter[subscribed]", "required": false, "schema": { "type": "boolean" } }, { "description": "Specify true to return top-level playlists, only. Note: a top-level playlist is either a playlist with no parent or a playlist whose parent is not visible to the current user.", "in": "query", "name": "top_level", "required": false, "schema": { "type": "boolean" } }, { "description": "Filter by type. Value must be a comma-delimited list. Each item must be one of the following: BOOKMARKS, HASHTAG_PLAYLIST, PINNED_MOMENTS, PLAYLIST, SMART_PLAYLIST", "in": "query", "name": "filter[type]", "required": false, "schema": { "type": "string" } }, { "description": "A comma-delimited list of fields to sort by. Value must be a comma-delimited list. A maximum of `1` values may be specified.", "in": "query", "name": "sort", "required": false, "schema": { "default": "-_modified_at", "type": "string" } }, { "description": "The page of playlists to return.", "in": "query", "name": "page[number]", "required": false, "schema": { "default": 1, "minimum": 1, "type": "integer" } }, { "description": "The number of playlists to return per page.", "in": "query", "name": "page[size]", "required": false, "schema": { "default": 20, "maximum": 1000, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/PlaylistsDoc" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/BadRequest" } }, "summary": "Fetch playlists", "tags": [ "Playlists" ] }, "post": { "deprecated": false, "description": "This API creates a new playlist.", "operationId": "post-api-v1-playlists", "parameters": [], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/PlaylistForCreatingDoc" } } }, "required": true }, "responses": { "201": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/PlaylistDoc" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/BadRequest" }, "409": { "$ref": "#/components/responses/Conflict" } }, "summary": "Create a new playlist", "tags": [ "Playlists" ] } }, "/api/v1/playlists/moments": { "post": { "deprecated": false, "description": "This API creates a new playlist.", "operationId": "post-api-v1-playlists-moments", "parameters": [], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "callid": "call_id_12345", "description": "new moment", "moment_duration": 7, "moment_time": 0.0, "playlist": 12345 }, "type": "playlist_moment_request" } }, "schema": { "$ref": "#/components/schemas/PlaylistMomentRequestForCreateDoc" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/BadRequest" }, "409": { "$ref": "#/components/responses/Conflict" } }, "summary": "Add a new playlist moment", "tags": [ "Public Playlist Moments" ] } }, "/api/v1/playlists/moments/{id}": { "patch": { "deprecated": false, "description": "This API partially updates the playlist moment with the given ID.", "operationId": "patch-api-v1-playlists-moments-id", "parameters": [ { "description": "id", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "description": "New description for existing playlist moment" }, "id": "11111", "type": "playlist_moment" } }, "schema": { "$ref": "#/components/schemas/MomentForPatchDoc" } } }, "required": true }, "responses": { "200": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/PlaylistMomentDoc" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/NotFound" } }, "summary": "Partially update a playlist moment", "tags": [ "Public Playlist Moments" ] } }, "/api/v1/playlists/{id}": { "delete": { "deprecated": false, "description": "This API deletes the playlist with the given ID.", "operationId": "delete-api-v1-playlists-id", "parameters": [ { "description": "id", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "description": "Force delete of the specified playlist, even if child playlists exist. If true, deletes all children recursively. If false, or unspecified, the delete will be rejected if children exist.", "in": "query", "name": "recursive", "required": false, "schema": { "default": false, "type": "boolean" } } ], "responses": { "204": { "description": "Success" }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/NotFound" } }, "summary": "Delete a playlist", "tags": [ "Playlists" ] }, "get": { "deprecated": false, "description": "This API fetches the playlist with the given ID.", "operationId": "get-api-v1-playlists-id", "parameters": [ { "description": "id", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/PlaylistDoc" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/NotFound" } }, "summary": "Fetch a specific playlist", "tags": [ "Playlists" ] }, "put": { "deprecated": false, "description": "This API updates (completely replaces) the playlist with the given ID.", "operationId": "put-api-v1-playlists-id", "parameters": [ { "description": "id", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/PlaylistDoc" } } }, "required": true }, "responses": { "200": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/PlaylistDoc" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/NotFound" } }, "summary": "Update a playlist", "tags": [ "Playlists" ] } }, "/api/v1/reports/{id}/actions/export": { "post": { "deprecated": false, "description": "This API is used to make an asynchronous call to generate a CSV file for the data of a given report. This CSV file will then be uploaded to Amazon S3, and an e-mail will be sent to the user containing a link to the file which will be valid for 7 days.", "operationId": "post-api-v1-reports-id-actions-export", "parameters": [ { "description": "id", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "examples": { "All supported fields": { "value": { "active_users_only": true, "call_ids": [ "892A873532FB4F1090A62" ], "end": "2026-08-30", "start": "2026-07-31", "teams": [ 123, 456 ] } }, "Minimum required fields": { "value": { "start": "2026-07-31" } } }, "schema": { "$ref": "#/components/schemas/ReportExportActionBody" } } }, "required": true }, "responses": { "202": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/TaskDoc" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/BadRequest" }, "409": { "$ref": "#/components/responses/Conflict" } }, "summary": "Export the data of a report.", "tags": [ "Reports" ] } }, "/api/v1/sales-qualification-values/{opportunity_id}": { "get": { "deprecated": false, "description": "This API returns the current CRM values of the tenant's active sales qualification framework fields for a given opportunity.", "operationId": "get-api-v1-sales-qualification-values-opportunity_id", "parameters": [ { "description": "opportunity_id", "in": "path", "name": "opportunity_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/SalesQualificationValuesDoc" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/NotFound" } }, "summary": "Get current CRM values for sales qualification fields", "tags": [ "Sales Qualifications" ] } }, "/api/v1/sales-qualifications": { "post": { "deprecated": false, "description": "Extract structured Sales Qualification Framework data from call transcripts, emails and CRM data at the opportunity level.", "operationId": "post-api-v1-sales-qualifications", "parameters": [], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/SalesQualificationAnalysisRequestForCreateDoc" } } }, "required": true }, "responses": { "201": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/SalesQualificationAnalysisDoc" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/BadRequest" }, "409": { "$ref": "#/components/responses/Conflict" } }, "summary": "Create Sales qualifications extraction", "tags": [ "Sales Qualifications" ] } }, "/api/v1/sales-qualifications/actions/writeback-crm": { "post": { "deprecated": false, "description": "This API write-back a CRM fields base on the meeting_id", "operationId": "post-api-v1-sales-qualifications-actions-writeback-crm", "parameters": [], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/SalesQualificationCrmWriteBackRequestForCreateDoc" } } }, "required": true }, "responses": { "201": { "description": "Success" }, "400": { "$ref": "#/components/responses/BadRequest" }, "409": { "$ref": "#/components/responses/Conflict" } }, "summary": "write-back crm fields", "tags": [ "Sales Qualifications" ] } }, "/api/v1/sales-qualifications/{recording_id}": { "get": { "deprecated": false, "description": "Retrieve previously extracted Sales Qualification Framework data by recording ID.", "operationId": "get-api-v1-sales-qualifications-recording_id", "parameters": [ { "description": "recording_id", "in": "path", "name": "recording_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/SalesQualificationAnalysisDoc" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/NotFound" } }, "summary": "Get Sales qualifications extraction", "tags": [ "Sales Qualifications" ] } }, "/api/v1/sales_qualification_configuration": { "get": { "deprecated": false, "description": "This API retrieves configurations of different sales qualification frameworks for the tenant", "operationId": "get-api-v1-sales_qualification_configuration", "parameters": [], "responses": { "200": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/FrameworkConfigurationsDoc" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/BadRequest" } }, "summary": "Get Sales qualification configurations", "tags": [ "Sales Qualifications" ] } }, "/api/v1/sales_qualification_configuration/{framework_id}": { "put": { "deprecated": false, "description": "This API updates a sales qualification configuration.", "operationId": "put-api-v1-sales_qualification_configuration-framework_id", "parameters": [ { "description": "framework_id", "in": "path", "name": "framework_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/FrameworkConfigurationDoc" } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/NotFound" } }, "summary": "Update sales qualification configuration", "tags": [ "Sales Qualifications" ] } }, "/api/v1/saved_searches/default/actions/reset": { "post": { "deprecated": false, "description": "This API allows a user to reset their default search (view) for Recordings Views.", "operationId": "post-api-v1-saved_searches-default-actions-reset", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "type": "filter" }, "schema": { "$ref": "#/components/schemas/ResetDefaultBody" } } }, "required": true }, "responses": { "204": { "description": "Success" }, "400": { "$ref": "#/components/responses/BadRequest" }, "409": { "$ref": "#/components/responses/Conflict" } }, "summary": "Reset user default saved search", "tags": [ "Saved Search" ] } }, "/api/v1/saved_searches/{id}/actions/set_default": { "post": { "deprecated": false, "description": "This API allows a user to set a saved search as their default.", "operationId": "post-api-v1-saved_searches-id-actions-set_default", "parameters": [ { "description": "id", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/SavedSearchDoc" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/BadRequest" }, "409": { "$ref": "#/components/responses/Conflict" } }, "summary": "Sets a user's saved search as their default", "tags": [ "Saved Search" ] } }, "/api/v1/scorecards": { "get": { "deprecated": false, "description": "This API fetches all scorecards.", "operationId": "get-api-v1-scorecards", "parameters": [ { "description": "Ids of the users who were scored. Value must be a comma-delimited list.", "in": "query", "name": "filter[recipients]", "required": false, "schema": { "type": "string" } }, { "description": "Ids of the users who completed the scorecards. Value must be a comma-delimited list.", "in": "query", "name": "filter[reviewers]", "required": false, "schema": { "type": "string" } }, { "description": "Id of the initiative that the scorecards were completed against.", "in": "query", "name": "filter[initiative]", "required": false, "schema": { "type": "integer" } }, { "description": "The datetime that the scorecard was submitted by the reviewer. Value must be two ISO 8601-formatted dates separated by a colon (e.g. `2021-01-01T00:00:00Z:2021-01-31T00:00:00Z`). An asterisk may be used as a placeholder to represent no minimum (e.g. `*:2021-01-31T00:00:00Z`). An asterisk may be used as a placeholder to represent no maximum (e.g. `2021-01-01T00:00:00Z:*`).", "in": "query", "name": "filter[submitted]", "required": false, "schema": { "type": "string" } }, { "description": "The number of resources to return per page. The minimum value that may be specified is `1`. The maximum value that may be specified is `100`.", "in": "query", "name": "page[size]", "required": false, "schema": { "default": 20, "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "The page of resources to return. The minimum value that may be specified is `1`.", "in": "query", "name": "page[number]", "required": false, "schema": { "default": 1, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/ScorecardsDoc" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/BadRequest" } }, "summary": "Fetch scorecards", "tags": [ "Scorecards" ] } }, "/api/v1/scorecards:export": { "post": { "deprecated": false, "description": "Schedule a task to export the customer scorecards to csv file ", "operationId": "post-api-v1-scorecards:export", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportScorecardsBody" } } }, "required": true }, "responses": { "201": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/TaskDoc" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/BadRequest" }, "409": { "$ref": "#/components/responses/Conflict" } }, "summary": "Export scorecards", "tags": [ "Scorecards" ] } }, "/api/v1/sessions/current": { "delete": { "deprecated": false, "description": "Invalidates the current session (if any).", "operationId": "delete-api-v1-sessions-current", "parameters": [], "responses": { "204": { "description": "Success" }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/NotFound" } }, "summary": "Invalidates the current session (if any).", "tags": [ "Session management" ] }, "get": { "deprecated": false, "description": "Returns the the status of the current session", "operationId": "get-api-v1-sessions-current", "parameters": [], "responses": { "200": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/SessionDoc" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/BadRequest" } }, "summary": "Returns the status of the current session", "tags": [ "Session management" ] } }, "/api/v1/sessions/exchange": { "post": { "deprecated": false, "description": "Exchange a x-ziaccesstoken for a Chorus session cookie.", "operationId": "post-api-v1-sessions-exchange", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/SessionDoc" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/BadRequest" }, "409": { "$ref": "#/components/responses/Conflict" } }, "summary": "Create session cookie from JWT token", "tags": [ "Session management" ] } }, "/api/v1/smart_playlists": { "post": { "deprecated": false, "description": "This API creates a new smart playlist.", "operationId": "post-api-v1-smart_playlists", "parameters": [], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "custom_search": { "run": { "filters": { "account_ids": [ 8464609 ], "extra_data.StageName": [ "Meeting Scheduled", "Research" ], "team_ids": [ 21460 ], "user_ids": [ 178377 ] }, "searches": [ { "type": "topics", "value": "ace___end_goal_822bda3" }, { "type": "topics", "value": "ae_agenda_end_of_call_1" } ], "tracker_operation": "or" }, "show": [ { "account_id": 8464609, "disabled": true, "exists": true, "id": "", "name": "Adam Silverman Meetings" } ] }, "description": "My first smart playlist description.", "name": "My first smart playlist", "parent": 0 }, "type": "smart_playlist" } }, "schema": { "$ref": "#/components/schemas/SmartPlaylistForCreatingDoc" } } }, "required": true }, "responses": { "201": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/PlaylistDoc" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/BadRequest" }, "409": { "$ref": "#/components/responses/Conflict" } }, "summary": "Create a new smart playlist", "tags": [ "Playlists" ] } }, "/api/v1/smart_playlists/{id}": { "put": { "deprecated": false, "description": "This API updates (completely replaces) the smart playlist with the given ID.", "operationId": "put-api-v1-smart_playlists-id", "parameters": [ { "description": "id", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/SmartPlaylistDoc" } } }, "required": true }, "responses": { "200": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/PlaylistDoc" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/NotFound" } }, "summary": "Update a smart playlist", "tags": [ "Playlists" ] } }, "/api/v1/teams": { "get": { "deprecated": false, "description": "This API fetches all teams.", "operationId": "get-api-v1-teams", "parameters": [], "responses": { "200": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/TeamsDoc" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/BadRequest" } }, "summary": "Fetch teams", "tags": [ "Teams" ] } }, "/api/v1/teams/{id}": { "get": { "deprecated": false, "description": "This API fetches the team with the given ID.", "operationId": "get-api-v1-teams-id", "parameters": [ { "description": "id", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/TeamDoc" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/NotFound" } }, "summary": "Fetch a specific team", "tags": [ "Teams" ] } }, "/api/v1/users/me": { "get": { "deprecated": false, "description": "Fetch details about yourself.", "operationId": "get-api-v1-users-me", "parameters": [ { "in": "header", "name": "X-Timezone-Offset", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/UserDoc" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/NotFound" } }, "summary": "Get details about yourself", "tags": [ "Users" ] } }, "/api/v1/users/me/actions/deregister_token": { "post": { "deprecated": false, "description": "Deregister the user's calling device from receiving push notifications.", "operationId": "post-api-v1-users-me-actions-deregister_token", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TokenDeregistration" } } }, "required": true }, "responses": { "204": { "description": "Success" }, "400": { "$ref": "#/components/responses/BadRequest" }, "409": { "$ref": "#/components/responses/Conflict" } }, "summary": "Deregister mobile device from push notifications service", "tags": [ "Users" ] } }, "/api/v1/users/me/actions/register_token": { "post": { "deprecated": false, "description": "Register the user's device into 'Zoominfo Notifications Center', so it will be able to receive push notifications.", "operationId": "post-api-v1-users-me-actions-register_token", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TokenRegistration" } } }, "required": true }, "responses": { "204": { "description": "Success" }, "400": { "$ref": "#/components/responses/BadRequest" }, "409": { "$ref": "#/components/responses/Conflict" } }, "summary": "Register mobile device to push notifications service", "tags": [ "Users" ] } }, "/api/v1/users/me/settings": { "get": { "deprecated": false, "description": "Get the current user's settings.", "operationId": "get-api-v1-users-me-settings", "parameters": [], "responses": { "200": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/UserSettingsDoc" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/BadRequest" } }, "summary": "Get settings", "tags": [ "Users" ] }, "put": { "deprecated": false, "description": "Update the current user's settings.", "operationId": "put-api-v1-users-me-settings", "parameters": [], "requestBody": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/UserSettingsDoc" } } }, "required": true }, "responses": { "204": { "description": "Success" }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/NotFound" } }, "summary": "Update settings", "tags": [ "Users" ] } }, "/api/v1/video_conferences": { "post": { "deprecated": false, "description": "This API creates a new video conference.", "operationId": "post-api-v1-video_conferences", "parameters": [], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "provider": "ZOOM" }, "type": "video_conference" } }, "schema": { "$ref": "#/components/schemas/VideoConferenceForCreateDoc" } } }, "required": true }, "responses": { "201": { "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/VideoConferenceDoc" } } }, "description": "Success" }, "400": { "$ref": "#/components/responses/BadRequest" }, "409": { "$ref": "#/components/responses/Conflict" } }, "summary": "Create a new video conference", "tags": [ "Video Conferences" ] } }, "/api/v1/video_conferences/{go_link}": { "delete": { "deprecated": false, "description": "This API deletes the video conference with the given ID.", "operationId": "delete-api-v1-video_conferences-go_link", "parameters": [ { "description": "go_link", "in": "path", "name": "go_link", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success" }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/NotFound" } }, "summary": "Delete a video conference", "tags": [ "Video Conferences" ] }, "patch": { "deprecated": false, "description": "This API partially updates the video conference with the given ID.", "operationId": "patch-api-v1-video_conferences-go_link", "parameters": [ { "description": "go_link", "in": "path", "name": "go_link", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.api+json": { "example": { "data": { "attributes": { "duration": 30, "start_time": "2022-01-30T18:00:00Z", "subject": "Updated Meeting subject" }, "id": "https://go.chorus.ai/8992359323", "type": "video_conference" } }, "schema": { "$ref": "#/components/schemas/VideoConferenceForPatchDoc" } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "$ref": "#/components/responses/BadRequest" }, "404": { "$ref": "#/components/responses/NotFound" } }, "summary": "Partially update a video conference", "tags": [ "Video Conferences" ] } }, "/login": { "post": { "deprecated": false, "description": "Establishes an authenticated session.", "operationId": "post-login", "parameters": [], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "email": { "description": "Your email address.", "title": "Email", "type": "string" }, "password": { "description": "Your password.", "format": "password", "title": "Password", "type": "string" } }, "required": [ "email", "password" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Success" } }, "summary": "Establishes an authenticated session.", "tags": [ "Session management" ] } }, "/v3/engagements": { "delete": { "deprecated": false, "description": "This API allows you to delete multiple engagements by ID.", "operationId": "delete-v3-engagements", "parameters": [ { "description": "Comma-separated list of Engagements ID(s) to delete. Supports up to 100 per API call.", "in": "query", "name": "engagement_id", "required": true, "schema": { "example": "string", "type": "string" } } ], "responses": { "202": { "content": { "application/json": {} }, "description": "Success" } }, "summary": "Delete multiple engagements", "tags": [ "Conversations" ] }, "get": { "deprecated": false, "description": "Get conversations matching the specified criteria.", "operationId": "get-v3-engagements", "parameters": [ { "description": "Call recording compliance flag", "in": "query", "name": "compliance", "required": false, "schema": { "enum": [ "COMPLIANT", "NON-COMPLIANT", "UNKNOWN" ], "type": "string" } }, { "description": "Continuation key for pagination", "in": "query", "name": "continuation_key", "required": false, "schema": { "type": "string" } }, { "description": "Chorus disposition - connected", "in": "query", "name": "disposition_connected", "required": false, "schema": { "type": "boolean" } }, { "description": "Chorus disposition - gatekeeper", "in": "query", "name": "disposition_gatekeeper", "required": false, "schema": { "type": "boolean" } }, { "description": "Chorus disposition - phone tree", "in": "query", "name": "disposition_tree", "required": false, "schema": { "type": "boolean" } }, { "description": "Chorus disposition - voicemail", "in": "query", "name": "disposition_voicemail", "required": false, "schema": { "type": "boolean" } }, { "description": "Comma-separated list of engagement ids", "in": "query", "name": "engagement_id", "required": false, "schema": { "type": "string" } }, { "description": "Type of engagement", "in": "query", "name": "engagement_type", "required": false, "schema": { "enum": [ "meeting", "dialer", "email", "content_viewed", "unrecorded_meeting" ], "type": "string" } }, { "description": "Type of engagement", "in": "query", "name": "content_type", "required": false, "schema": { "enum": [ "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": "string" } }, { "description": "Max date of engagement", "in": "query", "name": "max_date", "required": false, "schema": { "format": "date-time", "type": "string" } }, { "description": "Max duration of meeting (in seconds)", "in": "query", "name": "max_duration", "required": false, "schema": { "format": "float", "type": "number" } }, { "description": "Min date of engagement", "in": "query", "name": "min_date", "required": false, "schema": { "format": "date-time", "type": "string" } }, { "description": "Min duration of meeting (in seconds)", "in": "query", "name": "min_duration", "required": false, "schema": { "format": "float", "type": "number" } }, { "description": "The email address of a participant", "in": "query", "name": "participants_email", "required": false, "schema": { "type": "string" } }, { "description": "Comma-separated list of Team ID(s) for engagement owner", "in": "query", "name": "team_id", "required": false, "schema": { "type": "string" } }, { "description": "Comma-separated list of User ID(s) for engagement owner", "in": "query", "name": "user_id", "required": false, "schema": { "type": "string" } }, { "description": "Return tracker information with results", "in": "query", "name": "with_trackers", "required": false, "schema": { "default": false, "type": "boolean" } }, { "description": "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.", "in": "query", "name": "additional_parameters", "required": false, "schema": { "additionalProperties": true, "example": { "filter[foo]": "bar" }, "title": "Additional parameters", "type": "object" } } ], "responses": { "200": { "content": { "application/json": { "example": { "continuation_key": "1591110020.0 20C790A0EB9646DBB95725D7951C2506", "engagements": [ { "account_id": "", "account_name": "Mike Gorman Meetings", "compliance": "non-compliant", "date_time": 1632490362, "disposition_connected": true, "disposition_gatekeeper": false, "disposition_tree": false, "disposition_voicemail": false, "duration": 2872.75, "engagement_id": "EE8ED5BBBC254177B8201B9D84855949", "engagement_type": "meeting", "initiator": "string", "language": "en", "no_show": true, "num_cust_questions": 0, "num_engaging_questions": 0, "opportunity_id": "string", "opportunity_name": "string", "participants": [ { "company_name": "ZoomInfo", "email": "mike.gorman@zoominfo.com", "name": "Mike Gorman", "person_id": 18272271, "title": "Principal Architect", "type": "rep", "user_id": 305921 } ], "processing_state": "done", "subject": "Unscheduled Meeting", "tracker_matches": [ { "name": "Authority", "num_matches": 1, "type": "chorus" }, { "name": "Objection - Great Question / Feedback", "num_matches": 1, "type": "chorus" }, { "name": "Trial / POC", "num_matches": 1, "type": "chorus" }, { "name": "Next Steps & To Do's", "num_matches": 3, "type": "chorus" }, { "name": "Note to self", "num_matches": 1, "type": "chorus" }, { "name": "Coronavirus", "num_matches": 2, "type": "chorus" } ], "url": "https://chorus.ai/meeting/EE8ED5BBBC254177B8201B9D84855949", "user_email": "mike.gorman@zoominfo.com", "user_id": 305921, "user_name": "Mike Gorman" } ] } } }, "description": "Success" } }, "summary": "Get conversations", "tags": [ "Conversations" ] } }, "/v3/engagements/{engagement_id}": { "delete": { "deprecated": false, "description": "This API allows you to delete a single engagement.", "operationId": "delete-v3-engagements-id", "parameters": [ { "description": "Engagements ID(s) to delete", "in": "path", "name": "engagement_id", "required": true, "schema": { "type": "string" } } ], "responses": { "202": { "content": { "application/json": {} }, "description": "Success" } }, "summary": "Delete a single engagement", "tags": [ "Conversations" ] } }, "/v3/upload": { "post": { "deprecated": false, "description": "Upload a conversation to Chorus. Support formats: 3GPP, AU, AVI, FLV, HLS, MKV, MP3, MP4, Ogg, WAV, WebM", "operationId": "post-v3-upload", "parameters": [], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "crm_account_id": { "description": "CRM account ID to which to associate the recording", "nullable": true, "type": "string" }, "crm_opportunity_id": { "description": "CRM opportunity ID to associate recording to", "nullable": true, "type": "string" }, "data": { "format": "binary", "type": "string" }, "enforce_unique_meeting_id": { "default": true, "description": "enforce unique meeting id for a call", "nullable": true, "type": "boolean" }, "meeting_id": { "description": "ID of a scheduled meeting", "nullable": true, "type": "string" }, "name": { "description": "Name of recording", "type": "string" }, "user": { "description": "Recording owner email", "type": "string" } }, "required": [ "data", "name", "user" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Success" } }, "summary": "Upload a conversation", "tags": [ "Conversations" ] } }, "/v3/users": { "get": { "deprecated": false, "description": "This API returns all users.", "operationId": "get-v3-users", "parameters": [ { "in": "header", "name": "x-al-version", "required": false, "schema": { "default": "2020-03-01", "type": "string" } } ], "responses": { "200": { "content": { "application/json": {} }, "description": "Success" } }, "summary": "Fetch users", "tags": [ "Users" ] } }, "/v3/webhook": { "delete": { "deprecated": false, "description": "Delete an existing webhook by its URL.", "operationId": "delete-v3-webhook", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "properties": { "hook_url": { "description": "The URL of the webhook to delete", "type": "string" } }, "required": [ "hook_url" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Success" } }, "summary": "Delete a webhook", "tags": [ "Webhook" ] }, "get": { "deprecated": false, "description": "Retrieve all webhooks configured for the authenticated customer.", "operationId": "get-v3-webhook", "parameters": [], "responses": { "200": { "content": { "application/json": { "example": { "webhooks": [ { "events": [ { "event_name": "recording_done", "filter_arguments": { "es_args": { "duration_min": 60 } } } ], "id": 123, "url": "https://example.com/webhook" } ] } } }, "description": "Success" } }, "summary": "Fetch webhooks", "tags": [ "Webhook" ] }, "post": { "deprecated": false, "description": "Register a new webhook that Chorus will post to when a specified event occurs. Webhooks can be filtered based on conversation criteria.", "operationId": "post-v3-webhook", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "properties": { "event": { "description": "The event type that triggers the webhook", "enum": [ "recording_done" ], "type": "string" }, "hook_url": { "description": "The URL to post to when the event occurs", "type": "string" }, "type": { "description": "Optional webhook type with predefined filters (e.g., 'zapier' for common Zapier use cases)", "nullable": true, "type": "string" } }, "required": [ "event", "hook_url" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {} }, "description": "Success" } }, "summary": "Register a webhook", "tags": [ "Webhook" ] } } }, "security": [ { "basic": [] }, { "bearer-token": [] }, { "x-ziaccesstoken": [] } ], "servers": [ { "url": "/" }, { "url": "https://chorus.ai" } ] }