Reference

Endpoint Get Conversations

Name

get_conversations

Description

No description available

Related Tables

Conversations

Parameters

Parameter Required Options
Name: Status

Label: Status
Option Value
open open
closed closed
waiting waiting
connected connected
missed missed
end end
Name: OperatorIds

Label: OperatorIds
Name: DepartmentId

Label: DepartmentId
Name: AppId

Label: AppId
Name: Email

Label: Email
Name: StartTime

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)
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
Name: EndTime

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)
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
Name: VisitorType

Label: VisitorType
Option Value
lead lead
contact contact
Name: UpdatedTimeStart

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)
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
Name: UpdatedTimeEnd

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)
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
Name: SortBy

Label: SortBy
Option Value
end_time end_time
updated_time updated_time
Name: PageSize

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
If the column you are looking for is missing, consider customizing Zoho SalesIQ Connector.

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:

API Source - Zoho SalesIQ
Zoho SalesIQ Connector can be used to integrate Zoho SalesIQ API in your App / BI Tools. You can exchange data on Chats, Visits and more.
Zoho SalesIQ
Conversations
Optional Parameters
Status
OperatorIds
DepartmentId
AppId
Email
StartTime
EndTime
VisitorType
UpdatedTimeStart
UpdatedTimeEnd
SortBy
SSIS API Source - Read from table or endpoint

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:

API Destination - Zoho SalesIQ
Zoho SalesIQ Connector can be used to integrate Zoho SalesIQ API in your App / BI Tools. You can exchange data on Chats, Visits and more.
Zoho SalesIQ
Conversations
Select
Optional Parameters
Status
OperatorIds
DepartmentId
AppId
Email
StartTime
EndTime
VisitorType
UpdatedTimeStart
UpdatedTimeEnd
SortBy
SSIS API Destination - Access table operation

ODBC application

Use these SQL queries in your ODBC application data source:

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 (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).