Zoho SalesIQ Connector
Documentation
Version: 2
Documentation
Endpoint

Get Conversations

Name

get_conversations

Description

No description available

Related Tables

Conversations

Parameters

Parameter Label Required Options Description
Status Status NO
Option Value
open open
closed closed
waiting waiting
connected connected
missed missed
end end
OperatorIds OperatorIds NO
DepartmentId DepartmentId NO
AppId AppId NO
Email Email NO
StartTime StartTime NO
Option Value
2023-12-31T00:00:00 2023-12-31T00:00:00
now now
today today
yesterday yesterday
yearstart-10y yearstart-10y
monthstart monthstart
monthend monthend
yearstart yearstart
yearend yearend
weekstart weekstart
weekend weekend
yearstart-1y yearstart-1y
yearend-1y yearend-1y
monthstart-1d monthstart-1d
monthend+1d monthend+1d
monthend+1d-1y monthend+1d-1y
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)
EndTime EndTime NO
Option Value
2023-12-31T00:00:00 2023-12-31T00:00:00
now now
today today
yesterday yesterday
yearstart-10y yearstart-10y
monthstart monthstart
monthend monthend
yearstart yearstart
yearend yearend
weekstart weekstart
weekend weekend
yearstart-1y yearstart-1y
yearend-1y yearend-1y
monthstart-1d monthstart-1d
monthend+1d monthend+1d
monthend+1d-1y monthend+1d-1y
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)
VisitorType VisitorType NO
Option Value
lead lead
contact contact
UpdatedTimeStart UpdatedTimeStart NO
Option Value
2023-12-31T00:00:00 2023-12-31T00:00:00
now now
today today
yesterday yesterday
yearstart-10y yearstart-10y
monthstart monthstart
monthend monthend
yearstart yearstart
yearend yearend
weekstart weekstart
weekend weekend
yearstart-1y yearstart-1y
yearend-1y yearend-1y
monthstart-1d monthstart-1d
monthend+1d monthend+1d
monthend+1d-1y monthend+1d-1y
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)
UpdatedTimeEnd UpdatedTimeEnd NO
Option Value
2023-12-31T00:00:00 2023-12-31T00:00:00
now now
today today
yesterday yesterday
yearstart-10y yearstart-10y
monthstart monthstart
monthend monthend
yearstart yearstart
yearend yearend
weekstart weekstart
weekend weekend
yearstart-1y yearstart-1y
yearend-1y yearend-1y
monthstart-1d monthstart-1d
monthend+1d monthend+1d
monthend+1d-1y monthend+1d-1y
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)
SortBy SortBy NO
Option Value
end_time end_time
updated_time updated_time
PageSize PageSize NO

Output Columns

Label Data Type (SSIS) Data Type (SQL) Length Raw Description
Id DT_WSTR nvarchar(500) 500 False
Question DT_WSTR nvarchar(4000) 4000 False
Status DT_WSTR nvarchar(500) 500 False
StartTime DT_DBTIMESTAMP datetime False
EndTime DT_DBTIMESTAMP datetime False
ChatDuration DT_WSTR nvarchar(500) 500 False
MissedReason DT_WSTR nvarchar(500) 500 False
OwnerEmail DT_WSTR nvarchar(500) 500 False
OwnerId DT_WSTR nvarchar(500) 500 False
RatingString DT_WSTR nvarchar(100) 100 False
Rating DT_I4 int False
VisitorCountryCode DT_WSTR nvarchar(50) 50 False
VisitorName DT_WSTR nvarchar(500) 500 False
VisitorEmail DT_WSTR nvarchar(1000) 1000 False
VisitorId DT_WSTR nvarchar(500) 500 False
VisitorChannelDetailsChannel DT_WSTR nvarchar(100) 100 False
VisitorChannelDetailsSource DT_WSTR nvarchar(4000) 4000 False
VisitorSupportedOperations DT_WSTR nvarchar(4000) 4000 False
VisitorIp DT_WSTR nvarchar(500) 500 False
VisitorPhone DT_WSTR nvarchar(500) 500 False
VisitorType DT_WSTR nvarchar(100) 100 False
VisitorChannelName DT_WSTR nvarchar(100) 100 False
HasNotes DT_BOOL bit False
UnreadChats DT_BOOL bit False
Uvid DT_WSTR nvarchar(500) 500 False
StatusCode DT_I4 int False
DepartmentName DT_WSTR nvarchar(500) 500 False
DepartmentId DT_WSTR nvarchar(500) 500 False
AppName DT_WSTR nvarchar(100) 100 False
LastModifiedTime DT_DBTIMESTAMP datetime False
AppId DT_WSTR nvarchar(500) 500 False
Type DT_WSTR nvarchar(50) 50 False
ChatStatusStateKey DT_WSTR nvarchar(50) 50 False
ChatStatusStatusCode DT_I4 int False
ChatStatusState DT_I4 int False
ChatStatusId DT_WSTR nvarchar(50) 50 False
ChatStatusLabel DT_WSTR nvarchar(500) 500 False
ChatStatusStatusKey DT_WSTR nvarchar(100) 100 False
ReferenceId DT_WSTR nvarchar(50) 50 False
MissedTime DT_DBTIMESTAMP datetime False
VisitorUuid DT_WSTR nvarchar(500) 500 False
Supervisors DT_WSTR nvarchar(4000) 4000 False
OwnerImageKey DT_WSTR nvarchar(500) 500 False
OwnerName DT_WSTR nvarchar(500) 500 False
OwnerIsBot DT_BOOL bit False
OwnerCallEnabled DT_BOOL bit False
EndedByName DT_WSTR nvarchar(500) 500 False
EndedByType DT_WSTR nvarchar(100) 100 False
EndedById DT_WSTR nvarchar(500) 500 False
AttenderImageKey DT_WSTR nvarchar(500) 500 False
AttenderEmail DT_WSTR nvarchar(500) 500 False
AttenderName DT_WSTR nvarchar(500) 500 False
AttenderIsBot DT_BOOL bit False
AttenderCallEnabled DT_BOOL bit False
AttenderId DT_WSTR nvarchar(500) 500 False
Participants DT_WSTR nvarchar(4000) 4000 False
AttendedTime DT_DBTIMESTAMP datetime False
LastMessageInfoSequenceId DT_WSTR nvarchar(50) 50 False
LastMessageInfoSenderName DT_WSTR nvarchar(500) 500 False
LastMessageInfoSenderId DT_WSTR nvarchar(500) 500 False
LastMessageInfoType DT_WSTR nvarchar(50) 50 False
LastMessageInfoTime DT_DBTIMESTAMP datetime False
LastMessageInfoLastReadMessageId DT_WSTR nvarchar(500) 500 False
LastMessageInfoId DT_WSTR nvarchar(500) 500 False
VisitorStatusWhileEnd DT_WSTR nvarchar(100) 100 False
CustomerInfoCompany DT_WSTR nvarchar(500) 500 False
LastMessageInfoText DT_WSTR nvarchar(4000) 4000 False
LastMessageInfoFormattedText DT_WSTR nvarchar(4000) 4000 False
LastMessageInfoMessage DT_WSTR nvarchar(4000) 4000 False
LastMessageInfoMessageTime DT_DBTIMESTAMP datetime False
LastMessageInfoMode DT_WSTR nvarchar(100) 100 False
LastMessageInfoOperationUserName DT_WSTR nvarchar(500) 500 False
LastMessageInfoOperationUserId DT_WSTR nvarchar(500) 500 False
OwnerAboutme DT_WSTR nvarchar(500) 500 False
AttenderAboutme DT_WSTR nvarchar(500) 500 False
LastMessageInfoEditedTime DT_DBTIMESTAMP datetime False
LastMessageInfoEdited DT_BOOL bit False
VisitorUserId DT_WSTR nvarchar(500) 500 False
If the column you are looking for is missing, consider customizing Zoho SalesIQ Connector.

Input Columns

Label Data Type (SSIS) Data Type (SQL) Length Raw 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 component to read data or in API Destination component to read/write data:

Read from Conversations table using API Destination

This Endpoint belongs to Conversations table, therefore you cannot work with it directly. Use this table and table-operation pair instead:

Zoho SalesIQ
Conversations
Select
SSIS API Destination - Access table operation

ODBC application

Use these SQL queries in your ODBC application data source:

Get conversations 

SELECT * FROM get_conversations

Get Conversations (i.e. chats)

List all conversations (chats) 

SELECT * FROM Conversations

Get Total Feedbacks by Rating Type and Operator for Last Year

Count Feedbacks by Rating Type and Operator for Last Year. 

SELECT
 OwnerEmail,
 OwnerId, 
 RatingString,
 COUNT(Id) Total
FROM Conversations
GROUP BY OwnerEmail, OwnerId, RatingString
Order BY OwnerEmail,RatingString
WITH(
	  --OperatorIds='81565000003048017,81565000002408043,81565000013131025' --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:

Get conversations 

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM get_conversations';

EXEC (@MyQuery) AT [LS_TO_ZOHO_SALESIQ_IN_GATEWAY];

Get Conversations (i.e. chats)

List all conversations (chats) 

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM Conversations';

EXEC (@MyQuery) AT [LS_TO_ZOHO_SALESIQ_IN_GATEWAY];

Get Total Feedbacks by Rating Type and Operator for Last Year

Count Feedbacks by Rating Type and Operator for Last Year. 

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,81565000013131025'' --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).