Jump to: navigation, search
(→‎service-client-api.accepted-web-content-origins)
(→‎service-client-api.accepted-web-content-origins)
Line 10: Line 10:
 
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'.  
 
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 <tt>service-client-api.accepted-web-content-origins</tt> could now be: <tt><nowiki>http://my-web-server0, http://my-web-server1 (*), http://my-web-server2 (agent.*, voice.dial), http://my-web-server3 (agent.*, interaction.*)</nowiki></tt>
 
*:For example, the value for the option <tt>service-client-api.accepted-web-content-origins</tt> could now be: <tt><nowiki>http://my-web-server0, http://my-web-server1 (*), http://my-web-server2 (agent.*, voice.dial), http://my-web-server3 (agent.*, interaction.*)</nowiki></tt>
−
*:In this example, everything is allowed for the <tt><nowiki>http://my-web-server0</nowiki></tt> and <tt><nowiki>http://my-web-server1</nowiki></tt> domains, but for the <tt><nowiki>http://my-web-server2</nowiki</tt>> 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.
+
*:In this example, everything is allowed for the <tt><nowiki>http://my-web-server0</nowiki></tt> and <tt><nowiki>http://my-web-server1</nowiki></tt> domains, but for the <tt><nowiki>http://my-web-server2</nowiki></tt> 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.
 
<section end="service-client-api.accepted-web-content-origins"/>
 
<section end="service-client-api.accepted-web-content-origins"/>
 
<section begin="service-client-api.default-filter-type"/>
 
<section begin="service-client-api.default-filter-type"/>
−
 
−
====service-client-api.default-filter-type====
 
−
*Default Value: <tt>copy</tt>
 
−
*Valid Values: <tt>copy, skip, hide, hide-first, hide-last, unhide-first, unhide-last, custom-filter,<KeyPrefix>,<KeyPost>,<ValuePrefix>,<ValuePost></tt>
 
−
*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 <tt>log-filter-data</tt> key. The filter <tt>custom-filter</tt> enables you to define <tt>KeyPrefix, KeyPost, ValuePrefix</tt>, and <tt>ValuePost</tt>. For example: <tt>service-client-api.default-filter-type: custom-filter,<,>,<#,#></tt>
 
−
<section end="service-client-api.default-filter-type"/>
 
−
<section begin="service-client-api.filter-data.key-name"/>
 
−
====service-client-api.filter-data.<key-name>====
 
−
*Default Value: <tt>copy</tt>
 
−
*Valid Values: <tt>copy, skip, hide, hide-first, hide-last, unhide-first, unhide-last, custom-filter,<KeyPrefix>,<KeyPost>,<ValuePrefix>,<ValuePost></tt>
 
−
*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 [[ServiceClientAPI#service-client-api.default-filter-type|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 <tt>log-filter-data</tt> key. The filter <tt>custom-filter</tt> enables you to define <tt>KeyPrefix, KeyPost, ValuePrefix,</tt> and <tt>ValuePost</tt>. For example: <tt>service-client-api.default-filter-type: custom-filter,<,>,<#,#></tt>
 
−
<section end="service-client-api.filter-data.key-name"/>
 
−
<section begin="service-client-api.rate-limit"/>
 
−
 
−
====service-client-api.rate-limit====
 
−
* Default Value: <tt>0</tt>
 
−
* Valid Values: An integer value greater than or equal to <tt>0</tt>. Specify <tt>0</tt> 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.
 
−
<section end="service-client-api.rate-limit"/>
 
−
<section begin="service-client-api.rate-limit.service-name"/>
 
−
====service-client-api.rate-limit.<service-name>====
 
−
*Default Value: <tt>0</tt>
 
−
*Valid Values: An integer value greater than or equal to <tt>0</tt>. Specify <tt>0</tt> 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 <tt><service-name></tt> 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'.
 
−
<section end="service-client-api.rate-limit.service-name"/>
 
−
<section begin="service-client-api.rate-limit-quarantine-delay"/>
 
−
====service-client-api.rate-limit-quarantine-delay====
 
−
* Default Value: <tt>30</tt>
 
−
* Valid Values: An integer value greater than or equal to <tt>0</tt>. Specify <tt>0</tt> 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.
 
−
<section end="service-client-api.rate-limit-quarantine-delay"/>
 
−
[[Category:V:HTCC:8.5.2DRAFT]]
 

Revision as of 14:21, July 10, 2015

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.


Comments or questions about this documentation? Contact us for support!