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
Global_Loginipallowlist

You need Manage Security permission to manage login ip allowlist.

Allowed IP List
- Allowed IP List Manage
GET global/loginIpAllowlists
- Get the list of Allowed IP List
GET global/loginIpAllowlists/{id}
- Get a single Global_Loginipallowlist
POST global/loginIpAllowlists
- Create a new Global_Loginipallowlist
PUT global/loginIpAllowlists/{id}
- Update the Global_Loginipallowlist
DELETE global/loginIpAllowlists/{id}
- Remove the Global_Loginipallowlist
Model
Global_Loginipallowlist JSON Format

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

Name Type Description
ipRangeFrom string Where an IP range starts.
ipRangeTo string Where an IP range ends.
id guid Id of the login IP allowlist.
Endpoint
Get the list of Allowed IP List

GET global/loginIpAllowlists

Parameters:
No Parameters
Response:

An array of   Global_Loginipallowlist

Example

Sample Request:

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

Response:

 HTTP/1.1 200 OK

[{"ipRangeFrom":"192.168.0.1","ipRangeTo":"192.168.0.100","id":"e7893633-cea6-4d1b-be66-f65cb5dc1726"}]
Get a single Global_Loginipallowlist

GET global/loginIpAllowlists/{id}

Parameters:
No Parameters
Response:

Global_Loginipallowlist

Example

Sample Request:

curl https://api15.comm100.io/v4/global/loginIpAllowlists/e7893633-cea6-4d1b-be66-f65cb5dc1726 \
-X 'GET' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

{"ipRangeFrom":"192.168.0.1","ipRangeTo":"192.168.0.100","id":"e7893633-cea6-4d1b-be66-f65cb5dc1726"}
Create a new Global_Loginipallowlist

POST global/loginIpAllowlists

Parameters:
Name Type In Required Description
ipRangeFrom string body yes Where an IP range starts.
ipRangeTo string body yes Where an IP range ends.
Response:

Global_Loginipallowlist

Example

Sample Request:

curl https://api15.comm100.io/v4/global/loginIpAllowlists \
-X 'POST' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
-D '{"ipRangeFrom":"192.168.0.1","ipRangeTo":"192.168.0.100"}'

Response:

 HTTP/1.1 201 Created

{"ipRangeFrom":"192.168.0.1","ipRangeTo":"192.168.0.100","id":"e7893633-cea6-4d1b-be66-f65cb5dc1726"}
Update the Global_Loginipallowlist

PUT global/loginIpAllowlists/{id}

Parameters:
Name Type In Required Description
ipRangeFrom string body yes Where an IP range starts.
ipRangeTo string body yes Where an IP range ends.
Response:

Global_Loginipallowlist

Example

Sample Request:

curl https://api15.comm100.io/v4/global/loginIpAllowlists/e7893633-cea6-4d1b-be66-f65cb5dc1726 \
-X 'PUT' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
-D '{"ipRangeFrom":"192.168.0.1","ipRangeTo":"192.168.0.100"}'

Response:

 HTTP/1.1 200 OK

{"ipRangeFrom":"192.168.0.1","ipRangeTo":"192.168.0.100","id":"e7893633-cea6-4d1b-be66-f65cb5dc1726"}
Remove the Global_Loginipallowlist

DELETE global/loginIpAllowlists/{id}

Parameters:
No Parameters
Response:

No Content

Example

Sample Request:

curl https://api15.comm100.io/v4/global/loginIpAllowlists/e7893633-cea6-4d1b-be66-f65cb5dc1726 \
-X 'DELETE' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 204 No Content

© 2021 | Comm100