{ "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
\nDefault value is 20 and maximum allowed value is 50.\n" }, { "name": "sync_token", "value": "", "type": "query", "description": "To fetch the bots which recently got added or updated after the previous request was made. \n" }, { "name": "next_token", "value": "", "type": "query", "description": "Pagination token to fetch the next set of bots.\n" } ], "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.zoho.com/oauth/v2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Retrieves a paginated list of all Bots available to the user.

\nUse limit and next_token for cursor-based pagination, sync_token for incremental sync, and search and scope to filter results when browsing the Marketplace catalogue.\n
\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

\n" }, { "info": { "name": "Create a bot", "type": "http" }, "http": { "method": "POST", "url": "https://cliq.zoho.com/api/v3/bots", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.zoho.com/oauth/v2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Create a new bot in Cliq by specifying the bot's display name, description, and access level (organization or team). Upon creation, Cliq auto-assigns a unique_name as a permanent identifier for the bot - this cannot be changed even if the display name is updated later.

After creation, add handlers to define the bot's behaviour for each trigger event.
\nWith this API, you can create both Deluge bots (which run handler log" }, { "info": { "name": "Retrieve details of a specific bot", "type": "http" }, "http": { "method": "GET", "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.
\nTo learn how to retrieve this ID, see BOT_ID in the Glossary page.\n" }, { "name": "fields", "value": "subscription_details", "type": "query", "description": "Additonal field to be fetched in the response. By default, the API returns basic details of the bot along with a summary of its handlers (type and count).\n
\nAllowed value
\n\n" } ], "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.zoho.com/oauth/v2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Retrieves the full configuration and details of a specific bot, including its name, description, unique name, access level, and handler summary.
\nUse the fields query parameter to fetch additional details such as subscriber count or handler code.\n

\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

\n
\nTo learn how to retrieve this ID, see BOT_ID in the Glossary page.\n" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://accounts.zoho.com/oauth/v2/auth", "credentials": { "clientId": "{{clientId}}" } } }, "docs": "Update the details and configuration of an existing bot. You can change the bot's display name, description, access level (organization-wide, team, or personal), and logo.
\n
Note:\n