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
Level2Menu_AgentAssist

[Label]
- [Label] Manage
GET bot/agentAssist
- Get a single Level2Menu_AgentAssist
POST bot/agentAssist:disable
- Disable the Level2Menu_AgentAssist
POST bot/agentAssist:enable
- Enable the Level2Menu_AgentAssist
PUT bot/agentAssist
- Update the Level2Menu_AgentAssist
Model
Level2Menu_AgentAssist JSON Format

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

Name Type Description
isEnabled bool Whether provide different answer suggestions to agents or not.
languageId string Language options: en, zh-CN, zh-TW.
isCannedMessageIncluded bool Whether canned message is an answer source for the agent assist or not. When true, there will be a new option called "Similar questions" under each public canned message. Default: true.
isKnowledgeBaseIncluded bool Whether knowledge base is an answer source for the agent assist or not. When true, there will be a new option called "Similar questions" under each knowledge base article. Default: false.
isChatbotIncluded bool Whether bot is an answer source for the Agent Assist or not. When true, agent assist will provide agents with the answers pulled from the selected bot intents. Default: false.
highConfidenceScore integer Agent Assist will display suggestions only when the score of the suggested item is higher than this value. Value is beteween 1 and 100. Default: 40.
maximumSuggestionNumber integer The maximum number of suggestions Agent Assist can provide. Available value: 1, 2, 3, 4, 5. Default: 3.
ifAutoAddVisitorQuestionAsSimilarQuestionWhenSelected bool Whether enriching Canned Message and KB article similar questions with Agent Assist suggestions or not.
ifAutoAddUnrecognizedQuestionsToLearning bool Whether adding unrecognized visitor questions to Agent Assist Learning section automatically or not.
textBeforeKBArticle string Texts displayed before the suggested knowledge base article link
chatbotIds array The list of chatbot that agent assist select.
knowledgeBaseIds array List of knowledge bases selected as the agent assist answer source.
Endpoint
Get a single Level2Menu_AgentAssist

GET bot/agentAssist

Parameters:
Name Type In Required Description
include string query no Allowed values are "chatbot", "knowledgeBase".
Response:

Level2Menu_AgentAssist

Example

Sample Request:

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

Response:

 HTTP/1.1 200 OK

{"isEnabled":true,"languageId":"en","isCannedMessageIncluded":true,"isKnowledgeBaseIncluded":true,"isChatbotIncluded":true,"highConfidenceScore":40,"maximumSuggestionNumber":3,"ifAutoAddVisitorQuestionAsSimilarQuestionWhenSelected":true,"ifAutoAddUnrecognizedQuestionsToLearning":true,"textBeforeKBArticle":"Please refer to the Knowledge Base article ","chatbotIds":["56A2EF45-7D46-EB11-8100-00155D081D0B"],"knowledgeBaseIds":["4eA2EF45-7D46-EB11-8100-00155D081D0B"]}
Disable the Level2Menu_AgentAssist

POST bot/agentAssist:disable

Parameters:
No Parameters
Response:

Level2Menu_AgentAssist

Example

Sample Request:

curl https://api11.comm100.io/v4/bot/agentAssist:disable \
-X 'POST' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

{"isEnabled":false,"languageId":"en","isCannedMessageIncluded":true,"isKnowledgeBaseIncluded":true,"isChatbotIncluded":true,"highConfidenceScore":40,"maximumSuggestionNumber":3,"ifAutoAddVisitorQuestionAsSimilarQuestionWhenSelected":true,"ifAutoAddUnrecognizedQuestionsToLearning":true,"textBeforeKBArticle":"Please refer to the Knowledge Base article ","chatbotIds":["56A2EF45-7D46-EB11-8100-00155D081D0B"],"knowledgeBaseIds":["4eA2EF45-7D46-EB11-8100-00155D081D0B"]}
Enable the Level2Menu_AgentAssist

POST bot/agentAssist:enable

Parameters:
No Parameters
Response:

Level2Menu_AgentAssist

Example

Sample Request:

curl https://api11.comm100.io/v4/bot/agentAssist:enable \
-X 'POST' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

{"isEnabled":true,"languageId":"en","isCannedMessageIncluded":true,"isKnowledgeBaseIncluded":true,"isChatbotIncluded":true,"highConfidenceScore":40,"maximumSuggestionNumber":3,"ifAutoAddVisitorQuestionAsSimilarQuestionWhenSelected":true,"ifAutoAddUnrecognizedQuestionsToLearning":true,"textBeforeKBArticle":"Please refer to the Knowledge Base article ","chatbotIds":["56A2EF45-7D46-EB11-8100-00155D081D0B"],"knowledgeBaseIds":["4eA2EF45-7D46-EB11-8100-00155D081D0B"]}
Update the Level2Menu_AgentAssist

PUT bot/agentAssist

Parameters:
Name Type In Required Description
isEnabled bool body yes Whether provide different answer suggestions to agents or not.
languageId string body yes Language options: en, zh-CN, zh-TW.
isCannedMessageIncluded bool body no Whether canned message is an answer source for the agent assist or not. When true, there will be a new option called "Similar questions" under each public canned message. Default: true.
isKnowledgeBaseIncluded bool body no Whether knowledge base is an answer source for the agent assist or not. When true, there will be a new option called "Similar questions" under each knowledge base article. Default: false.
isChatbotIncluded bool body no Whether bot is an answer source for the Agent Assist or not. When true, agent assist will provide agents with the answers pulled from the selected bot intents. Default: false.
highConfidenceScore integer body no Agent Assist will display suggestions only when the score of the suggested item is higher than this value. Value is beteween 1 and 100. Default: 40.
maximumSuggestionNumber integer body no The maximum number of suggestions Agent Assist can provide. Available value: 1, 2, 3, 4, 5. Default: 3.
ifAutoAddVisitorQuestionAsSimilarQuestionWhenSelected bool body no Whether enriching Canned Message and KB article similar questions with Agent Assist suggestions or not.
ifAutoAddUnrecognizedQuestionsToLearning bool body no Whether adding unrecognized visitor questions to Agent Assist Learning section automatically or not.
textBeforeKBArticle string body no Texts displayed before the suggested knowledge base article link
chatbotIds array body no The list of chatbot that agent assist select.
knowledgeBaseIds array body no List of knowledge bases selected as the agent assist answer source.
Response:

Level2Menu_AgentAssist

Example

Sample Request:

curl https://api11.comm100.io/v4/bot/agentAssist \
-X 'PUT' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
-D '{"isEnabled":true,"languageId":"en","isCannedMessageIncluded":true,"isKnowledgeBaseIncluded":true,"isChatbotIncluded":true,"highConfidenceScore":40,"maximumSuggestionNumber":3,"ifAutoAddVisitorQuestionAsSimilarQuestionWhenSelected":true,"ifAutoAddUnrecognizedQuestionsToLearning":true,"textBeforeKBArticle":"Please refer to the Knowledge Base article "}'

Response:

 HTTP/1.1 200 OK

{"isEnabled":true,"languageId":"en","isCannedMessageIncluded":true,"isKnowledgeBaseIncluded":true,"isChatbotIncluded":true,"highConfidenceScore":40,"maximumSuggestionNumber":3,"ifAutoAddVisitorQuestionAsSimilarQuestionWhenSelected":true,"ifAutoAddUnrecognizedQuestionsToLearning":true,"textBeforeKBArticle":"Please refer to the Knowledge Base article ","chatbotIds":["56A2EF45-7D46-EB11-8100-00155D081D0B"],"knowledgeBaseIds":["4eA2EF45-7D46-EB11-8100-00155D081D0B"]}
© 2021 | Comm100