{
"opencollection": "1.0.0",
"info": {
"name": "Bots API",
"version": "1.0.0"
},
"items": [
{
"info": {
"name": "Bots",
"type": "folder"
},
"items": [
{
"info": {
"name": "Trigger Bot Calls",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://cliq.zoho.com/api/v3/bots/:BOT_UNIQUE_NAME/calls",
"params": [
{
"name": "BOT_UNIQUE_NAME",
"value": "BOT_UNIQUE_NAME",
"type": "path",
"description": "Unique identifier of the bot from which bot call needs to be triggered. To learn how to retrieve this ID, see BOT_UNIQUE_NAME in the Glossary page."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "implicit",
"authorizationUrl": "https://accounts.zoho.com/oauth/v2/auth",
"credentials": {
"clientId": "{{clientId}}"
}
}
},
"docs": "Utilize this API to send a voice alert to specific users via the bot.\n
\n
\n Threshold limit: 10 requests per 5 min per user
\n Number of API calls allowed within a minute.
\n Lock period: 30 minutes
Wait time before consecutive API requests.
\n
\n Threshold limit: 30 requests per min per user
\n Number of API calls allowed within a minute.
\n Lock period: 5 minutes
Wait time before consecutive API requests.
\n
unique_name as a permanent identifier for the bot - this cannot be changed even if the display name is updated later.fields query parameter to fetch additional details such as subscriber count or handler code.\n\n Threshold limit: 30 requests per min per user
\n Number of API calls allowed within a minute.
\n Lock period: 5 minutes
Wait time before consecutive API requests.
\n
unique_name is auto-assigned by Cliq upon creation and serves as a permanent identifier. It cannot be changed even if the display name is updated.execution_url can be updated independently - you can point the bot to a n"
},
{
"info": {
"name": "Delete a specific bot",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://cliq.zoho.com/api/v3/bots/:BOT_ID",
"params": [
{
"name": "BOT_ID",
"value": "BOT_ID",
"type": "path",
"description": "Unique numeric identifier of the bot.\nHow to retrieve BOT_ID?\n Threshold limit: 10 requests per min per user
\n Number of API calls allowed within a minute.
\n Lock period: 5 minutes
Wait time before consecutive API requests.
\n
\n Threshold limit: 50 requests per min per user
\n Number of API calls allowed within a minute.
\n Lock period: 10 minutes
Wait time before consecutive API requests.
\n
\n Threshold limit: 50 requests per min per user
\n Number of API calls allowed within a minute.
\n Lock period: 10 minutes
Wait time before consecutive API requests.
\n
\n Create a handler for a specific bot by providing the handler type and the execution logic for that event.
\n Handlers define the bot's behavior for different trigger events. Refer introduction to bot handlers in the documentation for more details on each handler type and when it is triggered.\n
\n The way you define a handler depends on the bot's execution type:\n
\nwelcome_handler: Executes when a user subscribes to the bot.message_handler: Executes when the bot receives a message.mention_handler: Executes when the bot is mentioned in a message.context_handler: Executes based on specific contextual triggers defined by the bot.participation_handler: Executes when the bot is added to or removed from a channel.incoming_webhook_handler: Executes when a message is received via an incoming webhook.menu_handler: Executes when a user interacts with a menu action associated with the bot.call_handler: Executes on bot call state events (e.g., ringing, answered, ended).\n Threshold limit: 10 requests per min per user
\n Number of API calls allowed within a minute.
\n Lock period: 5 minutes
Wait time before consecutive API requests.
\n
welcome_handler: Executes when a user subscribes to the bot.message_handler: Executes when the bot receives a message.mention_handler: Executes when the bot is mentioned in a message.context_handler: Executes based on specific contextual triggers defined by the bot.participation_handler: Executes when the bot is added to or removed from a channel.incoming_webhook_handler: Executes when a message is received via an incoming webhook.menu_handler: Executes when a user interacts with a menu action associated with the bot.call_handler: Executes on bot call state events (e.g., ringing, answered, ended).\n Update a handler for a specific bot by providing the handler type and the revised execution logic or configuration to apply for that event.
\n Handlers define the bot's behavior for different trigger events. Refer introduction to bot handlers in the documentation for more details on each handler type and when it is triggered.\n
\n What you can update depends on the bot's execution type:\n
\nwelcome_handler: Executes when a user subscribes to the bot.message_handler: Executes when the bot receives a message.mention_handler: Executes when the bot is mentioned in a message.context_handler: Executes based on specific contextual triggers defined by the bot.participation_handler: Executes when the bot is added to or removed from a channel.incoming_webhook_handler: Executes when a message is received via an incoming webhook.menu_handler: Executes when a user interacts with a menu action associated with the bot.call_handler: Executes on bot call state events (e.g., ringing, answered, ended).\n Threshold limit: 10 requests per min per user
\n Number of API calls allowed within a minute.
\n Lock period: 5 minutes
Wait time before consecutive API requests.
\n
\n Threshold limit: 5 requests per min per user
\n Number of API calls allowed within a minute.
\n Lock period: 5 minutes
Wait time before consecutive API requests.
\n
supportbot).\n Threshold limit: 100 requests per min per user
\n Number of API calls allowed within a min"
}
]
}
],
"bundled": true
}