Endpoint Get Conversations
Name
get_conversations
Description
Related Tables
Parameters
| Parameter | Required | Options | ||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Name:
Label: Status |
|
|||||||||||||||||||||||||||||||||||
|
Name:
Label: OperatorIds |
||||||||||||||||||||||||||||||||||||
|
Name:
Label: DepartmentId |
||||||||||||||||||||||||||||||||||||
|
Name:
Label: AppId |
||||||||||||||||||||||||||||||||||||
|
Name:
Label: Email |
||||||||||||||||||||||||||||||||||||
|
Name:
Label: StartTime The date for which to retrieve the report in YYYYMMDD format. Supported functions now|today|yesterday|weekstart|weekend|monthstart|monthend|yearstart|yearend and supported intervals for add/subtract are ms|s|sec|min|h|hour|y|year|d|day|m|month|y|year. Example monthstart-3d (subtract 3days from month start) |
|
|||||||||||||||||||||||||||||||||||
|
Name:
Label: EndTime The date for which to retrieve the report in YYYYMMDD format. Supported functions now|today|yesterday|weekstart|weekend|monthstart|monthend|yearstart|yearend and supported intervals for add/subtract are ms|s|sec|min|h|hour|y|year|d|day|m|month|y|year. Example monthstart-3d (subtract 3days from month start) |
|
|||||||||||||||||||||||||||||||||||
|
Name:
Label: VisitorType |
|
|||||||||||||||||||||||||||||||||||
|
Name:
Label: UpdatedTimeStart The date for which to retrieve the report in YYYYMMDD format. Supported functions now|today|yesterday|weekstart|weekend|monthstart|monthend|yearstart|yearend and supported intervals for add/subtract are ms|s|sec|min|h|hour|y|year|d|day|m|month|y|year. Example monthstart-3d (subtract 3days from month start) |
|
|||||||||||||||||||||||||||||||||||
|
Name:
Label: UpdatedTimeEnd The date for which to retrieve the report in YYYYMMDD format. Supported functions now|today|yesterday|weekstart|weekend|monthstart|monthend|yearstart|yearend and supported intervals for add/subtract are ms|s|sec|min|h|hour|y|year|d|day|m|month|y|year. Example monthstart-3d (subtract 3days from month start) |
|
|||||||||||||||||||||||||||||||||||
|
Name:
Label: SortBy |
|
|||||||||||||||||||||||||||||||||||
|
Name:
Label: PageSize |
Output Columns
| Label | Data Type (SSIS) | Data Type (SQL) | Length | Description |
|---|---|---|---|---|
| Id |
DT_WSTR
|
nvarchar(500)
|
500 | |
| Question |
DT_WSTR
|
nvarchar(4000)
|
4000 | |
| Status |
DT_WSTR
|
nvarchar(500)
|
500 | |
| StartTime |
DT_DBTIMESTAMP
|
datetime
|
||
| EndTime |
DT_DBTIMESTAMP
|
datetime
|
||
| ChatDuration |
DT_WSTR
|
nvarchar(500)
|
500 | |
| MissedReason |
DT_WSTR
|
nvarchar(500)
|
500 | |
| OwnerEmail |
DT_WSTR
|
nvarchar(500)
|
500 | |
| OwnerId |
DT_WSTR
|
nvarchar(500)
|
500 | |
| RatingString |
DT_WSTR
|
nvarchar(100)
|
100 | |
| Rating |
DT_I4
|
int
|
||
| VisitorCountryCode |
DT_WSTR
|
nvarchar(50)
|
50 | |
| VisitorName |
DT_WSTR
|
nvarchar(500)
|
500 | |
| VisitorEmail |
DT_WSTR
|
nvarchar(1000)
|
1000 | |
| VisitorId |
DT_WSTR
|
nvarchar(500)
|
500 | |
| VisitorChannelDetailsChannel |
DT_WSTR
|
nvarchar(100)
|
100 | |
| VisitorChannelDetailsSource |
DT_WSTR
|
nvarchar(4000)
|
4000 | |
| VisitorSupportedOperations |
DT_WSTR
|
nvarchar(4000)
|
4000 | |
| VisitorIp |
DT_WSTR
|
nvarchar(500)
|
500 | |
| VisitorPhone |
DT_WSTR
|
nvarchar(500)
|
500 | |
| VisitorType |
DT_WSTR
|
nvarchar(100)
|
100 | |
| VisitorChannelName |
DT_WSTR
|
nvarchar(100)
|
100 | |
| HasNotes |
DT_BOOL
|
bit
|
||
| UnreadChats |
DT_BOOL
|
bit
|
||
| Uvid |
DT_WSTR
|
nvarchar(500)
|
500 | |
| StatusCode |
DT_I4
|
int
|
||
| DepartmentName |
DT_WSTR
|
nvarchar(500)
|
500 | |
| DepartmentId |
DT_WSTR
|
nvarchar(500)
|
500 | |
| AppName |
DT_WSTR
|
nvarchar(100)
|
100 | |
| LastModifiedTime |
DT_DBTIMESTAMP
|
datetime
|
||
| AppId |
DT_WSTR
|
nvarchar(500)
|
500 | |
| Type |
DT_WSTR
|
nvarchar(50)
|
50 | |
| ChatStatusStateKey |
DT_WSTR
|
nvarchar(50)
|
50 | |
| ChatStatusStatusCode |
DT_I4
|
int
|
||
| ChatStatusState |
DT_I4
|
int
|
||
| ChatStatusId |
DT_WSTR
|
nvarchar(50)
|
50 | |
| ChatStatusLabel |
DT_WSTR
|
nvarchar(500)
|
500 | |
| ChatStatusStatusKey |
DT_WSTR
|
nvarchar(100)
|
100 | |
| ReferenceId |
DT_WSTR
|
nvarchar(50)
|
50 | |
| MissedTime |
DT_DBTIMESTAMP
|
datetime
|
||
| VisitorUuid |
DT_WSTR
|
nvarchar(500)
|
500 | |
| Supervisors |
DT_WSTR
|
nvarchar(4000)
|
4000 | |
| OwnerImageKey |
DT_WSTR
|
nvarchar(500)
|
500 | |
| OwnerName |
DT_WSTR
|
nvarchar(500)
|
500 | |
| OwnerIsBot |
DT_BOOL
|
bit
|
||
| OwnerCallEnabled |
DT_BOOL
|
bit
|
||
| EndedByName |
DT_WSTR
|
nvarchar(500)
|
500 | |
| EndedByType |
DT_WSTR
|
nvarchar(100)
|
100 | |
| EndedById |
DT_WSTR
|
nvarchar(500)
|
500 | |
| AttenderImageKey |
DT_WSTR
|
nvarchar(500)
|
500 | |
| AttenderEmail |
DT_WSTR
|
nvarchar(500)
|
500 | |
| AttenderName |
DT_WSTR
|
nvarchar(500)
|
500 | |
| AttenderIsBot |
DT_BOOL
|
bit
|
||
| AttenderCallEnabled |
DT_BOOL
|
bit
|
||
| AttenderId |
DT_WSTR
|
nvarchar(500)
|
500 | |
| Participants |
DT_WSTR
|
nvarchar(4000)
|
4000 | |
| AttendedTime |
DT_DBTIMESTAMP
|
datetime
|
||
| LastMessageInfoSequenceId |
DT_WSTR
|
nvarchar(50)
|
50 | |
| LastMessageInfoSenderName |
DT_WSTR
|
nvarchar(500)
|
500 | |
| LastMessageInfoSenderId |
DT_WSTR
|
nvarchar(500)
|
500 | |
| LastMessageInfoType |
DT_WSTR
|
nvarchar(50)
|
50 | |
| LastMessageInfoTime |
DT_DBTIMESTAMP
|
datetime
|
||
| LastMessageInfoLastReadMessageId |
DT_WSTR
|
nvarchar(500)
|
500 | |
| LastMessageInfoId |
DT_WSTR
|
nvarchar(500)
|
500 | |
| VisitorStatusWhileEnd |
DT_WSTR
|
nvarchar(100)
|
100 | |
| CustomerInfoCompany |
DT_WSTR
|
nvarchar(500)
|
500 | |
| LastMessageInfoText |
DT_WSTR
|
nvarchar(4000)
|
4000 | |
| LastMessageInfoFormattedText |
DT_WSTR
|
nvarchar(4000)
|
4000 | |
| LastMessageInfoMessage |
DT_WSTR
|
nvarchar(4000)
|
4000 | |
| LastMessageInfoMessageTime |
DT_DBTIMESTAMP
|
datetime
|
||
| LastMessageInfoMode |
DT_WSTR
|
nvarchar(100)
|
100 | |
| LastMessageInfoOperationUserName |
DT_WSTR
|
nvarchar(500)
|
500 | |
| LastMessageInfoOperationUserId |
DT_WSTR
|
nvarchar(500)
|
500 | |
| OwnerAboutme |
DT_WSTR
|
nvarchar(500)
|
500 | |
| AttenderAboutme |
DT_WSTR
|
nvarchar(500)
|
500 | |
| LastMessageInfoEditedTime |
DT_DBTIMESTAMP
|
datetime
|
||
| LastMessageInfoEdited |
DT_BOOL
|
bit
|
||
| VisitorUserId |
DT_WSTR
|
nvarchar(500)
|
500 |
Input Columns
| Label | Data Type (SSIS) | Data Type (SQL) | Length | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Examples
SSIS
Use Zoho SalesIQ Connector in API Source or in API Destination SSIS Data Flow components to read or write data.
API Source
This Endpoint belongs to the Conversations table, therefore it is better to use it, instead of accessing the endpoint directly:
| Optional Parameters | |
|---|---|
| Status | |
| OperatorIds | |
| DepartmentId | |
| AppId | |
| StartTime | |
| EndTime | |
| VisitorType | |
| UpdatedTimeStart | |
| UpdatedTimeEnd | |
| SortBy | |
API Destination
This Endpoint belongs to the Conversations table, therefore it is better to use it, instead of accessing the endpoint directly. Use this table and table-operation pair to get conversations:
| Optional Parameters | |
|---|---|
| Status | |
| OperatorIds | |
| DepartmentId | |
| AppId | |
| StartTime | |
| EndTime | |
| VisitorType | |
| UpdatedTimeStart | |
| UpdatedTimeEnd | |
| SortBy | |
ODBC application
Use these SQL queries in your ODBC application data source:
Read conversations
<p>Reads all chat conversations between visitors and operators. This includes message content, timestamps, and visitor details for auditing and analysis.</p> <p>Use the <code>Conversations</code> table to retrieve full chat transcripts and session metadata.</p>
SELECT * FROM Conversations
Read feedback summary by operator
<p>Reads a summary of feedback ratings grouped by operator for the previous year. This aggregation is useful for performance reviews and identifying top-performing agents.</p> <p>This query aggregates data from the <code>Conversations</code> table, grouping by <code>OwnerEmail</code> and <code>RatingString</code> to provide a count of each rating type per operator.</p>
SELECT
OwnerEmail,
OwnerId,
RatingString,
COUNT(Id) Total
FROM Conversations
GROUP BY OwnerEmail, OwnerId, RatingString
ORDER BY OwnerEmail, RatingString
WITH(
--OperatorIds='81565000003048017,81565000002408043' --You can supply Operator Ids to filter result for those Operators only
StartTime='yearstart-1y'
, EndTime='yearstart-1d'
)
get_conversations endpoint belongs to
Conversations
table(s), and can therefore be used via those table(s).
SQL Server
Use these SQL queries in SQL Server after you create a data source in Data Gateway:
Read conversations
<p>Reads all chat conversations between visitors and operators. This includes message content, timestamps, and visitor details for auditing and analysis.</p> <p>Use the <code>Conversations</code> table to retrieve full chat transcripts and session metadata.</p>
DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM Conversations';
EXEC (@MyQuery) AT [LS_TO_ZOHO_SALESIQ_IN_GATEWAY];
Read feedback summary by operator
<p>Reads a summary of feedback ratings grouped by operator for the previous year. This aggregation is useful for performance reviews and identifying top-performing agents.</p> <p>This query aggregates data from the <code>Conversations</code> table, grouping by <code>OwnerEmail</code> and <code>RatingString</code> to provide a count of each rating type per operator.</p>
DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT
OwnerEmail,
OwnerId,
RatingString,
COUNT(Id) Total
FROM Conversations
GROUP BY OwnerEmail, OwnerId, RatingString
ORDER BY OwnerEmail, RatingString
WITH(
--OperatorIds=''81565000003048017,81565000002408043'' --You can supply Operator Ids to filter result for those Operators only
StartTime=''yearstart-1y''
, EndTime=''yearstart-1d''
)';
EXEC (@MyQuery) AT [LS_TO_ZOHO_SALESIQ_IN_GATEWAY];
get_conversations endpoint belongs to
Conversations
table(s), and can therefore be used via those table(s).