API Guide

To add or remove the ability to access bot builder to create new bots. This API requires JWT generated by an application created only from the Bot Admin Console. Method POST Endpoint https://{{host}}/api/public/useraccess Content Type application/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope Bot Builder:…

To add or remove users or groups from admin roles. This API requires JWT generated by an application created only from the Bot Admin Console. Method POST Endpoint https://{{host}}/api/public/adminroles/assignments/ Content Type application/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope Bot Builder: Not Applicable Admin Console:…

To assign a bot role to a set of users in a specific bot. This API requires JWT generated by an application created only from the Bot Admin Console. Method POST Endpoint https://{{host}}/api/public/btroles/assignments/ Content Type application/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope Bot Builder:…

To get the list of groups and group members available in the account. This API requires JWT generated by an application created only from the Bot Admin Console. Method GET Endpoint https://{{host}}/api/public/groups?offset=0&limit=2 Content Type application/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope Bot Builder: Not…

To retrieve the list of the bots available in an account. This API requires JWT generated by an application created only from Bot Admin Console. Method GET Endpoint https://{{host}}/api/public/bots?offset=0&limit=50s Content Type application/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope Bot Builder: Not Applicable Admin Console:…

To retrieve the list of the bot or admin roles available in an account. This API requires JWT generated by an application created only from the Bot Admin Console. Method GET Endpoint https://{{host}}/api/public/roles?roleType=bot&limit=2 Content Type application/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope Bot Builder:…

To export bot or admin roles from an account. This is typically used to export roles from one environment to another. This API requires JWT generated by an application created only from the Bot Admin Console. Method GET Endpoint https://{{host}}/api/public/roles/export?roleType=admin Content Type application/json Authorization auth: {{JWT}} See How to generate…

To import bot or admin roles into an account. This is typically used to import roles from one environment to another. This API requires JWT generated by an application created only from Bot Admin Console. Method POST Endpoint https://{{host}}/api/public/roles/import?roleType=bot&fullImport=true Content Type application/json Authorization auth: {{JWT}} See How to generate the…

To get the list of changes made to the bot definition for a given date period. Method GET Endpoint https://{{host}}/api/public/bot/{{BotID}}/changelogs Content Type application/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope Bot Builder: Logs History Admin Console: Logs > Bot Audit Logs Path Parameters Parameter Required/Optional…

To get the status of the FAQ training.   Method GET Endpoint https://{{host}}/api/public/bot/{{BotID}}/faqs/train/status?language={{Lang}}&state={{state}} Content Type application/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope Bot Builder: Train FAQ Admin Console: Test and Train > Train FAQ   Path Parameters Parameter Description Mandate host The environment URL.…