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
Custom Variable

You need the Manage Custom Variables to manage Custom Variables.

Custom Variables
- Custom Variables Manage
GET livechat/customVariables
- Get the list of Custom Variables
GET livechat/customVariables/{id}
- Get a single Custom Variable
POST livechat/customVariables
- Create a new Custom Variable
PUT livechat/customVariables/{id}
- Update the Custom Variable
DELETE livechat/customVariables/{id}
- Remove the Custom Variable
Model
Custom Variable JSON Format

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

Name Type Description
id guid Id of the custom variable.
name string Name of the custom variable.
value string Value of the custom variable.
hyperlink string Hyperlink of the custom variable.
type string Allowed values are "text", "integer", "decimal".
Endpoint
Get the list of Custom Variables

GET livechat/customVariables

Parameters:
No Parameters
Response:

An array of   Custom Variable

Example

Sample Request:

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

Response:

 HTTP/1.1 200 OK

[{"id":"6BB15329-7C46-EB11-8100-00155D081D0B","name":"c_v_name","value":"c_v_value","hyperlink":"{!Visitor.IP}","type":"text"}]
Get a single Custom Variable

GET livechat/customVariables/{id}

Parameters:
No Parameters
Response:

Custom Variable

Example

Sample Request:

curl https://api11.comm100.io/v4/livechat/customVariables/6BB15329-7C46-EB11-8100-00155D081D0B \
-X 'GET' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

{"id":"6BB15329-7C46-EB11-8100-00155D081D0B","name":"c_v_name","value":"c_v_value","hyperlink":"{!Visitor.IP}","type":"text"}
Create a new Custom Variable

POST livechat/customVariables

Parameters:
Name Type In Required Description
name string body yes Name of the custom variable.
value string body no Value of the custom variable.
hyperlink string body no Hyperlink of the custom variable.
type string body yes Allowed values are "text", "integer", "decimal".
Response:

Custom Variable

Example

Sample Request:

curl https://api11.comm100.io/v4/livechat/customVariables \
-X 'POST' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
-D '{"name":"c_v_name","value":"c_v_value","hyperlink":"{!Visitor.IP}","type":"text"}'

Response:

 HTTP/1.1 201 Created

{"id":"6BB15329-7C46-EB11-8100-00155D081D0B","name":"c_v_name","value":"c_v_value","hyperlink":"{!Visitor.IP}","type":"text"}
Update the Custom Variable

PUT livechat/customVariables/{id}

Parameters:
Name Type In Required Description
name string body yes Name of the custom variable.
value string body no Value of the custom variable.
hyperlink string body no Hyperlink of the custom variable.
type string body yes Allowed values are "text", "integer", "decimal".
Response:

Custom Variable

Example

Sample Request:

curl https://api11.comm100.io/v4/livechat/customVariables/6BB15329-7C46-EB11-8100-00155D081D0B \
-X 'PUT' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
-D '{"name":"c_v_name","value":"c_v_value","hyperlink":"{!Visitor.IP}","type":"text"}'

Response:

 HTTP/1.1 200 OK

{"id":"6BB15329-7C46-EB11-8100-00155D081D0B","name":"c_v_name","value":"c_v_value","hyperlink":"{!Visitor.IP}","type":"text"}
Remove the Custom Variable

DELETE livechat/customVariables/{id}

Parameters:
No Parameters
Response:

No Content

Example

Sample Request:

curl https://api11.comm100.io/v4/livechat/customVariables/6BB15329-7C46-EB11-8100-00155D081D0B \
-X 'DELETE' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 204 No Content

© 2021 | Comm100