LiveChat_BannedIp
You need the Manage Ban List permission to manage Banned Ip.
LiveChat_BannedIps
- LiveChat_BannedIps Manage
GET livechat/bannedIps
GET livechat/bannedIps/{id}
POST livechat/bannedIps
PUT livechat/bannedIps/{id}
DELETE livechat/bannedIps/{id}
Model
LiveChat_BannedIp JSON Format
LiveChat_BannedIp is represented as simple flat JSON objects with the following keys:
Name | Type | Description |
---|---|---|
id |
guid | Id of the banned IP. |
ipRangeFrom |
string | Beginning of the banned IP range. |
ipRangeTo |
string | End of the banned IP range. |
comment |
string | Comment of the banned IP. |
lastUpdatedTime |
timestamp | Last updated time of the banned IP. |
createdTime |
datetime | Created time of the ban. |
agentId |
guid | Id of the agent. |
Endpoint
Get the list of LiveChat_BannedIps
GET livechat/bannedIps
Parameters:
Name | Type | In | Required | Description |
---|---|---|---|---|
include |
string | query | no | Allowed value is "agent". |
Response:
An array of LiveChat_BannedIp
Example
Sample Request:
curl https://api15.comm100.io/v4/livechat/bannedIps \
-X
'GET'
\
-H
'Authorization: Bearer {access_token}'
\
Response:
HTTP/1.1 200 OK
Get a single LiveChat_BannedIp
GET livechat/bannedIps/{id}
Parameters:
Name | Type | In | Required | Description |
---|---|---|---|---|
include |
string | query | no | Allowed value is "agent". |
Response:
Example
Sample Request:
curl https://api15.comm100.io/v4/livechat/bannedIps/7ba1f316-2ae2-49fc-ab65-0114a636c4ca \
-X
'GET'
\
-H
'Authorization: Bearer {access_token}'
\
Response:
HTTP/1.1 200 OK
Create a new LiveChat_BannedIp
POST livechat/bannedIps
Parameters:
Name | Type | In | Required | Description |
---|---|---|---|---|
ipRangeFrom |
string | body | yes | Beginning of the banned IP range. |
ipRangeTo |
string | body | yes | End of the banned IP range. |
comment |
string | body | no | Comment of the banned IP. |
agentId |
guid | body | no | Id of the agent. |
Response:
Example
Sample Request:
curl https://api15.comm100.io/v4/livechat/bannedIps \
-X
'POST'
\
-H
'Authorization: Bearer {access_token}'
\
-H
'Content-Type: application/json'
\
-D
'{"ipRangeFrom":"192.168.2.127","ipRangeTo":"192.168.2.127","comment":"This comment is used as an example.","agentId":"AF63BFD4-3C20-4D16-833D-C9F9671589CD"}'
Response:
HTTP/1.1 201 Created
Update the LiveChat_BannedIp
PUT livechat/bannedIps/{id}
Parameters:
Name | Type | In | Required | Description |
---|---|---|---|---|
ipRangeFrom |
string | body | yes | Beginning of the banned IP range. |
ipRangeTo |
string | body | yes | End of the banned IP range. |
comment |
string | body | no | Comment of the banned IP. |
agentId |
guid | body | no | Id of the agent. |
Response:
Example
Sample Request:
curl https://api15.comm100.io/v4/livechat/bannedIps/7ba1f316-2ae2-49fc-ab65-0114a636c4ca \
-X
'PUT'
\
-H
'Authorization: Bearer {access_token}'
\
-H
'Content-Type: application/json'
\
-D
'{"ipRangeFrom":"192.168.2.127","ipRangeTo":"192.168.2.127","comment":"This comment is used as an example.","agentId":"AF63BFD4-3C20-4D16-833D-C9F9671589CD"}'
Response:
HTTP/1.1 200 OK
Remove the LiveChat_BannedIp
DELETE livechat/bannedIps/{id}
Parameters:
No Parameters
Response:
No Content
Example
Sample Request:
curl https://api15.comm100.io/v4/livechat/bannedIps/7ba1f316-2ae2-49fc-ab65-0114a636c4ca \
-X
'DELETE'
\
-H
'Authorization: Bearer {access_token}'
\
Response:
HTTP/1.1 204 No Content