/icws/{sessionId}/dialer/log-in

POST

/icws/{sessionId}/dialer/log-in

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.

Note

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

Request

Parameters
Type
Name
Comments
Header
ININ-ICWS-CSRF-Token

Required

The ININ session token necessary for all calls that require a security or user context.

    Header
    Cookie

    Required

    The session cookie. With the exception of the connection request, all requests must provide a session cookie.

      Template
      sessionId

      Required

      The ININ session ID necessary for all calls that require a security or user context.

        Representations
        logInParameters
        Property
        Value
        Comments
        campaignId
        String
        The ID of the campaign to log the agent in to. This is only needed for agents that have the "Logon Campaign" security right. If the campaign ID is not present for agents with the "Logon Campaign" security right, call the log-in method again when the agent selects a campaign.

        Response

        200 - OK
        The request to log in to Dialer succeeded.
        Associated Message
        This message occurs immediately after the initial login and whenever the agent's break status changes.
        breakStatusMessage
        Property
        Value
        Comments
        __type
        "urn:inin.com:dialer:breakStatusMessage"

        Required

        The JSON type representing this option.
        isDelta
        Boolean

        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.

        NotOnBreak
        0
        BreakPending
        1
        OnBreak
        2
        Associated Message
        This message occurs when the form definition on an active Dialer campaign changes.
        Feature Version
        dialer 3
        setFormDefinitionMessage
        Property
        Value
        Comments
        __type
        "urn:inin.com:dialer:setFormDefinitionMessage"

        Required

        The JSON type representing this option.
        isDelta
        Boolean

        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.

        campaignId
        String

        Required

        Campaign ID for Base Script definition.
        name
        String

        Required

        Name of the Base Script page.
        column
        String

        Required

        Database column linked to control.
        label
        String

        Required

        Label of the Base Script page.
        readOnly
        Boolean

        Required

        Specifies whether control has read-only property set.
        Text
        0
        Numeric
        1
        Radio
        2
        Listbox
        3
        DateTime
        4
        maxLines
        Int
        Maximum lines allowed for the control if applicable.
        maxChars
        Int
        Maximum characters allowed for the control if applicable.
        ShortDate
        1
        LongDate
        2
        Time
        4
        ShortDateWithTime
        5
        LongDateWithTime
        6
        [key]
        String

        Required

        The key identifying this pair.
        [value]
        String

        Required

        The value of this pair.
        label
        String

        Required

        Name of a disposition choice the agent can select from at the end of a call.
        wrapUpCategory
        String

        Required

        The wrap-up category assigned to the call.
        wrapUpCode
        String

        Required

        The wrap-up code assigned to the call.
        abandon
        Boolean

        Required

        Specifies if a call is marked as abandoned.
        recordStatus
        String

        Required

        Record status assigned for this disposition.
        isContact
        Boolean

        Required

        Specifies if this disposition is considered a contact.
        text
        String

        Required

        Static text of the Base Script page.
        stage
        Int
        Stage ID for the Base Script page.
        foregroundColor
        String

        Required

        Foreground color of the Base Script page.
        backgroundColor
        String

        Required

        Background color of the Base Script page.
        allowBreak
        Boolean

        Required

        Specifies whether this base script allows agents to request break.
        allowSkip
        Boolean

        Required

        Specifies whether this base script allows agents to skip calls.
        allowAgentOwned
        Boolean

        Required

        Specifies whether this base script allows agent-owned callbacks.
        militaryTime
        Boolean

        Required

        Specifies whether this base script should use 24-time format.
        pickupCall
        Boolean

        Required

        Specifies whether this base script should automatically pick-up alerting calls.
        allowSchedulePhone
        Boolean

        Required

        Specifies whether this base script allows scheduling.
        autoDisconnect
        Boolean

        Required

        Specifies whether this base script allows auto disconnect on disposition.
        allowEditingOfNumberToDial
        Boolean

        Required

        Specifies whether this base script allows editing of Number to Dial.
        allowAgentsAdditionalCalls
        Boolean

        Required

        Specifies whether this base script allows agents to place Additional Followup calls.
        allowEditingAdditionalCallNumbers
        Boolean

        Required

        Specifies whether this base script allows editing Additional Call Numbers.
        overrideDncBlock
        Boolean

        Required

        Specifies whether this base script allows overriding DNC block for manual calls.
        overrideZoneBlock
        Boolean

        Required

        Specifies whether this base script allows overriding zone block for manual calls.
        overrideSkillsBlock
        Boolean

        Required

        Specifies whether this base script allows overriding skills block for manual calls.
        overrideDailyLimitBlock
        Boolean

        Required

        Specifies whether this base script allows overriding daily limit block for manual calls.
        objectName
        String

        Required

        Object display name.
        extension
        String

        Required

        Extension number.
        objectType
        String

        Required

        Type of the object [Station, User, Workgroup, StationGroup or Attendant].
        Associated Message
        This message occurs immediately after the initial login and whenever the list of available campaigns for the agent changes.
        availableCampaignsMessage
        Property
        Value
        Comments
        __type
        "urn:inin.com:dialer:availableCampaignsMessage"

        Required

        The JSON type representing this option.
        isDelta
        Boolean

        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.

        __type
        "urn:inin.com:dialer:availableCampaign"

        Required

        The JSON type representing this option.
        name
        String

        Required

        The name of the campaign.
        id
        String

        Required

        The ID of the campaign.
        workgroup
        String

        Required

        The workgroup associated with the campaign.
        Invalid
        0
        On
        1
        Off
        2
        ScheduleOnly
        4
        Auto
        8
        Paused
        16
        Completed
        32
        hasBaseScript
        Boolean
        Represents whether this campaign applies a Base Script definition.
        Feature Version
        dialer 3
        customScriptUrl
        String
        Custom script URL associated with campaign.
        Feature Version
        dialer 3
        isLoggedIn
        Boolean
        Indicates whether agent is currently logged into this campaign.
        Feature Version
        dialer 3
        Predictive
        1
        Power
        2
        Preview
        3
        Agentless
        8
        __type
        "urn:inin.com:dialer:changedCampaign"

        Required

        The JSON type representing this option.
        name
        String

        Required

        The name of the campaign.
        id
        String

        Required

        The ID of the campaign.
        Invalid
        0
        On
        1
        Off
        2
        ScheduleOnly
        4
        Auto
        8
        Paused
        16
        Completed
        32
        id
        String

        Required

        The ID of the removed campaign.
        agentHasLogonCampaignRight
        Boolean

        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.
        Associated Message
        This message occurs when the agent is assigned a preview or predictive campaign call.
        dataPopMessage
        Property
        Value
        Comments
        __type
        "urn:inin.com:dialer:dataPopMessage"

        Required

        The JSON type representing this option.
        isDelta
        Boolean

        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.

        Multiple options:

        The value can be assigned any of the following options.
        __type
        "urn:inin.com:dialer:dataPop"

        Required

        The JSON type representing this option.
        interactionId
        String

        Required

        The interaction ID for the call being popped.
        campaignId
        String

        Required

        ID of the campaign associated with the call.
        [key]
        String

        Required

        The key identifying this pair.
        [value]
        String

        Required

        The value of this pair.
        autoDisconnectOnDisposition
        Boolean

        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.
        allowAgentCallbacks
        Boolean

        Required

        Specifies if this call can be dispositioned as rescheduled for a specific agent.
        label
        String

        Required

        Name of a disposition choice the agent can select from at the end of a call.
        wrapUpCategory
        String

        Required

        The wrap-up category assigned to the call.
        wrapUpCode
        String

        Required

        The wrap-up code assigned to the call.
        abandon
        Boolean

        Required

        Specifies if a call is marked as abandoned.
        preview
        0
        This is a preview call.
        ownAgentCallback_Preview
        1
        This is an agent-owned callback from a preview campaign.
        regular
        2
        This is a regularly dialed call.
        ownAgentCallback
        3
        This is an agent-owned callback from a non-preview campaign.
        agentless
        4
        This is an agentless call.
        precise
        5
        This is a precisely dialed call.
        manual
        6
        This is a manually dialed outbound call.
        __type
        "urn:inin.com:dialer:previewPop"

        Required

        The JSON type representing this option.
        interactionId
        String

        Required

        The interaction ID for the call being popped.
        campaignId
        String

        Required

        ID of the campaign associated with the call.
        [key]
        String

        Required

        The key identifying this pair.
        [value]
        String

        Required

        The value of this pair.
        autoDisconnectOnDisposition
        Boolean

        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.
        allowAgentCallbacks
        Boolean

        Required

        Specifies if this call can be dispositioned as rescheduled for a specific agent.
        preview
        0
        This is a preview call.
        ownAgentCallback_Preview
        1
        This is an agent-owned callback from a preview campaign.
        callPlaced
        Boolean

        Required

        Indicates whether Dialer has been requested to place the preview call. If true, attempts to call the place-preview-call method fail.
        previewTimeout
        DateTime
        If "Enable preview countdown" is configured for the campaign, the 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.
        allowSkip
        Boolean

        Required

        Indicates whether the agent is allowed to skip this preview call. To skip a preview call, call the disposition method with a wrapup label of "Skipped - Agent Skip".
        Associated Message
        This message occurs when the agent is automatically logged in to a campaign via a rule or by a supervisor.
        autoLoginMessage
        Property
        Value
        Comments
        __type
        "urn:inin.com:dialer:autoLoginMessage"

        Required

        The JSON type representing this option.
        isDelta
        Boolean

        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.

        campaignId
        String

        Required

        The ID of the campaign the agent is logged in to.
        initiatorName
        String

        Required

        This identifies the rule or supervisor who initiated the agent's campaign login.
        Associated Message
        This message notifies the user when a Dialer rule or supervisor has initiated a Dialer campaign logout request for the user. The user will receive a urn:inin.com:dialer:logoutGrantedMessage message when the logout has been granted by Dialer.
        autoLogoutMessage
        Property
        Value
        Comments
        __type
        "urn:inin.com:dialer:autoLogoutMessage"

        Required

        The JSON type representing this option.
        isDelta
        Boolean

        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.

        campaignIds
        List [1,*]: String

        Required

        The list of campaign IDs for which a campaign logoff was requested.
        initiatorName
        String

        Required

        This identifies the rule or supervisor who initiated the agent's campaign logout request.
        Associated Message
        If the Outbound Dialing server restarts, this message will be sent to the client to inform the client to log off and log on again.
        Feature Version
        dialer 3
        outboundServerConnectionStateChangeMessage
        Property
        Value
        Comments
        __type
        "urn:inin.com:dialer:outboundServerConnectionStateChangeMessage"

        Required

        The JSON type representing this option.
        isDelta
        Boolean

        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.

        none
        0
        up
        1
        down
        2
        none
        0
        up
        1
        down
        2
        reason
        String

        Required

        A description of the condition that caused the change in connection state.
        400 - Bad Request
        An error occurred while attempting to log in to the campaign.

        Error Responses

        Error Identifier
        Error Type
        Error Description
        error.request.dialer.campaignLogonError
        Type: urn:inin.com:dialer:campaignLogonError
        There was an error logging into the campaign.
        error
        Provides additional detail for an error.
        Property
        Value
        Comments

        Multiple options:

        The value can be assigned any of the following options.
        errorId
        String
        The error identifier that describes the current error.
        message
        String

        Required

        A message that describes the current error.
        __type
        "urn:inin.com:dialer:campaignLogonError"

        Required

        The JSON type representing this option.
        errorId
        String
        The error identifier that describes the current error.
        message
        String

        Required

        A message that describes the current error.
        UnknownError
        0
        WrongWorkgroup
        1
        The agent is not a member of or is not active in the workgroup associated with the requested campaign.
        CampaignNotFound
        2
        The specified campaign ID could not be found.
        CampaignStopping
        3
        The requested campaign is not accepting logons. It is shutting down.
        403 - Forbidden
        Neither the agent nor the station the agent is logged in to has a Dialer Add-on License available, or the agent is trying to log in to a specific campaign without the "Logon Campaign" security right.
        error
        Provides additional detail for an error.
        Property
        Value
        Comments
        errorId
        String
        The error identifier that describes the current error.
        message
        String

        Required

        A message that describes the current error.
        401 - Unauthorized
        The specified session token is missing, invalid, or has expired.
        Parameters
        Type
        Name
        Comments
        Header
        WWW-Authenticate

        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"

          error
          Provides additional detail for an error.
          Property
          Value
          Comments
          errorId
          String
          The error identifier that describes the current error.
          message
          String

          Required

          A message that describes the current error.
          410 - Gone
          This resource has been deprecated and removed from the API.
          error
          Provides additional detail for an error.
          Property
          Value
          Comments
          errorId
          String
          The error identifier that describes the current error.
          message
          String

          Required

          A message that describes the current error.
          500 - Internal Server Error
          An unexpected error occurred while processing the request.
          error
          Provides additional detail for an error.
          Property
          Value
          Comments
          errorId
          String
          The error identifier that describes the current error.
          message
          String

          Required

          A message that describes the current error.