environmentId

String

Unique OM identifier for the switch environment instance to connect to. Some customers and OM internal testing resources have multiple switching environments. This member indicates which environment to use.

agent

Object

Container object for agent related login information.

agent.id

String

The username/id to use when authenticating with the switch platform. Usernames take many different forms depending on the requirements of the switch. Some usernames may be a simple string or number while others may be structured like an email address and contain non alpha-numeric characters.

agent.password

String

The password to use when authenticating with the switch platform. Passwords stored in config server are encrypted and are prefixed with “encrypted:”. The encrypted value should be passed to HIS as-is. There may be additional steps to obtain the password, like in the case of PureCloud, that requires native login screens.

name

String

The name of the endpoint being logged into. This can be a meta group such as a Genesys PureEngage place name or the extension number to use for Avaya.

email

Boolean

When set to “true”, the agent will have an email channel. A value of “false” disables the email channel. This setting is ignored if the switch doesn’t support email interactions.

chat

Boolean

When set to “true”, the agent will have a chat channel. A value of “false” disables the chat channel. This setting is ignored if the switch doesn’t support chat interactions.

platformExtensions

Object

Additional login information required by the target environment. The contents of this object are platform specific. See details of each platform’s expected extensions.