Bot
Bots are your Virtual Agents.
Paginations and Listings
Paginates through all Bots in an Environment. Removed Bots are not retrieved, and neither are Bots whose the current used has no access to.
A valid uuid of organization
A valid uuid of environment
Term being searched. This expects one optional String matching the name of a bot, left to right from the begining of it's name.
Current page, starting at 1.
1
Items per page, defaulted to 7.
7
Criteria to order result, defaulted to createdAt date.
createdAt
Order direction(ASC/DESC), defaulted to DESC
DESC
Searches (greedily) for any tag names that exists in a bot, matching the typed term, left-to-right, and returns a list of up to 6 Strings, ordered alphabetically.
A valid organization Uuid
A valid environment Uuid
Term being searched
How many items will be returned in the list. Defaults to 6.
6
Retrieves a list containing simplified information from all Bots within an Environment. Does not retrieve removed Bots.
A valid uuid of organization
A valid uuid of environment
CRUD Operations
A valid uuid of organization
A valid uuid of environment
A valid uuid of bot
Controls wether the returned default image is a thumbnail version or full image; user-submitted images are unaffected. Default value is false. (Full version)
false
A valid uuid of organization
A valid uuid of environment
Data to create a new bot
Name of the bot
Locale of the bot
Base64 of the bot's image in the DataURI format.
[DEPRECATED] Content-type of the bot image. Inferred from the image field.
Metadata of bot's nlp engine. OBS: Its not required if wants to insert or update bot clever
Name of the first channel to create with the bot
Type of the first channel to create with the bot. Types: 1 - Amazon Echo, 2 - Google Home, 4 - Jibo, 5 - Alexa, 6 - Cortana, 7 - Google Assistant, 8 - Siri, 9 - Facebook, 10 - RCS, 11 - SMS, 12 - Skype, 13 - ARCore, 14 - ARKit, 15 - Android, 16 - iOS, 17 - IVR, 18 - VR, 19 - Web, 20 - Web Mobile, 21 - App Mobile, 22 - WhatsApp, 24 - Skype for Business, 25 - Telegram, 26 - Twitter, 27 - WhatsApp (Infobip), 28 - HTC Vive, 29 - Oculus Rift, 30 - Oculus Go, 31 - Samsung Gear VR, 32 - Hololens, 33 - Apple Business Chat, 34 - Microsoft Teams
Description of the first channel to create with the bot
NlpName of the bot. Options: Clever, Watson, Luis, DialogFlow, Lex
Api key of the analytic platform: Dashbot, Chatbase...
A valid uuid of organization
A valid uuid of environment
A valid uuid of bot
Data to update bot
Name of the bot
Locale of the bot
Base64 of the bot's image in the DataURI format.
[DEPRECATED] Content-type of the bot image. Inferred from the image field.
Metadata of bot's nlp engine. OBS: Its not required if wants to insert or update bot clever
Api key of the analytic platform: Dashbot, Chatbase...
Returns the image of a Bot given it's UUID. If a Bot doesn't have image, returns a default image instead.
A valid uuid of organization
A valid uuid of environment
A valid uuid of bot
If return default image and has this parameter, will return default image thumb version
Last updated
Was this helpful?