Login

Overview

The Login API allows a user to sign into the CTI server. If the login response is successful, the user is signed into softphone and is automatically placed in the NOT_READY state.

If five consecutive sign-ins fail due to incorrect credentials, Acqueon Workspace blocks access to the user account for a period of 5 minutes.

If a user is already signed in and tries to log in to Acqueon Workspace using the API, the user is signed in again and keeps the current state provided the credentials are correct. For example, if a user signs in, changes state to Ready, and then signs in again, the user remains in Ready state.

Pre-requisite

The Agent must register to a Cisco channel.

Sequence Diagram

Message Structure

Data Parameters

Response Parameters

Sample Request

{
    "channel": "Cisco",
    "topic": "Agent",
    "subtopic": "SetUserInfo",
    "data": {
        "username": "102312778",
        "password": "pqsup1",
        "extension": "5069"
    }
}

Sample Response

The following APIs are triggered in the request to SetUserInfo API:

• OpenConnection

• SetConnectionStatus

• SetAgentState

• Login

• GetAppState

• CallsStateChange

• SetMRDList

• GetMedia

• SetSystemInfo

• SetMappedMRD

• Map

• SetLogOutReasonCodes

• SetNotReadyReasonCodes

• SetPhoneBook

• SetWrapupCode