Deployement management of Chatbots

Search…
Deployement management of Chatbots
In this section we will discuss the deployment management of Chatbots which consists of deployment/undeployment, checking status of deployment and list all the deployed Chatbots.
After all the resources required of the chatbot has been well created and configured ( Dictionary ,Behavior Rules,Output,Package,etc..) and the Chatbot is created through a POST to the API endpoint /botstore/bots, the deployment management of the Chatbots is offered by EDDI is key to have granular control over the deployed bots.
Deployment of a Chatbot :
The deployment of a specific chatbot is done through a POST to /administration/{environment}/deploy/{botId}
Deploy Chatbot REST API Endpoint
Element
Value
HTTP Method
POST
API endpoint
/administration/{environment}/deploy/{botId}
{environment}
(Path parameter):String deployment environment (e.g: restricted,unrestricted,test)
{botId}
(Path parameter):String id of the bot that you wish to deploy.
Example :
Request URL:
http://localhost:7070/administration/unrestricted/deploy/5aaf98e19f7dd421ac3c7de9?version=1&autoDeploy=true
Response Body:
no content
Response Code:
202
Response Headers:
1
{
2
"access-control-allow-origin": "*",
3
"date": "Mon, 19 Mar 2018 16:32:58 GMT",
4
"access-control-allow-headers": "authorization, Content-Type",
5
"content-length": "0",
6
"access-control-allow-methods": "GET, PUT, POST, DELETE, PATCH, OPTIONS",
7
"content-type": null
8
}
Copied!
Undeployment of a Chatbot
The undeployment of a specific chatbot is done through a POST to /administration/{environment}/undeploy/{botId}
Undeploy Chatbot REST API Endpoint
Element
Value
HTTP Method
POST
API endpoint
/administration/{environment}/undeploy/{botId}
{environment}
(Path parameter):String deployment environment (e.g: restricted,unrestricted,test)
{botId}
(Path parameter):String id of the bot that you wish to undeploy.
Example :
Undeploy a chatbot
Request URL
http://localhost:7070/administration/unrestricted/undeploy/5aaf98e19f7dd421ac3c7de9?version=1
Response Body
no content
Response Code
202
Response Headers
1
{
2
"access-control-allow-origin": "*",
3
"date": "Mon, 19 Mar 2018 16:38:36 GMT",
4
"access-control-allow-headers": "authorization, Content-Type",
5
"content-length": "0",
6
"access-control-allow-methods": "GET, PUT, POST, DELETE, PATCH, OPTIONS",
7
"content-type": null
8
​
9
}
Copied!
Check the deployment status of a chatbot:
Check the deployment status of a bot is done through a GET to /administration/{environment}/deploymentstatus/{botId}
Deployment status of a Chatbot REST API Endpoint
Element
Value
HTTP Method
GET
Api endpoint
/administration/{environment}/deploymentstatus/{botId}
{environment}
(Path parameter):String deployment environment (e.g: restricted,unrestricted,test)
{botId}
(Path parameter):String id of the bot that you wish to check its deployment status.
Response
NOT_FOUND, IN_PROGRESS, ERROR and READY.
Example:
Request URL
http://localhost:7070/administration/unrestricted/deploymentstatus/5aaf98e19f7dd421ac3c7de9?version=1
Response Body
READY
Response Code
200
Response Headers
List all deployed Chatbots:
1
{
2
"access-control-allow-origin": "*",
3
"date": "Mon, 19 Mar 2018 16:33:08 GMT",
4
"access-control-allow-headers": "authorization, Content-Type",
5
"content-length": "5",
6
"access-control-allow-methods": "GET, PUT, POST, DELETE, PATCH, OPTIONS",
7
"content-type": "text/plain;charset=utf-8"
8
}
Copied!
To list all the deployed Chabots a GET to /administration/{environment}/deploymentstore/{botId}:
List of Deployed Chatbots REST API Endpoint
Element
Value
HTTP Method
GET
API endpoint
/deploymentstore/deployments
Example :
Request URL
http://localhost:7070/deploymentstore/deployments
Response Code
200
Response Body
1
[
2
  {
3
    "botId": "5aaf90e29f7dd421ac3c7dd4",
4
    "botVersion": 1,
5
    "environment": "unrestricted",
6
    "deploymentStatus": "deployed"
7
  },
8
  {
9
    "botId": "5aaf90e29f7dd421ac3c7dd4",
10
    "botVersion": 1,
11
    "environment": "restricted",
12
    "deploymentStatus": "deployed"
13
  },
14
  {
15
    "botId": "5aaf98e19f7dd421ac3c7de9",
16
    "botVersion": 1,
17
    "environment": "unrestricted",
18
    "deploymentStatus": "deployed"
19
  }
20
]
Copied!
Response Headers
1
{
2
"access-control-allow-origin": "*",
3
"date": "Mon, 19 Mar 2018 16:33:29 GMT",
4
"access-control-allow-headers": "authorization, Content-Type",
5
"content-length": "414",
6
"access-control-allow-methods": "GET, PUT, POST, DELETE, PATCH, OPTIONS",
7
"content-type": "application/json"
8
}
Copied!
Managed Bots
Extensions
Last modified 1yr ago
Export as PDF
Copy link
Contents
Deployement management of Chatbots
Deployment of a Chatbot :
Deploy Chatbot REST API Endpoint
Example :
Undeployment of a Chatbot
Undeploy Chatbot REST API Endpoint
Example :
Check the deployment status of a chatbot:
Example:
List all deployed Chatbots:
List of Deployed Chatbots REST API Endpoint
Example :