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
Role Config

You need the Manage Agent & Agent Roles permission to manage role configs.

Role Configs
- Role Configs Manage
GET global/roleConfig
- Get a single Role Config
POST global/roleConfig:disable
- Disable the Role Config
POST global/roleConfig:enable
- Enable the Role Config
PUT global/roleConfig
- Update the Role Config
Model
Role Config JSON Format

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

Name Type Description
isEnabled bool Whether Role is enabled or not.
Endpoint
Get a single Role Config

GET global/roleConfig

Parameters:
No Parameters
Response:

Role Config

Example

Sample Request:

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

Response:

 HTTP/1.1 200 OK

{"isEnabled":true}
Disable the Role Config

POST global/roleConfig:disable

Parameters:
No Parameters
Response:

Role Config

Example

Sample Request:

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

Response:

 HTTP/1.1 200 OK

{"isEnabled":false}
Enable the Role Config

POST global/roleConfig:enable

Parameters:
No Parameters
Response:

Role Config

Example

Sample Request:

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

Response:

 HTTP/1.1 200 OK

{"isEnabled":true}
Update the Role Config

PUT global/roleConfig

Parameters:
Name Type In Required Description
isEnabled bool body no Whether Role is enabled or not.
Response:

Role Config

Example

Sample Request:

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

Response:

 HTTP/1.1 200 OK

{"isEnabled":true}
© 2021 | Comm100