Restricted Words Config

Restricted Words
- Restricted Words Manage
GET global/restrictedWordsConfig
POST global/restrictedWordsConfig:disable
POST global/restrictedWordsConfig:enable
PUT global/restrictedWordsConfig
Model
Restricted Words Config JSON Format

Restricted Words Config is represented as simple flat JSON objects with the following keys:

Name Type Description
siteId integer Id of the site.
isEnabled bool Whether Restricted Words is enabled or not.
restrictedWords string Words that agents are restricted to use.
Endpoint
Get a single Restricted Words Config

GET global/restrictedWordsConfig

Parameters:
No Parameters
Response:
Example

Sample Request:

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

Response:

 HTTP/1.1 200 OK

{"siteId":10000,"isEnabled":true,"restrictedWords":"test"}
Disable the Restricted Words Config

POST global/restrictedWordsConfig:disable

Parameters:
No Parameters
Response:
Example

Sample Request:

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

Response:

 HTTP/1.1 200 OK

{"siteId":10000,"isEnabled":false,"restrictedWords":"test"}
Enable the Restricted Words Config

POST global/restrictedWordsConfig:enable

Parameters:
No Parameters
Response:
Example

Sample Request:

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

Response:

 HTTP/1.1 200 OK

{"siteId":10000,"isEnabled":true,"restrictedWords":"test"}
Update the Restricted Words Config

PUT global/restrictedWordsConfig

Parameters:
Name Type In Required Description
isEnabled bool body no Whether Restricted Words is enabled or not.
restrictedWords string body no Words that agents are restricted to use.
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/global/restrictedWordsConfig \
-X 'PUT' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
-D '{"isEnabled":true,"restrictedWords":"test"}'

Response:

 HTTP/1.1 200 OK

{"siteId":10000,"isEnabled":true,"restrictedWords":"test"}