Get the list of Bots
Description
You can use this API to get the list of chatbots available on your portal.
OAuth Scope: bots.READ
Method: GET
Query Parameters
- limit- The number of bots you would like to fetch. The max limit is 1000 and if it is not provided the default value will be taken as 1000. For example, you can provide the limit as 10 to fetch the bot list in a set of 10.
- index- As the bots list is limited to 1000 per fetch, you can use this param to fetch the next set of bots. The index starts from 1 and the default value is 1.
URL:
Copiedhttps://{[zohosalesiq_server_uri](https://www.zoho.com/salesiq/help/developer-section/rest-api-v2.html)}/api/v2/{screenname}/bots
Example
Copiedhttps://salesiq.zoho.com/api/v2/zylker/bots
Sample Response Case 1 - Codeless bot
Copied{
"url": "/api/v2/zylker/bots",
"object": "list",
"data": [
{
"modifier": {
"name": "james",
"id": "44230000001285013"
},
"connector": {
"owner": {
"email_id": "jacknelson@zylker.com",
"name": "Jack Nelson",
"id": "44230000001145029"
},
"status": "enabled",
"type": "flow"
},
"modified_time": "1656480114139",
"image_fkey": "",
"permissions": "15",
"enabled": true,
"creator": {
"name": "james",
"id": "44230000001285013"
},
"source_type": "developed",
"deleted": false,
"id": "44230000013120009",
"description": "",
"app_id": "44230000013120001",
"department_ids": [],
"all_departments": true,
"published": true,
"stats": {
"last_used_time_in_millis": "1656482169464",
"total_chat_duration_in_millis": "2049800",
"number_of_transfered_chats": "1",
"number_of_chats": "5",
"number_of_resolved_chats": "4"
},
"created_time": "1656479791048",
"image_url": "",
"name": "Zbot"
}
],
"sync_time": "1656485740830"
}Sample Response Case 2 - SalesIQ Scripts
Copied{
"url": "/api/v2/zylker/bots",
"object": "list",
"data": [
{
"modifier": {
"name": "james",
"id": "44230000001285013"
},
"connector": {
"owner": {
"email_id": "jacknelson@zylker.com",
"name": "Jack Nelson",
"id": "4423003434445029"
},
"status": "enabled",
"type": "dre"
},
"modified_time": "1656480114139",
"image_fkey": "",
"permissions": "15",
"enabled": true,
"creator": {
"name": "james",
"id": "44230000001285013"
},
"source_type": "developed",
"deleted": false,
"id": "44230000013120009",
"description": "",
"app_id": "44230000013120001",
"department_ids": [],
"all_departments": true,
"published": true,
"stats": {
"last_used_time_in_millis": "1656482169464",
"total_chat_duration_in_millis": "2049800",
"number_of_transfered_chats": "1",
"number_of_chats": "5",
"number_of_resolved_chats": "4"
},
"created_time": "1656479791048",
"image_url": "",
"name": "Zack"
}
],
"sync_time": "1656485740830"
}Sample Response Case 3.1 - Webhooks
Copied{
"url": "/api/v2/zylker/bots",
"object": "list",
"data": [
{
"modifier": {
"name": "james",
"id": "44230000001285013"
},
"connector": {
"owner": {
"email_id": "jacknelson@zylker.com",
"name": "Jack Nelson",
"id": "44230000001145029"
},
"status": "enabled",
"type": "webhook"
},
"modified_time": "1656480114139",
"image_fkey": "",
"permissions": "15",
"enabled": true,
"creator": {
"name": "james",
"id": "44230000001285013"
},
"source_type": "developed",
"deleted": false,
"id": "44230000013120009",
"description": "",
"app_id": "44230000013120001",
"department_ids": [],
"all_departments": true,
"published": true,
"stats": {
"last_used_time_in_millis": "1656482169464",
"total_chat_duration_in_millis": "2049800",
"number_of_transfered_chats": "1",
"number_of_chats": "5",
"number_of_resolved_chats": "4"
},
"created_time": "1656479791048",
"image_url": "",
"name": "Dot"
}
],
"sync_time": "1656485740830"
}Sample Response Case 3.2 - Webhooks (Vendor Platform)
Copied{
"url": "/api/v2/zylker/bots",
"object": "list",
"data": [
{
"modifier": {
"name": "james",
"id": "42960000000002075"
},
"connector": {
"owner": {
"email_id": "jacknelson@zylker.com",
"name": "Jack Nelson",
"id": "44230000001145029"
},
"status": "unavailable",
"type": "webhook"
},
"modified_time": "1646042343021",
"image_fkey": "",
"permissions": "7",
"enabled": false,
"creator": {
"name": "james",
"id": "42960000000002075"
},
"source_type": "vendor",
"deleted": false,
"id": "42960000004385005",
"description": "Bot that works with haptik AI",
"app_id": "42960000000002043",
"department_ids": [
"42960000000002013"
],
"vendor": {
"version": "1.0.0",
"email_id": "james@zylker.com",
"name": "James Platform",
"website": "www.zoho.com/salesiq",
"logo_url": "/sites/zweb/images/salesiq/salesiq-logo.png",
"console_url": "https://irobo.com/developerconsole"
},
"all_departments": false,
"published": false,
"stats": {
"last_used_time_in_millis": "0",
"total_chat_duration_in_millis": "0",
"number_of_transfered_chats": "0",
"number_of_chats": "0",
"number_of_resolved_chats": "0"
},
"created_time": "1645512103788",
"image_url": "",
"name": "Zoe"
}
],
"sync_time": "1656485740830"
}Sample Response Case 4 - Zia Skills
Copied{
"url": "/api/v2/zylker/bots",
"object": "list",
"data": [
{
"modifier": {
"name": "james",
"id": "44230000001285013"
},
"connector": {
"owner": {
"email_id": "jacknelson@zylker.com",
"name": "Jack Nelson",
"id": "44230000001145029"
},
"status": "enabled",
"type": "ziaplatform"
},
"modified_time": "1656480114139",
"image_fkey": "",
"permissions": "15",
"enabled": true,
"creator": {
"name": "james",
"id": "44230000001285013"
},
"source_type": "developed",
"deleted": false,
"id": "44230000013120009",
"description": "",
"app_id": "44230000013120001",
"department_ids": [],
"all_departments": true,
"published": true,
"stats": {
"last_used_time_in_millis": "1656482169464",
"total_chat_duration_in_millis": "2049800",
"number_of_transfered_chats": "1",
"number_of_chats": "5",
"number_of_resolved_chats": "4"
},
"created_time": "1656479791048",
"image_url": "",
"name": "Dot"
}
],
"sync_time": "1656485740830"
}Sample Response Case 5 - Watson Assistant
Copied{
"url": "/api/v2/zylker/bots",
"object": "list",
"data": [
{
"modifier": {
"name": "james",
"id": "44230000001285013"
},
"connector": {
"owner": {
"email_id": "jacknelson@zylker.com",
"name": "Jack Nelson",
"id": "44230000001145029"
},
"status": "enabled",
"host_url": https://gateway.watsonplatform.net/assistant/api",
"type": "watson",
"api_key": "Oxyif2r10g2Rx6cEg4ci8vh4rjr9Jk4iG-Rn4_edZ0"
},
"modified_time": "1656480114139",
"image_fkey": "",
"permissions": "15",
"enabled": true,
"creator": {
"name": "james",
"id": "44230000001285013"
},
"source_type": "developed",
"deleted": false,
"id": "44230000013120009",
"description": "",
"app_id": "44230000013120001",
"department_ids": [],
"all_departments": true,
"published": true,
"stats": {
"last_used_time_in_millis": "1656482169464",
"total_chat_duration_in_millis": "2049800",
"number_of_transfered_chats": "1",
"number_of_chats": "5",
"number_of_resolved_chats": "4"
},
"created_time": "1656479791048",
"image_url": "",
"name": "Zoy"
}
],
"sync_time": "1656485740830"
}Sample Response Case 6 - Azure Service
Copied{
"url": "/api/v2/zylker/bots",
"object": "list",
"data": [
{
"modifier": {
"name": "james",
"id": "44230000001285013"
},
"connector": {
"owner": {
"email_id": "jacknelson@zylker.com",
"name": "Jack Nelson",
"id": "44230000001145029"
},
"status": "enabled",
"type": "msbotframework"
},
"modified_time": "1656480114139",
"image_fkey": "",
"permissions": "15",
"enabled": true,
"creator": {
"name": "james",
"id": "44230000001285013"
},
"source_type": "developed",
"deleted": false,
"id": "44230000013120009",
"description": "",
"app_id": "44230000013120001",
"department_ids": [],
"all_departments": true,
"published": true,
"stats": {
"last_used_time_in_millis": "1656482169464",
"total_chat_duration_in_millis": "2049800",
"number_of_transfered_chats": "1",
"number_of_chats": "5",
"number_of_resolved_chats": "4"
},
"created_time": "1656479791048",
"image_url": "",
"name": "Jot"
}
],
"sync_time": "1656485740830"
}Sample Response Case 7 - Dialogflow
Copied{
"url": "/api/v2/zylker/bots",
"object": "list",
"data": [
{
"modifier": {
"name": "james",
"id": "44230000001285013"
},
"connector": {
//Email ID synced with the Dialogflow
"email_id": "james@gmail.com"
"owner": {
//Email ID of the bot creator in SalesIQ
"email_id": "jacknelson@zylker.com"",
"name": "Jack Nelson",
"id": "44230000001145029"
},
"status": "enabled",
"type": "dialogflow"
},
"modified_time": "1656480114139",
"image_fkey": "",
"permissions": "15",
"enabled": true,
"creator": {
"name": "james",
"id": "44230000001285013"
},
"source_type": "developed",
"deleted": false,
"id": "44230000013120009",
"description": "",
"app_id": "44230000013120001",
"department_ids": [],
"all_departments": true,
"published": true,
"stats": {
"last_used_time_in_millis": "1656482169464",
"total_chat_duration_in_millis": "2049800",
"number_of_transfered_chats": "1",
"number_of_chats": "5",
"number_of_resolved_chats": "4"
},
"created_time": "1656479791048",
"image_url": "",
"name": "Zeo"
}
],
"sync_time": "1656485740830"
}