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
Restricted Words Config

Restricted Words
- Restricted Words Manage
GET global/restrictedWordsConfig
- Get a single Restricted Words Config
POST global/restrictedWordsConfig:disable
- Disable the Restricted Words Config
POST global/restrictedWordsConfig:enable
- Enable the Restricted Words Config
PUT global/restrictedWordsConfig
- Update the Restricted Words Config
Model
Restricted Words Config JSON Format

Restricted Words Config is represented as simple flat JSON objects with the following keys:

Name Type Description
siteId integer Id of the site.
isEnabled bool Whether Restricted Words is enabled or not.
restrictedWords string Words that agents are restricted to use.
restrictedWordsForVisitors string
Endpoint
Get a single Restricted Words Config

GET global/restrictedWordsConfig

Parameters:
No Parameters
Response:

Restricted Words Config

Example

Sample Request:

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

Response:

 HTTP/1.1 200 OK

{"siteId":10000,"isEnabled":true,"restrictedWords":"test","restrictedWordsForVisitors":""}
Disable the Restricted Words Config

POST global/restrictedWordsConfig:disable

Parameters:
No Parameters
Response:

Restricted Words Config

Example

Sample Request:

curl https://api15.comm100.io/v4/global/restrictedWordsConfig:disable \
-X 'POST' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

{"siteId":10000,"isEnabled":false,"restrictedWords":"test","restrictedWordsForVisitors":""}
Enable the Restricted Words Config

POST global/restrictedWordsConfig:enable

Parameters:
No Parameters
Response:

Restricted Words Config

Example

Sample Request:

curl https://api15.comm100.io/v4/global/restrictedWordsConfig:enable \
-X 'POST' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

{"siteId":10000,"isEnabled":true,"restrictedWords":"test","restrictedWordsForVisitors":""}
Update the Restricted Words Config

PUT global/restrictedWordsConfig

Parameters:
Name Type In Required Description
isEnabled bool body no Whether Restricted Words is enabled or not.
restrictedWords string body no Words that agents are restricted to use.
restrictedWordsForVisitors string body no
Response:

Restricted Words Config

Example

Sample Request:

curl https://api15.comm100.io/v4/global/restrictedWordsConfig \
-X 'PUT' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
-D '{"isEnabled":true,"restrictedWords":"test","restrictedWordsForVisitors":""}'

Response:

 HTTP/1.1 200 OK

{"siteId":10000,"isEnabled":true,"restrictedWords":"test","restrictedWordsForVisitors":""}
© 2021 | Comm100