An overview of Bot API v3 used with the Automation Framework for bot integration
The Khoros Care Automation Framework and Bot API v3 is your bot integration path for channels supported by Khoros's engagement platform (the underlying technology of Khoros Care and Messaging). You may use the same bot across multiple source channels or use separate bots for different channels. The Framework currently allows a single bot per source network/page.
Bot API v3 supports:
- Bot registration
- General bot functions like responding to a message and passing conversation control
- Changes to the bot operating mode
- Bot health checks
- JWT token refresh and invalidation
Authentication
Bot API v3 endpoints use JWT authentication.
API Gateway
The Bot v3 API uses a different API URL than the v2 APIs. Use one of the following API gateways:
- US -
https://api.app.lithium.com/
- EMEA -
https://api-eu.app.lithium.com/
- APAC -
https://api-ap.app.lithium.com/
Note
All development environments use the US gateway.
Bot registration
Register a bot. |
---|
Register or update a bot. |
GET /bots/v3/registrations/network/networkKey/externalId/externalId Get all bot registrations on Khoros Care for a bot for a given network and external bot ID. |
GET /bots/v3/registrations/network/networkKey/externalId/externalId/appId/appId |
DELETE /bots/v3/registrations/network/networkKey/externalId/externalId/appId/appId |
General bot functions
POST /bots/v3/respond |
---|
GET /bots/v3/control/network/networkKey/externalId/externalId/author/authorId |
GET /bots/v3/request/requestId |
GET /bots/v3/request/appId/appId} |
PUT /bots/v3/control |
PUT /bots/v3/priority |
PUT /bots/v3/tag |
PUT /bots/v3/note |
PUT /bots/v3/workqueue |
PUT /bots/v3/resolve |
PUT /bots/v3/authors/attributes |
Bot operating mode
PUT /bots/v3/registrations/network/networkKey/externalId/externalId/appId/appId/mode/mode |
---|
Bot health
GET /bots/v3/health/appId/appId |
---|
Refresh and invalidate the JWT token
PUT /tokens/appId/appId |
---|
DELETE /tokens/appId/appId |