Taskbot Version

Taskbot Versions
- Taskbot Versions Manage
GET bot/taskbotVersions
GET bot/taskbotVersions/{id}
POST bot/taskbotVersions
Taskbot Actions
- Taskbot Actions Manage
GET bot/taskbotActions
GET bot/taskbotActions/{id}
POST bot/taskbotActions
PUT bot/taskbotActions/{id}
DELETE bot/taskbotActions/{id}
Taskbot Starts
- Taskbot Starts Manage
GET bot/taskbotActions/{id}/taskbotStart
PUT bot/taskbotActions/{id}/taskbotStart
Taskbot Collect Comments
- Taskbot Collect Comments Manage
GET bot/taskbotActions/{id}/taskbotCollectComment
PUT bot/taskbotActions/{id}/taskbotCollectComment
Taskbot Collect Company Names
- Taskbot Collect Company Names Manage
GET bot/taskbotActions/{id}/taskbotCollectCompanyName
PUT bot/taskbotActions/{id}/taskbotCollectCompanyName
Taskbot Collect Emails
- Taskbot Collect Emails Manage
GET bot/taskbotActions/{id}/taskbotCollectEmail
PUT bot/taskbotActions/{id}/taskbotCollectEmail
Taskbot Send Emails
- Taskbot Send Emails Manage
GET bot/taskbotActions/{id}/taskbotSendEmail
PUT bot/taskbotActions/{id}/taskbotSendEmail
Taskbot Book Meetings
- Taskbot Book Meetings Manage
GET bot/taskbotActions/{id}/taskbotBookMeeting
PUT bot/taskbotActions/{id}/taskbotBookMeeting
Taskbot Collect Locations
- Taskbot Collect Locations Manage
GET bot/taskbotActions/{id}/taskbotCollectLocation
PUT bot/taskbotActions/{id}/taskbotCollectLocation
Taskbot Collect Names
- Taskbot Collect Names Manage
GET bot/taskbotActions/{id}/taskbotCollectName
PUT bot/taskbotActions/{id}/taskbotCollectName
Taskbot Collect Phone Numbers
- Taskbot Collect Phone Numbers Manage
GET bot/taskbotActions/{id}/taskbotCollectPhoneNumber
PUT bot/taskbotActions/{id}/taskbotCollectPhoneNumber
Taskbot Collect Variable Datas
- Taskbot Collect Variable Datas Manage
GET bot/taskbotActions/{id}/taskbotCollectVariableData
PUT bot/taskbotActions/{id}/taskbotCollectVariableData
Taskbot Go To Taskbots
- Taskbot Go To Taskbots Manage
GET bot/taskbotActions/{id}/taskbotGotoTaskbot
PUT bot/taskbotActions/{id}/taskbotGotoTaskbot
Taskbot Quick Replies
- Taskbot Quick Replies Manage
GET bot/taskbotActions/{id}/taskbotQuickReply
PUT bot/taskbotActions/{id}/taskbotQuickReply
Taskbot Quick Reply Options
- Taskbot Quick Reply Options Manage
GET bot/taskbotQuickReplyOptions
GET bot/taskbotQuickReplyOptions/{id}
POST bot/taskbotQuickReplyOptions
PUT bot/taskbotQuickReplyOptions/{id}
DELETE bot/taskbotQuickReplyOptions/{id}
Taskbot Send Images
- Taskbot Send Images Manage
GET bot/taskbotActions/{id}/taskbotSendImage
PUT bot/taskbotActions/{id}/taskbotSendImage
Taskbot Send Messages
- Taskbot Send Messages Manage
GET bot/taskbotActions/{id}/taskbotSendMessage
PUT bot/taskbotActions/{id}/taskbotSendMessage
Taskbot Send Message Buttons
- Taskbot Send Message Buttons Manage
GET bot/taskbotSendMessageButtons
GET bot/taskbotSendMessageButtons/{id}
POST bot/taskbotSendMessageButtons
PUT bot/taskbotSendMessageButtons/{id}
DELETE bot/taskbotSendMessageButtons/{id}
Taskbot Send Videos
- Taskbot Send Videos Manage
GET bot/taskbotActions/{id}/taskbotSendVideo
PUT bot/taskbotActions/{id}/taskbotSendVideo
Taskbot SSO Login Buttons
- Taskbot SSO Login Buttons Manage
GET bot/taskbotActions/{id}/taskbotSSOLoginButton
PUT bot/taskbotActions/{id}/taskbotSSOLoginButton
Taskbot Webhooks
- Taskbot Webhooks Manage
GET bot/taskbotActions/{id}/taskbotWebhook
PUT bot/taskbotActions/{id}/taskbotWebhook
Taskbot Webhook Headers
- Taskbot Webhook Headers Manage
GET bot/taskbotWebhookHeaders
GET bot/taskbotWebhookHeaders/{id}
POST bot/taskbotWebhookHeaders
PUT bot/taskbotWebhookHeaders/{id}
DELETE bot/taskbotWebhookHeaders/{id}
Taskbot Webhook Response To Variables
- Taskbot Webhook Response To Variables Manage
GET bot/taskbotWebhookResponseToVariables
GET bot/taskbotWebhookResponseToVariables/{id}
POST bot/taskbotWebhookResponseToVariables
PUT bot/taskbotWebhookResponseToVariables/{id}
DELETE bot/taskbotWebhookResponseToVariables/{id}
Taskbot Webhook Response Code To Actions
- Taskbot Webhook Response Code To Actions Manage
GET bot/taskbotWebhookResponseCodeToActions
GET bot/taskbotWebhookResponseCodeToActions/{id}
POST bot/taskbotWebhookResponseCodeToActions
PUT bot/taskbotWebhookResponseCodeToActions/{id}
DELETE bot/taskbotWebhookResponseCodeToActions/{id}
Model
Taskbot Version JSON Format

Taskbot Version is represented as simple flat JSON objects with the following keys:

Name Type Description
id guid Id of the taskbot version.
taskbotId guid Id of the taskbot.
createdTime datetime Taskbot created time.
taskbotActions taskbotActions[] Reference to Taskbot Action.
Endpoint
Get the list of Taskbot Versions

GET bot/taskbotVersions

Parameters:
Name Type In Required Description
taskbotId guid query no Id of the taskbot.
include string query no Allowed value is "taskbotAction".
Response:

An array of   Taskbot Version

Example

Sample Request:

curl https://api15.comm100.io/v4/bot/taskbotVersions \
-X 'GET' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

[{"id":"00000000-0000-0000-0000-000000000000","taskbotId":"00000000-0000-0000-0000-000000000000","createdTime":"2021-04-07T05:59:17.887Z","taskbotActions":[{"taskbotVersionId":"7A6A35A3-814A-EB11-8100-00155D081D0B","xPosition":50,"yPosition":50,"type":"taskbotStart","id":"A762827E-0D4B-EB11-8100-00155D081D0B","taskbotStart":{"taskbotActionId":"F8A7A50B-B049-EB11-8100-00155D081D0B","nextActionId":"d2be5b63-24dc-4c14-9926-788e9af54760"},"taskbotCollectComment":{"typingDelay":1.0,"message":"text","nextActionId":"D4C7158C-644A-EB11-8100-00155D081D0B","taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B"},"taskbotCollectCompanyName":{"typingDelay":1.0,"message":"text","nextActionId":"D4C7158C-644A-EB11-8100-00155D081D0B","taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B"},"taskbotCollectEmail":{"typingDelay":1.0,"message":"text","nextActionId":"D4C7158C-644A-EB11-8100-00155D081D0B","taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B"},"taskbotSendEmail":{"taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","subject":"subject","content":"content","to":"test@comm100.com","cc":"test1@comm100.com","nextActionId":"9F813BFF-E65A-EB11-8101-00155D081D0B"},"taskbotBookMeeting":{"taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","failedActionId":"5341d43d-2238-43a0-a5e1-5bf8e471ea93","successActionId":"d6bd7d9a-536e-43e4-a030-7b9f36b6ab4f","integrationCalendlyId":"64bb87e4-6940-4d2c-a6e4-176d52b8e9b8","calendlyEventTypeUri":"https://..."},"taskbotCollectLocation":{"taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","typingDelay":1.0,"message":"shareLocation","buttonText":"button","successActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","failedActionId":"D6C7158C-644A-EB11-8100-00155D081D0B"},"taskbotCollectName":{"taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","nextActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","message":"text","typingDelay":1.0},"taskbotCollectPhoneNumber":{"typingDelay":1.0,"message":"text","nextActionId":"D4C7158C-644A-EB11-8100-00155D081D0B","taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B"},"taskbotCollectVariableData":{"taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","nextActionId":"D4C7158C-644A-EB11-8100-00155D081D0B","variableName":"name","options":"option1","message":"text","typingDelay":1.0,"type":"<!DOCTYPE html>\r\n?<html>\r\n?<head>\r\n? <title>{{title}}</title>\r\n? <meta charset=\"UTF-8\" />\r\n? <meta http-equiv=\"X-UA-Compatible\" content=\"IE=edge,chrome=1\" />\r\n? <meta name=\"viewport\" content=\"width=device-width, initial-scale=1.0\" />\r\n? <script type=\"text/javascript\" src=\"/kb/resources/js/jquery-1.10.2.min.js\"></script>\r\n? <script type=\"text/javascript\" src=\"/kb/resources/js/common.js?v=gbrqhch3oj0lob1m2w\"></script>\r\n? <link href=\"{{cssUrl}}\" rel=\"stylesheet\" type=\"text/css\" />\r\n? <link rel=\"canonical\" href=\"{{url}}\" />\r\n?</head>\r\n?<body>\r\n? <div class=\"header\">\r\n? <div class=\"container\">\r\n? <div class=\"header_logo\"><img src=\"/kb/resources/your_logo.png\" /></div>\r\n? <div class=\"header__title\"><span>Find answers in our Knowledge Base</span></div>\r\n? <div class=\"header__search\">\r\n? <input type=\"text\" class=\"search-input header__searchinput\" placeholder=\"Enter your question...\" autocomplete=\"off\" />\r\n? <i class=\"iconfont icon-search\"></i>\r\n? </div>\r\n? </div>\r\n? </div>\r\n? <div class=\"content\">\r\n? <div class=\"container\">\r\n? <div class=\"breadcrumbs\">\r\n? {{breadcrumbs}}\r\n? </div>\r\n? <div class=\"category-list\">\r\n? {% for category in categories %}\r\n? <div class=\"category-list__item\">\r\n? <div class=\"category-list__item__header\" onclick=\"showHide();\">\r\n? <i class=\"iconfont icon-folder\"></i>\r\n? <div class=\"category-list__item__name\"><a href=\"{{category.url}}\">{{category.name}}</a></div>\r\n? <i class=\"iconfont icon-fold\"></i>\r\n? </div>\r\n? <div class=\"category-list__item__content collapse\">\r\n? <div class=\"article-list\" id=\"{{category.id}}\">\r\n? {% for article in articles %}\r\n? {% if category.id == article.category_id %}\r\n? <div class=\"article-list__title\">\r\n? {% if article.if_featured %}\r\n? <i class=\"iconfont icon-feature\"></i>\r\n? {% endif %}\r\n? <a href=\"{{article.url}}\">{{article.title}}</a>\r\n? </div>\r\n? {% endif %}\r\n? {% endfor %}\r\n? </div>\r\n? </div>\r\n? </div>\r\n? {% endfor %}\r\n? </div>\r\n? </div>\r\n? </div>\r\n?</body>\r\n?</html>"},"taskbotGotoTaskbot":{"taskbotActionId":"4E8E8CE8-AD49-EB11-8100-00155D081D0B","taskbotId":"4E8E8CE8-AD49-EB11-8100-00155D081D0B"},"taskbotQuickReply":{"taskbotActionId":"D0948954-AE49-EB11-8100-00155D081D0B","typingDelay":1.0,"message":"link to baidu","otherResponseToActionId":"4CB9B085-AC49-EB11-8100-00155D081D0B","taskbotQuickReplyOptions":[{"id":"EF948954-AE49-EB11-8100-00155D081D0B","taskbotActionId":"D0948954-AE49-EB11-8100-00155D081D0B","text":"Baidu","order":0,"nextActionId":"F5948954-AE49-EB11-8100-00155D081D0B"}]},"taskbotSendImage":{"taskbotActionId":"7AE8FDBF-504A-EB11-8100-00155D081D0B","nextActionId":"8AE8FDBF-504A-EB11-8100-00155D081D0B","typingDelay":1.0,"message":"test","image":"https://api15.comm100.io/v4/Bot/taskbotSendImages/7AE8FDBF-504A-EB11-8100-00155D081D0B/image"},"taskbotSendMessage":{"taskbotActionId":"F8A7A50B-B049-EB11-8100-00155D081D0B","typingDelay":1.0,"message":"hi","nextActionId":"693c1ffa-4d57-40d2-9fc0-68e89430b4f1","taskbotSendMessageButtons":[{"id":"a46afdad-82c9-4405-bb4b-8d5517ef57d8","taskbotActionId":"E4099BB1-774A-EB11-8100-00155D081D0B","buttonText":"test","url":"https://...","order":1,"type":"link","openIn":"currentWindow","openStyle":"compact"}]},"taskbotSendVideo":{"taskbotActionId":"4CB9B085-AC49-EB11-8100-00155D081D0B","nextActionId":"D0948954-AE49-EB11-8100-00155D081D0B","typingDelay":1.0,"message":"test","videoUrl":"https://..."},"taskbotSSOLoginButton":{"taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","typingDelay":1.0,"message":"To get personized service, you need to login first.","loginButtonText":"login","loginInActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","failedActionId":"D6C7158C-644A-EB11-8100-00155D081D0B"},"taskbotTransferChat":{"taskbotActionId":"B0101911-4E4A-EB11-8100-00155D081D0B","type":"transferToDepartment","transferTo":"EF101911-4E4A-EB11-8100-00155D081D0B","whenAgentOfflineToActionId":"5A101911-4E4A-EB11-8100-00155D081D0B"},"taskbotWebhook":{"taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","url":"https://...","ifSendChatTranscript":false,"additionalPostBody":"","otherResponseToActionId":"4CB006E2-BA49-EB11-8100-00155D081D0B","taskbotWebhookHeaders":[{"id":"4DB006E2-BA49-EB11-8100-00155D081D0B","taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","key":"key","value":"value","order":1}],"taskbotWebhookResponseToVariables":[{"id":"D4C7158C-644A-EB11-8100-00155D081D0B","taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","variableName":"name","responseKey":"text","order":1}],"taskbotWebhookResponseCodeToActions":[{"id":"4DB006E2-BA49-EB11-8100-00155D081D0B","taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","responseCode":"","nextActionId":"5AB006E2-BA49-EB11-8100-00155D081D0B","order":1}]}}]}]
Get a single Taskbot Version

GET bot/taskbotVersions/{id}

Parameters:
Name Type In Required Description
include string query no Allowed value is "taskbotAction".
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/bot/taskbotVersions/00000000-0000-0000-0000-000000000000 \
-X 'GET' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

{"id":"00000000-0000-0000-0000-000000000000","taskbotId":"00000000-0000-0000-0000-000000000000","createdTime":"2021-04-07T05:59:17.887Z","taskbotActions":[{"taskbotVersionId":"7A6A35A3-814A-EB11-8100-00155D081D0B","xPosition":50,"yPosition":50,"type":"taskbotStart","id":"A762827E-0D4B-EB11-8100-00155D081D0B","taskbotStart":{"taskbotActionId":"F8A7A50B-B049-EB11-8100-00155D081D0B","nextActionId":"d2be5b63-24dc-4c14-9926-788e9af54760"},"taskbotCollectComment":{"typingDelay":1.0,"message":"text","nextActionId":"D4C7158C-644A-EB11-8100-00155D081D0B","taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B"},"taskbotCollectCompanyName":{"typingDelay":1.0,"message":"text","nextActionId":"D4C7158C-644A-EB11-8100-00155D081D0B","taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B"},"taskbotCollectEmail":{"typingDelay":1.0,"message":"text","nextActionId":"D4C7158C-644A-EB11-8100-00155D081D0B","taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B"},"taskbotSendEmail":{"taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","subject":"subject","content":"content","to":"test@comm100.com","cc":"test1@comm100.com","nextActionId":"9F813BFF-E65A-EB11-8101-00155D081D0B"},"taskbotBookMeeting":{"taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","failedActionId":"5341d43d-2238-43a0-a5e1-5bf8e471ea93","successActionId":"d6bd7d9a-536e-43e4-a030-7b9f36b6ab4f","integrationCalendlyId":"64bb87e4-6940-4d2c-a6e4-176d52b8e9b8","calendlyEventTypeUri":"https://..."},"taskbotCollectLocation":{"taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","typingDelay":1.0,"message":"shareLocation","buttonText":"button","successActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","failedActionId":"D6C7158C-644A-EB11-8100-00155D081D0B"},"taskbotCollectName":{"taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","nextActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","message":"text","typingDelay":1.0},"taskbotCollectPhoneNumber":{"typingDelay":1.0,"message":"text","nextActionId":"D4C7158C-644A-EB11-8100-00155D081D0B","taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B"},"taskbotCollectVariableData":{"taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","nextActionId":"D4C7158C-644A-EB11-8100-00155D081D0B","variableName":"name","options":"option1","message":"text","typingDelay":1.0,"type":"<!DOCTYPE html>\r\n?<html>\r\n?<head>\r\n? <title>{{title}}</title>\r\n? <meta charset=\"UTF-8\" />\r\n? <meta http-equiv=\"X-UA-Compatible\" content=\"IE=edge,chrome=1\" />\r\n? <meta name=\"viewport\" content=\"width=device-width, initial-scale=1.0\" />\r\n? <script type=\"text/javascript\" src=\"/kb/resources/js/jquery-1.10.2.min.js\"></script>\r\n? <script type=\"text/javascript\" src=\"/kb/resources/js/common.js?v=gbrqhch3oj0lob1m2w\"></script>\r\n? <link href=\"{{cssUrl}}\" rel=\"stylesheet\" type=\"text/css\" />\r\n? <link rel=\"canonical\" href=\"{{url}}\" />\r\n?</head>\r\n?<body>\r\n? <div class=\"header\">\r\n? <div class=\"container\">\r\n? <div class=\"header_logo\"><img src=\"/kb/resources/your_logo.png\" /></div>\r\n? <div class=\"header__title\"><span>Find answers in our Knowledge Base</span></div>\r\n? <div class=\"header__search\">\r\n? <input type=\"text\" class=\"search-input header__searchinput\" placeholder=\"Enter your question...\" autocomplete=\"off\" />\r\n? <i class=\"iconfont icon-search\"></i>\r\n? </div>\r\n? </div>\r\n? </div>\r\n? <div class=\"content\">\r\n? <div class=\"container\">\r\n? <div class=\"breadcrumbs\">\r\n? {{breadcrumbs}}\r\n? </div>\r\n? <div class=\"category-list\">\r\n? {% for category in categories %}\r\n? <div class=\"category-list__item\">\r\n? <div class=\"category-list__item__header\" onclick=\"showHide();\">\r\n? <i class=\"iconfont icon-folder\"></i>\r\n? <div class=\"category-list__item__name\"><a href=\"{{category.url}}\">{{category.name}}</a></div>\r\n? <i class=\"iconfont icon-fold\"></i>\r\n? </div>\r\n? <div class=\"category-list__item__content collapse\">\r\n? <div class=\"article-list\" id=\"{{category.id}}\">\r\n? {% for article in articles %}\r\n? {% if category.id == article.category_id %}\r\n? <div class=\"article-list__title\">\r\n? {% if article.if_featured %}\r\n? <i class=\"iconfont icon-feature\"></i>\r\n? {% endif %}\r\n? <a href=\"{{article.url}}\">{{article.title}}</a>\r\n? </div>\r\n? {% endif %}\r\n? {% endfor %}\r\n? </div>\r\n? </div>\r\n? </div>\r\n? {% endfor %}\r\n? </div>\r\n? </div>\r\n? </div>\r\n?</body>\r\n?</html>"},"taskbotGotoTaskbot":{"taskbotActionId":"4E8E8CE8-AD49-EB11-8100-00155D081D0B","taskbotId":"4E8E8CE8-AD49-EB11-8100-00155D081D0B"},"taskbotQuickReply":{"taskbotActionId":"D0948954-AE49-EB11-8100-00155D081D0B","typingDelay":1.0,"message":"link to baidu","otherResponseToActionId":"4CB9B085-AC49-EB11-8100-00155D081D0B","taskbotQuickReplyOptions":[{"id":"EF948954-AE49-EB11-8100-00155D081D0B","taskbotActionId":"D0948954-AE49-EB11-8100-00155D081D0B","text":"Baidu","order":0,"nextActionId":"F5948954-AE49-EB11-8100-00155D081D0B"}]},"taskbotSendImage":{"taskbotActionId":"7AE8FDBF-504A-EB11-8100-00155D081D0B","nextActionId":"8AE8FDBF-504A-EB11-8100-00155D081D0B","typingDelay":1.0,"message":"test","image":"https://api15.comm100.io/v4/Bot/taskbotSendImages/7AE8FDBF-504A-EB11-8100-00155D081D0B/image"},"taskbotSendMessage":{"taskbotActionId":"F8A7A50B-B049-EB11-8100-00155D081D0B","typingDelay":1.0,"message":"hi","nextActionId":"693c1ffa-4d57-40d2-9fc0-68e89430b4f1","taskbotSendMessageButtons":[{"id":"a46afdad-82c9-4405-bb4b-8d5517ef57d8","taskbotActionId":"E4099BB1-774A-EB11-8100-00155D081D0B","buttonText":"test","url":"https://...","order":1,"type":"link","openIn":"currentWindow","openStyle":"compact"}]},"taskbotSendVideo":{"taskbotActionId":"4CB9B085-AC49-EB11-8100-00155D081D0B","nextActionId":"D0948954-AE49-EB11-8100-00155D081D0B","typingDelay":1.0,"message":"test","videoUrl":"https://..."},"taskbotSSOLoginButton":{"taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","typingDelay":1.0,"message":"To get personized service, you need to login first.","loginButtonText":"login","loginInActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","failedActionId":"D6C7158C-644A-EB11-8100-00155D081D0B"},"taskbotTransferChat":{"taskbotActionId":"B0101911-4E4A-EB11-8100-00155D081D0B","type":"transferToDepartment","transferTo":"EF101911-4E4A-EB11-8100-00155D081D0B","whenAgentOfflineToActionId":"5A101911-4E4A-EB11-8100-00155D081D0B"},"taskbotWebhook":{"taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","url":"https://...","ifSendChatTranscript":false,"additionalPostBody":"","otherResponseToActionId":"4CB006E2-BA49-EB11-8100-00155D081D0B","taskbotWebhookHeaders":[{"id":"4DB006E2-BA49-EB11-8100-00155D081D0B","taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","key":"key","value":"value","order":1}],"taskbotWebhookResponseToVariables":[{"id":"D4C7158C-644A-EB11-8100-00155D081D0B","taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","variableName":"name","responseKey":"text","order":1}],"taskbotWebhookResponseCodeToActions":[{"id":"4DB006E2-BA49-EB11-8100-00155D081D0B","taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","responseCode":"","nextActionId":"5AB006E2-BA49-EB11-8100-00155D081D0B","order":1}]}}]}
Create a new Taskbot Version

POST bot/taskbotVersions

Parameters:
Name Type In Required Description
taskbotId guid body yes Id of the taskbot.
createdTime datetime body no Taskbot created time.
taskbotActions taskbotActions[] body no Reference to Taskbot Action.
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/bot/taskbotVersions \
-X 'POST' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
-D '{"taskbotId":"00000000-0000-0000-0000-000000000000","createdTime":"2021-04-07T05:59:17.887Z","taskbotActions":[{"xPosition":50,"yPosition":50,"type":"taskbotStart","taskbotStart":{"nextActionId":"d2be5b63-24dc-4c14-9926-788e9af54760"},"taskbotSendMessage":{"typingDelay":1.0,"message":"hi","nextActionId":"693c1ffa-4d57-40d2-9fc0-68e89430b4f1","taskbotSendMessageButtons":[{"buttonText":"test","url":"https://...","order":1,"type":"link","openIn":"currentWindow","openStyle":"compact"}]},"taskbotSendImage":{"nextActionId":"8AE8FDBF-504A-EB11-8100-00155D081D0B","typingDelay":1.0,"message":"test","image":""},"taskbotSendVideo":{"nextActionId":"D0948954-AE49-EB11-8100-00155D081D0B","typingDelay":1.0,"message":"test","videoUrl":"https://..."},"taskbotSSOLoginButton":{"typingDelay":1.0,"message":"To get personized service, you need to login first.","loginButtonText":"login","loginInActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","failedActionId":"D6C7158C-644A-EB11-8100-00155D081D0B"},"taskbotCollectLocation":{"typingDelay":1.0,"message":"shareLocation","buttonText":"button","successActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","failedActionId":"D6C7158C-644A-EB11-8100-00155D081D0B"},"taskbotCollectName":{"nextActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","message":"text","typingDelay":1.0},"taskbotCollectEmail":{"typingDelay":1.0,"message":"text","nextActionId":"D4C7158C-644A-EB11-8100-00155D081D0B"},"taskbotCollectPhoneNumber":{"typingDelay":1.0,"message":"text","nextActionId":"D4C7158C-644A-EB11-8100-00155D081D0B"},"taskbotCollectCompanyName":{"typingDelay":1.0,"message":"text","nextActionId":"D4C7158C-644A-EB11-8100-00155D081D0B"},"taskbotCollectComment":{"typingDelay":1.0,"message":"text","nextActionId":"D4C7158C-644A-EB11-8100-00155D081D0B"},"taskbotCollectVariableData":{"nextActionId":"D4C7158C-644A-EB11-8100-00155D081D0B","variableName":"name","options":"option1","message":"text","typingDelay":1.0,"type":"<!DOCTYPE html>\r\n?<html>\r\n?<head>\r\n? <title>{{title}}</title>\r\n? <meta charset=\"UTF-8\" />\r\n? <meta http-equiv=\"X-UA-Compatible\" content=\"IE=edge,chrome=1\" />\r\n? <meta name=\"viewport\" content=\"width=device-width, initial-scale=1.0\" />\r\n? <script type=\"text/javascript\" src=\"/kb/resources/js/jquery-1.10.2.min.js\"></script>\r\n? <script type=\"text/javascript\" src=\"/kb/resources/js/common.js?v=gbrqhch3oj0lob1m2w\"></script>\r\n? <link href=\"{{cssUrl}}\" rel=\"stylesheet\" type=\"text/css\" />\r\n? <link rel=\"canonical\" href=\"{{url}}\" />\r\n?</head>\r\n?<body>\r\n? <div class=\"header\">\r\n? <div class=\"container\">\r\n? <div class=\"header_logo\"><img src=\"/kb/resources/your_logo.png\" /></div>\r\n? <div class=\"header__title\"><span>Find answers in our Knowledge Base</span></div>\r\n? <div class=\"header__search\">\r\n? <input type=\"text\" class=\"search-input header__searchinput\" placeholder=\"Enter your question...\" autocomplete=\"off\" />\r\n? <i class=\"iconfont icon-search\"></i>\r\n? </div>\r\n? </div>\r\n? </div>\r\n? <div class=\"content\">\r\n? <div class=\"container\">\r\n? <div class=\"breadcrumbs\">\r\n? {{breadcrumbs}}\r\n? </div>\r\n? <div class=\"category-list\">\r\n? {% for category in categories %}\r\n? <div class=\"category-list__item\">\r\n? <div class=\"category-list__item__header\" onclick=\"showHide();\">\r\n? <i class=\"iconfont icon-folder\"></i>\r\n? <div class=\"category-list__item__name\"><a href=\"{{category.url}}\">{{category.name}}</a></div>\r\n? <i class=\"iconfont icon-fold\"></i>\r\n? </div>\r\n? <div class=\"category-list__item__content collapse\">\r\n? <div class=\"article-list\" id=\"{{category.id}}\">\r\n? {% for article in articles %}\r\n? {% if category.id == article.category_id %}\r\n? <div class=\"article-list__title\">\r\n? {% if article.if_featured %}\r\n? <i class=\"iconfont icon-feature\"></i>\r\n? {% endif %}\r\n? <a href=\"{{article.url}}\">{{article.title}}</a>\r\n? </div>\r\n? {% endif %}\r\n? {% endfor %}\r\n? </div>\r\n? </div>\r\n? </div>\r\n? {% endfor %}\r\n? </div>\r\n? </div>\r\n? </div>\r\n?</body>\r\n?</html>"},"taskbotWebhook":{"url":"https://...","ifSendChatTranscript":false,"additionalPostBody":"","otherResponseToActionId":"4CB006E2-BA49-EB11-8100-00155D081D0B","taskbotWebhookHeaders":[{"key":"key","value":"value","order":1}],"taskbotWebhookResponseToVariables":[{"variableName":"name","responseKey":"text","order":1}],"taskbotWebhookResponseCodeToActions":[{"responseCode":"","nextActionId":"5AB006E2-BA49-EB11-8100-00155D081D0B","order":1}]},"taskbotSendEmail":{"subject":"subject","content":"content","to":"test@comm100.com","cc":"test1@comm100.com","nextActionId":"9F813BFF-E65A-EB11-8101-00155D081D0B"},"taskbotBookMeeting":{"failedActionId":"5341d43d-2238-43a0-a5e1-5bf8e471ea93","successActionId":"d6bd7d9a-536e-43e4-a030-7b9f36b6ab4f","integrationCalendlyId":"64bb87e4-6940-4d2c-a6e4-176d52b8e9b8","calendlyEventTypeUri":"https://..."},"taskbotGotoTaskbot":{"taskbotId":"4E8E8CE8-AD49-EB11-8100-00155D081D0B"},"taskbotTransferChat":{"type":"transferToDepartment","transferTo":"EF101911-4E4A-EB11-8100-00155D081D0B","whenAgentOfflineToActionId":"5A101911-4E4A-EB11-8100-00155D081D0B"},"taskbotQuickReply":{"typingDelay":1.0,"message":"link to baidu","otherResponseToActionId":"4CB9B085-AC49-EB11-8100-00155D081D0B","taskbotQuickReplyOptions":[{"text":"Baidu","order":0,"nextActionId":"F5948954-AE49-EB11-8100-00155D081D0B"}]}}]}'

Response:

 HTTP/1.1 201 Created

{"id":"00000000-0000-0000-0000-000000000000","taskbotId":"00000000-0000-0000-0000-000000000000","createdTime":"2021-04-07T05:59:17.887Z","taskbotActions":[{"taskbotVersionId":"7A6A35A3-814A-EB11-8100-00155D081D0B","xPosition":50,"yPosition":50,"type":"taskbotStart","id":"A762827E-0D4B-EB11-8100-00155D081D0B","taskbotStart":{"taskbotActionId":"F8A7A50B-B049-EB11-8100-00155D081D0B","nextActionId":"d2be5b63-24dc-4c14-9926-788e9af54760"},"taskbotCollectComment":{"typingDelay":1.0,"message":"text","nextActionId":"D4C7158C-644A-EB11-8100-00155D081D0B","taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B"},"taskbotCollectCompanyName":{"typingDelay":1.0,"message":"text","nextActionId":"D4C7158C-644A-EB11-8100-00155D081D0B","taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B"},"taskbotCollectEmail":{"typingDelay":1.0,"message":"text","nextActionId":"D4C7158C-644A-EB11-8100-00155D081D0B","taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B"},"taskbotSendEmail":{"taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","subject":"subject","content":"content","to":"test@comm100.com","cc":"test1@comm100.com","nextActionId":"9F813BFF-E65A-EB11-8101-00155D081D0B"},"taskbotBookMeeting":{"taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","failedActionId":"5341d43d-2238-43a0-a5e1-5bf8e471ea93","successActionId":"d6bd7d9a-536e-43e4-a030-7b9f36b6ab4f","integrationCalendlyId":"64bb87e4-6940-4d2c-a6e4-176d52b8e9b8","calendlyEventTypeUri":"https://..."},"taskbotCollectLocation":{"taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","typingDelay":1.0,"message":"shareLocation","buttonText":"button","successActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","failedActionId":"D6C7158C-644A-EB11-8100-00155D081D0B"},"taskbotCollectName":{"taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","nextActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","message":"text","typingDelay":1.0},"taskbotCollectPhoneNumber":{"typingDelay":1.0,"message":"text","nextActionId":"D4C7158C-644A-EB11-8100-00155D081D0B","taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B"},"taskbotCollectVariableData":{"taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","nextActionId":"D4C7158C-644A-EB11-8100-00155D081D0B","variableName":"name","options":"option1","message":"text","typingDelay":1.0,"type":"<!DOCTYPE html>\r\n?<html>\r\n?<head>\r\n? <title>{{title}}</title>\r\n? <meta charset=\"UTF-8\" />\r\n? <meta http-equiv=\"X-UA-Compatible\" content=\"IE=edge,chrome=1\" />\r\n? <meta name=\"viewport\" content=\"width=device-width, initial-scale=1.0\" />\r\n? <script type=\"text/javascript\" src=\"/kb/resources/js/jquery-1.10.2.min.js\"></script>\r\n? <script type=\"text/javascript\" src=\"/kb/resources/js/common.js?v=gbrqhch3oj0lob1m2w\"></script>\r\n? <link href=\"{{cssUrl}}\" rel=\"stylesheet\" type=\"text/css\" />\r\n? <link rel=\"canonical\" href=\"{{url}}\" />\r\n?</head>\r\n?<body>\r\n? <div class=\"header\">\r\n? <div class=\"container\">\r\n? <div class=\"header_logo\"><img src=\"/kb/resources/your_logo.png\" /></div>\r\n? <div class=\"header__title\"><span>Find answers in our Knowledge Base</span></div>\r\n? <div class=\"header__search\">\r\n? <input type=\"text\" class=\"search-input header__searchinput\" placeholder=\"Enter your question...\" autocomplete=\"off\" />\r\n? <i class=\"iconfont icon-search\"></i>\r\n? </div>\r\n? </div>\r\n? </div>\r\n? <div class=\"content\">\r\n? <div class=\"container\">\r\n? <div class=\"breadcrumbs\">\r\n? {{breadcrumbs}}\r\n? </div>\r\n? <div class=\"category-list\">\r\n? {% for category in categories %}\r\n? <div class=\"category-list__item\">\r\n? <div class=\"category-list__item__header\" onclick=\"showHide();\">\r\n? <i class=\"iconfont icon-folder\"></i>\r\n? <div class=\"category-list__item__name\"><a href=\"{{category.url}}\">{{category.name}}</a></div>\r\n? <i class=\"iconfont icon-fold\"></i>\r\n? </div>\r\n? <div class=\"category-list__item__content collapse\">\r\n? <div class=\"article-list\" id=\"{{category.id}}\">\r\n? {% for article in articles %}\r\n? {% if category.id == article.category_id %}\r\n? <div class=\"article-list__title\">\r\n? {% if article.if_featured %}\r\n? <i class=\"iconfont icon-feature\"></i>\r\n? {% endif %}\r\n? <a href=\"{{article.url}}\">{{article.title}}</a>\r\n? </div>\r\n? {% endif %}\r\n? {% endfor %}\r\n? </div>\r\n? </div>\r\n? </div>\r\n? {% endfor %}\r\n? </div>\r\n? </div>\r\n? </div>\r\n?</body>\r\n?</html>"},"taskbotGotoTaskbot":{"taskbotActionId":"4E8E8CE8-AD49-EB11-8100-00155D081D0B","taskbotId":"4E8E8CE8-AD49-EB11-8100-00155D081D0B"},"taskbotQuickReply":{"taskbotActionId":"D0948954-AE49-EB11-8100-00155D081D0B","typingDelay":1.0,"message":"link to baidu","otherResponseToActionId":"4CB9B085-AC49-EB11-8100-00155D081D0B","taskbotQuickReplyOptions":[{"id":"EF948954-AE49-EB11-8100-00155D081D0B","taskbotActionId":"D0948954-AE49-EB11-8100-00155D081D0B","text":"Baidu","order":0,"nextActionId":"F5948954-AE49-EB11-8100-00155D081D0B"}]},"taskbotSendImage":{"taskbotActionId":"7AE8FDBF-504A-EB11-8100-00155D081D0B","nextActionId":"8AE8FDBF-504A-EB11-8100-00155D081D0B","typingDelay":1.0,"message":"test","image":"https://api15.comm100.io/v4/Bot/taskbotSendImages/7AE8FDBF-504A-EB11-8100-00155D081D0B/image"},"taskbotSendMessage":{"taskbotActionId":"F8A7A50B-B049-EB11-8100-00155D081D0B","typingDelay":1.0,"message":"hi","nextActionId":"693c1ffa-4d57-40d2-9fc0-68e89430b4f1","taskbotSendMessageButtons":[{"id":"a46afdad-82c9-4405-bb4b-8d5517ef57d8","taskbotActionId":"E4099BB1-774A-EB11-8100-00155D081D0B","buttonText":"test","url":"https://...","order":1,"type":"link","openIn":"currentWindow","openStyle":"compact"}]},"taskbotSendVideo":{"taskbotActionId":"4CB9B085-AC49-EB11-8100-00155D081D0B","nextActionId":"D0948954-AE49-EB11-8100-00155D081D0B","typingDelay":1.0,"message":"test","videoUrl":"https://..."},"taskbotSSOLoginButton":{"taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","typingDelay":1.0,"message":"To get personized service, you need to login first.","loginButtonText":"login","loginInActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","failedActionId":"D6C7158C-644A-EB11-8100-00155D081D0B"},"taskbotTransferChat":{"taskbotActionId":"B0101911-4E4A-EB11-8100-00155D081D0B","type":"transferToDepartment","transferTo":"EF101911-4E4A-EB11-8100-00155D081D0B","whenAgentOfflineToActionId":"5A101911-4E4A-EB11-8100-00155D081D0B"},"taskbotWebhook":{"taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","url":"https://...","ifSendChatTranscript":false,"additionalPostBody":"","otherResponseToActionId":"4CB006E2-BA49-EB11-8100-00155D081D0B","taskbotWebhookHeaders":[{"id":"4DB006E2-BA49-EB11-8100-00155D081D0B","taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","key":"key","value":"value","order":1}],"taskbotWebhookResponseToVariables":[{"id":"D4C7158C-644A-EB11-8100-00155D081D0B","taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","variableName":"name","responseKey":"text","order":1}],"taskbotWebhookResponseCodeToActions":[{"id":"4DB006E2-BA49-EB11-8100-00155D081D0B","taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","responseCode":"","nextActionId":"5AB006E2-BA49-EB11-8100-00155D081D0B","order":1}]}}]}
Model
Taskbot Action JSON Format

Taskbot Action is represented as simple flat JSON objects with the following keys:

Name Type Description
taskbotVersionId guid Id of the taskbot version.
xPosition integer The action's xPosition(in pixel) in the diagram.
yPosition integer The action's yPosition(in pixel) in the diagram.
type string Type of the taskbotAction.Allowed values are "taskbotStart", "taskbotSendMessage", "taskbotSendImage", "taskbotSendVideo", "taskbotSSOLoginButton", "taskbotCollectLocation", "taskbotCollectName", "taskbotCollectEmail", "taskbotCollectPhoneNumber", "taskbotCollectCompanyName", "taskbotCollectComment", "taskbotCollectVariableData", "taskbotWebhook", "taskbotSendEmail", "taskbotBookMeeting", "taskbotGotoTaskbot", "taskbotTransferChat", "taskbotQuickReply".
id guid Id of the taskbot action.
taskbotStart taskbotStart Reference to Taskbot Start.
taskbotCollectComment taskbotCollectComment Reference to Taskbot Collect Comment.
taskbotCollectCompanyName taskbotCollectCompanyName Reference to Taskbot Collect Company Name.
taskbotCollectEmail taskbotCollectEmail Reference to Taskbot Collect Email.
taskbotSendEmail taskbotSendEmail Reference to Taskbot Send Email.
taskbotBookMeeting taskbotBookMeeting Reference to Taskbot Book Meeting.
taskbotCollectLocation taskbotCollectLocation Reference to Taskbot Collect Location.
taskbotCollectName taskbotCollectName Reference to Taskbot Collect Name.
taskbotCollectPhoneNumber taskbotCollectPhoneNumber Reference to Taskbot Collect Phone Number.
taskbotCollectVariableData taskbotCollectVariableData Reference to Taskbot Collect Variable Data.
taskbotGotoTaskbot taskbotGotoTaskbot Reference to Taskbot Go To Taskbot.
taskbotQuickReply taskbotQuickReply Reference to Taskbot Quick Reply.
taskbotSendImage taskbotSendImage Reference to Taskbot Send Image.
taskbotSendMessage taskbotSendMessage Reference to Taskbot Send Message.
taskbotSendVideo taskbotSendVideo Reference to Taskbot Send Video.
taskbotSSOLoginButton taskbotSSOLoginButton Reference to Taskbot SSO Login Button.
taskbotTransferChat taskbotTransferChat Reference to Taskbot Transfer Chat.
taskbotWebhook taskbotWebhook Reference to Taskbot Webhook.
Endpoint
Get the list of Taskbot Actions

GET bot/taskbotActions

Parameters:
Name Type In Required Description
include string query no Allowed values are "taskbotStart", "taskbotCollectComment", "taskbotCollectCompanyName", "taskbotCollectEmail", "taskbotCollectLocation", "taskbotCollectName", "taskbotCollectPhoneNumber", "taskbotCollectVariableData", "taskbotGotoTaskbot", "taskbotQuickReply", "taskbotSendImage", "taskbotSendMessage", "taskbotSendVideo", "taskbotSSOLoginButton", "taskbotWebhook", "taskbotSendEmail", "taskbotBookMeeting".
Response:

An array of   Taskbot Action

Example

Sample Request:

curl https://api15.comm100.io/v4/bot/taskbotActions \
-X 'GET' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

[{"taskbotVersionId":"7A6A35A3-814A-EB11-8100-00155D081D0B","xPosition":50,"yPosition":50,"type":"taskbotStart","id":"A762827E-0D4B-EB11-8100-00155D081D0B","taskbotStart":{"taskbotActionId":"F8A7A50B-B049-EB11-8100-00155D081D0B","nextActionId":"d2be5b63-24dc-4c14-9926-788e9af54760"},"taskbotCollectComment":{"typingDelay":1.0,"message":"text","nextActionId":"D4C7158C-644A-EB11-8100-00155D081D0B","taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B"},"taskbotCollectCompanyName":{"typingDelay":1.0,"message":"text","nextActionId":"D4C7158C-644A-EB11-8100-00155D081D0B","taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B"},"taskbotCollectEmail":{"typingDelay":1.0,"message":"text","nextActionId":"D4C7158C-644A-EB11-8100-00155D081D0B","taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B"},"taskbotSendEmail":{"taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","subject":"subject","content":"content","to":"test@comm100.com","cc":"test1@comm100.com","nextActionId":"9F813BFF-E65A-EB11-8101-00155D081D0B"},"taskbotBookMeeting":{"taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","failedActionId":"5341d43d-2238-43a0-a5e1-5bf8e471ea93","successActionId":"d6bd7d9a-536e-43e4-a030-7b9f36b6ab4f","integrationCalendlyId":"64bb87e4-6940-4d2c-a6e4-176d52b8e9b8","calendlyEventTypeUri":"https://..."},"taskbotCollectLocation":{"taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","typingDelay":1.0,"message":"shareLocation","buttonText":"button","successActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","failedActionId":"D6C7158C-644A-EB11-8100-00155D081D0B"},"taskbotCollectName":{"taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","nextActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","message":"text","typingDelay":1.0},"taskbotCollectPhoneNumber":{"typingDelay":1.0,"message":"text","nextActionId":"D4C7158C-644A-EB11-8100-00155D081D0B","taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B"},"taskbotCollectVariableData":{"taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","nextActionId":"D4C7158C-644A-EB11-8100-00155D081D0B","variableName":"name","options":"option1","message":"text","typingDelay":1.0,"type":"<!DOCTYPE html>\r\n?<html>\r\n?<head>\r\n? <title>{{title}}</title>\r\n? <meta charset=\"UTF-8\" />\r\n? <meta http-equiv=\"X-UA-Compatible\" content=\"IE=edge,chrome=1\" />\r\n? <meta name=\"viewport\" content=\"width=device-width, initial-scale=1.0\" />\r\n? <script type=\"text/javascript\" src=\"/kb/resources/js/jquery-1.10.2.min.js\"></script>\r\n? <script type=\"text/javascript\" src=\"/kb/resources/js/common.js?v=gbrqhch3oj0lob1m2w\"></script>\r\n? <link href=\"{{cssUrl}}\" rel=\"stylesheet\" type=\"text/css\" />\r\n? <link rel=\"canonical\" href=\"{{url}}\" />\r\n?</head>\r\n?<body>\r\n? <div class=\"header\">\r\n? <div class=\"container\">\r\n? <div class=\"header_logo\"><img src=\"/kb/resources/your_logo.png\" /></div>\r\n? <div class=\"header__title\"><span>Find answers in our Knowledge Base</span></div>\r\n? <div class=\"header__search\">\r\n? <input type=\"text\" class=\"search-input header__searchinput\" placeholder=\"Enter your question...\" autocomplete=\"off\" />\r\n? <i class=\"iconfont icon-search\"></i>\r\n? </div>\r\n? </div>\r\n? </div>\r\n? <div class=\"content\">\r\n? <div class=\"container\">\r\n? <div class=\"breadcrumbs\">\r\n? {{breadcrumbs}}\r\n? </div>\r\n? <div class=\"category-list\">\r\n? {% for category in categories %}\r\n? <div class=\"category-list__item\">\r\n? <div class=\"category-list__item__header\" onclick=\"showHide();\">\r\n? <i class=\"iconfont icon-folder\"></i>\r\n? <div class=\"category-list__item__name\"><a href=\"{{category.url}}\">{{category.name}}</a></div>\r\n? <i class=\"iconfont icon-fold\"></i>\r\n? </div>\r\n? <div class=\"category-list__item__content collapse\">\r\n? <div class=\"article-list\" id=\"{{category.id}}\">\r\n? {% for article in articles %}\r\n? {% if category.id == article.category_id %}\r\n? <div class=\"article-list__title\">\r\n? {% if article.if_featured %}\r\n? <i class=\"iconfont icon-feature\"></i>\r\n? {% endif %}\r\n? <a href=\"{{article.url}}\">{{article.title}}</a>\r\n? </div>\r\n? {% endif %}\r\n? {% endfor %}\r\n? </div>\r\n? </div>\r\n? </div>\r\n? {% endfor %}\r\n? </div>\r\n? </div>\r\n? </div>\r\n?</body>\r\n?</html>"},"taskbotGotoTaskbot":{"taskbotActionId":"4E8E8CE8-AD49-EB11-8100-00155D081D0B","taskbotId":"4E8E8CE8-AD49-EB11-8100-00155D081D0B"},"taskbotQuickReply":{"taskbotActionId":"D0948954-AE49-EB11-8100-00155D081D0B","typingDelay":1.0,"message":"link to baidu","otherResponseToActionId":"4CB9B085-AC49-EB11-8100-00155D081D0B","taskbotQuickReplyOptions":[{"id":"EF948954-AE49-EB11-8100-00155D081D0B","taskbotActionId":"D0948954-AE49-EB11-8100-00155D081D0B","text":"Baidu","order":0,"nextActionId":"F5948954-AE49-EB11-8100-00155D081D0B"}]},"taskbotSendImage":{"taskbotActionId":"7AE8FDBF-504A-EB11-8100-00155D081D0B","nextActionId":"8AE8FDBF-504A-EB11-8100-00155D081D0B","typingDelay":1.0,"message":"test","image":"https://api15.comm100.io/v4/Bot/taskbotSendImages/7AE8FDBF-504A-EB11-8100-00155D081D0B/image"},"taskbotSendMessage":{"taskbotActionId":"F8A7A50B-B049-EB11-8100-00155D081D0B","typingDelay":1.0,"message":"hi","nextActionId":"693c1ffa-4d57-40d2-9fc0-68e89430b4f1","taskbotSendMessageButtons":[{"id":"a46afdad-82c9-4405-bb4b-8d5517ef57d8","taskbotActionId":"E4099BB1-774A-EB11-8100-00155D081D0B","buttonText":"test","url":"https://...","order":1,"type":"link","openIn":"currentWindow","openStyle":"compact"}]},"taskbotSendVideo":{"taskbotActionId":"4CB9B085-AC49-EB11-8100-00155D081D0B","nextActionId":"D0948954-AE49-EB11-8100-00155D081D0B","typingDelay":1.0,"message":"test","videoUrl":"https://..."},"taskbotSSOLoginButton":{"taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","typingDelay":1.0,"message":"To get personized service, you need to login first.","loginButtonText":"login","loginInActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","failedActionId":"D6C7158C-644A-EB11-8100-00155D081D0B"},"taskbotTransferChat":{"taskbotActionId":"B0101911-4E4A-EB11-8100-00155D081D0B","type":"transferToDepartment","transferTo":"EF101911-4E4A-EB11-8100-00155D081D0B","whenAgentOfflineToActionId":"5A101911-4E4A-EB11-8100-00155D081D0B"},"taskbotWebhook":{"taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","url":"https://...","ifSendChatTranscript":false,"additionalPostBody":"","otherResponseToActionId":"4CB006E2-BA49-EB11-8100-00155D081D0B","taskbotWebhookHeaders":[{"id":"4DB006E2-BA49-EB11-8100-00155D081D0B","taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","key":"key","value":"value","order":1}],"taskbotWebhookResponseToVariables":[{"id":"D4C7158C-644A-EB11-8100-00155D081D0B","taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","variableName":"name","responseKey":"text","order":1}],"taskbotWebhookResponseCodeToActions":[{"id":"4DB006E2-BA49-EB11-8100-00155D081D0B","taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","responseCode":"","nextActionId":"5AB006E2-BA49-EB11-8100-00155D081D0B","order":1}]}}]
Get a single Taskbot Action

GET bot/taskbotActions/{id}

Parameters:
Name Type In Required Description
include string query no Allowed values are "taskbotStart", "taskbotCollectComment", "taskbotCollectCompanyName", "taskbotCollectEmail", "taskbotCollectLocation", "taskbotCollectName", "taskbotCollectPhoneNumber", "taskbotCollectVariableData", "taskbotGotoTaskbot", "taskbotQuickReply", "taskbotSendImage", "taskbotSendMessage", "taskbotSendVideo", "taskbotSSOLoginButton", "taskbotWebhook", "taskbotSendEmail", "taskbotBookMeeting".
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/bot/taskbotActions/A762827E-0D4B-EB11-8100-00155D081D0B \
-X 'GET' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

{"taskbotVersionId":"7A6A35A3-814A-EB11-8100-00155D081D0B","xPosition":50,"yPosition":50,"type":"taskbotStart","id":"A762827E-0D4B-EB11-8100-00155D081D0B","taskbotStart":{"taskbotActionId":"F8A7A50B-B049-EB11-8100-00155D081D0B","nextActionId":"d2be5b63-24dc-4c14-9926-788e9af54760"},"taskbotCollectComment":{"typingDelay":1.0,"message":"text","nextActionId":"D4C7158C-644A-EB11-8100-00155D081D0B","taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B"},"taskbotCollectCompanyName":{"typingDelay":1.0,"message":"text","nextActionId":"D4C7158C-644A-EB11-8100-00155D081D0B","taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B"},"taskbotCollectEmail":{"typingDelay":1.0,"message":"text","nextActionId":"D4C7158C-644A-EB11-8100-00155D081D0B","taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B"},"taskbotSendEmail":{"taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","subject":"subject","content":"content","to":"test@comm100.com","cc":"test1@comm100.com","nextActionId":"9F813BFF-E65A-EB11-8101-00155D081D0B"},"taskbotBookMeeting":{"taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","failedActionId":"5341d43d-2238-43a0-a5e1-5bf8e471ea93","successActionId":"d6bd7d9a-536e-43e4-a030-7b9f36b6ab4f","integrationCalendlyId":"64bb87e4-6940-4d2c-a6e4-176d52b8e9b8","calendlyEventTypeUri":"https://..."},"taskbotCollectLocation":{"taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","typingDelay":1.0,"message":"shareLocation","buttonText":"button","successActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","failedActionId":"D6C7158C-644A-EB11-8100-00155D081D0B"},"taskbotCollectName":{"taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","nextActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","message":"text","typingDelay":1.0},"taskbotCollectPhoneNumber":{"typingDelay":1.0,"message":"text","nextActionId":"D4C7158C-644A-EB11-8100-00155D081D0B","taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B"},"taskbotCollectVariableData":{"taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","nextActionId":"D4C7158C-644A-EB11-8100-00155D081D0B","variableName":"name","options":"option1","message":"text","typingDelay":1.0,"type":"<!DOCTYPE html>\r\n?<html>\r\n?<head>\r\n? <title>{{title}}</title>\r\n? <meta charset=\"UTF-8\" />\r\n? <meta http-equiv=\"X-UA-Compatible\" content=\"IE=edge,chrome=1\" />\r\n? <meta name=\"viewport\" content=\"width=device-width, initial-scale=1.0\" />\r\n? <script type=\"text/javascript\" src=\"/kb/resources/js/jquery-1.10.2.min.js\"></script>\r\n? <script type=\"text/javascript\" src=\"/kb/resources/js/common.js?v=gbrqhch3oj0lob1m2w\"></script>\r\n? <link href=\"{{cssUrl}}\" rel=\"stylesheet\" type=\"text/css\" />\r\n? <link rel=\"canonical\" href=\"{{url}}\" />\r\n?</head>\r\n?<body>\r\n? <div class=\"header\">\r\n? <div class=\"container\">\r\n? <div class=\"header_logo\"><img src=\"/kb/resources/your_logo.png\" /></div>\r\n? <div class=\"header__title\"><span>Find answers in our Knowledge Base</span></div>\r\n? <div class=\"header__search\">\r\n? <input type=\"text\" class=\"search-input header__searchinput\" placeholder=\"Enter your question...\" autocomplete=\"off\" />\r\n? <i class=\"iconfont icon-search\"></i>\r\n? </div>\r\n? </div>\r\n? </div>\r\n? <div class=\"content\">\r\n? <div class=\"container\">\r\n? <div class=\"breadcrumbs\">\r\n? {{breadcrumbs}}\r\n? </div>\r\n? <div class=\"category-list\">\r\n? {% for category in categories %}\r\n? <div class=\"category-list__item\">\r\n? <div class=\"category-list__item__header\" onclick=\"showHide();\">\r\n? <i class=\"iconfont icon-folder\"></i>\r\n? <div class=\"category-list__item__name\"><a href=\"{{category.url}}\">{{category.name}}</a></div>\r\n? <i class=\"iconfont icon-fold\"></i>\r\n? </div>\r\n? <div class=\"category-list__item__content collapse\">\r\n? <div class=\"article-list\" id=\"{{category.id}}\">\r\n? {% for article in articles %}\r\n? {% if category.id == article.category_id %}\r\n? <div class=\"article-list__title\">\r\n? {% if article.if_featured %}\r\n? <i class=\"iconfont icon-feature\"></i>\r\n? {% endif %}\r\n? <a href=\"{{article.url}}\">{{article.title}}</a>\r\n? </div>\r\n? {% endif %}\r\n? {% endfor %}\r\n? </div>\r\n? </div>\r\n? </div>\r\n? {% endfor %}\r\n? </div>\r\n? </div>\r\n? </div>\r\n?</body>\r\n?</html>"},"taskbotGotoTaskbot":{"taskbotActionId":"4E8E8CE8-AD49-EB11-8100-00155D081D0B","taskbotId":"4E8E8CE8-AD49-EB11-8100-00155D081D0B"},"taskbotQuickReply":{"taskbotActionId":"D0948954-AE49-EB11-8100-00155D081D0B","typingDelay":1.0,"message":"link to baidu","otherResponseToActionId":"4CB9B085-AC49-EB11-8100-00155D081D0B","taskbotQuickReplyOptions":[{"id":"EF948954-AE49-EB11-8100-00155D081D0B","taskbotActionId":"D0948954-AE49-EB11-8100-00155D081D0B","text":"Baidu","order":0,"nextActionId":"F5948954-AE49-EB11-8100-00155D081D0B"}]},"taskbotSendImage":{"taskbotActionId":"7AE8FDBF-504A-EB11-8100-00155D081D0B","nextActionId":"8AE8FDBF-504A-EB11-8100-00155D081D0B","typingDelay":1.0,"message":"test","image":"https://api15.comm100.io/v4/Bot/taskbotSendImages/7AE8FDBF-504A-EB11-8100-00155D081D0B/image"},"taskbotSendMessage":{"taskbotActionId":"F8A7A50B-B049-EB11-8100-00155D081D0B","typingDelay":1.0,"message":"hi","nextActionId":"693c1ffa-4d57-40d2-9fc0-68e89430b4f1","taskbotSendMessageButtons":[{"id":"a46afdad-82c9-4405-bb4b-8d5517ef57d8","taskbotActionId":"E4099BB1-774A-EB11-8100-00155D081D0B","buttonText":"test","url":"https://...","order":1,"type":"link","openIn":"currentWindow","openStyle":"compact"}]},"taskbotSendVideo":{"taskbotActionId":"4CB9B085-AC49-EB11-8100-00155D081D0B","nextActionId":"D0948954-AE49-EB11-8100-00155D081D0B","typingDelay":1.0,"message":"test","videoUrl":"https://..."},"taskbotSSOLoginButton":{"taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","typingDelay":1.0,"message":"To get personized service, you need to login first.","loginButtonText":"login","loginInActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","failedActionId":"D6C7158C-644A-EB11-8100-00155D081D0B"},"taskbotTransferChat":{"taskbotActionId":"B0101911-4E4A-EB11-8100-00155D081D0B","type":"transferToDepartment","transferTo":"EF101911-4E4A-EB11-8100-00155D081D0B","whenAgentOfflineToActionId":"5A101911-4E4A-EB11-8100-00155D081D0B"},"taskbotWebhook":{"taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","url":"https://...","ifSendChatTranscript":false,"additionalPostBody":"","otherResponseToActionId":"4CB006E2-BA49-EB11-8100-00155D081D0B","taskbotWebhookHeaders":[{"id":"4DB006E2-BA49-EB11-8100-00155D081D0B","taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","key":"key","value":"value","order":1}],"taskbotWebhookResponseToVariables":[{"id":"D4C7158C-644A-EB11-8100-00155D081D0B","taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","variableName":"name","responseKey":"text","order":1}],"taskbotWebhookResponseCodeToActions":[{"id":"4DB006E2-BA49-EB11-8100-00155D081D0B","taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","responseCode":"","nextActionId":"5AB006E2-BA49-EB11-8100-00155D081D0B","order":1}]}}
Create a new Taskbot Action

POST bot/taskbotActions

Parameters:
Name Type In Required Description
taskbotVersionId guid body yes Id of the taskbot version.
xPosition integer body no The action's xPosition(in pixel) in the diagram.
yPosition integer body no The action's yPosition(in pixel) in the diagram.
type string body yes Type of the taskbotAction.Allowed values are "taskbotStart", "taskbotSendMessage", "taskbotSendImage", "taskbotSendVideo", "taskbotSSOLoginButton", "taskbotCollectLocation", "taskbotCollectName", "taskbotCollectEmail", "taskbotCollectPhoneNumber", "taskbotCollectCompanyName", "taskbotCollectComment", "taskbotCollectVariableData", "taskbotWebhook", "taskbotSendEmail", "taskbotBookMeeting", "taskbotGotoTaskbot", "taskbotTransferChat", "taskbotQuickReply".
taskbotStart taskbotStart body no Reference to Taskbot Start.
taskbotSendMessage taskbotSendMessage body no Reference to Taskbot Send Message.
taskbotSendImage taskbotSendImage body no Reference to Taskbot Send Image.
taskbotSendVideo taskbotSendVideo body no Reference to Taskbot Send Video.
taskbotSSOLoginButton taskbotSSOLoginButton body no Reference to Taskbot SSO Login Button.
taskbotCollectLocation taskbotCollectLocation body no Reference to Taskbot Collect Location.
taskbotCollectName taskbotCollectName body no Reference to Taskbot Collect Name.
taskbotCollectEmail taskbotCollectEmail body no Reference to Taskbot Collect Email.
taskbotCollectPhoneNumber taskbotCollectPhoneNumber body no Reference to Taskbot Collect Phone Number.
taskbotCollectCompanyName taskbotCollectCompanyName body no Reference to Taskbot Collect Company Name.
taskbotCollectComment taskbotCollectComment body no Reference to Taskbot Collect Comment.
taskbotCollectVariableData taskbotCollectVariableData body no Reference to Taskbot Collect Variable Data.
taskbotWebhook taskbotWebhook body no Reference to Taskbot Webhook.
taskbotSendEmail taskbotSendEmail body no Reference to Taskbot Send Email.
taskbotBookMeeting taskbotBookMeeting body no Reference to Taskbot Book Meeting.
taskbotGotoTaskbot taskbotGotoTaskbot body no Reference to Taskbot Go To Taskbot.
taskbotTransferChat taskbotTransferChat body no Reference to Taskbot Transfer Chat.
taskbotQuickReply taskbotQuickReply body no Reference to Taskbot Quick Reply.
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/bot/taskbotActions \
-X 'POST' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
-D '{"taskbotVersionId":"7A6A35A3-814A-EB11-8100-00155D081D0B","xPosition":50,"yPosition":50,"type":"taskbotStart","taskbotStart":{"nextActionId":"d2be5b63-24dc-4c14-9926-788e9af54760"},"taskbotSendMessage":{"typingDelay":1.0,"message":"hi","nextActionId":"693c1ffa-4d57-40d2-9fc0-68e89430b4f1","taskbotSendMessageButtons":[{"buttonText":"test","url":"https://...","order":1,"type":"link","openIn":"currentWindow","openStyle":"compact"}]},"taskbotSendImage":{"nextActionId":"8AE8FDBF-504A-EB11-8100-00155D081D0B","typingDelay":1.0,"message":"test","image":""},"taskbotSendVideo":{"nextActionId":"D0948954-AE49-EB11-8100-00155D081D0B","typingDelay":1.0,"message":"test","videoUrl":"https://..."},"taskbotSSOLoginButton":{"typingDelay":1.0,"message":"To get personized service, you need to login first.","loginButtonText":"login","loginInActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","failedActionId":"D6C7158C-644A-EB11-8100-00155D081D0B"},"taskbotCollectLocation":{"typingDelay":1.0,"message":"shareLocation","buttonText":"button","successActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","failedActionId":"D6C7158C-644A-EB11-8100-00155D081D0B"},"taskbotCollectName":{"nextActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","message":"text","typingDelay":1.0},"taskbotCollectEmail":{"typingDelay":1.0,"message":"text","nextActionId":"D4C7158C-644A-EB11-8100-00155D081D0B"},"taskbotCollectPhoneNumber":{"typingDelay":1.0,"message":"text","nextActionId":"D4C7158C-644A-EB11-8100-00155D081D0B"},"taskbotCollectCompanyName":{"typingDelay":1.0,"message":"text","nextActionId":"D4C7158C-644A-EB11-8100-00155D081D0B"},"taskbotCollectComment":{"typingDelay":1.0,"message":"text","nextActionId":"D4C7158C-644A-EB11-8100-00155D081D0B"},"taskbotCollectVariableData":{"nextActionId":"D4C7158C-644A-EB11-8100-00155D081D0B","variableName":"name","options":"option1","message":"text","typingDelay":1.0,"type":"<!DOCTYPE html>\r\n?<html>\r\n?<head>\r\n? <title>{{title}}</title>\r\n? <meta charset=\"UTF-8\" />\r\n? <meta http-equiv=\"X-UA-Compatible\" content=\"IE=edge,chrome=1\" />\r\n? <meta name=\"viewport\" content=\"width=device-width, initial-scale=1.0\" />\r\n? <script type=\"text/javascript\" src=\"/kb/resources/js/jquery-1.10.2.min.js\"></script>\r\n? <script type=\"text/javascript\" src=\"/kb/resources/js/common.js?v=gbrqhch3oj0lob1m2w\"></script>\r\n? <link href=\"{{cssUrl}}\" rel=\"stylesheet\" type=\"text/css\" />\r\n? <link rel=\"canonical\" href=\"{{url}}\" />\r\n?</head>\r\n?<body>\r\n? <div class=\"header\">\r\n? <div class=\"container\">\r\n? <div class=\"header_logo\"><img src=\"/kb/resources/your_logo.png\" /></div>\r\n? <div class=\"header__title\"><span>Find answers in our Knowledge Base</span></div>\r\n? <div class=\"header__search\">\r\n? <input type=\"text\" class=\"search-input header__searchinput\" placeholder=\"Enter your question...\" autocomplete=\"off\" />\r\n? <i class=\"iconfont icon-search\"></i>\r\n? </div>\r\n? </div>\r\n? </div>\r\n? <div class=\"content\">\r\n? <div class=\"container\">\r\n? <div class=\"breadcrumbs\">\r\n? {{breadcrumbs}}\r\n? </div>\r\n? <div class=\"category-list\">\r\n? {% for category in categories %}\r\n? <div class=\"category-list__item\">\r\n? <div class=\"category-list__item__header\" onclick=\"showHide();\">\r\n? <i class=\"iconfont icon-folder\"></i>\r\n? <div class=\"category-list__item__name\"><a href=\"{{category.url}}\">{{category.name}}</a></div>\r\n? <i class=\"iconfont icon-fold\"></i>\r\n? </div>\r\n? <div class=\"category-list__item__content collapse\">\r\n? <div class=\"article-list\" id=\"{{category.id}}\">\r\n? {% for article in articles %}\r\n? {% if category.id == article.category_id %}\r\n? <div class=\"article-list__title\">\r\n? {% if article.if_featured %}\r\n? <i class=\"iconfont icon-feature\"></i>\r\n? {% endif %}\r\n? <a href=\"{{article.url}}\">{{article.title}}</a>\r\n? </div>\r\n? {% endif %}\r\n? {% endfor %}\r\n? </div>\r\n? </div>\r\n? </div>\r\n? {% endfor %}\r\n? </div>\r\n? </div>\r\n? </div>\r\n?</body>\r\n?</html>"},"taskbotWebhook":{"url":"https://...","ifSendChatTranscript":false,"additionalPostBody":"","otherResponseToActionId":"4CB006E2-BA49-EB11-8100-00155D081D0B","taskbotWebhookHeaders":[{"key":"key","value":"value","order":1}],"taskbotWebhookResponseToVariables":[{"variableName":"name","responseKey":"text","order":1}],"taskbotWebhookResponseCodeToActions":[{"responseCode":"","nextActionId":"5AB006E2-BA49-EB11-8100-00155D081D0B","order":1}]},"taskbotSendEmail":{"subject":"subject","content":"content","to":"test@comm100.com","cc":"test1@comm100.com","nextActionId":"9F813BFF-E65A-EB11-8101-00155D081D0B"},"taskbotBookMeeting":{"failedActionId":"5341d43d-2238-43a0-a5e1-5bf8e471ea93","successActionId":"d6bd7d9a-536e-43e4-a030-7b9f36b6ab4f","integrationCalendlyId":"64bb87e4-6940-4d2c-a6e4-176d52b8e9b8","calendlyEventTypeUri":"https://..."},"taskbotGotoTaskbot":{"taskbotId":"4E8E8CE8-AD49-EB11-8100-00155D081D0B"},"taskbotTransferChat":{"type":"transferToDepartment","transferTo":"EF101911-4E4A-EB11-8100-00155D081D0B","whenAgentOfflineToActionId":"5A101911-4E4A-EB11-8100-00155D081D0B"},"taskbotQuickReply":{"typingDelay":1.0,"message":"link to baidu","otherResponseToActionId":"4CB9B085-AC49-EB11-8100-00155D081D0B","taskbotQuickReplyOptions":[{"text":"Baidu","order":0,"nextActionId":"F5948954-AE49-EB11-8100-00155D081D0B"}]}}'

Response:

 HTTP/1.1 201 Created

{"taskbotVersionId":"7A6A35A3-814A-EB11-8100-00155D081D0B","xPosition":50,"yPosition":50,"type":"taskbotStart","id":"A762827E-0D4B-EB11-8100-00155D081D0B","taskbotStart":{"taskbotActionId":"F8A7A50B-B049-EB11-8100-00155D081D0B","nextActionId":"d2be5b63-24dc-4c14-9926-788e9af54760"},"taskbotCollectComment":{"typingDelay":1.0,"message":"text","nextActionId":"D4C7158C-644A-EB11-8100-00155D081D0B","taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B"},"taskbotCollectCompanyName":{"typingDelay":1.0,"message":"text","nextActionId":"D4C7158C-644A-EB11-8100-00155D081D0B","taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B"},"taskbotCollectEmail":{"typingDelay":1.0,"message":"text","nextActionId":"D4C7158C-644A-EB11-8100-00155D081D0B","taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B"},"taskbotSendEmail":{"taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","subject":"subject","content":"content","to":"test@comm100.com","cc":"test1@comm100.com","nextActionId":"9F813BFF-E65A-EB11-8101-00155D081D0B"},"taskbotBookMeeting":{"taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","failedActionId":"5341d43d-2238-43a0-a5e1-5bf8e471ea93","successActionId":"d6bd7d9a-536e-43e4-a030-7b9f36b6ab4f","integrationCalendlyId":"64bb87e4-6940-4d2c-a6e4-176d52b8e9b8","calendlyEventTypeUri":"https://..."},"taskbotCollectLocation":{"taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","typingDelay":1.0,"message":"shareLocation","buttonText":"button","successActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","failedActionId":"D6C7158C-644A-EB11-8100-00155D081D0B"},"taskbotCollectName":{"taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","nextActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","message":"text","typingDelay":1.0},"taskbotCollectPhoneNumber":{"typingDelay":1.0,"message":"text","nextActionId":"D4C7158C-644A-EB11-8100-00155D081D0B","taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B"},"taskbotCollectVariableData":{"taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","nextActionId":"D4C7158C-644A-EB11-8100-00155D081D0B","variableName":"name","options":"option1","message":"text","typingDelay":1.0,"type":"<!DOCTYPE html>\r\n?<html>\r\n?<head>\r\n? <title>{{title}}</title>\r\n? <meta charset=\"UTF-8\" />\r\n? <meta http-equiv=\"X-UA-Compatible\" content=\"IE=edge,chrome=1\" />\r\n? <meta name=\"viewport\" content=\"width=device-width, initial-scale=1.0\" />\r\n? <script type=\"text/javascript\" src=\"/kb/resources/js/jquery-1.10.2.min.js\"></script>\r\n? <script type=\"text/javascript\" src=\"/kb/resources/js/common.js?v=gbrqhch3oj0lob1m2w\"></script>\r\n? <link href=\"{{cssUrl}}\" rel=\"stylesheet\" type=\"text/css\" />\r\n? <link rel=\"canonical\" href=\"{{url}}\" />\r\n?</head>\r\n?<body>\r\n? <div class=\"header\">\r\n? <div class=\"container\">\r\n? <div class=\"header_logo\"><img src=\"/kb/resources/your_logo.png\" /></div>\r\n? <div class=\"header__title\"><span>Find answers in our Knowledge Base</span></div>\r\n? <div class=\"header__search\">\r\n? <input type=\"text\" class=\"search-input header__searchinput\" placeholder=\"Enter your question...\" autocomplete=\"off\" />\r\n? <i class=\"iconfont icon-search\"></i>\r\n? </div>\r\n? </div>\r\n? </div>\r\n? <div class=\"content\">\r\n? <div class=\"container\">\r\n? <div class=\"breadcrumbs\">\r\n? {{breadcrumbs}}\r\n? </div>\r\n? <div class=\"category-list\">\r\n? {% for category in categories %}\r\n? <div class=\"category-list__item\">\r\n? <div class=\"category-list__item__header\" onclick=\"showHide();\">\r\n? <i class=\"iconfont icon-folder\"></i>\r\n? <div class=\"category-list__item__name\"><a href=\"{{category.url}}\">{{category.name}}</a></div>\r\n? <i class=\"iconfont icon-fold\"></i>\r\n? </div>\r\n? <div class=\"category-list__item__content collapse\">\r\n? <div class=\"article-list\" id=\"{{category.id}}\">\r\n? {% for article in articles %}\r\n? {% if category.id == article.category_id %}\r\n? <div class=\"article-list__title\">\r\n? {% if article.if_featured %}\r\n? <i class=\"iconfont icon-feature\"></i>\r\n? {% endif %}\r\n? <a href=\"{{article.url}}\">{{article.title}}</a>\r\n? </div>\r\n? {% endif %}\r\n? {% endfor %}\r\n? </div>\r\n? </div>\r\n? </div>\r\n? {% endfor %}\r\n? </div>\r\n? </div>\r\n? </div>\r\n?</body>\r\n?</html>"},"taskbotGotoTaskbot":{"taskbotActionId":"4E8E8CE8-AD49-EB11-8100-00155D081D0B","taskbotId":"4E8E8CE8-AD49-EB11-8100-00155D081D0B"},"taskbotQuickReply":{"taskbotActionId":"D0948954-AE49-EB11-8100-00155D081D0B","typingDelay":1.0,"message":"link to baidu","otherResponseToActionId":"4CB9B085-AC49-EB11-8100-00155D081D0B","taskbotQuickReplyOptions":[{"id":"EF948954-AE49-EB11-8100-00155D081D0B","taskbotActionId":"D0948954-AE49-EB11-8100-00155D081D0B","text":"Baidu","order":0,"nextActionId":"F5948954-AE49-EB11-8100-00155D081D0B"}]},"taskbotSendImage":{"taskbotActionId":"7AE8FDBF-504A-EB11-8100-00155D081D0B","nextActionId":"8AE8FDBF-504A-EB11-8100-00155D081D0B","typingDelay":1.0,"message":"test","image":"https://api15.comm100.io/v4/Bot/taskbotSendImages/7AE8FDBF-504A-EB11-8100-00155D081D0B/image"},"taskbotSendMessage":{"taskbotActionId":"F8A7A50B-B049-EB11-8100-00155D081D0B","typingDelay":1.0,"message":"hi","nextActionId":"693c1ffa-4d57-40d2-9fc0-68e89430b4f1","taskbotSendMessageButtons":[{"id":"a46afdad-82c9-4405-bb4b-8d5517ef57d8","taskbotActionId":"E4099BB1-774A-EB11-8100-00155D081D0B","buttonText":"test","url":"https://...","order":1,"type":"link","openIn":"currentWindow","openStyle":"compact"}]},"taskbotSendVideo":{"taskbotActionId":"4CB9B085-AC49-EB11-8100-00155D081D0B","nextActionId":"D0948954-AE49-EB11-8100-00155D081D0B","typingDelay":1.0,"message":"test","videoUrl":"https://..."},"taskbotSSOLoginButton":{"taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","typingDelay":1.0,"message":"To get personized service, you need to login first.","loginButtonText":"login","loginInActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","failedActionId":"D6C7158C-644A-EB11-8100-00155D081D0B"},"taskbotTransferChat":{"taskbotActionId":"B0101911-4E4A-EB11-8100-00155D081D0B","type":"transferToDepartment","transferTo":"EF101911-4E4A-EB11-8100-00155D081D0B","whenAgentOfflineToActionId":"5A101911-4E4A-EB11-8100-00155D081D0B"},"taskbotWebhook":{"taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","url":"https://...","ifSendChatTranscript":false,"additionalPostBody":"","otherResponseToActionId":"4CB006E2-BA49-EB11-8100-00155D081D0B","taskbotWebhookHeaders":[{"id":"4DB006E2-BA49-EB11-8100-00155D081D0B","taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","key":"key","value":"value","order":1}],"taskbotWebhookResponseToVariables":[{"id":"D4C7158C-644A-EB11-8100-00155D081D0B","taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","variableName":"name","responseKey":"text","order":1}],"taskbotWebhookResponseCodeToActions":[{"id":"4DB006E2-BA49-EB11-8100-00155D081D0B","taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","responseCode":"","nextActionId":"5AB006E2-BA49-EB11-8100-00155D081D0B","order":1}]}}
Update the Taskbot Action

PUT bot/taskbotActions/{id}

Parameters:
Name Type In Required Description
taskbotVersionId guid body yes Id of the taskbot version.
xPosition integer body no The action's xPosition(in pixel) in the diagram.
yPosition integer body no The action's yPosition(in pixel) in the diagram.
type string body yes Type of the taskbotAction.Allowed values are "taskbotStart", "taskbotSendMessage", "taskbotSendImage", "taskbotSendVideo", "taskbotSSOLoginButton", "taskbotCollectLocation", "taskbotCollectName", "taskbotCollectEmail", "taskbotCollectPhoneNumber", "taskbotCollectCompanyName", "taskbotCollectComment", "taskbotCollectVariableData", "taskbotWebhook", "taskbotSendEmail", "taskbotBookMeeting", "taskbotGotoTaskbot", "taskbotTransferChat", "taskbotQuickReply".
taskbotStart taskbotStart body no Reference to Taskbot Start.
taskbotSendMessage taskbotSendMessage body no Reference to Taskbot Send Message.
taskbotSendImage taskbotSendImage body no Reference to Taskbot Send Image.
taskbotSendVideo taskbotSendVideo body no Reference to Taskbot Send Video.
taskbotSSOLoginButton taskbotSSOLoginButton body no Reference to Taskbot SSO Login Button.
taskbotCollectLocation taskbotCollectLocation body no Reference to Taskbot Collect Location.
taskbotCollectName taskbotCollectName body no Reference to Taskbot Collect Name.
taskbotCollectEmail taskbotCollectEmail body no Reference to Taskbot Collect Email.
taskbotCollectPhoneNumber taskbotCollectPhoneNumber body no Reference to Taskbot Collect Phone Number.
taskbotCollectCompanyName taskbotCollectCompanyName body no Reference to Taskbot Collect Company Name.
taskbotCollectComment taskbotCollectComment body no Reference to Taskbot Collect Comment.
taskbotCollectVariableData taskbotCollectVariableData body no Reference to Taskbot Collect Variable Data.
taskbotWebhook taskbotWebhook body no Reference to Taskbot Webhook.
taskbotSendEmail taskbotSendEmail body no Reference to Taskbot Send Email.
taskbotBookMeeting taskbotBookMeeting body no Reference to Taskbot Book Meeting.
taskbotGotoTaskbot taskbotGotoTaskbot body no Reference to Taskbot Go To Taskbot.
taskbotTransferChat taskbotTransferChat body no Reference to Taskbot Transfer Chat.
taskbotQuickReply taskbotQuickReply body no Reference to Taskbot Quick Reply.
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/bot/taskbotActions/A762827E-0D4B-EB11-8100-00155D081D0B \
-X 'PUT' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
-D '{"taskbotVersionId":"7A6A35A3-814A-EB11-8100-00155D081D0B","xPosition":50,"yPosition":50,"type":"taskbotStart","taskbotStart":{"nextActionId":"d2be5b63-24dc-4c14-9926-788e9af54760"},"taskbotSendMessage":{"typingDelay":1.0,"message":"hi","nextActionId":"693c1ffa-4d57-40d2-9fc0-68e89430b4f1","taskbotSendMessageButtons":[{"buttonText":"test","url":"https://...","order":1,"type":"link","openIn":"currentWindow","openStyle":"compact"}]},"taskbotSendImage":{"nextActionId":"8AE8FDBF-504A-EB11-8100-00155D081D0B","typingDelay":1.0,"message":"test","image":""},"taskbotSendVideo":{"nextActionId":"D0948954-AE49-EB11-8100-00155D081D0B","typingDelay":1.0,"message":"test","videoUrl":"https://..."},"taskbotSSOLoginButton":{"typingDelay":1.0,"message":"To get personized service, you need to login first.","loginButtonText":"login","loginInActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","failedActionId":"D6C7158C-644A-EB11-8100-00155D081D0B"},"taskbotCollectLocation":{"typingDelay":1.0,"message":"shareLocation","buttonText":"button","successActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","failedActionId":"D6C7158C-644A-EB11-8100-00155D081D0B"},"taskbotCollectName":{"nextActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","message":"text","typingDelay":1.0},"taskbotCollectEmail":{"typingDelay":1.0,"message":"text","nextActionId":"D4C7158C-644A-EB11-8100-00155D081D0B"},"taskbotCollectPhoneNumber":{"typingDelay":1.0,"message":"text","nextActionId":"D4C7158C-644A-EB11-8100-00155D081D0B"},"taskbotCollectCompanyName":{"typingDelay":1.0,"message":"text","nextActionId":"D4C7158C-644A-EB11-8100-00155D081D0B"},"taskbotCollectComment":{"typingDelay":1.0,"message":"text","nextActionId":"D4C7158C-644A-EB11-8100-00155D081D0B"},"taskbotCollectVariableData":{"nextActionId":"D4C7158C-644A-EB11-8100-00155D081D0B","variableName":"name","options":"option1","message":"text","typingDelay":1.0,"type":"<!DOCTYPE html>\r\n?<html>\r\n?<head>\r\n? <title>{{title}}</title>\r\n? <meta charset=\"UTF-8\" />\r\n? <meta http-equiv=\"X-UA-Compatible\" content=\"IE=edge,chrome=1\" />\r\n? <meta name=\"viewport\" content=\"width=device-width, initial-scale=1.0\" />\r\n? <script type=\"text/javascript\" src=\"/kb/resources/js/jquery-1.10.2.min.js\"></script>\r\n? <script type=\"text/javascript\" src=\"/kb/resources/js/common.js?v=gbrqhch3oj0lob1m2w\"></script>\r\n? <link href=\"{{cssUrl}}\" rel=\"stylesheet\" type=\"text/css\" />\r\n? <link rel=\"canonical\" href=\"{{url}}\" />\r\n?</head>\r\n?<body>\r\n? <div class=\"header\">\r\n? <div class=\"container\">\r\n? <div class=\"header_logo\"><img src=\"/kb/resources/your_logo.png\" /></div>\r\n? <div class=\"header__title\"><span>Find answers in our Knowledge Base</span></div>\r\n? <div class=\"header__search\">\r\n? <input type=\"text\" class=\"search-input header__searchinput\" placeholder=\"Enter your question...\" autocomplete=\"off\" />\r\n? <i class=\"iconfont icon-search\"></i>\r\n? </div>\r\n? </div>\r\n? </div>\r\n? <div class=\"content\">\r\n? <div class=\"container\">\r\n? <div class=\"breadcrumbs\">\r\n? {{breadcrumbs}}\r\n? </div>\r\n? <div class=\"category-list\">\r\n? {% for category in categories %}\r\n? <div class=\"category-list__item\">\r\n? <div class=\"category-list__item__header\" onclick=\"showHide();\">\r\n? <i class=\"iconfont icon-folder\"></i>\r\n? <div class=\"category-list__item__name\"><a href=\"{{category.url}}\">{{category.name}}</a></div>\r\n? <i class=\"iconfont icon-fold\"></i>\r\n? </div>\r\n? <div class=\"category-list__item__content collapse\">\r\n? <div class=\"article-list\" id=\"{{category.id}}\">\r\n? {% for article in articles %}\r\n? {% if category.id == article.category_id %}\r\n? <div class=\"article-list__title\">\r\n? {% if article.if_featured %}\r\n? <i class=\"iconfont icon-feature\"></i>\r\n? {% endif %}\r\n? <a href=\"{{article.url}}\">{{article.title}}</a>\r\n? </div>\r\n? {% endif %}\r\n? {% endfor %}\r\n? </div>\r\n? </div>\r\n? </div>\r\n? {% endfor %}\r\n? </div>\r\n? </div>\r\n? </div>\r\n?</body>\r\n?</html>"},"taskbotWebhook":{"url":"https://...","ifSendChatTranscript":false,"additionalPostBody":"","otherResponseToActionId":"4CB006E2-BA49-EB11-8100-00155D081D0B","taskbotWebhookHeaders":[{"key":"key","value":"value","order":1}],"taskbotWebhookResponseToVariables":[{"variableName":"name","responseKey":"text","order":1}],"taskbotWebhookResponseCodeToActions":[{"responseCode":"","nextActionId":"5AB006E2-BA49-EB11-8100-00155D081D0B","order":1}]},"taskbotSendEmail":{"subject":"subject","content":"content","to":"test@comm100.com","cc":"test1@comm100.com","nextActionId":"9F813BFF-E65A-EB11-8101-00155D081D0B"},"taskbotBookMeeting":{"failedActionId":"5341d43d-2238-43a0-a5e1-5bf8e471ea93","successActionId":"d6bd7d9a-536e-43e4-a030-7b9f36b6ab4f","integrationCalendlyId":"64bb87e4-6940-4d2c-a6e4-176d52b8e9b8","calendlyEventTypeUri":"https://..."},"taskbotGotoTaskbot":{"taskbotId":"4E8E8CE8-AD49-EB11-8100-00155D081D0B"},"taskbotTransferChat":{"type":"transferToDepartment","transferTo":"EF101911-4E4A-EB11-8100-00155D081D0B","whenAgentOfflineToActionId":"5A101911-4E4A-EB11-8100-00155D081D0B"},"taskbotQuickReply":{"typingDelay":1.0,"message":"link to baidu","otherResponseToActionId":"4CB9B085-AC49-EB11-8100-00155D081D0B","taskbotQuickReplyOptions":[{"text":"Baidu","order":0,"nextActionId":"F5948954-AE49-EB11-8100-00155D081D0B"}]}}'

Response:

 HTTP/1.1 200 OK

{"taskbotVersionId":"7A6A35A3-814A-EB11-8100-00155D081D0B","xPosition":50,"yPosition":50,"type":"taskbotStart","id":"A762827E-0D4B-EB11-8100-00155D081D0B","taskbotStart":{"taskbotActionId":"F8A7A50B-B049-EB11-8100-00155D081D0B","nextActionId":"d2be5b63-24dc-4c14-9926-788e9af54760"},"taskbotCollectComment":{"typingDelay":1.0,"message":"text","nextActionId":"D4C7158C-644A-EB11-8100-00155D081D0B","taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B"},"taskbotCollectCompanyName":{"typingDelay":1.0,"message":"text","nextActionId":"D4C7158C-644A-EB11-8100-00155D081D0B","taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B"},"taskbotCollectEmail":{"typingDelay":1.0,"message":"text","nextActionId":"D4C7158C-644A-EB11-8100-00155D081D0B","taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B"},"taskbotSendEmail":{"taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","subject":"subject","content":"content","to":"test@comm100.com","cc":"test1@comm100.com","nextActionId":"9F813BFF-E65A-EB11-8101-00155D081D0B"},"taskbotBookMeeting":{"taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","failedActionId":"5341d43d-2238-43a0-a5e1-5bf8e471ea93","successActionId":"d6bd7d9a-536e-43e4-a030-7b9f36b6ab4f","integrationCalendlyId":"64bb87e4-6940-4d2c-a6e4-176d52b8e9b8","calendlyEventTypeUri":"https://..."},"taskbotCollectLocation":{"taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","typingDelay":1.0,"message":"shareLocation","buttonText":"button","successActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","failedActionId":"D6C7158C-644A-EB11-8100-00155D081D0B"},"taskbotCollectName":{"taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","nextActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","message":"text","typingDelay":1.0},"taskbotCollectPhoneNumber":{"typingDelay":1.0,"message":"text","nextActionId":"D4C7158C-644A-EB11-8100-00155D081D0B","taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B"},"taskbotCollectVariableData":{"taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","nextActionId":"D4C7158C-644A-EB11-8100-00155D081D0B","variableName":"name","options":"option1","message":"text","typingDelay":1.0,"type":"<!DOCTYPE html>\r\n?<html>\r\n?<head>\r\n? <title>{{title}}</title>\r\n? <meta charset=\"UTF-8\" />\r\n? <meta http-equiv=\"X-UA-Compatible\" content=\"IE=edge,chrome=1\" />\r\n? <meta name=\"viewport\" content=\"width=device-width, initial-scale=1.0\" />\r\n? <script type=\"text/javascript\" src=\"/kb/resources/js/jquery-1.10.2.min.js\"></script>\r\n? <script type=\"text/javascript\" src=\"/kb/resources/js/common.js?v=gbrqhch3oj0lob1m2w\"></script>\r\n? <link href=\"{{cssUrl}}\" rel=\"stylesheet\" type=\"text/css\" />\r\n? <link rel=\"canonical\" href=\"{{url}}\" />\r\n?</head>\r\n?<body>\r\n? <div class=\"header\">\r\n? <div class=\"container\">\r\n? <div class=\"header_logo\"><img src=\"/kb/resources/your_logo.png\" /></div>\r\n? <div class=\"header__title\"><span>Find answers in our Knowledge Base</span></div>\r\n? <div class=\"header__search\">\r\n? <input type=\"text\" class=\"search-input header__searchinput\" placeholder=\"Enter your question...\" autocomplete=\"off\" />\r\n? <i class=\"iconfont icon-search\"></i>\r\n? </div>\r\n? </div>\r\n? </div>\r\n? <div class=\"content\">\r\n? <div class=\"container\">\r\n? <div class=\"breadcrumbs\">\r\n? {{breadcrumbs}}\r\n? </div>\r\n? <div class=\"category-list\">\r\n? {% for category in categories %}\r\n? <div class=\"category-list__item\">\r\n? <div class=\"category-list__item__header\" onclick=\"showHide();\">\r\n? <i class=\"iconfont icon-folder\"></i>\r\n? <div class=\"category-list__item__name\"><a href=\"{{category.url}}\">{{category.name}}</a></div>\r\n? <i class=\"iconfont icon-fold\"></i>\r\n? </div>\r\n? <div class=\"category-list__item__content collapse\">\r\n? <div class=\"article-list\" id=\"{{category.id}}\">\r\n? {% for article in articles %}\r\n? {% if category.id == article.category_id %}\r\n? <div class=\"article-list__title\">\r\n? {% if article.if_featured %}\r\n? <i class=\"iconfont icon-feature\"></i>\r\n? {% endif %}\r\n? <a href=\"{{article.url}}\">{{article.title}}</a>\r\n? </div>\r\n? {% endif %}\r\n? {% endfor %}\r\n? </div>\r\n? </div>\r\n? </div>\r\n? {% endfor %}\r\n? </div>\r\n? </div>\r\n? </div>\r\n?</body>\r\n?</html>"},"taskbotGotoTaskbot":{"taskbotActionId":"4E8E8CE8-AD49-EB11-8100-00155D081D0B","taskbotId":"4E8E8CE8-AD49-EB11-8100-00155D081D0B"},"taskbotQuickReply":{"taskbotActionId":"D0948954-AE49-EB11-8100-00155D081D0B","typingDelay":1.0,"message":"link to baidu","otherResponseToActionId":"4CB9B085-AC49-EB11-8100-00155D081D0B","taskbotQuickReplyOptions":[{"id":"EF948954-AE49-EB11-8100-00155D081D0B","taskbotActionId":"D0948954-AE49-EB11-8100-00155D081D0B","text":"Baidu","order":0,"nextActionId":"F5948954-AE49-EB11-8100-00155D081D0B"}]},"taskbotSendImage":{"taskbotActionId":"7AE8FDBF-504A-EB11-8100-00155D081D0B","nextActionId":"8AE8FDBF-504A-EB11-8100-00155D081D0B","typingDelay":1.0,"message":"test","image":"https://api15.comm100.io/v4/Bot/taskbotSendImages/7AE8FDBF-504A-EB11-8100-00155D081D0B/image"},"taskbotSendMessage":{"taskbotActionId":"F8A7A50B-B049-EB11-8100-00155D081D0B","typingDelay":1.0,"message":"hi","nextActionId":"693c1ffa-4d57-40d2-9fc0-68e89430b4f1","taskbotSendMessageButtons":[{"id":"a46afdad-82c9-4405-bb4b-8d5517ef57d8","taskbotActionId":"E4099BB1-774A-EB11-8100-00155D081D0B","buttonText":"test","url":"https://...","order":1,"type":"link","openIn":"currentWindow","openStyle":"compact"}]},"taskbotSendVideo":{"taskbotActionId":"4CB9B085-AC49-EB11-8100-00155D081D0B","nextActionId":"D0948954-AE49-EB11-8100-00155D081D0B","typingDelay":1.0,"message":"test","videoUrl":"https://..."},"taskbotSSOLoginButton":{"taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","typingDelay":1.0,"message":"To get personized service, you need to login first.","loginButtonText":"login","loginInActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","failedActionId":"D6C7158C-644A-EB11-8100-00155D081D0B"},"taskbotTransferChat":{"taskbotActionId":"B0101911-4E4A-EB11-8100-00155D081D0B","type":"transferToDepartment","transferTo":"EF101911-4E4A-EB11-8100-00155D081D0B","whenAgentOfflineToActionId":"5A101911-4E4A-EB11-8100-00155D081D0B"},"taskbotWebhook":{"taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","url":"https://...","ifSendChatTranscript":false,"additionalPostBody":"","otherResponseToActionId":"4CB006E2-BA49-EB11-8100-00155D081D0B","taskbotWebhookHeaders":[{"id":"4DB006E2-BA49-EB11-8100-00155D081D0B","taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","key":"key","value":"value","order":1}],"taskbotWebhookResponseToVariables":[{"id":"D4C7158C-644A-EB11-8100-00155D081D0B","taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","variableName":"name","responseKey":"text","order":1}],"taskbotWebhookResponseCodeToActions":[{"id":"4DB006E2-BA49-EB11-8100-00155D081D0B","taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","responseCode":"","nextActionId":"5AB006E2-BA49-EB11-8100-00155D081D0B","order":1}]}}
Remove the Taskbot Action

DELETE bot/taskbotActions/{id}

Parameters:
No Parameters
Response:

No Content

Example

Sample Request:

curl https://api15.comm100.io/v4/bot/taskbotActions/A762827E-0D4B-EB11-8100-00155D081D0B \
-X 'DELETE' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 204 No Content

Model
Taskbot Start JSON Format

Taskbot Start is represented as simple flat JSON objects with the following keys:

Name Type Description
taskbotActionId guid Id of the current taskbot action.
nextActionId guid Id of the next taskbot action.
Endpoint
Get a single Taskbot Start

GET bot/taskbotActions/{id}/taskbotStart

Parameters:
No Parameters
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/bot/taskbotActions/F8A7A50B-B049-EB11-8100-00155D081D0B/taskbotStart \
-X 'GET' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

{"taskbotActionId":"F8A7A50B-B049-EB11-8100-00155D081D0B","nextActionId":"d2be5b63-24dc-4c14-9926-788e9af54760"}
Update the Taskbot Start

PUT bot/taskbotActions/{id}/taskbotStart

Parameters:
Name Type In Required Description
nextActionId guid body no Id of the next taskbot action.
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/bot/taskbotActions/F8A7A50B-B049-EB11-8100-00155D081D0B/taskbotStart \
-X 'PUT' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
-D '{"nextActionId":"d2be5b63-24dc-4c14-9926-788e9af54760"}'

Response:

 HTTP/1.1 200 OK

{"taskbotActionId":"F8A7A50B-B049-EB11-8100-00155D081D0B","nextActionId":"d2be5b63-24dc-4c14-9926-788e9af54760"}
Model
Taskbot Collect Comment JSON Format

Taskbot Collect Comment is represented as simple flat JSON objects with the following keys:

Name Type Description
typingDelay float TypingDelay is only available when channel is Live Chat. The typing delay in seconds before this message is shown in chat window.
message string HTML Text.
nextActionId guid Id of the next taskbot action.
taskbotActionId guid Id of the current taskbot action.
Endpoint
Get a single Taskbot Collect Comment

GET bot/taskbotActions/{id}/taskbotCollectComment

Parameters:
No Parameters
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/bot/taskbotActions/D6C7158C-644A-EB11-8100-00155D081D0B/taskbotCollectComment \
-X 'GET' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

{"typingDelay":1.0,"message":"text","nextActionId":"D4C7158C-644A-EB11-8100-00155D081D0B","taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B"}
Update the Taskbot Collect Comment

PUT bot/taskbotActions/{id}/taskbotCollectComment

Parameters:
Name Type In Required Description
typingDelay float body yes TypingDelay is only available when channel is Live Chat. The typing delay in seconds before this message is shown in chat window.
message string body no HTML Text.
nextActionId guid body no Id of the next taskbot action.
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/bot/taskbotActions/D6C7158C-644A-EB11-8100-00155D081D0B/taskbotCollectComment \
-X 'PUT' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
-D '{"typingDelay":1.0,"message":"text","nextActionId":"D4C7158C-644A-EB11-8100-00155D081D0B"}'

Response:

 HTTP/1.1 200 OK

{"typingDelay":1.0,"message":"text","nextActionId":"D4C7158C-644A-EB11-8100-00155D081D0B","taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B"}
Model
Taskbot Collect Company Name JSON Format

Taskbot Collect Company Name is represented as simple flat JSON objects with the following keys:

Name Type Description
typingDelay float TypingDelay is only available when channel is Live Chat. The typing delay in seconds before this message is shown in chat window.
message string HTML Text.
nextActionId guid Id of the next taskbot action.
taskbotActionId guid Id of the current taskbot action.
Endpoint
Get a single Taskbot Collect Company Name

GET bot/taskbotActions/{id}/taskbotCollectCompanyName

Parameters:
No Parameters
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/bot/taskbotActions/D6C7158C-644A-EB11-8100-00155D081D0B/taskbotCollectCompanyName \
-X 'GET' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

{"typingDelay":1.0,"message":"text","nextActionId":"D4C7158C-644A-EB11-8100-00155D081D0B","taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B"}
Update the Taskbot Collect Company Name

PUT bot/taskbotActions/{id}/taskbotCollectCompanyName

Parameters:
Name Type In Required Description
typingDelay float body yes TypingDelay is only available when channel is Live Chat. The typing delay in seconds before this message is shown in chat window.
message string body no HTML Text.
nextActionId guid body no Id of the next taskbot action.
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/bot/taskbotActions/D6C7158C-644A-EB11-8100-00155D081D0B/taskbotCollectCompanyName \
-X 'PUT' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
-D '{"typingDelay":1.0,"message":"text","nextActionId":"D4C7158C-644A-EB11-8100-00155D081D0B"}'

Response:

 HTTP/1.1 200 OK

{"typingDelay":1.0,"message":"text","nextActionId":"D4C7158C-644A-EB11-8100-00155D081D0B","taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B"}
Model
Taskbot Collect Email JSON Format

Taskbot Collect Email is represented as simple flat JSON objects with the following keys:

Name Type Description
typingDelay float TypingDelay is only available when channel is Live Chat. The typing delay in seconds before this message is shown in chat window.
message string HTML Text.
nextActionId guid Id of the next taskbot action.
taskbotActionId guid Id of the current taskbot action.
Endpoint
Get a single Taskbot Collect Email

GET bot/taskbotActions/{id}/taskbotCollectEmail

Parameters:
No Parameters
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/bot/taskbotActions/D6C7158C-644A-EB11-8100-00155D081D0B/taskbotCollectEmail \
-X 'GET' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

{"typingDelay":1.0,"message":"text","nextActionId":"D4C7158C-644A-EB11-8100-00155D081D0B","taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B"}
Update the Taskbot Collect Email

PUT bot/taskbotActions/{id}/taskbotCollectEmail

Parameters:
Name Type In Required Description
typingDelay float body yes TypingDelay is only available when channel is Live Chat. The typing delay in seconds before this message is shown in chat window.
message string body no HTML Text.
nextActionId guid body no Id of the next taskbot action.
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/bot/taskbotActions/D6C7158C-644A-EB11-8100-00155D081D0B/taskbotCollectEmail \
-X 'PUT' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
-D '{"typingDelay":1.0,"message":"text","nextActionId":"D4C7158C-644A-EB11-8100-00155D081D0B"}'

Response:

 HTTP/1.1 200 OK

{"typingDelay":1.0,"message":"text","nextActionId":"D4C7158C-644A-EB11-8100-00155D081D0B","taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B"}
Model
Taskbot Send Email JSON Format

Taskbot Send Email is represented as simple flat JSON objects with the following keys:

Name Type Description
taskbotActionId guid Id of the current taskbot action.
subject string Email subject.
content string Email content.
to string The email to address. Use commas if there are multiple emails.
cc string The email CCs. Use commas if there are multiple emails.
nextActionId guid Id of the next taskbot action.
Endpoint
Get a single Taskbot Send Email

GET bot/taskbotActions/{id}/taskbotSendEmail

Parameters:
No Parameters
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/bot/taskbotActions/D6C7158C-644A-EB11-8100-00155D081D0B/taskbotSendEmail \
-X 'GET' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

{"taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","subject":"subject","content":"content","to":"test@comm100.com","cc":"test1@comm100.com","nextActionId":"9F813BFF-E65A-EB11-8101-00155D081D0B"}
Update the Taskbot Send Email

PUT bot/taskbotActions/{id}/taskbotSendEmail

Parameters:
Name Type In Required Description
subject string body no Email subject.
content string body no Email content.
to string body no The email to address. Use commas if there are multiple emails.
cc string body no The email CCs. Use commas if there are multiple emails.
nextActionId guid body no Id of the next taskbot action.
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/bot/taskbotActions/D6C7158C-644A-EB11-8100-00155D081D0B/taskbotSendEmail \
-X 'PUT' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
-D '{"subject":"subject","content":"content","to":"test@comm100.com","cc":"test1@comm100.com","nextActionId":"9F813BFF-E65A-EB11-8101-00155D081D0B"}'

Response:

 HTTP/1.1 200 OK

{"taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","subject":"subject","content":"content","to":"test@comm100.com","cc":"test1@comm100.com","nextActionId":"9F813BFF-E65A-EB11-8101-00155D081D0B"}
Model
Taskbot Book Meeting JSON Format

Taskbot Book Meeting is represented as simple flat JSON objects with the following keys:

Name Type Description
taskbotActionId guid Id of the current taskbot action.
failedActionId guid Id of the action to go to when book meeting failed.
successActionId guid Id of the action to go to when book meeting success.
integrationCalendlyId guid Id of the integration calendly.
calendlyEventTypeUri string URL of the calendly event type.
Endpoint
Get a single Taskbot Book Meeting

GET bot/taskbotActions/{id}/taskbotBookMeeting

Parameters:
No Parameters
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/bot/taskbotActions/D6C7158C-644A-EB11-8100-00155D081D0B/taskbotBookMeeting \
-X 'GET' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

{"taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","failedActionId":"5341d43d-2238-43a0-a5e1-5bf8e471ea93","successActionId":"d6bd7d9a-536e-43e4-a030-7b9f36b6ab4f","integrationCalendlyId":"64bb87e4-6940-4d2c-a6e4-176d52b8e9b8","calendlyEventTypeUri":"https://..."}
Update the Taskbot Book Meeting

PUT bot/taskbotActions/{id}/taskbotBookMeeting

Parameters:
Name Type In Required Description
failedActionId guid body no Id of the action to go to when book meeting failed.
successActionId guid body no Id of the action to go to when book meeting success.
integrationCalendlyId guid body yes Id of the integration calendly.
calendlyEventTypeUri string body yes URL of the calendly event type.
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/bot/taskbotActions/D6C7158C-644A-EB11-8100-00155D081D0B/taskbotBookMeeting \
-X 'PUT' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
-D '{"failedActionId":"5341d43d-2238-43a0-a5e1-5bf8e471ea93","successActionId":"d6bd7d9a-536e-43e4-a030-7b9f36b6ab4f","integrationCalendlyId":"64bb87e4-6940-4d2c-a6e4-176d52b8e9b8","calendlyEventTypeUri":"https://..."}'

Response:

 HTTP/1.1 200 OK

{"taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","failedActionId":"5341d43d-2238-43a0-a5e1-5bf8e471ea93","successActionId":"d6bd7d9a-536e-43e4-a030-7b9f36b6ab4f","integrationCalendlyId":"64bb87e4-6940-4d2c-a6e4-176d52b8e9b8","calendlyEventTypeUri":"https://..."}
Model
Taskbot Collect Location JSON Format

Taskbot Collect Location is represented as simple flat JSON objects with the following keys:

Name Type Description
taskbotActionId guid Id of the current taskbot action.
typingDelay float TypingDelay is only available when channel is Live Chat. The typing delay in seconds before this message is shown in chat window.
message string The message will be shown above Share Location button.
buttonText string The button text for Share Location button.
successActionId guid Id of the action to go to when successfully get location info.
failedActionId guid Id of the action to go to when can not get location info.
Endpoint
Get a single Taskbot Collect Location

GET bot/taskbotActions/{id}/taskbotCollectLocation

Parameters:
No Parameters
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/bot/taskbotActions/D6C7158C-644A-EB11-8100-00155D081D0B/taskbotCollectLocation \
-X 'GET' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

{"taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","typingDelay":1.0,"message":"shareLocation","buttonText":"button","successActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","failedActionId":"D6C7158C-644A-EB11-8100-00155D081D0B"}
Update the Taskbot Collect Location

PUT bot/taskbotActions/{id}/taskbotCollectLocation

Parameters:
Name Type In Required Description
typingDelay float body yes TypingDelay is only available when channel is Live Chat. The typing delay in seconds before this message is shown in chat window.
message string body no The message will be shown above Share Location button.
buttonText string body no The button text for Share Location button.
successActionId guid body no Id of the action to go to when successfully get location info.
failedActionId guid body no Id of the action to go to when can not get location info.
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/bot/taskbotActions/D6C7158C-644A-EB11-8100-00155D081D0B/taskbotCollectLocation \
-X 'PUT' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
-D '{"typingDelay":1.0,"message":"shareLocation","buttonText":"button","successActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","failedActionId":"D6C7158C-644A-EB11-8100-00155D081D0B"}'

Response:

 HTTP/1.1 200 OK

{"taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","typingDelay":1.0,"message":"shareLocation","buttonText":"button","successActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","failedActionId":"D6C7158C-644A-EB11-8100-00155D081D0B"}
Model
Taskbot Collect Name JSON Format

Taskbot Collect Name is represented as simple flat JSON objects with the following keys:

Name Type Description
taskbotActionId guid Id of the current taskbot action.
nextActionId guid Id of the next taskbot action.
message string HTML Text.
typingDelay float TypingDelay is only available when channel is Live Chat. The typing delay in seconds before this message is shown in chat window.
Endpoint
Get a single Taskbot Collect Name

GET bot/taskbotActions/{id}/taskbotCollectName

Parameters:
No Parameters
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/bot/taskbotActions/D6C7158C-644A-EB11-8100-00155D081D0B/taskbotCollectName \
-X 'GET' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

{"taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","nextActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","message":"text","typingDelay":1.0}
Update the Taskbot Collect Name

PUT bot/taskbotActions/{id}/taskbotCollectName

Parameters:
Name Type In Required Description
nextActionId guid body no Id of the next taskbot action.
message string body no HTML Text.
typingDelay float body yes TypingDelay is only available when channel is Live Chat. The typing delay in seconds before this message is shown in chat window.
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/bot/taskbotActions/D6C7158C-644A-EB11-8100-00155D081D0B/taskbotCollectName \
-X 'PUT' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
-D '{"nextActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","message":"text","typingDelay":1.0}'

Response:

 HTTP/1.1 200 OK

{"taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","nextActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","message":"text","typingDelay":1.0}
Model
Taskbot Collect Phone Number JSON Format

Taskbot Collect Phone Number is represented as simple flat JSON objects with the following keys:

Name Type Description
typingDelay float TypingDelay is only available when channel is Live Chat. The typing delay in seconds before this message is shown in chat window.
message string HTML Text.
nextActionId guid Id of the next taskbot action.
taskbotActionId guid Id of the current taskbot action.
Endpoint
Get a single Taskbot Collect Phone Number

GET bot/taskbotActions/{id}/taskbotCollectPhoneNumber

Parameters:
No Parameters
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/bot/taskbotActions/D6C7158C-644A-EB11-8100-00155D081D0B/taskbotCollectPhoneNumber \
-X 'GET' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

{"typingDelay":1.0,"message":"text","nextActionId":"D4C7158C-644A-EB11-8100-00155D081D0B","taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B"}
Update the Taskbot Collect Phone Number

PUT bot/taskbotActions/{id}/taskbotCollectPhoneNumber

Parameters:
Name Type In Required Description
typingDelay float body yes TypingDelay is only available when channel is Live Chat. The typing delay in seconds before this message is shown in chat window.
message string body no HTML Text.
nextActionId guid body no Id of the next taskbot action.
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/bot/taskbotActions/D6C7158C-644A-EB11-8100-00155D081D0B/taskbotCollectPhoneNumber \
-X 'PUT' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
-D '{"typingDelay":1.0,"message":"text","nextActionId":"D4C7158C-644A-EB11-8100-00155D081D0B"}'

Response:

 HTTP/1.1 200 OK

{"typingDelay":1.0,"message":"text","nextActionId":"D4C7158C-644A-EB11-8100-00155D081D0B","taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B"}
Model
Taskbot Collect Variable Data JSON Format

Taskbot Collect Variable Data is represented as simple flat JSON objects with the following keys:

Name Type Description
taskbotActionId guid Id of the current taskbot action.
nextActionId guid Id of the next taskbot action.
variableName string Can only contain letters and numbers.
options string Only available when type is singleSelect or multipleSelect.
message string HTML Text.
typingDelay float TypingDelay is only available when channel is Live Chat. The typing delay in seconds before this message is shown in chat window.
type string Content of the custom page.Allowed values are "text", "textArea", "singleSelect", "multipleSelect", "email", "password", "date", "time".
Endpoint
Get a single Taskbot Collect Variable Data

GET bot/taskbotActions/{id}/taskbotCollectVariableData

Parameters:
No Parameters
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/bot/taskbotActions/D6C7158C-644A-EB11-8100-00155D081D0B/taskbotCollectVariableData \
-X 'GET' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

{"taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","nextActionId":"D4C7158C-644A-EB11-8100-00155D081D0B","variableName":"name","options":"option1","message":"text","typingDelay":1.0,"type":"<!DOCTYPE html>\r\n?<html>\r\n?<head>\r\n? <title>{{title}}</title>\r\n? <meta charset=\"UTF-8\" />\r\n? <meta http-equiv=\"X-UA-Compatible\" content=\"IE=edge,chrome=1\" />\r\n? <meta name=\"viewport\" content=\"width=device-width, initial-scale=1.0\" />\r\n? <script type=\"text/javascript\" src=\"/kb/resources/js/jquery-1.10.2.min.js\"></script>\r\n? <script type=\"text/javascript\" src=\"/kb/resources/js/common.js?v=gbrqhch3oj0lob1m2w\"></script>\r\n? <link href=\"{{cssUrl}}\" rel=\"stylesheet\" type=\"text/css\" />\r\n? <link rel=\"canonical\" href=\"{{url}}\" />\r\n?</head>\r\n?<body>\r\n? <div class=\"header\">\r\n? <div class=\"container\">\r\n? <div class=\"header_logo\"><img src=\"/kb/resources/your_logo.png\" /></div>\r\n? <div class=\"header__title\"><span>Find answers in our Knowledge Base</span></div>\r\n? <div class=\"header__search\">\r\n? <input type=\"text\" class=\"search-input header__searchinput\" placeholder=\"Enter your question...\" autocomplete=\"off\" />\r\n? <i class=\"iconfont icon-search\"></i>\r\n? </div>\r\n? </div>\r\n? </div>\r\n? <div class=\"content\">\r\n? <div class=\"container\">\r\n? <div class=\"breadcrumbs\">\r\n? {{breadcrumbs}}\r\n? </div>\r\n? <div class=\"category-list\">\r\n? {% for category in categories %}\r\n? <div class=\"category-list__item\">\r\n? <div class=\"category-list__item__header\" onclick=\"showHide();\">\r\n? <i class=\"iconfont icon-folder\"></i>\r\n? <div class=\"category-list__item__name\"><a href=\"{{category.url}}\">{{category.name}}</a></div>\r\n? <i class=\"iconfont icon-fold\"></i>\r\n? </div>\r\n? <div class=\"category-list__item__content collapse\">\r\n? <div class=\"article-list\" id=\"{{category.id}}\">\r\n? {% for article in articles %}\r\n? {% if category.id == article.category_id %}\r\n? <div class=\"article-list__title\">\r\n? {% if article.if_featured %}\r\n? <i class=\"iconfont icon-feature\"></i>\r\n? {% endif %}\r\n? <a href=\"{{article.url}}\">{{article.title}}</a>\r\n? </div>\r\n? {% endif %}\r\n? {% endfor %}\r\n? </div>\r\n? </div>\r\n? </div>\r\n? {% endfor %}\r\n? </div>\r\n? </div>\r\n? </div>\r\n?</body>\r\n?</html>"}
Update the Taskbot Collect Variable Data

PUT bot/taskbotActions/{id}/taskbotCollectVariableData

Parameters:
Name Type In Required Description
nextActionId guid body no Id of the next taskbot action.
variableName string body no Can only contain letters and numbers.
options string body no Only available when type is singleSelect or multipleSelect.
message string body no HTML Text.
typingDelay float body yes TypingDelay is only available when channel is Live Chat. The typing delay in seconds before this message is shown in chat window.
type string body no Content of the custom page.Allowed values are "text", "textArea", "singleSelect", "multipleSelect", "email", "password", "date", "time".
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/bot/taskbotActions/D6C7158C-644A-EB11-8100-00155D081D0B/taskbotCollectVariableData \
-X 'PUT' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
-D '{"nextActionId":"D4C7158C-644A-EB11-8100-00155D081D0B","variableName":"name","options":"option1","message":"text","typingDelay":1.0,"type":"<!DOCTYPE html>\r\n?<html>\r\n?<head>\r\n? <title>{{title}}</title>\r\n? <meta charset=\"UTF-8\" />\r\n? <meta http-equiv=\"X-UA-Compatible\" content=\"IE=edge,chrome=1\" />\r\n? <meta name=\"viewport\" content=\"width=device-width, initial-scale=1.0\" />\r\n? <script type=\"text/javascript\" src=\"/kb/resources/js/jquery-1.10.2.min.js\"></script>\r\n? <script type=\"text/javascript\" src=\"/kb/resources/js/common.js?v=gbrqhch3oj0lob1m2w\"></script>\r\n? <link href=\"{{cssUrl}}\" rel=\"stylesheet\" type=\"text/css\" />\r\n? <link rel=\"canonical\" href=\"{{url}}\" />\r\n?</head>\r\n?<body>\r\n? <div class=\"header\">\r\n? <div class=\"container\">\r\n? <div class=\"header_logo\"><img src=\"/kb/resources/your_logo.png\" /></div>\r\n? <div class=\"header__title\"><span>Find answers in our Knowledge Base</span></div>\r\n? <div class=\"header__search\">\r\n? <input type=\"text\" class=\"search-input header__searchinput\" placeholder=\"Enter your question...\" autocomplete=\"off\" />\r\n? <i class=\"iconfont icon-search\"></i>\r\n? </div>\r\n? </div>\r\n? </div>\r\n? <div class=\"content\">\r\n? <div class=\"container\">\r\n? <div class=\"breadcrumbs\">\r\n? {{breadcrumbs}}\r\n? </div>\r\n? <div class=\"category-list\">\r\n? {% for category in categories %}\r\n? <div class=\"category-list__item\">\r\n? <div class=\"category-list__item__header\" onclick=\"showHide();\">\r\n? <i class=\"iconfont icon-folder\"></i>\r\n? <div class=\"category-list__item__name\"><a href=\"{{category.url}}\">{{category.name}}</a></div>\r\n? <i class=\"iconfont icon-fold\"></i>\r\n? </div>\r\n? <div class=\"category-list__item__content collapse\">\r\n? <div class=\"article-list\" id=\"{{category.id}}\">\r\n? {% for article in articles %}\r\n? {% if category.id == article.category_id %}\r\n? <div class=\"article-list__title\">\r\n? {% if article.if_featured %}\r\n? <i class=\"iconfont icon-feature\"></i>\r\n? {% endif %}\r\n? <a href=\"{{article.url}}\">{{article.title}}</a>\r\n? </div>\r\n? {% endif %}\r\n? {% endfor %}\r\n? </div>\r\n? </div>\r\n? </div>\r\n? {% endfor %}\r\n? </div>\r\n? </div>\r\n? </div>\r\n?</body>\r\n?</html>"}'

Response:

 HTTP/1.1 200 OK

{"taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","nextActionId":"D4C7158C-644A-EB11-8100-00155D081D0B","variableName":"name","options":"option1","message":"text","typingDelay":1.0,"type":"<!DOCTYPE html>\r\n?<html>\r\n?<head>\r\n? <title>{{title}}</title>\r\n? <meta charset=\"UTF-8\" />\r\n? <meta http-equiv=\"X-UA-Compatible\" content=\"IE=edge,chrome=1\" />\r\n? <meta name=\"viewport\" content=\"width=device-width, initial-scale=1.0\" />\r\n? <script type=\"text/javascript\" src=\"/kb/resources/js/jquery-1.10.2.min.js\"></script>\r\n? <script type=\"text/javascript\" src=\"/kb/resources/js/common.js?v=gbrqhch3oj0lob1m2w\"></script>\r\n? <link href=\"{{cssUrl}}\" rel=\"stylesheet\" type=\"text/css\" />\r\n? <link rel=\"canonical\" href=\"{{url}}\" />\r\n?</head>\r\n?<body>\r\n? <div class=\"header\">\r\n? <div class=\"container\">\r\n? <div class=\"header_logo\"><img src=\"/kb/resources/your_logo.png\" /></div>\r\n? <div class=\"header__title\"><span>Find answers in our Knowledge Base</span></div>\r\n? <div class=\"header__search\">\r\n? <input type=\"text\" class=\"search-input header__searchinput\" placeholder=\"Enter your question...\" autocomplete=\"off\" />\r\n? <i class=\"iconfont icon-search\"></i>\r\n? </div>\r\n? </div>\r\n? </div>\r\n? <div class=\"content\">\r\n? <div class=\"container\">\r\n? <div class=\"breadcrumbs\">\r\n? {{breadcrumbs}}\r\n? </div>\r\n? <div class=\"category-list\">\r\n? {% for category in categories %}\r\n? <div class=\"category-list__item\">\r\n? <div class=\"category-list__item__header\" onclick=\"showHide();\">\r\n? <i class=\"iconfont icon-folder\"></i>\r\n? <div class=\"category-list__item__name\"><a href=\"{{category.url}}\">{{category.name}}</a></div>\r\n? <i class=\"iconfont icon-fold\"></i>\r\n? </div>\r\n? <div class=\"category-list__item__content collapse\">\r\n? <div class=\"article-list\" id=\"{{category.id}}\">\r\n? {% for article in articles %}\r\n? {% if category.id == article.category_id %}\r\n? <div class=\"article-list__title\">\r\n? {% if article.if_featured %}\r\n? <i class=\"iconfont icon-feature\"></i>\r\n? {% endif %}\r\n? <a href=\"{{article.url}}\">{{article.title}}</a>\r\n? </div>\r\n? {% endif %}\r\n? {% endfor %}\r\n? </div>\r\n? </div>\r\n? </div>\r\n? {% endfor %}\r\n? </div>\r\n? </div>\r\n? </div>\r\n?</body>\r\n?</html>"}
Model
Taskbot Go To Taskbot JSON Format

Taskbot Go To Taskbot is represented as simple flat JSON objects with the following keys:

Name Type Description
taskbotActionId guid Id of the taskbotaction.
taskbotId guid Id of the taskbot.
Endpoint
Get a single Taskbot Go To Taskbot

GET bot/taskbotActions/{id}/taskbotGotoTaskbot

Parameters:
No Parameters
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/bot/taskbotActions/4E8E8CE8-AD49-EB11-8100-00155D081D0B/taskbotGotoTaskbot \
-X 'GET' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

{"taskbotActionId":"4E8E8CE8-AD49-EB11-8100-00155D081D0B","taskbotId":"4E8E8CE8-AD49-EB11-8100-00155D081D0B"}
Update the Taskbot Go To Taskbot

PUT bot/taskbotActions/{id}/taskbotGotoTaskbot

Parameters:
Name Type In Required Description
taskbotId guid body yes Id of the taskbot.
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/bot/taskbotActions/4E8E8CE8-AD49-EB11-8100-00155D081D0B/taskbotGotoTaskbot \
-X 'PUT' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
-D '{"taskbotId":"4E8E8CE8-AD49-EB11-8100-00155D081D0B"}'

Response:

 HTTP/1.1 200 OK

{"taskbotActionId":"4E8E8CE8-AD49-EB11-8100-00155D081D0B","taskbotId":"4E8E8CE8-AD49-EB11-8100-00155D081D0B"}
Model
Taskbot Quick Reply JSON Format

Taskbot Quick Reply is represented as simple flat JSON objects with the following keys:

Name Type Description
taskbotActionId guid Id of the taskbot action.
typingDelay float Add a delay (the bot shows a typing indicator) to bot responses to deliver multiple messages to the customer at a comfortable reading pace.
message string Message of the quick reply.
otherResponseToActionId guid Id of other responset to action.
taskbotQuickReplyOptions taskbotQuickReplyOptions[] Reference to Taskbot Quick Reply Option.
Endpoint
Get a single Taskbot Quick Reply

GET bot/taskbotActions/{id}/taskbotQuickReply

Parameters:
Name Type In Required Description
include string query no Allowed value is "taskbotQuickReplyOption".
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/bot/taskbotActions/D0948954-AE49-EB11-8100-00155D081D0B/taskbotQuickReply \
-X 'GET' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

{"taskbotActionId":"D0948954-AE49-EB11-8100-00155D081D0B","typingDelay":1.0,"message":"link to baidu","otherResponseToActionId":"4CB9B085-AC49-EB11-8100-00155D081D0B","taskbotQuickReplyOptions":[{"id":"EF948954-AE49-EB11-8100-00155D081D0B","taskbotActionId":"D0948954-AE49-EB11-8100-00155D081D0B","text":"Baidu","order":0,"nextActionId":"F5948954-AE49-EB11-8100-00155D081D0B"}]}
Update the Taskbot Quick Reply

PUT bot/taskbotActions/{id}/taskbotQuickReply

Parameters:
Name Type In Required Description
typingDelay float body yes Add a delay (the bot shows a typing indicator) to bot responses to deliver multiple messages to the customer at a comfortable reading pace.
message string body no Message of the quick reply.
otherResponseToActionId guid body no Id of other responset to action.
taskbotQuickReplyOptions taskbotQuickReplyOptions[] body no Reference to Taskbot Quick Reply Option.
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/bot/taskbotActions/D0948954-AE49-EB11-8100-00155D081D0B/taskbotQuickReply \
-X 'PUT' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
-D '{"typingDelay":1.0,"message":"link to baidu","otherResponseToActionId":"4CB9B085-AC49-EB11-8100-00155D081D0B","taskbotQuickReplyOptions":[{"text":"Baidu","order":0,"nextActionId":"F5948954-AE49-EB11-8100-00155D081D0B"}]}'

Response:

 HTTP/1.1 200 OK

{"taskbotActionId":"D0948954-AE49-EB11-8100-00155D081D0B","typingDelay":1.0,"message":"link to baidu","otherResponseToActionId":"4CB9B085-AC49-EB11-8100-00155D081D0B","taskbotQuickReplyOptions":[{"id":"EF948954-AE49-EB11-8100-00155D081D0B","taskbotActionId":"D0948954-AE49-EB11-8100-00155D081D0B","text":"Baidu","order":0,"nextActionId":"F5948954-AE49-EB11-8100-00155D081D0B"}]}
Model
Taskbot Quick Reply Option JSON Format

Taskbot Quick Reply Option is represented as simple flat JSON objects with the following keys:

Name Type Description
id guid Id of Quick Reply item.
taskbotActionId guid Id of the taskbot action.
text string Only available when Type is triggerAnIntent.
order integer Must greater than or equal 0, ascending sort.
nextActionId guid Id of the next action.
Endpoint
Get the list of Taskbot Quick Reply Options

GET bot/taskbotQuickReplyOptions

Parameters:
No Parameters
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/bot/taskbotQuickReplyOptions \
-X 'GET' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

[{"id":"EF948954-AE49-EB11-8100-00155D081D0B","taskbotActionId":"D0948954-AE49-EB11-8100-00155D081D0B","text":"Baidu","order":0,"nextActionId":"F5948954-AE49-EB11-8100-00155D081D0B"}]
Get a single Taskbot Quick Reply Option

GET bot/taskbotQuickReplyOptions/{id}

Parameters:
No Parameters
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/bot/taskbotQuickReplyOptions/EF948954-AE49-EB11-8100-00155D081D0B \
-X 'GET' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

{"id":"EF948954-AE49-EB11-8100-00155D081D0B","taskbotActionId":"D0948954-AE49-EB11-8100-00155D081D0B","text":"Baidu","order":0,"nextActionId":"F5948954-AE49-EB11-8100-00155D081D0B"}
Create a new Taskbot Quick Reply Option

POST bot/taskbotQuickReplyOptions

Parameters:
Name Type In Required Description
taskbotActionId guid body yes Id of the taskbot action.
text string body no Only available when Type is triggerAnIntent.
order integer body yes Must greater than or equal 0, ascending sort.
nextActionId guid body no Id of the next action.
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/bot/taskbotQuickReplyOptions \
-X 'POST' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
-D '{"taskbotActionId":"D0948954-AE49-EB11-8100-00155D081D0B","text":"Baidu","order":0,"nextActionId":"F5948954-AE49-EB11-8100-00155D081D0B"}'

Response:

 HTTP/1.1 201 Created

{"id":"EF948954-AE49-EB11-8100-00155D081D0B","taskbotActionId":"D0948954-AE49-EB11-8100-00155D081D0B","text":"Baidu","order":0,"nextActionId":"F5948954-AE49-EB11-8100-00155D081D0B"}
Update the Taskbot Quick Reply Option

PUT bot/taskbotQuickReplyOptions/{id}

Parameters:
Name Type In Required Description
taskbotActionId guid body yes Id of the taskbot action.
text string body no Only available when Type is triggerAnIntent.
order integer body yes Must greater than or equal 0, ascending sort.
nextActionId guid body no Id of the next action.
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/bot/taskbotQuickReplyOptions/EF948954-AE49-EB11-8100-00155D081D0B \
-X 'PUT' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
-D '{"taskbotActionId":"D0948954-AE49-EB11-8100-00155D081D0B","text":"Baidu","order":0,"nextActionId":"F5948954-AE49-EB11-8100-00155D081D0B"}'

Response:

 HTTP/1.1 200 OK

{"id":"EF948954-AE49-EB11-8100-00155D081D0B","taskbotActionId":"D0948954-AE49-EB11-8100-00155D081D0B","text":"Baidu","order":0,"nextActionId":"F5948954-AE49-EB11-8100-00155D081D0B"}
Remove the Taskbot Quick Reply Option

DELETE bot/taskbotQuickReplyOptions/{id}

Parameters:
No Parameters
Response:

No Content

Example

Sample Request:

curl https://api15.comm100.io/v4/bot/taskbotQuickReplyOptions/EF948954-AE49-EB11-8100-00155D081D0B \
-X 'DELETE' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 204 No Content

Model
Taskbot Send Image JSON Format

Taskbot Send Image is represented as simple flat JSON objects with the following keys:

Name Type Description
taskbotActionId guid Id of the current taskbot action.
nextActionId guid Id of the next taskbot action.
typingDelay float TypingDelay is only available when channel is Live Chat. The typing delay in seconds before this message is shown in chat window.
message string HTML text, can be blank. The message will be in the same bubble above image.
image string
Endpoint
Get a single Taskbot Send Image

GET bot/taskbotActions/{id}/taskbotSendImage

Parameters:
No Parameters
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/bot/taskbotActions/7AE8FDBF-504A-EB11-8100-00155D081D0B/taskbotSendImage \
-X 'GET' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

{"taskbotActionId":"7AE8FDBF-504A-EB11-8100-00155D081D0B","nextActionId":"8AE8FDBF-504A-EB11-8100-00155D081D0B","typingDelay":1.0,"message":"test","image":"https://api15.comm100.io/v4/Bot/taskbotSendImages/7AE8FDBF-504A-EB11-8100-00155D081D0B/image"}
Update the Taskbot Send Image

PUT bot/taskbotActions/{id}/taskbotSendImage

Parameters:
Name Type In Required Description
nextActionId guid body no Id of the next taskbot action.
typingDelay float body yes TypingDelay is only available when channel is Live Chat. The typing delay in seconds before this message is shown in chat window.
message string body no HTML text, can be blank. The message will be in the same bubble above image.
image string body no
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/bot/taskbotActions/7AE8FDBF-504A-EB11-8100-00155D081D0B/taskbotSendImage \
-X 'PUT' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
-D '{"nextActionId":"8AE8FDBF-504A-EB11-8100-00155D081D0B","typingDelay":1.0,"message":"test","image":""}'

Response:

 HTTP/1.1 200 OK

{"taskbotActionId":"7AE8FDBF-504A-EB11-8100-00155D081D0B","nextActionId":"8AE8FDBF-504A-EB11-8100-00155D081D0B","typingDelay":1.0,"message":"test","image":"https://api15.comm100.io/v4/Bot/taskbotSendImages/7AE8FDBF-504A-EB11-8100-00155D081D0B/image"}
Model
Taskbot Send Message JSON Format

Taskbot Send Message is represented as simple flat JSON objects with the following keys:

Name Type Description
taskbotActionId guid Id of the current taskbot action.
typingDelay float TypingDelay is only available when channel is Live Chat. The typing delay in seconds before this message is shown in chat window.
message string A string text of the message.
nextActionId guid Id of the next taskbot action.
taskbotSendMessageButtons taskbotSendMessageButtons[] Reference to Taskbot Send Message Button.
Endpoint
Get a single Taskbot Send Message

GET bot/taskbotActions/{id}/taskbotSendMessage

Parameters:
Name Type In Required Description
include string query no Allowed value is "taskbotSendMessageButton".
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/bot/taskbotActions/F8A7A50B-B049-EB11-8100-00155D081D0B/taskbotSendMessage \
-X 'GET' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

{"taskbotActionId":"F8A7A50B-B049-EB11-8100-00155D081D0B","typingDelay":1.0,"message":"hi","nextActionId":"693c1ffa-4d57-40d2-9fc0-68e89430b4f1","taskbotSendMessageButtons":[{"id":"a46afdad-82c9-4405-bb4b-8d5517ef57d8","taskbotActionId":"E4099BB1-774A-EB11-8100-00155D081D0B","buttonText":"test","url":"https://...","order":1,"type":"link","openIn":"currentWindow","openStyle":"compact"}]}
Update the Taskbot Send Message

PUT bot/taskbotActions/{id}/taskbotSendMessage

Parameters:
Name Type In Required Description
typingDelay float body yes TypingDelay is only available when channel is Live Chat. The typing delay in seconds before this message is shown in chat window.
message string body no A string text of the message.
nextActionId guid body no Id of the next taskbot action.
taskbotSendMessageButtons taskbotSendMessageButtons[] body no Reference to Taskbot Send Message Button.
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/bot/taskbotActions/F8A7A50B-B049-EB11-8100-00155D081D0B/taskbotSendMessage \
-X 'PUT' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
-D '{"typingDelay":1.0,"message":"hi","nextActionId":"693c1ffa-4d57-40d2-9fc0-68e89430b4f1","taskbotSendMessageButtons":[{"buttonText":"test","url":"https://...","order":1,"type":"link","openIn":"currentWindow","openStyle":"compact"}]}'

Response:

 HTTP/1.1 200 OK

{"taskbotActionId":"F8A7A50B-B049-EB11-8100-00155D081D0B","typingDelay":1.0,"message":"hi","nextActionId":"693c1ffa-4d57-40d2-9fc0-68e89430b4f1","taskbotSendMessageButtons":[{"id":"a46afdad-82c9-4405-bb4b-8d5517ef57d8","taskbotActionId":"E4099BB1-774A-EB11-8100-00155D081D0B","buttonText":"test","url":"https://...","order":1,"type":"link","openIn":"currentWindow","openStyle":"compact"}]}
Model
Taskbot Send Message Button JSON Format

Taskbot Send Message Button is represented as simple flat JSON objects with the following keys:

Name Type Description
id guid Id of the taskbot send message button.
taskbotActionId guid Id of the taskbot action.
buttonText string Text displaied on the button.
url string URL of the button, only available when type is Link or Webview.
order integer Must be greater than or equal to 0, ascending order.
type string Allowed values are "link", "webview".
openIn string Allowed values are "sideWindow", "newWindow", "currentWindow".
openStyle string Allowed values are "compact", "tall", "full".
Endpoint
Get the list of Taskbot Send Message Buttons

GET bot/taskbotSendMessageButtons

Parameters:
No Parameters
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/bot/taskbotSendMessageButtons \
-X 'GET' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

[{"id":"a46afdad-82c9-4405-bb4b-8d5517ef57d8","taskbotActionId":"E4099BB1-774A-EB11-8100-00155D081D0B","buttonText":"test","url":"https://...","order":1,"type":"link","openIn":"currentWindow","openStyle":"compact"}]
Get a single Taskbot Send Message Button

GET bot/taskbotSendMessageButtons/{id}

Parameters:
No Parameters
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/bot/taskbotSendMessageButtons/a46afdad-82c9-4405-bb4b-8d5517ef57d8 \
-X 'GET' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

{"id":"a46afdad-82c9-4405-bb4b-8d5517ef57d8","taskbotActionId":"E4099BB1-774A-EB11-8100-00155D081D0B","buttonText":"test","url":"https://...","order":1,"type":"link","openIn":"currentWindow","openStyle":"compact"}
Create a new Taskbot Send Message Button

POST bot/taskbotSendMessageButtons

Parameters:
Name Type In Required Description
taskbotActionId guid body yes Id of the taskbot action.
buttonText string body no Text displaied on the button.
url string body no URL of the button, only available when type is Link or Webview.
order integer body no Must be greater than or equal to 0, ascending order.
type string body no Allowed values are "link", "webview".
openIn string body no Allowed values are "sideWindow", "newWindow", "currentWindow".
openStyle string body no Allowed values are "compact", "tall", "full".
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/bot/taskbotSendMessageButtons \
-X 'POST' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
-D '{"taskbotActionId":"E4099BB1-774A-EB11-8100-00155D081D0B","buttonText":"test","url":"https://...","order":1,"type":"link","openIn":"currentWindow","openStyle":"compact"}'

Response:

 HTTP/1.1 201 Created

{"id":"a46afdad-82c9-4405-bb4b-8d5517ef57d8","taskbotActionId":"E4099BB1-774A-EB11-8100-00155D081D0B","buttonText":"test","url":"https://...","order":1,"type":"link","openIn":"currentWindow","openStyle":"compact"}
Update the Taskbot Send Message Button

PUT bot/taskbotSendMessageButtons/{id}

Parameters:
Name Type In Required Description
taskbotActionId guid body yes Id of the taskbot action.
buttonText string body no Text displaied on the button.
url string body no URL of the button, only available when type is Link or Webview.
order integer body no Must be greater than or equal to 0, ascending order.
type string body no Allowed values are "link", "webview".
openIn string body no Allowed values are "sideWindow", "newWindow", "currentWindow".
openStyle string body no Allowed values are "compact", "tall", "full".
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/bot/taskbotSendMessageButtons/a46afdad-82c9-4405-bb4b-8d5517ef57d8 \
-X 'PUT' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
-D '{"taskbotActionId":"E4099BB1-774A-EB11-8100-00155D081D0B","buttonText":"test","url":"https://...","order":1,"type":"link","openIn":"currentWindow","openStyle":"compact"}'

Response:

 HTTP/1.1 200 OK

{"id":"a46afdad-82c9-4405-bb4b-8d5517ef57d8","taskbotActionId":"E4099BB1-774A-EB11-8100-00155D081D0B","buttonText":"test","url":"https://...","order":1,"type":"link","openIn":"currentWindow","openStyle":"compact"}
Remove the Taskbot Send Message Button

DELETE bot/taskbotSendMessageButtons/{id}

Parameters:
No Parameters
Response:

No Content

Example

Sample Request:

curl https://api15.comm100.io/v4/bot/taskbotSendMessageButtons/a46afdad-82c9-4405-bb4b-8d5517ef57d8 \
-X 'DELETE' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 204 No Content

Model
Taskbot Send Video JSON Format

Taskbot Send Video is represented as simple flat JSON objects with the following keys:

Name Type Description
taskbotActionId guid Id of the current taskbot action.
nextActionId guid Id of the next taskbot action.
typingDelay float TypingDelay is only available when channel is Live Chat. The typing delay in seconds before this message is shown in chat window.
message string Can be blank. The message will be in the same bubble above video.
videoUrl string URL of the video.
Endpoint
Get a single Taskbot Send Video

GET bot/taskbotActions/{id}/taskbotSendVideo

Parameters:
No Parameters
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/bot/taskbotActions/4CB9B085-AC49-EB11-8100-00155D081D0B/taskbotSendVideo \
-X 'GET' \

Response:

 HTTP/1.1 200 OK

{"taskbotActionId":"4CB9B085-AC49-EB11-8100-00155D081D0B","nextActionId":"D0948954-AE49-EB11-8100-00155D081D0B","typingDelay":1.0,"message":"test","videoUrl":"https://..."}
Update the Taskbot Send Video

PUT bot/taskbotActions/{id}/taskbotSendVideo

Parameters:
Name Type In Required Description
nextActionId guid body no Id of the next taskbot action.
typingDelay float body yes TypingDelay is only available when channel is Live Chat. The typing delay in seconds before this message is shown in chat window.
message string body no Can be blank. The message will be in the same bubble above video.
videoUrl string body no URL of the video.
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/bot/taskbotActions/4CB9B085-AC49-EB11-8100-00155D081D0B/taskbotSendVideo \
-X 'PUT' \
-H 'Content-Type: application/json' \
-D '{"nextActionId":"D0948954-AE49-EB11-8100-00155D081D0B","typingDelay":1.0,"message":"test","videoUrl":"https://..."}'

Response:

 HTTP/1.1 200 OK

{"taskbotActionId":"4CB9B085-AC49-EB11-8100-00155D081D0B","nextActionId":"D0948954-AE49-EB11-8100-00155D081D0B","typingDelay":1.0,"message":"test","videoUrl":"https://..."}
Model
Taskbot SSO Login Button JSON Format

Taskbot SSO Login Button is represented as simple flat JSON objects with the following keys:

Name Type Description
taskbotActionId guid Id of the taskbot action.
typingDelay float TypingDelay is only available when channel is Live Chat. The typing delay in seconds before this message is shown in chat window.
message string The message will be shown above Login button.
loginButtonText string The button text for Login button.
loginInActionId guid Id of the login in action.
failedActionId guid Id of the failed action.
Endpoint
Get a single Taskbot SSO Login Button

GET bot/taskbotActions/{id}/taskbotSSOLoginButton

Parameters:
No Parameters
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/bot/taskbotActions/D6C7158C-644A-EB11-8100-00155D081D0B/taskbotSSOLoginButton \
-X 'GET' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

{"taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","typingDelay":1.0,"message":"To get personized service, you need to login first.","loginButtonText":"login","loginInActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","failedActionId":"D6C7158C-644A-EB11-8100-00155D081D0B"}
Update the Taskbot SSO Login Button

PUT bot/taskbotActions/{id}/taskbotSSOLoginButton

Parameters:
Name Type In Required Description
typingDelay float body yes TypingDelay is only available when channel is Live Chat. The typing delay in seconds before this message is shown in chat window.
message string body no The message will be shown above Login button.
loginButtonText string body no The button text for Login button.
loginInActionId guid body no Id of the login in action.
failedActionId guid body no Id of the failed action.
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/bot/taskbotActions/D6C7158C-644A-EB11-8100-00155D081D0B/taskbotSSOLoginButton \
-X 'PUT' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
-D '{"typingDelay":1.0,"message":"To get personized service, you need to login first.","loginButtonText":"login","loginInActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","failedActionId":"D6C7158C-644A-EB11-8100-00155D081D0B"}'

Response:

 HTTP/1.1 200 OK

{"taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","typingDelay":1.0,"message":"To get personized service, you need to login first.","loginButtonText":"login","loginInActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","failedActionId":"D6C7158C-644A-EB11-8100-00155D081D0B"}
Model
Taskbot Webhook JSON Format

Taskbot Webhook is represented as simple flat JSON objects with the following keys:

Name Type Description
taskbotActionId guid Id of the taskbot action.
url string URL of the webhook request.
ifSendChatTranscript bool If send the chat transcript to 3rd party system.
additionalPostBody string The additional post body of the request.
otherResponseToActionId guid Id of the other response to action.
taskbotWebhookHeaders taskbotWebhookHeaders[] Reference to Taskbot Webhook Header.
taskbotWebhookResponseToVariables taskbotWebhookResponseToVariables[] Reference to Taskbot Webhook Response To Variable.
taskbotWebhookResponseCodeToActions taskbotWebhookResponseCodeToActions[] Reference to Taskbot Webhook Response Code To Action.
Endpoint
Get a single Taskbot Webhook

GET bot/taskbotActions/{id}/taskbotWebhook

Parameters:
Name Type In Required Description
include string query no Allowed values are "taskbotWebhookHeader", "taskbotWebhookResponseToVariable", "taskbotWebhookResponseCodeToAction".
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/bot/taskbotActions/D6C7158C-644A-EB11-8100-00155D081D0B/taskbotWebhook \
-X 'GET' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

{"taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","url":"https://...","ifSendChatTranscript":false,"additionalPostBody":"","otherResponseToActionId":"4CB006E2-BA49-EB11-8100-00155D081D0B","taskbotWebhookHeaders":[{"id":"4DB006E2-BA49-EB11-8100-00155D081D0B","taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","key":"key","value":"value","order":1}],"taskbotWebhookResponseToVariables":[{"id":"D4C7158C-644A-EB11-8100-00155D081D0B","taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","variableName":"name","responseKey":"text","order":1}],"taskbotWebhookResponseCodeToActions":[{"id":"4DB006E2-BA49-EB11-8100-00155D081D0B","taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","responseCode":"","nextActionId":"5AB006E2-BA49-EB11-8100-00155D081D0B","order":1}]}
Update the Taskbot Webhook

PUT bot/taskbotActions/{id}/taskbotWebhook

Parameters:
Name Type In Required Description
url string body no URL of the webhook request.
ifSendChatTranscript bool body no If send the chat transcript to 3rd party system.
additionalPostBody string body no The additional post body of the request.
otherResponseToActionId guid body no Id of the other response to action.
taskbotWebhookHeaders taskbotWebhookHeaders[] body no Reference to Taskbot Webhook Header.
taskbotWebhookResponseToVariables taskbotWebhookResponseToVariables[] body no Reference to Taskbot Webhook Response To Variable.
taskbotWebhookResponseCodeToActions taskbotWebhookResponseCodeToActions[] body no Reference to Taskbot Webhook Response Code To Action.
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/bot/taskbotActions/D6C7158C-644A-EB11-8100-00155D081D0B/taskbotWebhook \
-X 'PUT' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
-D '{"url":"https://...","ifSendChatTranscript":false,"additionalPostBody":"","otherResponseToActionId":"4CB006E2-BA49-EB11-8100-00155D081D0B","taskbotWebhookHeaders":[{"key":"key","value":"value","order":1}],"taskbotWebhookResponseToVariables":[{"variableName":"name","responseKey":"text","order":1}],"taskbotWebhookResponseCodeToActions":[{"responseCode":"","nextActionId":"5AB006E2-BA49-EB11-8100-00155D081D0B","order":1}]}'

Response:

 HTTP/1.1 200 OK

{"taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","url":"https://...","ifSendChatTranscript":false,"additionalPostBody":"","otherResponseToActionId":"4CB006E2-BA49-EB11-8100-00155D081D0B","taskbotWebhookHeaders":[{"id":"4DB006E2-BA49-EB11-8100-00155D081D0B","taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","key":"key","value":"value","order":1}],"taskbotWebhookResponseToVariables":[{"id":"D4C7158C-644A-EB11-8100-00155D081D0B","taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","variableName":"name","responseKey":"text","order":1}],"taskbotWebhookResponseCodeToActions":[{"id":"4DB006E2-BA49-EB11-8100-00155D081D0B","taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","responseCode":"","nextActionId":"5AB006E2-BA49-EB11-8100-00155D081D0B","order":1}]}
Model
Taskbot Webhook Header JSON Format

Taskbot Webhook Header is represented as simple flat JSON objects with the following keys:

Name Type Description
id guid Id of the taskbot webhook header.
taskbotActionId guid Id of the taskbot action.
key string Key of the header.
value string Value of the header.
order integer Must be greater than or equal to 0, ascending order.
Endpoint
Get the list of Taskbot Webhook Headers

GET bot/taskbotWebhookHeaders

Parameters:
No Parameters
Response:

An array of   Taskbot Webhook Header

Example

Sample Request:

curl https://api15.comm100.io/v4/bot/taskbotWebhookHeaders \
-X 'GET' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

[{"id":"4DB006E2-BA49-EB11-8100-00155D081D0B","taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","key":"key","value":"value","order":1}]
Get a single Taskbot Webhook Header

GET bot/taskbotWebhookHeaders/{id}

Parameters:
No Parameters
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/bot/taskbotWebhookHeaders/4DB006E2-BA49-EB11-8100-00155D081D0B \
-X 'GET' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

{"id":"4DB006E2-BA49-EB11-8100-00155D081D0B","taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","key":"key","value":"value","order":1}
Create a new Taskbot Webhook Header

POST bot/taskbotWebhookHeaders

Parameters:
Name Type In Required Description
taskbotActionId guid body yes Id of the taskbot action.
key string body no Key of the header.
value string body no Value of the header.
order integer body no Must be greater than or equal to 0, ascending order.
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/bot/taskbotWebhookHeaders \
-X 'POST' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
-D '{"taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","key":"key","value":"value","order":1}'

Response:

 HTTP/1.1 201 Created

{"id":"4DB006E2-BA49-EB11-8100-00155D081D0B","taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","key":"key","value":"value","order":1}
Update the Taskbot Webhook Header

PUT bot/taskbotWebhookHeaders/{id}

Parameters:
Name Type In Required Description
taskbotActionId guid body yes Id of the taskbot action.
key string body no Key of the header.
value string body no Value of the header.
order integer body no Must be greater than or equal to 0, ascending order.
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/bot/taskbotWebhookHeaders/4DB006E2-BA49-EB11-8100-00155D081D0B \
-X 'PUT' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
-D '{"taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","key":"key","value":"value","order":1}'

Response:

 HTTP/1.1 200 OK

{"id":"4DB006E2-BA49-EB11-8100-00155D081D0B","taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","key":"key","value":"value","order":1}
Remove the Taskbot Webhook Header

DELETE bot/taskbotWebhookHeaders/{id}

Parameters:
No Parameters
Response:

No Content

Example

Sample Request:

curl https://api15.comm100.io/v4/bot/taskbotWebhookHeaders/4DB006E2-BA49-EB11-8100-00155D081D0B \
-X 'DELETE' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 204 No Content

Model
Taskbot Webhook Response To Variable JSON Format

Taskbot Webhook Response To Variable is represented as simple flat JSON objects with the following keys:

Name Type Description
id guid Id of the item.
taskbotActionId guid Id of current taskbotAction.
variableName string Name of the variable.
responseKey string Key of the response.
order integer Must be greater than or equal to 0.
Endpoint
Get the list of Taskbot Webhook Response To Variables

GET bot/taskbotWebhookResponseToVariables

Parameters:
No Parameters
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/bot/taskbotWebhookResponseToVariables \
-X 'GET' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

[{"id":"D4C7158C-644A-EB11-8100-00155D081D0B","taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","variableName":"name","responseKey":"text","order":1}]
Get a single Taskbot Webhook Response To Variable

GET bot/taskbotWebhookResponseToVariables/{id}

Parameters:
No Parameters
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/bot/taskbotWebhookResponseToVariables/D4C7158C-644A-EB11-8100-00155D081D0B \
-X 'GET' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

{"id":"D4C7158C-644A-EB11-8100-00155D081D0B","taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","variableName":"name","responseKey":"text","order":1}
Create a new Taskbot Webhook Response To Variable

POST bot/taskbotWebhookResponseToVariables

Parameters:
Name Type In Required Description
taskbotActionId guid body yes Id of current taskbotAction.
variableName string body no Name of the variable.
responseKey string body no Key of the response.
order integer body no Must be greater than or equal to 0.
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/bot/taskbotWebhookResponseToVariables \
-X 'POST' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
-D '{"taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","variableName":"name","responseKey":"text","order":1}'

Response:

 HTTP/1.1 201 Created

{"id":"D4C7158C-644A-EB11-8100-00155D081D0B","taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","variableName":"name","responseKey":"text","order":1}
Update the Taskbot Webhook Response To Variable

PUT bot/taskbotWebhookResponseToVariables/{id}

Parameters:
Name Type In Required Description
taskbotActionId guid body yes Id of current taskbotAction.
variableName string body no Name of the variable.
responseKey string body no Key of the response.
order integer body no Must be greater than or equal to 0.
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/bot/taskbotWebhookResponseToVariables/D4C7158C-644A-EB11-8100-00155D081D0B \
-X 'PUT' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
-D '{"taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","variableName":"name","responseKey":"text","order":1}'

Response:

 HTTP/1.1 200 OK

{"id":"D4C7158C-644A-EB11-8100-00155D081D0B","taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","variableName":"name","responseKey":"text","order":1}
Remove the Taskbot Webhook Response To Variable

DELETE bot/taskbotWebhookResponseToVariables/{id}

Parameters:
No Parameters
Response:

No Content

Example

Sample Request:

curl https://api15.comm100.io/v4/bot/taskbotWebhookResponseToVariables/D4C7158C-644A-EB11-8100-00155D081D0B \
-X 'DELETE' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 204 No Content

Model
Taskbot Webhook Response Code To Action JSON Format

Taskbot Webhook Response Code To Action is represented as simple flat JSON objects with the following keys:

Name Type Description
id guid Id of the item.
taskbotActionId guid Id of the current taskbot action.
responseCode string Code of the response.
nextActionId guid Id of the next taskbot action.
order integer Must be greater than or equal to 0.
Endpoint
Get the list of Taskbot Webhook Response Code To Actions

GET bot/taskbotWebhookResponseCodeToActions

Parameters:
No Parameters
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/bot/taskbotWebhookResponseCodeToActions \
-X 'GET' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

[{"id":"4DB006E2-BA49-EB11-8100-00155D081D0B","taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","responseCode":"","nextActionId":"5AB006E2-BA49-EB11-8100-00155D081D0B","order":1}]
Get a single Taskbot Webhook Response Code To Action

GET bot/taskbotWebhookResponseCodeToActions/{id}

Parameters:
No Parameters
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/bot/taskbotWebhookResponseCodeToActions/4DB006E2-BA49-EB11-8100-00155D081D0B \
-X 'GET' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

{"id":"4DB006E2-BA49-EB11-8100-00155D081D0B","taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","responseCode":"","nextActionId":"5AB006E2-BA49-EB11-8100-00155D081D0B","order":1}
Create a new Taskbot Webhook Response Code To Action

POST bot/taskbotWebhookResponseCodeToActions

Parameters:
Name Type In Required Description
taskbotActionId guid body yes Id of the current taskbot action.
responseCode string body no Code of the response.
nextActionId guid body no Id of the next taskbot action.
order integer body no Must be greater than or equal to 0.
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/bot/taskbotWebhookResponseCodeToActions \
-X 'POST' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
-D '{"taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","responseCode":"","nextActionId":"5AB006E2-BA49-EB11-8100-00155D081D0B","order":1}'

Response:

 HTTP/1.1 201 Created

{"id":"4DB006E2-BA49-EB11-8100-00155D081D0B","taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","responseCode":"","nextActionId":"5AB006E2-BA49-EB11-8100-00155D081D0B","order":1}
Update the Taskbot Webhook Response Code To Action

PUT bot/taskbotWebhookResponseCodeToActions/{id}

Parameters:
Name Type In Required Description
taskbotActionId guid body yes Id of the current taskbot action.
responseCode string body no Code of the response.
nextActionId guid body no Id of the next taskbot action.
order integer body no Must be greater than or equal to 0.
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/bot/taskbotWebhookResponseCodeToActions/4DB006E2-BA49-EB11-8100-00155D081D0B \
-X 'PUT' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
-D '{"taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","responseCode":"","nextActionId":"5AB006E2-BA49-EB11-8100-00155D081D0B","order":1}'

Response:

 HTTP/1.1 200 OK

{"id":"4DB006E2-BA49-EB11-8100-00155D081D0B","taskbotActionId":"D6C7158C-644A-EB11-8100-00155D081D0B","responseCode":"","nextActionId":"5AB006E2-BA49-EB11-8100-00155D081D0B","order":1}
Remove the Taskbot Webhook Response Code To Action

DELETE bot/taskbotWebhookResponseCodeToActions/{id}

Parameters:
No Parameters
Response:

No Content

Example

Sample Request:

curl https://api15.comm100.io/v4/bot/taskbotWebhookResponseCodeToActions/4DB006E2-BA49-EB11-8100-00155D081D0B \
-X 'DELETE' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 204 No Content