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
Wrapup Category Config

You need the Manage Campaigns permission to manage Wrapup Category Config.

Wrapup Category Configs
- Wrapup Category Configs Manage
GET livechat/wrapupCategoryConfig
- Get a single Wrapup Category Config
PUT livechat/wrapupCategoryConfig
- Update the Wrapup Category Config
Wrapup Category Groups
- Wrapup Category Groups Manage
GET livechat/wrapupCategoryGroups
- Get the list of Wrapup Category Groups
GET livechat/wrapupCategoryGroups/{id}
- Get a single Wrapup Category Group
PUT livechat/wrapupCategoryGroups/{id}
- Update the Wrapup Category Group
Wrapup Category Options
- Wrapup Category Options Manage
GET livechat/wrapupCategoryOptions
- Get the list of Wrapup Category Options
GET livechat/wrapupCategoryOptions/{id}
- Get a single Wrapup Category Option
Model
Wrapup Category Config JSON Format

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

Name Type Description
displayMode string The mode that how wrap-ups are shown in agent console. Allowed values are "basic", "advanced".
siteId integer Id of the site which the wrap-up ctegory belongs to.
Endpoint
Get a single Wrapup Category Config

GET livechat/wrapupCategoryConfig

Parameters:
No Parameters
Response:

Wrapup Category Config

Example

Sample Request:

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

Response:

 HTTP/1.1 200 OK

{"displayMode":"basic","siteId":1000000}
Update the Wrapup Category Config

PUT livechat/wrapupCategoryConfig

Parameters:
Name Type In Required Description
displayMode string body no The mode that how wrap-ups are shown in agent console. Allowed values are "basic", "advanced".
wrapupCategoryGroups wrapupCategoryGroups[] body no Reference to Wrapup Category Group.
Response:

Wrapup Category Config

Example

Sample Request:

curl https://api11.comm100.io/v4/livechat/wrapupCategoryConfig \
-X 'PUT' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
-D '{"displayMode":"basic","wrapupCategoryGroups":[{"name":"97D0D2AB-AF00-415D-9FEB-302386AC40FC","order":1,"createdTime":"2021-04-07T06:05:28.98Z","siteId":10000,"wrapupCategoryOptions":[{"name":"Group101","order":0,"siteId":10000}]}]}'

Response:

 HTTP/1.1 200 OK

{"displayMode":"basic","siteId":1000000}
Model
Wrapup Category Group JSON Format

Wrapup Category Group is represented as simple flat JSON objects with the following keys:

Name Type Description
id guid Id of the wrap-up category group.
name string Name of the wrap-up category group.
order integer Order of the wrap-up category group.
createdTime datetime Created time of the wrap-up category group.
siteId integer Id of the site which the wrap-up category group belongs to.
wrapupCategoryOptions wrapupCategoryOptions[] Reference to Wrapup Category Option.
Endpoint
Get the list of Wrapup Category Groups

GET livechat/wrapupCategoryGroups

Parameters:
Name Type In Required Description
include string query no Allowed value is "wrapupCategoryOption".
Response:

An array of   Wrapup Category Group

Example

Sample Request:

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

Response:

 HTTP/1.1 200 OK

[{"id":"1AEAE8BA-F91D-414F-8AB9-5992AF564EFD","name":"97D0D2AB-AF00-415D-9FEB-302386AC40FC","order":1,"createdTime":"2021-04-07T06:05:28.98Z","siteId":10000,"wrapupCategoryOptions":[{"id":"e9e1379a-c478-4659-b1c5-04d3da5efddf","name":"Group101","groupId":"1245e3e2-6d42-466d-97b8-80579b4b8c2e","order":0,"siteId":10000}]}]
Get a single Wrapup Category Group

GET livechat/wrapupCategoryGroups/{id}

Parameters:
Name Type In Required Description
include string query no Allowed value is "wrapupCategoryOption".
Response:

Wrapup Category Group

Example

Sample Request:

curl https://api11.comm100.io/v4/livechat/wrapupCategoryGroups/1AEAE8BA-F91D-414F-8AB9-5992AF564EFD \
-X 'GET' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

{"id":"1AEAE8BA-F91D-414F-8AB9-5992AF564EFD","name":"97D0D2AB-AF00-415D-9FEB-302386AC40FC","order":1,"createdTime":"2021-04-07T06:05:28.98Z","siteId":10000,"wrapupCategoryOptions":[{"id":"e9e1379a-c478-4659-b1c5-04d3da5efddf","name":"Group101","groupId":"1245e3e2-6d42-466d-97b8-80579b4b8c2e","order":0,"siteId":10000}]}
Update the Wrapup Category Group

PUT livechat/wrapupCategoryGroups/{id}

Parameters:
Name Type In Required Description
name string body no Name of the wrap-up category group.
order integer body no Order of the wrap-up category group.
siteId integer body no Id of the site which the wrap-up category group belongs to.
wrapupCategoryOptions wrapupCategoryOptions[] body no Reference to Wrapup Category Option.
Response:

Wrapup Category Group

Example

Sample Request:

curl https://api11.comm100.io/v4/livechat/wrapupCategoryGroups/1AEAE8BA-F91D-414F-8AB9-5992AF564EFD \
-X 'PUT' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
-D '{"name":"97D0D2AB-AF00-415D-9FEB-302386AC40FC","order":1,"siteId":10000,"wrapupCategoryOptions":[{"name":"Group101","order":0,"siteId":10000}]}'

Response:

 HTTP/1.1 200 OK

{"id":"1AEAE8BA-F91D-414F-8AB9-5992AF564EFD","name":"97D0D2AB-AF00-415D-9FEB-302386AC40FC","order":1,"createdTime":"2021-04-07T06:05:28.98Z","siteId":10000,"wrapupCategoryOptions":[{"id":"e9e1379a-c478-4659-b1c5-04d3da5efddf","name":"Group101","groupId":"1245e3e2-6d42-466d-97b8-80579b4b8c2e","order":0,"siteId":10000}]}
Model
Wrapup Category Option JSON Format

Wrapup Category Option is represented as simple flat JSON objects with the following keys:

Name Type Description
id guid Id of the wrap-up category option.
name string Name of the wrap-up category option.
groupId guid Id of the wrapup category group which the wrapup category option belongs to.
order integer Order of the wrapup category option.
siteId integer SiteId of the wrap-up category group which the wrapup category option belongs to.
Endpoint
Get the list of Wrapup Category Options

GET livechat/wrapupCategoryOptions

Parameters:
No Parameters
Response:

An array of   Wrapup Category Option

Example

Sample Request:

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

Response:

 HTTP/1.1 200 OK

[{"id":"e9e1379a-c478-4659-b1c5-04d3da5efddf","name":"Group101","groupId":"1245e3e2-6d42-466d-97b8-80579b4b8c2e","order":0,"siteId":10000}]
Get a single Wrapup Category Option

GET livechat/wrapupCategoryOptions/{id}

Parameters:
No Parameters
Response:

Wrapup Category Option

Example

Sample Request:

curl https://api11.comm100.io/v4/livechat/wrapupCategoryOptions/e9e1379a-c478-4659-b1c5-04d3da5efddf \
-X 'GET' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

{"id":"e9e1379a-c478-4659-b1c5-04d3da5efddf","name":"Group101","groupId":"1245e3e2-6d42-466d-97b8-80579b4b8c2e","order":0,"siteId":10000}
© 2021 | Comm100