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: 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
format: Use the Get configurationfunction to pull the security
configuration for your organization from the chat database. Use the Post configuration function to update the security
configuration for your company in the chat database. Company data has been updated.Authentication
authorization: privateAPIKey FPK4mmKXmwtKFyzNe4aN0XUAuthentication error codes
Error code Description 401 Authorization missing 402 Authorization is invalid Get configuration method
Endpoint
GET/{{chatserverURL}}/chat/api/securityConfigurationResponse parameters
Parameter Required Description 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 (*). Example response
{
"company":{
"Websocket Ratelimit":2,
"Message Ratelimit":6,
"Allowed origins":[
"http://expressjs.com",
"http://www.sustainablesites.com"
]
}
}Post configuration function
Endpoint
POST/{{chatserverURL}}/chat/api/securityConfigurationUpdateHeaders
Content-Type: application/JSONRequest parameters
Parameter Required Description 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 (*). Example request
{
"websocketRateLimit":5,
"messageRatelimit":7,
"allowedOrigins":[
"http://expressjs.com",
"http://www.sustainablesites.com"
}
Successful Response
Previous topic Pega Customer Service Chat in a reverse proxy server Next topic Pega Customer Service Chat engine architecture