This request is used to log the agent in to Dialer or into individual Dialer campaigns. The initial log-in request should not specify a campaign id. Logins for specific campaigns may be used, depending on the security settings for the agent.
Agents without the "Logon Campaign" security right are logged in to all campaigns they are eligible for when the initial log-in is sent. This initial login (with no campaing id specified) is used as a global login. "Master Administrator" agents automatically inherit the "Logon Campaign" security right.
Agents with the "Logon Campaign" security right begin their Dialer session with the use of the initial log-in message. Additional log-in message can be sent with an individual campaign id specified to log the agent into the Dialer campaign.
With the "Logon Campaign" security right, individual campaigns should not be logged into more than once. Also, the campaign id in the log-in message must be present in the availableCampaigns message in order for the login to succeed.
Without the "Logon Campaign" security right, logging into individual campaigns is not supported and campaign ids should not be sent with the log-in message.
| 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.log-in method again when the agent selects a campaign.
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 agent's current break status.| Feature | Version | |
|---|---|---|
| dialer | 3 |
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
Campaign ID for Base Script definition.Required
Base Script form definition.Required
Collection of pages used within a Base Script.Required
Name of the Base Script page.Required
Form controls for a Base Script page.Required
Database column linked to control.Required
Label of the Base Script page.Required
Specifies whether control has read-only property set.Required
Specifies type of control to display.Property type documentation:
Represents a collection of key/value string pairs.
Required
The key identifying this pair.Required
The value of this pair.Required
The collection of disposition choices an agent can select from at the end of a call. These choices are configured on the default page of the script that this campaign is configured to use.Required
Name of a disposition choice the agent can select from at the end of a call.Required
The wrap-up category assigned to the call.Required
The wrap-up code assigned to the call.Required
Specifies if a call is marked as abandoned.Required
Record status assigned for this disposition.Required
Specifies if this disposition is considered a contact.Required
Static text of the Base Script page.Required
Foreground color of the Base Script page.Required
Background color of the Base Script page.Required
Miscellaneous options configured for a Base Script.Required
Specifies whether this base script allows agents to request break.Required
Specifies whether this base script allows agents to skip calls.Required
Specifies whether this base script allows agent-owned callbacks.Required
Specifies whether this base script should use 24-time format.Required
Specifies whether this base script should automatically pick-up alerting calls.Required
Specifies whether this base script allows scheduling.Required
Specifies whether this base script allows auto disconnect on disposition.Required
Specifies whether this base script allows editing of Number to Dial.Required
Specifies whether this base script allows agents to place Additional Followup calls.Required
Specifies whether this base script allows editing Additional Call Numbers.Required
Specifies whether this base script allows overriding DNC block for manual calls.Required
Specifies whether this base script allows overriding zone block for manual calls.Required
Specifies whether this base script allows overriding skills block for manual calls.Required
Specifies whether this base script allows overriding daily limit block for manual calls.Required
Contains list of allowable extensions to dial.Required
Object display name.Required
Extension number.Required
Type of the object [Station, User, Workgroup, StationGroup or Attendant].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 JSON type representing this option.Required
The name of the campaign.Required
The ID of the campaign.Required
The workgroup associated with the campaign.| Feature | Version | |
|---|---|---|
| dialer | 3 |
| Feature | Version | |
|---|---|---|
| dialer | 3 |
| Feature | Version | |
|---|---|---|
| dialer | 3 |
| Feature | Version | |
|---|---|---|
| dialer | 6 |
Required
The JSON type representing this option.Required
The name of the campaign.Required
The ID of the campaign.Required
The ID of the removed campaign.Required
Specifies if the agent has the "Logon Campaign" security right to choose which campaigns to log in to. Agents without this right are automatically logged in to all campaigns they are eligible for. After agents are logged in,ready-for-calls still needs to be called to have calls routed to them.
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
DataPop information for a call. The specific attributes vary for preview and non-preview calls.Multiple options:
The value can be assigned any of the following options.Required
The JSON type representing this option.Required
The interaction ID for the call being popped.Required
ID of the campaign associated with the call.Required
Contact data for the call.Property type documentation:
Represents a collection of key/value string pairs.
Required
The key identifying this pair.Required
The value of this pair.Required
Specifies if the client application should disconnect the call immediately after it is dispositioned. If true, the client application, agent, or caller must disconnect the call. Dialer does not automatically disconnect.Required
Specifies if this call can be dispositioned as rescheduled for a specific agent.Required
The collection of disposition choices an agent can select from at the end of a call. These choices are configured on the default page of the script that this campaign is configured to use.Required
Name of a disposition choice the agent can select from at the end of a call.Required
The wrap-up category assigned to the call.Required
The wrap-up code assigned to the call.Required
Specifies if a call is marked as abandoned.Required
Dialing mode for the call.Property type documentation:
Specifies constants that indicate the dialing mode for a Dialer call.
Required
The JSON type representing this option.Required
The interaction ID for the call being popped.Required
ID of the campaign associated with the call.Required
Contact data for the call.Property type documentation:
Represents a collection of key/value string pairs.
Required
The key identifying this pair.Required
The value of this pair.Required
Specifies if the client application should disconnect the call immediately after it is dispositioned. If true, the client application, agent, or caller must disconnect the call. Dialer does not automatically disconnect.Required
Specifies if this call can be dispositioned as rescheduled for a specific agent.Required
The collection of disposition choices an agent can select from at the end of a call. These choices are configured on the default page of the script that this campaign is configured to use.Required
Dialing mode for the call.Property type documentation:
Specifies constants that indicate the preview dialing mode for a Dialer call.
Required
Indicates whether Dialer has been requested to place the preview call. If true, attempts to call theplace-preview-call method fail.
previewTimeout is the IC server time when the preview countdown expires. Compare this time to the server clock time via GET /icws/connection/server-time to account for client/server time drift. The server does not support initiating a preview call after the countdown is reached. If that functionality is required, it must be included in the client application.
Required
Indicates whether the agent is allowed to skip this preview call. To skip a preview call, call thedisposition method with a wrapup label of "Skipped - Agent Skip".
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 campaign the agent is logged in to.Required
This identifies the rule or supervisor who initiated the agent's campaign login.urn:inin.com:dialer:logoutGrantedMessage message when the logout has been granted by Dialer.
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 list of campaign IDs for which a campaign logoff was requested.Required
This identifies the rule or supervisor who initiated the agent's campaign logout request.| Feature | Version | |
|---|---|---|
| dialer | 3 |
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 state of the connection before change.Required
The state of the connection after the connection change.Required
A description of the condition that caused the change in connection state.Multiple options:
The value can be assigned any of the following options.Required
A message that describes the current error.Required
The JSON type representing this option.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.