Get details of a List of Conversations
Description
You can use this API to get the details of a list of conversations.
Query Parameters:
- page - Each page fetches 20 conversations. Use this parameter to fetch the set of conversations with respect to pages.
- limit - Number of conversations to be fetched in a particular request, the default value is 20, and the maximum value is 99.
- status - To list the conversations associated with the specified status (Values: open, closed, waiting, connected, missed, end)
- department_id - To list the conversation associated with the specified department ID, if the department id is not mentioned, then the operator's current department ID will be considered.
- attender_id - The chat attender's (operator) unique ID. To get the list of conversations attended by a particular operator.
- fields - This param can be used to fetch the data of a specified field. You can specify any field, and in the response, you'll receive only the data of the specified field (visitor, department, question, start_time, attended_time, missed_time, end_time, owner, attender, supervisors, participants, status.)
- from_time - The conversations with start time greater than the mentioned time are fetched. The value must be mentioned in milliseconds.
- to_time - The conversations with start time lesser than the mentioned time are fetched. The value must be mentioned in milliseconds.
- app_id - To list the conversation associated with the specified Website/Brand ID.
- email - The conversations associated with the mentioned email IDs are fetched.
- visitor_type - To get the list of all conversations based on the visitor type mentioned. (Values: lead and contact)
- updated_till_time - To get the conversations before the specified update time.
- updated_from_time - To get the conversations after the specified update time.
- sort_by - To sort conversations based on in_time (Chat initiated time), end_time, or updated_time. By default, the conversations are sorted based on updated_time.
Note: For department_id, app_id, and attender_id multiple IDs can be given separated by a comma.
OAuth Scope:
SalesIQ.conversations.READ
URL:
Copiedhttps://{zohosalesiq_server_uri}/api/v2/{screen name}/conversationsExample:
Copiedhttps://salesiq.zoho.com/api/v2/zylker/conversations?status=closed&limit=20
Sample Response:
Copied{
"url": "/api/v2/zylker/conversations",
"object": "list",
"data": [
{
"id": "19000000085003",
"end_time": "1567141185253",
"owner": {
"email": "patricia@zylker.com",
"name": "Patricia",
"id": "19000000079005"
},
"question": "hello",
"attender": {
"email": "tricia@zylker.com",
"name": "Tricia",
"id": "19000000079006"
},
"status": "Attended Online",
"department": {
"name": "conversation2",
"id": "19000000000017"
},
"participants": [
{
"email": "Danny@zylker.com",
"name": "Danny",
"id": "19000000079007"
}
],
"start_time": "1567073480392",
"visitor": {
"phone": "122321421341",
"email": "Daffany@zylker.com",
"name": "Daffany"
},
"app_id": "19000000000047",
"supervisors": [
{
"email": "Dency@zylker.com",
"name": "Dency",
"id": "19000000000008"
}
],
"attended_time": "1567073481231"
},
{
"id": "19000000084165",
"end_time": "1566976875732",
"owner": {
"email": "Patricia@zylker.com",
"name": "Patricia",
"id": "19000000079005"
},
"question": "Bot pickuped?",
"attender": {
"email": "Tricia@zylker.com",
"name": "Tricia",
"id": "19000000079006"
},
"status": "Attended Online",
"department": {
"name": "conversation2",
"id": "19000000000017"
},
"participants": [
{
"email": "Danny@zylker.com",
"name": "Danny",
"id": "19000000079007"
},
{
"email": "Dency@zylker.com",
"name": "Dency",
"id": "19000000000008"
}
],
"start_time": "1566976697276",
"visitor": {
"phone": "0098765434567876",
"email": "Danna@zylker.com",
"name": "Dann"
},
"app_id": "19000000000047",
"supervisors": [
{
"email": "Tricia@zylker.com",
"name": "Tricia",
"id": "19000000000006"
}
],
"last_message_info": {
"sender": {
"name": "Dann",
"id": "$2487775191209924871"
},
"type": "text",
"message": {
"text": "I would like to contact the shipping status team."
},
"time": "1566976680259"
},
"attended_time": "1566976697476"
}
],
"more_data_available": true
}