Service Client API

service-client-api.accepted-web-content-origins

• Default Value: An empty string
• Valid Values: A comma-separated list of URLs or '*' — for example: 'http://my-web-server-1,http://my-web-server-2' or '*'.
• Changes take effect: When the session is started or restarted.
• Description: Specifies the list of granted origins and allowed APIs that are used in the web extension views. This option cannot be overridden and must be set in the WWEWS Cluster application.

Specifies the list of granted origins and allowed APIs that are used in the web extension views. You can filter requested API with the following self explanatory keywords: 'agent.get', 'agent.getStateList', 'agent.setState', 'agent.getState', 'interaction.getInteractions', 'interaction.getByInteractionId', 'interaction.getByBundleId', 'interaction.getByCaseId', 'interaction.attachUserData', 'interaction.updateUserData', 'interaction.deleteUserData', 'voice.dial', 'voice.startCallRecording', 'voice.stopCallRecording', 'voice.pauseCallRecording', 'voice.resumeCallRecording' and 'email.create'.

• For example, the value for the option service-client-api.accepted-web-content-origins could now be: http://my-web-server0, http://my-web-server1 (*), http://my-web-server2 (agent.*, voice.dial), http://my-web-server3 (agent.*, interaction.*)

  In this example, everything is allowed for the 'http://my-web-server0' and 'http://my-web-server1' domains, but for the 'http://my-web-server2' domain, only the following requests are allowed: 'agent.get', 'agent.getStateList', 'agent.setState', 'agent.getState', 'voice.dial', 'voice.startCallRecording', 'voice.stopCallRecording', 'voice.pauseCallRecording', 'voice.resumeCallRecording' and 'email.create'. So, in addition to filtering by origin, you can also filter by API with a wildcard in in parentheses after the allowed origin.

service-client-api.default-filter-type

• Default Value: copy
• Valid Values: copy, skip, hide, hide-first, hide-last, unhide-first, unhide-last, custom-filter,<KeyPrefix>,<KeyPost>,<ValuePrefix>,<ValuePost>
• Changes take effect: When the session is started or restarted.
• Description: Specifies the default view of KVList information (including UserData, Extensions, and Reasons) in the service events. It is applied to the attributes of all KVList pairs, except those that are explicitly defined in the log-filter-data key. The filter custom-filter enables you to define KeyPrefix, KeyPost, ValuePrefix, and ValuePost. For example: service-client-api.default-filter-type: custom-filter,<,>,<#,#>

service-client-api.filter-data.<key-name>

• Default Value: copy
• Valid Values: copy, skip, hide, hide-first, hide-last, unhide-first, unhide-last, custom-filter,<KeyPrefix>,<KeyPost>,<ValuePrefix>,<ValuePost>
• Changes take effect: When the session is started or restarted.
• Description: Specifies the treatment of specific data in the service. It overrides the general settings specified by the service-client-api.default-filter-type option, which specifies the default view of KVList information (including UserData, Extensions, and Reasons) in the service. It is applied to the attributes of all KVList pairs except those that are explicitly defined in the log-filter-data key. The filter custom-filter enables you to define KeyPrefix, KeyPost, ValuePrefix, and ValuePost. For example: service-client-api.default-filter-type: custom-filter,<,>,<#,#>

service-client-api.rate-limit

• Default Value: 0
• Valid Values: An integer value greater than or equal to 0. Specify 0 for an unlimited rate.
• Changes take effect: When the session is started or restarted.
• Description: Specifies the limit for the maximum number of requests per minute on the Service Client API. This option cannot be overridden and must be set in the WWEWS Cluster application.

service-client-api.rate-limit.<service-name>

• Default Value: 0
• Valid Values: An integer value greater than or equal to 0. Specify 0 for an unlimited rate.
• Changes take effect: When the session is started or restarted.
• Description: Specifies the limit for the maximum number of requests per minute on a specific API request on the Service Client API. The value of <service-name> can be one of the following: 'agent.get', 'agent.getStateList', 'agent.setState', 'agent.getState', 'interaction.getInteractions', 'interaction.getByInteractionId', 'interaction.getByBundleId', 'interaction.getByCaseId', 'interaction.attachUserData', 'interaction.updateUserData', 'interaction.deleteUserData', 'voice.dial', 'voice.startCallRecording', 'voice.stopCallRecording', 'voice.pauseCallRecording', 'voice.resumeCallRecording' and 'email.create'.

service-client-api.rate-limit-quarantine-delay

• Default Value: 30
• Valid Values: An integer value greater than or equal to 0. Specify 0 for infinite quarantine delay.
• Changes take effect: When the session is started or restarted.
• Description: Specifies the quarantine delay, in seconds, during which requests are ignored once the rate limit is reached. This option cannot be overridden and must be set in the WWEWS Cluster application.