User API Parameters
|
Parameter |
Type |
Description |
Possible Values |
Notes |
|---|---|---|---|---|
|
id |
String |
The ID of the user. |
— |
If the user is configured in Unified CCE, size is determined by Unified CCE. If the user is configured in Unified CCX, the size is determined by Unified Communications Manager. |
|
uri |
String |
The URI to get a new copy of the object. |
— |
— |
|
roles |
Collection |
List of roles for this user. |
Agent, Supervisor |
— |
|
-->role |
String |
One of the roles assigned to this user. |
Agent, Supervisor |
— |
|
loginId |
String |
The login ID of the user. |
— |
— |
|
loginName |
String |
The login name of the user. |
— |
— |
|
state |
String |
The state for this user. |
LOGOUT, NOT_READY, READY, RESERVED, RESERVED_OUTBOUND, RESERVED_OUTBOUND_ PREVIEW, TALKING, HOLD, WORK, WORK_READY, UNKNOWN |
— |
|
stateChangeTime |
String |
The time at which the state of the user changed to the current state. 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). |
|
mediaType |
String |
The type of media under which the dialog is classified. |
— |
— |
|
pendingState |
String |
The state to which the user will transition next. |
LOGOUT |
For Unified CCX deployments, when an agent is in TALKING state and a Finesse failover or reconnect occurs, this parameter is set to LOGOUT. The pendingState parameter indicates that the agent transitions to LOGOUT state when the call ends. |
|
reasonCodeId |
Integer |
The database ID for the reason code that indicates why the user is in the current state. |
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:
|
|
ReasonCode |
Collection |
Information about the reason code currently associated with this user. |
— |
— |
|
-->category |
String |
The category of the reason code. |
NOT_READY, LOGOUT |
— |
|
-->uri |
String |
The full URI for the reason code. |
— |
— |
|
-->code |
Integer |
CTI code associated with this reason code. |
— |
— |
|
-->label |
String |
The label associated with this reason code. |
— |
— |
|
-->forAll |
Boolean |
Whether the reason code is global (true) or non-global (false). |
true, false |
— |
|
systemCode |
Boolean |
The reserved status of the reason code |
true, false |
— |
|
-->id |
Integer |
The ID of the reason code. |
— |
— |
|
settings |
Collection |
The settings for this user. |
— |
The settings parameter is only present for Unified CCE deployments. |
|
-->wrapUpOn Incoming |
String |
Indicates whether this user required or allowed to enter wrap-up data on an incoming call. |
REQUIRED, OPTIONAL, NOT_ALLOWED, REQUIRED_WITH_ WRAP_UP_DATA |
This parameter applies only to Unified CCE deployments. |
|
-->wrapUpOn Outgoing |
String |
Indicates whether this user required or allowed to enter wrap-up data on an outgoing call. |
REQUIRED, OPTIONAL, NOT_ALLOWED |
This parameter applies only to Unified CCE deployments. |
|
-->deviceSelection |
String |
Indicates whether the CTI device selection is enabled for the agent. For more information about CTI device selection, see Device Selection for Shared ACD Line chapter in Cisco Finesse Administration Guide and Select Active Device chapter in Cisco Finesse Agent and Supervisor Desktop User Guide. |
enabled, disabled |
The login request must contain activeDeviceId when the device selection is enabled, and when the multiple devices are configured for the extension selected by the agent. |
|
extension |
String |
The extension that this user is currently using. |
— |
The extension must exist in Unified Communications Manager. If the user is configured in Unified CCE, size is determined by Unified Communications Manager. If the user is configured in Unified CCX, the size is determined by Unified CCX. |
|
mobileAgent |
Collection |
Indicates that the user is a mobile agent. |
— |
This parameter is returned for mobile agents only. Finesse supports mobile agents only in Unified CCE deployments. |
|
-->mode |
String |
The work mode for the mobile agent |
CALL_BY_CALL, NAILED_CONNECTION |
This parameter is returned for mobile agents only. Finesse supports mobile agents only in Unified CCE deployments. |
|
-->dialNumber |
String |
The external number that the system calls to connect to the mobile agent. |
— |
This parameter is returned for mobile agents only. Finesse supports mobile agents only in Unified CCE deployments. Validated by the Unified Communications Manager dial plan. |
|
firstName |
String |
The first name of this user. |
— |
|
|
lastName |
String |
The last name of this user. |
— |
— |
|
teamId |
String |
The ID of the team to which this user belongs. |
— |
— |
|
teamName |
String |
The name of the team to which this user belongs. |
— |
— |
|
skillTargetId |
String |
Unique identifier for the skill target assigned to the agent in the Unified CCE database. This is supported from Cisco Finesse, Release 12.5(1) ES2 onwards. |
— |
This parameter applies only to Unified CCE deployments. |
|
dialogs |
String |
URI to the collection of dialogs that the user is a part of. |
— |
|
|
teams |
Collection |
If the user has a role of Supervisor, a list of teams that the user supervises. |
— |
|
|
-->Team |
Collection |
Set of information for a team. |
— |
|
|
--->uri |
String |
The URI to get a new copy of the Team object. |
— |
|
|
--->id |
String |
The ID for the team. |
— |
|
|
--->name |
String |
The name of the team. |
— |
|
|
mediaState |
— |
The state of the user on a manual outbound call from NOT_READY state. |
BUSY, IDLE |
This parameter is returned for Team API only and not for User API. This parameter applies only to Unified CCX deployments. |
|
logoutAllMedia |
Boolean |
Determines if the the logout request is for all media channels (true) or only from the channels configured by the Administrator. |
true, false |
This parameter applies only to Unified CCE deployments, and is used only when signing out. Administartor can configure the signout channels with the CLI utils finesse user_signout_channel |
|
activeDeviceId |
String |
A unique ID of the active device associated with the extension to which the agent is signed in. |
— |
This parameter is mandatory in the request payload if multiple devices are associated with the extension, and device selection is enabled for the agent. |
|
Devices |
Collection |
Information about the list of devices associated with the extension agent has signed in. For more information, see Devices API Parameters. |
— |
— |