This request is used to log the agent out of Dialer or out of individual Dialer campaigns. Receiving a corresponding logoutGrantedMessage
indicates that the logout has been granted.
When a campaign is specified, the agent is logged out of the specified Dialer campaign, but not completely logged out of Dialer. If no campaign is specified, then the agent is completely logged out of Dialer.
When the "Logon Campaign" security right is in use, agents may be logged out of individual campaigns by sending the campaignId
parameter. Without the "Logon Campaign" security right, this should be avoided and the log-off
message should be sent as a global logout without a campaignId
specified.
Feature | Version | |
---|---|---|
dialer | 2 |
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
Required
The ID of the campaign.Feature | Obsolete Version | |
---|---|---|
dialer | 3 |
Required
A message that describes the current error.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.