MediaPropertiesLayout API Parameters

uri

String

The id maps to the primary key of the media properties layout entry.

—

name

String

The name of the media properties layout.

—

Max length of 40 characters

description

String

The description of the media properties layout.

—

Max length of 128 characters

type

String

The type of media properties layout.

DEFAULT, CUSTOM

header

Object

Contains a single entry (combination of displayName and mediaProperty) that appears in the call header on the desktop for each call.

—

column

Object

Grouping of media properties for agent and supervisor desktops.

Contains a list of entry objects

—

Finesse supports up to two columns in the MediaProperties Layout object. Columns can contain up to 10 entries and can be empty.

The first column supplied in a PUT is always the left column. The second column (if any) is always the right column.

-->entry

Object

A displayName and mediaProperty combination.

—

Each entry must contain one displayName and one mediaProperty.

The displayName can be empty.

--->displayName

String

Part of an entry. A label that describes the mediaProperty for that entry (for example, Customer Name). The label appears on the Finesse desktop.

—

Maximum of 50 characters.

--->mediaProperty

String

The name of the variable that is displayed on the Finesse desktop.

Each entry contains exactly one mediaProperty.

Allowed strings include callVariable1 through callVariable10, any valid ECC variable (user.*), and the following Outbound Option variables:

• BACampaign

• BAAccountNumber

• BAResponse

• BAStatus

• BADialedListID

• BATimeZone

• BABuddyName

• BACustomerNumber (Unified CCX only)

Maximum of 32 characters.

--->showInPopOver

Boolean

Indicates the call variables to be displayed in the Call PopOver and in Supervisor team performance gadget based on the value.

TRUE, FALSE

Default value for this parameter is FALSE.

--->uiEditable

Boolean

Indicates the call variables that are editable in the agent and supervisor desktop.

TRUE, FALSE

Default value for this parameter is FALSE.