Media API Parameters

uri

String

The URI to get a new copy of the Media object.

—

description

String

A description of the Media Routing Domain (MRD)

—

Any special XML characters in the description are escaped. For example, "<" is replaced with "&amp;lt;".

id

String

The ID of the MRD.

—

The size is determined by CCE.

interruptible

Boolean

Whether a task in this MRD can be interrupted by a task from another MRD.

true, false

maxDialogLimit

Integer

The maximum number of concurrent dialogs this user is allowed to handle in this MRD. Each dialog represents a task.

1 through 10

The maximum value for this parameter is 10.

name

String

The name of the MRD.

—

requestId

String

A user provided unique string used to correlate originating request with the resulting HTTP response or asynchronous error. This parameter is not part of the resulting event/events.

—

ReasonCode

Collection

Information about the reason code currently associated with this user.

—

-->category

String

The category of the reason code.

NOT_READY

-->code

Integer

CTI code associated with this reason code.

—

-->forAll

Boolean

Whether the reason code is global (true) or non-global (false).

true, false

-->id

Integer

The ID of the reason code.

—

-->label

String

The label associated with this reason code.

—

-->uri

String

The full URI for the reason code.

—

reasonCodeId

Integer

The database ID for the reason code that indicates why the user is in the current state in this MRD.

If the user has not selected the reason code, this parameter is empty. Otherwise, the value of this parameter is the database ID for the selected reason code.

The value of the reasonCodeId may be -1 in the following cases:

• The agent logged out.

• No reason codes are configured for the category.

• The agent has just signed in (transitioned from LOGIN to NOT_READY)

• A failover occurred. The agent is in NOT_READY state but Finesse could not recover the reasonCode used before failover.

routable

Boolean

Indicates whether CCE can route the tasks to the user in this MRD. When the agent is routable (true), CCE can route tasks to the user. When the agent is not routable (false), CCE cannot route tasks to the agent.

true, false

state

String

The state for this user in this MRD.

LOGIN, NOT_READY, READY, LOGOUT, RESERVED, ACTIVE, PAUSED, WORK_READY, INTERRUPTED, WORK_NOT_READY

stateChangeTime

String

The time at which the state of the user changed to the current state in this MRD. The format for this parameter is YYYY-MM-DDThh:MM:ss. SSSZ.

—

This parameter is empty if the time of the state change is not available (if no agent state change notification was received yet).

interruptAction

String

This parameter only applies to interruptible MRDs. It is ignored for noninterruptible MRDs.

An agent setting that defines the behavior when an agent is handling a task in an interruptible MRD and is interrupted by a task or call from a non-interruptible MRD.

ACCEPT: The MRD accepts the interrupt event. The agent state is INTERRUPTED in the interruptible MRD and the agent cannot perform any actions on dialogs in that MRD.

IGNORE: The MRD does not accept the interrupt event. The agent state does not change in the interruptible MRD and the agent can continue to perform actions on dialogs in that MRD.

ACCEPT, IGNORE

This parameter reflects the configured setting only if you are performing a GET on the Finesse server that the user is signed in to.

dialogLogoutAction

String

An agent setting that determines whether active tasks are closed or transferred when an agent logs out of an MRD.

CLOSE (default): Active tasks are closed when an agent logs out. Finesse sends Customer Collaboration Platform the task handled events. CCE determines the correct disposition codes for the closed task.

TRANSFER: Active tasks are transferred using Customer Collaboration Platform when an agent logs out. Finesse puts the dialogs in the CLOSED state with the CD_TASK_TRANSFERRED_ AGENT_LOGOUT disposition code.

CLOSE, TRANSFER

This parameter reflects the configured setting only if you are performing a GET on the Finesse server that the user is signed in to.