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
Permission

Permissions
- Permissions Manage
GET global/agents/{agentId}/permissions
- Get agent Permissions
GET global/agents/{roleId}/permissions
- Get role Permissions
GET global/permissions
- Get the list of Permissions
GET global/permissions/{id}
- Get a single Permission
PUT global/agents/{agentId}/permissions
- Update agent Permissions
PUT global/roles/{roleId}/permissions
- Update role Permissions
Model
Permission JSON Format

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

Name Type Description
id integer Id of the permission.
moduleId string Id of the module.
name string Name of the permission.
description string Description of the permission.
order integer Order of the permission.
isEnabledForAgentByDefault bool Whether the permission is enabled for agent by default or not.
parentId integer Parent of the permission.
Endpoint
Get agent Permissions

GET global/agents/{agentId}/permissions

Parameters:

No Parameters
Response:

Name Type Description
permissionIds array The list of permission id.
Example

Sample Request:

curl https://api15.comm100.io/v4/global/agents/edd568c2-9e9f-416c-b98b-17fb03c1ee52/permissions \
-X 'GET' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

{"permissionIds": [1,2]}
Get role Permissions

GET global/agents/{roleId}/permissions

Parameters:

No Parameters
Response:

Name Type Description
permissionIds array The list of permission id.
Example

Sample Request:

curl https://api15.comm100.io/v4/global/roles/edd568c2-9e9f-416c-b98b-17fb03c1ee52/permissions \
-X 'GET' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

{"permissionIds": [1,2]}
Get the list of Permissions

GET global/permissions

Parameters:

No Parameters
Response:

An array of   Permission

Example

Sample Request:

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

Response:

 HTTP/1.1 200 OK

[ { "id": 1, "moduleId": "Global", "name": "Manage My Profile", "description": "• Edit My Profile", "order": 0, "isEnabledForAgentByDefault": false, "parentId": 0 } ]
Get a single Permission

GET global/permissions/{id}

Parameters:

No Parameters
Response:

Permission

Example

Sample Request:

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

Response:

 HTTP/1.1 200 OK

{ "id": 1, "moduleId": "Global", "name": "Manage My Profile", "description": "• Edit My Profile", "order": 0, "isEnabledForAgentByDefault": false, "parentId": 0 }
Update agent Permissions

PUT global/agents/{agentId}/permissions

Parameters:

Name Type In Required Description
permissionIds array body yes The list of permission id
Response:

Name Type Description
permissionIds array The list of permission id.
Example

Sample Request:

curl https://api15.comm100.io/v4/global/agents/edd568c2-9e9f-416c-b98b-17fb03c1ee52/permissions \
-X 'PUT' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
-D '{"permissionIds": [1,2]}'

Response:

 HTTP/1.1 200 OK

{"permissionIds": [1,2]}
Update role Permissions

PUT global/roles/{roleId}/permissions

Parameters:

Name Type In Required Description
permissionIds array body yes The list of permission id
Response:

Name Type Description
permissionIds array The list of permission id.
Example

Sample Request:

curl https://api15.comm100.io/v4/global/roles/edd568c2-9e9f-416c-b98b-17fb03c1ee52/permissions \
-X 'PUT' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
-D '{"permissionIds": [1,2]}'

Response:

 HTTP/1.1 200 OK

{"permissionIds": [1,2]}
© 2021 | Comm100