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:
Valid Values: 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 -- endpoint for 'regular' interactions, which are processed in 'paging' mode
101:pg_endpoint, 101:chat_endpoint -- same as previous, plus additional end point that Chat Server uses to place interactions in 'chat session' mode

inbound-route-by-call

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


Specifies the endpoint for chat sessions created by 'invite to chat' requests (aka 'outbound chat').
For example:</br>
not specified or empty -- means, that the channel does not support 'invite to chat' requests.</br>
101:chat_endpoint -- endpoint for outbound chat session. This endpoint is an endpoint specified in a Chat Server's configuration. Chat Server will use this endpoint to place interactions to interaction queue.</br>

media-type-chat-by-call

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


Specifies the media type that is assigned to interactions, that are submitted to Interaction Server by Chat Server, created by 'invite to chat' requests (aka 'outbound chat').

password

Default Value:
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 should be set up once and not changed without first communicating with Genesys team. CRITICAL: Changing this field without taking care will stop the connection between your channel driver and Genesys Hub, and 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 should be set to 'true'.

x-hub-apikey

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


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

x-hub-baseurl

Default Value:
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 should be set up once and not changed without first communicating with Genesys team. CRITICAL: Changing this field without taking care will stop the connection between your channel driver and Genesys Hub, and may cause a loss of data.

x-hub-channelid

Default Value:
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 should be set up once and not changed without first communicating with Genesys team. CRITICAL: Changing this field without taking care will stop the connection between your channel driver and Genesys Hub, and may cause a loss of data.

x-hub-pull-reserve-time

Default Value: 300
Valid Values: min option value 1, max option value is 3600
Changes Take Effect: After restart


Specifies how long in seconds fetched messages are reserved by Hub

x-hub-pull-size

Default Value: 10
Valid Values: min option value 1, max option value is 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 Hub

x-hub-userid

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


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

x-media-subtype-chat

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


Specifies the media subtype that is assigned to interactions that are 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 that are submitted to Interaction Server by Chat Server based on incoming messages.

x-phone-format

Default Value: us

Valid Values:
  • us - Leading character '+', if present in a phone number, is removed.
  • non-us - A phone number is not modified.

Changes Take Effect: After restart
Introduced: 9.1.002.04

Specifies the type of phone numbers transformation that is applied before passing phone numbers as interaction attributes (whether phone number format should contain international '+' prefix or not).

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

Feedback

Comment on this article:

blog comments powered by Disqus