Jump to: navigation, search

channel-ghub Section



  


driver-classname

Default Value: com.genesyslab.mcr.smserver.channel.ghub.drv.GHubDriver
Valid Values: com.genesyslab.mcr.smserver.channel.ghub.drv.GHubDriver
Changes Take Effect: After restart


Specifies the class name of the media driver for a specific media service.

inbound-route

Default Value: An empty string
Valid Values: A comma-separated list of endpoints
Changes Take Effect: After restart


Specifies the endpoints for inbound messages arriving from the media channel.
For example:
101:pg_endpoint—The endpoint for "regular" interactions, which are processed in "paging" mode.
101:pg_endpoint, 101:chat_endpoint—The same as previous, plus an additional endpoint that Chat Server uses to place interactions in "chat session" mode.

inbound-route-by-call

Default Value: An empty string
Valid Values: A valid endpoint
Changes Take Effect: After restart


Specifies the endpoint for outbound chat sessions created by "InviteToChat" requests. This endpoint must exist in the Chat Server configuration. Chat Server will use this endpoint to place interactions into the interaction queue. If the option is not specified or empty, the channel does not support "InviteToChat" requests.
For example:
inbound-route-by-call = 101:chat_endpoint, where "101:chat_endpoint" is the endpoint from the Chat Server configuration.

media-type-chat-by-call

Default Value: whatsappsession
Valid Values: Any valid string
Changes Take Effect: After restart


Specifies the media type assigned to interactions that are submitted to Interaction Server by Chat Server, created by "InviteToChat" requests (or "outbound chat").

password

Default Value: An empty string
Valid Values: Any valid string
Changes Take Effect: After restart


Specifies the administrator user's password to access the Genesys Hub. Contact Genesys Customer Care to obtain the value of this option. This field must be set up once and not changed without first communicating with the Genesys team. CRITICAL: Changing this field without using caution will stop the connection between your channel driver and Genesys Hub, and it may cause a loss of data.

ucs-in-use

Default Value: true
Valid Values: true
Changes Take Effect: After restart


Allows the use of Universal Contact Server to save data. The option must be set to "true".

x-hub-apikey

Default Value: An empty string
Valid Values: Any valid string
Changes Take Effect: After restart


Specifies an access key that is used by the driver to access the Genesys Hub API. Contact Genesys Customer Care to obtain the value of this option. This field must be set up once and not changed without first communicating with the Genesys team. CRITICAL: Changing this field without using caution will stop the connection between your channel driver and Genesys Hub, and it may cause a loss of data.

x-hub-baseurl

Default Value: An empty string
Valid Values: Any valid string
Changes Take Effect: After restart


Specifies the Genesys Hub URL. Contact Genesys Customer Care to obtain the value of this option. This field must be set up once and not changed without first communicating with the Genesys team. CRITICAL: Changing this field without using cuation will stop the connection between your channel driver and Genesys Hub, and it may cause a loss of data.

x-hub-channelid

Default Value: An empty string
Valid Values: Any valid string
Changes Take Effect: After restart


Specifies a channel ID in Genesys Hub. Contact Genesys Customer Care to obtain the value of this option. This field must be set up once and not changed without first communicating with the Genesys team. CRITICAL: Changing this field without using caution will stop the connection between your channel driver and Genesys Hub, and it may cause a loss of data.

x-hub-pull-reserve-time

Default Value: 300
Valid Values: 1-3600
Changes Take Effect: After restart


Specifies how long, in seconds, fetched messages are reserved by the Genesys Hub.

x-hub-pull-size

Default Value: 10
Valid Values: 1-1000
Changes Take Effect: After restart
Modified: 9.1.001.03

Specifies how many messages per request are pulled.

x-hub-pull-timeout

Default Value: 15000
Valid Values: Integer value from 1000 to 600000
Changes Take Effect: After restart


Specifies a delay, in milliseconds, between requests for messages from the Genesys Hub.

x-hub-userid

Default Value: An empty string
Valid Values: Any valid string
Changes Take Effect: After restart


Specifies a user's email address associated with a channel in the Genesys Hub. Contact Genesys Customer Care to obtain the value of this option. This field must be set up once and not changed without first communicating with the Genesys team. CRITICAL: Changing this field without using caution will stop the connection between your channel driver and Genesys Hub, and it may cause a loss of data.

x-media-subtype-chat

Default Value: An empty string
Valid Values: whatsapp
Changes Take Effect: After restart


Specifies the media subtype that is assigned to interactions submitted to Interaction Server by Chat Server, based on incoming messages.

x-media-type-chat

Default Value: whatsappsession
Valid Values: whatsappsession
Changes Take Effect: After restart


Specifies the media type that is assigned to interactions submitted to Interaction Server by Chat Server, based on incoming messages.

x-phone-format

Default Value: us

Valid Values:
  • us—The leading character "+" is removed if present in a phone number.
  • non-us—A phone number is not modified.

Changes Take Effect: After restart
Introduced: 9.1.002.04

Specifies whether the leading "+" international prefix character is removed or not before passing a phone number as an interaction attribute.

This page was last modified on March 27, 2019, at 09:02.

Feedback

Comment on this article:

blog comments powered by Disqus