The associated message will contain all status messages defined in Interaction Center. This allows clients to retreive status messages only once (instead of them being embedded in each user status payload, for example). It is very important, however, that clients retrieve a user's access to status messages in order to present the user with accessible statuses.
| Feature | Version | |
|---|---|---|
| status | 1 |
Required
The ININ session token necessary for all calls that require a security or user context.Required
The session cookie. With the exception of the connection request, all requests must provide a session cookie.Required
The ININ session ID necessary for all calls that require a security or user context.Required
The JSON type representing this option.Required
When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.
When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.
Required
The ID of the status message. Used to refer to or set the status message.
The value represented by this property should be treated as case-insensitive.
Required
Localized message text when displaying this status. Appears in list of selectable statuses.Required
The icon associated with this status message.Required
The group this status belongs to for reporting. A Status Group is a name that loosely categorizes a status message for reporting purposes. When a new status is defined in Interaction Administrator using the System Configuration < Status Messages container, it is mapped to a Status Group for reporting purposes.Required
Indicates whether this status can have an ending date.Required
Indicates whether this status can have an ending time.Required
Indicates whether this status is a do not disturb status.Required
Indicates whether this status is selectable by an agent.Required
Indicates whether this status can persist when the agent logs out of IC.Required
Indicates whether this status is a forwarding status.Required
Indicates whether this status requires after call work (ACW). Indicates that an agent is in "Follow Up" mode (IsAllowFollowUpStatus) after an ACD call.Required
Indicates whether an agent is available to receive ACD calls.Required
Indicates that an agent's status can change to "Follow Up" after an ACD call terminates.Required
An unique numeric identifier for this status message.Required
A message that describes the current error.Required
Indicates that the client needs to authenticate using a custom ICWS scheme, which supports a realm of type ICWS and a location which is the URL at which the client can authenticate. A typical example would be the following.
WWW-Authenticate: ICWS realm="ICWS" location="/ICWS/connection"
Required
A message that describes the current error.Required
A message that describes the current error.Required
A message that describes the current error.| Feature | Version | |
|---|---|---|
| status | 1 |
Required
The ININ session token necessary for all calls that require a security or user context.Required
The session cookie. With the exception of the connection request, all requests must provide a session cookie.Required
The ININ session ID necessary for all calls that require a security or user context.Required
A message that describes the current error.Required
Indicates that the client needs to authenticate using a custom ICWS scheme, which supports a realm of type ICWS and a location which is the URL at which the client can authenticate. A typical example would be the following.
WWW-Authenticate: ICWS realm="ICWS" location="/ICWS/connection"
Required
A message that describes the current error.Required
A message that describes the current error.Required
A message that describes the current error.