COMM100 RESTFUL API
Introduction
LiveChat Agent Private Message Android Push Audio & Video Chat Auto Distribution Campaign Chat Custom Variable Custom Variable Config Dynamic Campaign Installation Integration Calendly IOS Push LiveChat_BannedIp LiveChat_BannedVisitor LiveChat_CampaignAutoInvitation LiveChat_ConversionAction LiveChat_Field LiveChat_Segment LiveChat_Shift LiveChat_Wrap-Up Field Offline Message SecureForm_Label Segment Config Shift Config Visitor History Visitor Single Sign-On (SSO) Webhook Wrapup Category Config Chat Server Real Time
Ticketing Agent Preference Auto Distribution Channel Channel App Channel Contact Identity Type Draft Event log Field Mapping Junk Message Note Operating Hours & Holidays Routing Config Tag Ticket Ticket Recycle Bin Ticketing_BlockedSender Ticketing_ChannelAccount Ticketing_Field Ticketing_Holiday Ticketing_SLAPolicy Ticketing_Trigger View
Bot Agent Assist Learning Question Bot_AgentAssistSynonym Bot_Chatbot Bot_ChatbotCannedQuickReply Bot_ChatbotEntity Bot_ChatbotIntentCategory Bot_ChatbotSmartTrigger Bot_Taskbot Chatbot Intent Chatbot Intent Answer Chatbot Intent Question Chatbot Learning Question Chatbot Message When A Visitor Start A Chat Chatbot Message When Not Helpful Chatbot Message When Providing Possible Answer Chatbot No Answer Message Level2Menu_AgentAssist Prebuilt Entity Taskbot Booked Calendly Meeting Taskbot Version
KB KnowledgeBase_Article KnowledgeBase_Category KnowledgeBase_CustomPage KnowledgeBase_Design KnowledgeBase_Image KnowledgeBase_KnowledgeBase KnowledgeBase_Tag Preview
Global Action Type Agent Agent Single Sign-On Config Audit Log Auto Translation Contact Contact identity Credit Card Masking Config Custom Agent Away Status Config Department Config Global_AgentAwayStatus Global_Loginipallowlist Global_PrivateCannedMessage Global_PrivateCannedMessageCategory Global_PublicCannedMessage Global_PublicCannedMessageCategory Global_Role Global_Skills LiveChat_Department Login IP Allowlist Config Module Password Policy Config Permission Restricted Words Config Role Config Site Profile SkillConfig System Avatar Visitor
Reporting Cube Report
Visitor Side JavaScript API Agent Console JavaScript API
Agent Assist Learning Question

Agent Assist Learning Questions
- Agent Assist Learning Questions Manage
GET bot/agentAssistLearningQuestions
- Get the list of Agent Assist Learning Questions
GET bot/agentAssistLearningQuestions/{id}
- Get a single Agent Assist Learning Question
POST bot/agentAssistLearningQuestions
- Create a new Agent Assist Learning Question
DELETE bot/agentAssistLearningQuestions/{id}
- Remove the Agent Assist Learning Question
Model
Agent Assist Learning Question JSON Format

Agent Assist Learning Question is represented as simple flat JSON objects with the following keys:

Name Type Description
id guid Id of the learning question.
chatId guid Id of the chat.
question string Questions for bot training.
agentResponse string Agent response for bot training.
suggestionType string Allowed values are "none", "publicCannedMessage", "KBArticle", "chatbotIntent".
score float Score of the suggestion.
createdTime datetime Time when the learning question was created.
publicCannedMessageId guid Id of the matched public canned message.
articleId guid Id of the matched KB article.
intentId guid Id of the matched intent in chatbot.
knowledgeBaseId guid Id of the matched KB.
chatbotId guid Id of the matched chatbot.
intent intent Reference to Chatbot Intent.
article article Reference to KnowledgeBase_Article.
publicCannedMessage publicCannedMessage Reference to Global_PublicCannedMessage.
Endpoint
Get the list of Agent Assist Learning Questions

GET bot/agentAssistLearningQuestions

Parameters:
Name Type In Required Description
question string query no Question for bot training.
dateRange dateTime query no Filter by date interval.
score float query no The score of suggestion.
include string query no Allowed values are "chatbotIntent", "article", "publicCannedMessage".
Response:

An array of   Agent Assist Learning Question

Example

Sample Request:

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

Response:

 HTTP/1.1 200 OK

{"agentAssistLearningQuestions":[{"id":"7dc75f7b-a82e-4048-9256-bb775a49bf35","chatId":"8c9b6c0c-f72e-4b56-b524-64f37be3d604","question":"I want to buy a clothes.","agentResponse":"What clothes you want to buy?","suggestionType":"chatbotIntent","score":60.0,"createdTime":"2021-04-09T09:30:26.553Z","publicCannedMessageId":"00000000-0000-0000-0000-000000000000","articleId":"00000000-0000-0000-0000-000000000000","intentId":"00000000-0000-0000-0000-000000000000","knowledgeBaseId":"00000000-0000-0000-0000-000000000000","chatbotId":"c2b618b1-9167-44c7-a399-a4974558fee8","intent":{"id":"54c51763-8241-40a7-bb61-95231a03bb86","name":"Thanks","chatbotIntentCategoryId":"3bfcf193-9939-4abd-a832-2625ea02e75b","chatbotIntentCategory":{"id":"ee705b05-33c0-43b6-ab4a-a138f28b6aa2","chatbotId":"e8bf0d25-eed6-4a46-a417-318e15019609","name":"fruit","order":1,"parentId":"3bfcf193-9939-4abd-a832-2625ea02e75b"}},"article":{"id":"4fc10466-3900-4d0d-89d8-635afb8a2c78","title":"Sample Article Title","body":" <p>\n? Setting up your knowledge base starts with creating articles. Building a repository of articles is simple by using our WYSIWYG editor. You can also organize your knowledge base articles by category and tag, so that they are easy to find and intuitive to use. Follow the steps below to start.\n? </p>\n? <h4 style=\"margin-bottom: 0px; margin-top: 40px;\">Step by Step Instructions</h4>\n? <ol style=\"margin-top: 0px;\">\n? <li style=\"margin-top: 10px;\">\n? <a href=\"https://www.comm100.com/secure/login.aspx\" target=\"_blank\">Log into</a> your Comm100 account.\n? </li>\n? <li>\n? Click <strong>Articles</strong> from the left menu list under the Knowledge Base product.\n? <p>\n? <img src=\"/kb/resources/images/kb-articles.png\" alt=\"knowledge base articles\" />\n? </p>\n? </li>\n? <li>\n? Click the <strong>New Article</strong> button on the page.\n? <p>\n? <img src=\"/kb/resources/images/new-article.png\" alt=\"New Article\" />\n? </p>\n? </li>\n? <li>\n? Input the article title and mark it as <strong>Featured</strong> when you see appropriate by clicking the <strong>Star</strong> icon in the <strong>Title</strong> box. (Featured articles appear above the non-featured ones on your knowledge base pages.)\n? <p>\n? <img src=\"/kb/resources/images/article-content.png\" alt=\"Article Content\" />\n? </p>\n? </li>\n? <li>\n? Draft your article content in our WYSIWYG HTML editor. If you have drafted the source code of the article elsewhere, you can click the <strong>Source Code</strong> icon at the end of the tool bar to simply paste the code in the editor.\n? </li>\n? <li>\n? Select a <strong>Category</strong> that the article should fall under, and assign <strong>Tags</strong> for the article.\n? <p>\n? <img src=\"/kb/resources/images/categorize-tag-publish.png\" alt=\"categorize tag and publish\" />\n? </p>\n? </li>\n? <li>\n? Click <strong>Preview</strong> to see how it looks like to your customers on your knowledge base.\n? </li>\n? <li>\n? Once the article is ready, change the article status to <strong>Published</strong>, and then hit <strong>Save</strong>.\n? <br />\n? <strong>Note:</strong> The default status of every article is <strong>Draft</strong>. To make an article visible on your knowledge base, you need to change its status to <strong>Published</strong>.\n? </li>\n? </ol>\n? <p>Now that the article has been published, your customers can view, and leave helpful or not helpful ratings if you allow them to do so. </p>","customUrl":"can-i-customize-the-look-of-my-knowledge-base","categoryId":"8a21934a-7def-4064-a211-3cc5295282f9","isFeatured":false,"status":"published","views":0,"createdById":"21b5d834-b98b-48ba-ae45-0d1316cb382f","createdTime":"2021-04-09T10:38:47.237Z","modifiedById":"21b5d834-b98b-48ba-ae45-0d1316cb382f","modifiedTime":"2021-04-09T10:38:47.237Z","similarQuestions":["null"],"tagIds":["e824f542-0187-4aac-a329-9263d6090fe9"],"helpful":5,"notHelpful":1},"publicCannedMessage":{"id":"7ea02303-959b-eb11-8103-00155d081d0b","categoryId":"79a02303-959b-eb11-8103-00155d081d0b","name":"thanks","message":"thanks","htmlMessage":"<p>thanks</p>","textMessage":"thanks","shortcuts":"thx","similarQuestions":["are you ok?"]}}],"nextPage":null,"previousPage":null,"total":1}
Get a single Agent Assist Learning Question

GET bot/agentAssistLearningQuestions/{id}

Parameters:
Name Type In Required Description
include string query no Allowed values are "chatbotIntent", "article", "publicCannedMessage".
Response:

Agent Assist Learning Question

Example

Sample Request:

curl https://api15.comm100.io/v4/bot/agentAssistLearningQuestions/7dc75f7b-a82e-4048-9256-bb775a49bf35 \
-X 'GET' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

{"id":"7dc75f7b-a82e-4048-9256-bb775a49bf35","chatId":"8c9b6c0c-f72e-4b56-b524-64f37be3d604","question":"I want to buy a clothes.","agentResponse":"What clothes you want to buy?","suggestionType":"chatbotIntent","score":60.0,"createdTime":"2021-04-09T09:30:26.553Z","publicCannedMessageId":"00000000-0000-0000-0000-000000000000","articleId":"00000000-0000-0000-0000-000000000000","intentId":"00000000-0000-0000-0000-000000000000","knowledgeBaseId":"00000000-0000-0000-0000-000000000000","chatbotId":"c2b618b1-9167-44c7-a399-a4974558fee8","intent":{"id":"54c51763-8241-40a7-bb61-95231a03bb86","name":"Thanks","chatbotIntentCategoryId":"3bfcf193-9939-4abd-a832-2625ea02e75b","chatbotIntentCategory":{"id":"ee705b05-33c0-43b6-ab4a-a138f28b6aa2","chatbotId":"e8bf0d25-eed6-4a46-a417-318e15019609","name":"fruit","order":1,"parentId":"3bfcf193-9939-4abd-a832-2625ea02e75b"}},"article":{"id":"4fc10466-3900-4d0d-89d8-635afb8a2c78","title":"Sample Article Title","body":" <p>\n? Setting up your knowledge base starts with creating articles. Building a repository of articles is simple by using our WYSIWYG editor. You can also organize your knowledge base articles by category and tag, so that they are easy to find and intuitive to use. Follow the steps below to start.\n? </p>\n? <h4 style=\"margin-bottom: 0px; margin-top: 40px;\">Step by Step Instructions</h4>\n? <ol style=\"margin-top: 0px;\">\n? <li style=\"margin-top: 10px;\">\n? <a href=\"https://www.comm100.com/secure/login.aspx\" target=\"_blank\">Log into</a> your Comm100 account.\n? </li>\n? <li>\n? Click <strong>Articles</strong> from the left menu list under the Knowledge Base product.\n? <p>\n? <img src=\"/kb/resources/images/kb-articles.png\" alt=\"knowledge base articles\" />\n? </p>\n? </li>\n? <li>\n? Click the <strong>New Article</strong> button on the page.\n? <p>\n? <img src=\"/kb/resources/images/new-article.png\" alt=\"New Article\" />\n? </p>\n? </li>\n? <li>\n? Input the article title and mark it as <strong>Featured</strong> when you see appropriate by clicking the <strong>Star</strong> icon in the <strong>Title</strong> box. (Featured articles appear above the non-featured ones on your knowledge base pages.)\n? <p>\n? <img src=\"/kb/resources/images/article-content.png\" alt=\"Article Content\" />\n? </p>\n? </li>\n? <li>\n? Draft your article content in our WYSIWYG HTML editor. If you have drafted the source code of the article elsewhere, you can click the <strong>Source Code</strong> icon at the end of the tool bar to simply paste the code in the editor.\n? </li>\n? <li>\n? Select a <strong>Category</strong> that the article should fall under, and assign <strong>Tags</strong> for the article.\n? <p>\n? <img src=\"/kb/resources/images/categorize-tag-publish.png\" alt=\"categorize tag and publish\" />\n? </p>\n? </li>\n? <li>\n? Click <strong>Preview</strong> to see how it looks like to your customers on your knowledge base.\n? </li>\n? <li>\n? Once the article is ready, change the article status to <strong>Published</strong>, and then hit <strong>Save</strong>.\n? <br />\n? <strong>Note:</strong> The default status of every article is <strong>Draft</strong>. To make an article visible on your knowledge base, you need to change its status to <strong>Published</strong>.\n? </li>\n? </ol>\n? <p>Now that the article has been published, your customers can view, and leave helpful or not helpful ratings if you allow them to do so. </p>","customUrl":"can-i-customize-the-look-of-my-knowledge-base","categoryId":"8a21934a-7def-4064-a211-3cc5295282f9","isFeatured":false,"status":"published","views":0,"createdById":"21b5d834-b98b-48ba-ae45-0d1316cb382f","createdTime":"2021-04-09T10:38:47.237Z","modifiedById":"21b5d834-b98b-48ba-ae45-0d1316cb382f","modifiedTime":"2021-04-09T10:38:47.237Z","similarQuestions":["null"],"tagIds":["e824f542-0187-4aac-a329-9263d6090fe9"],"helpful":5,"notHelpful":1},"publicCannedMessage":{"id":"7ea02303-959b-eb11-8103-00155d081d0b","categoryId":"79a02303-959b-eb11-8103-00155d081d0b","name":"thanks","message":"thanks","htmlMessage":"<p>thanks</p>","textMessage":"thanks","shortcuts":"thx","similarQuestions":["are you ok?"]}}
Create a new Agent Assist Learning Question

POST bot/agentAssistLearningQuestions

Parameters:
Name Type In Required Description
chatId guid body no Id of the chat.
question string body no Questions for bot training.
agentResponse string body no Agent response for bot training.
suggestionType string body yes Allowed values are "none", "publicCannedMessage", "KBArticle", "chatbotIntent".
score float body yes Score of the suggestion.
createdTime datetime body no Time when the learning question was created.
publicCannedMessageId guid body no Id of the matched public canned message.
articleId guid body no Id of the matched KB article.
intentId guid body no Id of the matched intent in chatbot.
knowledgeBaseId guid body no Id of the matched KB.
chatbotId guid body no Id of the matched chatbot.
Response:

Agent Assist Learning Question

Example

Sample Request:

curl https://api15.comm100.io/v4/bot/agentAssistLearningQuestions \
-X 'POST' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
-D '{"chatId":"8c9b6c0c-f72e-4b56-b524-64f37be3d604","question":"I want to buy a clothes.","agentResponse":"What clothes you want to buy?","suggestionType":"chatbotIntent","score":60.0,"createdTime":"2021-04-09T09:30:26.553Z","publicCannedMessageId":"00000000-0000-0000-0000-000000000000","articleId":"00000000-0000-0000-0000-000000000000","intentId":"00000000-0000-0000-0000-000000000000","knowledgeBaseId":"00000000-0000-0000-0000-000000000000","chatbotId":"c2b618b1-9167-44c7-a399-a4974558fee8"}'

Response:

 HTTP/1.1 201 Created

{"id":"7dc75f7b-a82e-4048-9256-bb775a49bf35","chatId":"8c9b6c0c-f72e-4b56-b524-64f37be3d604","question":"I want to buy a clothes.","agentResponse":"What clothes you want to buy?","suggestionType":"chatbotIntent","score":60.0,"createdTime":"2021-04-09T09:30:26.553Z","publicCannedMessageId":"00000000-0000-0000-0000-000000000000","articleId":"00000000-0000-0000-0000-000000000000","intentId":"00000000-0000-0000-0000-000000000000","knowledgeBaseId":"00000000-0000-0000-0000-000000000000","chatbotId":"c2b618b1-9167-44c7-a399-a4974558fee8","intent":{"id":"54c51763-8241-40a7-bb61-95231a03bb86","name":"Thanks","chatbotIntentCategoryId":"3bfcf193-9939-4abd-a832-2625ea02e75b","chatbotIntentCategory":{"id":"ee705b05-33c0-43b6-ab4a-a138f28b6aa2","chatbotId":"e8bf0d25-eed6-4a46-a417-318e15019609","name":"fruit","order":1,"parentId":"3bfcf193-9939-4abd-a832-2625ea02e75b"}},"article":{"id":"4fc10466-3900-4d0d-89d8-635afb8a2c78","title":"Sample Article Title","body":" <p>\n? Setting up your knowledge base starts with creating articles. Building a repository of articles is simple by using our WYSIWYG editor. You can also organize your knowledge base articles by category and tag, so that they are easy to find and intuitive to use. Follow the steps below to start.\n? </p>\n? <h4 style=\"margin-bottom: 0px; margin-top: 40px;\">Step by Step Instructions</h4>\n? <ol style=\"margin-top: 0px;\">\n? <li style=\"margin-top: 10px;\">\n? <a href=\"https://www.comm100.com/secure/login.aspx\" target=\"_blank\">Log into</a> your Comm100 account.\n? </li>\n? <li>\n? Click <strong>Articles</strong> from the left menu list under the Knowledge Base product.\n? <p>\n? <img src=\"/kb/resources/images/kb-articles.png\" alt=\"knowledge base articles\" />\n? </p>\n? </li>\n? <li>\n? Click the <strong>New Article</strong> button on the page.\n? <p>\n? <img src=\"/kb/resources/images/new-article.png\" alt=\"New Article\" />\n? </p>\n? </li>\n? <li>\n? Input the article title and mark it as <strong>Featured</strong> when you see appropriate by clicking the <strong>Star</strong> icon in the <strong>Title</strong> box. (Featured articles appear above the non-featured ones on your knowledge base pages.)\n? <p>\n? <img src=\"/kb/resources/images/article-content.png\" alt=\"Article Content\" />\n? </p>\n? </li>\n? <li>\n? Draft your article content in our WYSIWYG HTML editor. If you have drafted the source code of the article elsewhere, you can click the <strong>Source Code</strong> icon at the end of the tool bar to simply paste the code in the editor.\n? </li>\n? <li>\n? Select a <strong>Category</strong> that the article should fall under, and assign <strong>Tags</strong> for the article.\n? <p>\n? <img src=\"/kb/resources/images/categorize-tag-publish.png\" alt=\"categorize tag and publish\" />\n? </p>\n? </li>\n? <li>\n? Click <strong>Preview</strong> to see how it looks like to your customers on your knowledge base.\n? </li>\n? <li>\n? Once the article is ready, change the article status to <strong>Published</strong>, and then hit <strong>Save</strong>.\n? <br />\n? <strong>Note:</strong> The default status of every article is <strong>Draft</strong>. To make an article visible on your knowledge base, you need to change its status to <strong>Published</strong>.\n? </li>\n? </ol>\n? <p>Now that the article has been published, your customers can view, and leave helpful or not helpful ratings if you allow them to do so. </p>","customUrl":"can-i-customize-the-look-of-my-knowledge-base","categoryId":"8a21934a-7def-4064-a211-3cc5295282f9","isFeatured":false,"status":"published","views":0,"createdById":"21b5d834-b98b-48ba-ae45-0d1316cb382f","createdTime":"2021-04-09T10:38:47.237Z","modifiedById":"21b5d834-b98b-48ba-ae45-0d1316cb382f","modifiedTime":"2021-04-09T10:38:47.237Z","similarQuestions":["null"],"tagIds":["e824f542-0187-4aac-a329-9263d6090fe9"],"helpful":5,"notHelpful":1},"publicCannedMessage":{"id":"7ea02303-959b-eb11-8103-00155d081d0b","categoryId":"79a02303-959b-eb11-8103-00155d081d0b","name":"thanks","message":"thanks","htmlMessage":"<p>thanks</p>","textMessage":"thanks","shortcuts":"thx","similarQuestions":["are you ok?"]}}
Remove the Agent Assist Learning Question

DELETE bot/agentAssistLearningQuestions/{id}

Parameters:
No Parameters
Response:

No Content

Example

Sample Request:

curl https://api15.comm100.io/v4/bot/agentAssistLearningQuestions/7dc75f7b-a82e-4048-9256-bb775a49bf35 \
-X 'DELETE' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 204 No Content

© 2021 | Comm100