Pega Customer Service chat security configuration API
Pega Customer Service chat security configuration API to access and modify chat parameters in Pega Cloud, including the rate of new messages, the connection requests, and the allowed domains in the Pega Customer Service chat server.
The security configuration API includes the following methods:
- Get configuration
- Pulls the security configuration of your Pega Customer Service chat instance from the database.
- Post configuration
- Updates the security configuration of your Pega Customer Service chat in the database.
Both Get and Post configuration uses the
request header parameter for authentication. The Pega Customer Service
chat company identifier is included in the company provision mail in the following
authorization: privateAPIKey FPK4mmKXmwtKFyzNe4aN0XU
Authentication error codes
Authorization is invalid
Get configuration method
Use the Get configurationfunction to pull the security configuration for your organization from the chat database.
|Websocket Ratelimit||Optional||The number of WebSocket connections that can be established for an IP address in one second.|
|Message Ratelimit||Optional||The number of WebSocket messages that can be transferred in the socket in one second.|
|Allowed origins||Optional||Domains from which chat servers permit chat requests, separated by commas. The parameter does not support the asterisk (*).|
Post configuration function
Use the Post configuration function to update the security configuration for your company in the chat database.
|websocketRatelimit||Optional||The number of WebSocket connections that can be established for an IP address in one second. The minimum value for websocketRateLimit is one, and the maximum is five.|
|messageRatelimit||Optional||The number of WebSocket messages that can be transferred with in the socket in one second. The minimum value for messageRateLimit is three and the maximum is eight.|
|allowedOrigins||Optional||Domains from which chat servers permit chat requests, separated by commas. The parameter does not support the asterisk (*).|
Company data has been updated.