Call Web-JS SDk

​

Precautions:

• It is recommended to use Chrome browser first. It is not supported for use in mobile H5 pages. This version has only been fully tested for PC browsers. There may be unknown compatibility issues when used in mobile H5 pages.
• Since softphones need to rely on the WebRTC capabilities provided by the browser, when using softphones, it is recommended to use browsers with better support for WebRTC, such as Chrome or Firefox browsers.
• Integrating the SDK requires the use of the HTTPS protocol.
• Chrome browser needs to enable microphone and sound permissions. Firefox browser needs to enable microphone and speaker permissions.
• When using in an iFrame, the iframe needs to add an allow attribute. iframe.allow = “midi;encrypted-media;microphone *;camera *;“Only in this way can the relevant capabilities of WebRTC be used in the iframe.

​

javascript-sdk plug-in reference URL

Note: When using the SDK, please add the sysnum parameter in the following way. The sysnum corresponds to the enterprise ID of Sobot (which can be viewed in Sobot management background => Management Center => Account Management => Enterprise Account => Enterprise Information). Do not download the SDK code to the local area and use it on your own server to avoid being unable to obtain SDK updates in the future, resulting in the unavailability of the SDK.

<script type="text/javascript" src="https://sg.sobot.io/call-sdk/6.4.0/sobot-call-sdk.js?sysnum=Your enterprise ID"></script>

​

Initialization

​

● Initialize Plug-in

The first step for using the JavaScript SDK is to create an example

    const agent = new SobotClient.agent()

The second step is to initialize

    agent.initAgent({
        token: 'xxxxxxxxxxxx',
        companyId: 'xxxxxxxxxxxxxx',
        agent: " 1005 ",
        agentType: " 0 ",
        allowStorageListen: true,
        success: function (msg){
            console.log('new Client success : ', msg)
        },
        error: function (msg){
            console.log('new Client error : ', msg)
        }
    })
    // When the initialization succeeds, msg will be returned to success callback function, and the status in msg is success. See Table 1 below for the params

    // If the agent is not offline in the Sobot system before logging in, and subscribes to the EventAgentRegainStatus agent re-connection success event or subscribes to all agent events through EventAgentAll in the second event subscription step, after successful initialization, the agent will receive the EventAgentRegainStatus message from where it subscribed to the event. This message indicates that the agent has successfully reconnected, and it will carry the current agent's login status and call status for restoring the page. See Table 2 below for the params

Table 1 Initialization request param description

Request param

Return value of success callback function

Return value of failure callback function

Table 2 EventAgentRegainStatus event param description

Table 3 agentStateInfo event param description

Table 4 workStatusInfo event param description

DNRole description

    Unknown(0, ""),
    Origination(1, "Caller")
    Destination(2, "Called")
    AddedBy(3, "Attendee")
    NewParty(4, "Party added in the meeting")
    DeletedBy(5, "Party deleting others from the meeting")
    DeletedParty(6, "Party quitting from the meeting")
    ObserveBy(7, "Monitor")
    TransferBy(8, "Transfer initiator")
    ConsultBy(9, "Inquirer")
    BargeinBy(10, "Interrupt initiator")
    BargeinTo(11, "Interrupted")
    InterceptTo(12, "Taken-away")
    TransferTo(13, "Transferred")
    ObserveTo(14, "Monitored")
    InterceptBy(15, "Takeaway initiator")
    ConferenceBy(16, "")

The third step is to subscribe to the required talk events and events related to the agent status changes (choose either one of example 1 or 2. If they are both used, you will receive the event push from the two)

Example 1: Monitor all agent related events

    agent.on('EventAgentAll', function (msg) {
        // Perform logical processing according to messageID in msg
        switch(msg.messageID) {
            case 'EventAgentConnectionChanged' :
                // Agent enforced offline event
                // do something ...
                break
            case 'EventAgentReady' :
                // Agent ready event
                // do something ...
                break
            case 'EventAgentNotReady' :
                // Agent occupied event
                // do something ...
                break
            case 'EventTokenInvalid' :
                // Agent token is invalid.
                // Call the method for obtaining the token in your code to obtain the token again. After successful acquisition, call handleRefreshToken to update the token of the SDK.
                // window.sobotAgent.handleRefreshToken(newToken)
                // Note:
                // 1. After the token expires, if the method for refreshing the token is not called, calls can still be made, but HTTP interfaces cannot be called.
                // 2. After the EventTokenInvalid event is triggered, it will wait for 10 seconds to obtain a new token. During this period, the issued HTTP requests will be cached. After writing the new token, the cached requests will be reissued. If it exceeds 10 seconds without setting, the cache will be cleared and the EventTokenInvalid event will be triggered again.
                // 3. If you do not need to use handleRefreshToken to automatically update the token, it is recommended to add a pop-up prompt in EventTokenInvalid to prompt the agent that the current token has expired. You can refresh the page or perform other operations that can obtain the token again.
                break
            default: 
                //  do something ...
        }
    })

Example 2: Monitor the required agent related events (refer to Call Capability Message Format File for the complete events)

    // Perform chaining call
    agent
        .on('EventAgentRegainStatus', function (msg) {
            // Agent re-connection success event
            // do something ...
        })
        .on('EventAgentConnectionChanged', function (msg) {
            // Agent enforced offline event
            // do something ...
        })
        .on('EventAgentReady', function (msg) {
            // Agent ready event
            // do something ...
        })
        .on('EventAgentNotReady', function (msg) {
            // Agent occupied event
            // do something ...
        })
        .on('EventDialing', function (dialingMsg) {
            // dialingMsg -- Dialing event
            // do something ...
        })
        .on('EventRinging', function (ringingMsg) {
            // ringingMsg -- Ringing event
            // do something ...
        })
        ...

Method to unsubscribe events

    // Unsubscribe the events after subscription
    agent
        .off('EventAgentConnectionChanged')
        .off('EventAgentReady')
        ...
    // agent.off method provides two parameters, such as: agent.off(eventName, functionName)
    // eventName refers to the name of the event you subscribed, and functionName is the name of execution function you defined. The same event can be subscribed multiple times and cancelled independently. If the off method is passed only eventName, then all subscribed functions will be cancelled. The methods are as follows:
    function test1 (msg) {
        // Agent ready event for the first subscription
        // do something ...
    }
    function test2 (msg) {
        // Agent ready event for second subscription
        // do something ...
    }
    agent
        .on('EventAgentReady', test1)
        .on('EventAgentReady', test2)
    
    // Methods to unsubscribe are as follows:
    // Unsubscribe test1 individually
    agent.off('EventAgentReady', test1)
    // Unsubscribe test2 individually
    agent.off('EventAgentReady', test2)
    // Or unsubscribe all agent ready events
    agent.off('EventAgentReady')

​

Login Operation

​

● Login

1. The return value of this API will continue to increase its attributes. Please use the correct compatible coding method to ensure that the code of the calling end will not throw errors when the return value attributes are increased!
2. The system obtains the latest agent work no. in this API. In case of any work no. change, please log in again, so that the changed work no. will take effect.
3. Calling the login API from one end will cause the disconnection of the other end (not agent offline);
4. Login is available when agent server status = offline, online and all other status. However, it is unavailable when the work status on the agent server = calling, dialing, talking, holding and sorting.

Example:

    agent.login(
        {
            agentState: '2' ,
            phoneType: "webrtc",
            bindExt: " 1000 ",
            bindMobile: ' 13333333333 ',
            unbindExtOnLogout: false,
            success: function(event) {
                // do something ...
            },
            error: function(cause) {
                // Error, can't go on...
            },
        }
    )

Request param

Return value of success callback function

Return value of failure callback function

​

● Logout

1. The return value of this API will continue to increase its attributes. Please use the correct compatible coding method to ensure that the code of the calling end will not throw errors when the return value attributes are increased!
2. It is only available when agent work status is ready, occupied or locking. Otherwise, it is unavailable.

Example:

    agent.logout(
        {
            success: function(event) {
                // do something ...
            },
            error: function(cause) {
                // Error, can't go on...
            },
        }
    )

Request param

Return value of success callback function

Return value of failure callback function

​

● Occupied

1. The return value of this API will continue to increase its attributes. Please use the correct compatible coding method to ensure that the code of the calling end will not throw errors when the return value attributes are increased!

Example:

    agent.notReady(
        {
            reasonCode: 11 ,
            success: function(event) {
                // do something ...
            },
            error: function(cause) {
                // Error, can't go on...
            },
        }
    )

Request param

Return value of success callback function

Return value of failure callback function

​

● Available

1. The return value of this API will continue to increase its attributes. Please use the correct compatible coding method to ensure that the code of the calling end will not throw errors when the return value attributes are increased!

Example:

    agent.ready(
        {
            success: function(event) {
                // do something ...
            },
            error: function(cause) {
                // Error, can't go on...
            },
        }
    )

Request param

Return value of success callback function

Return value of failure callback function

​

● Agent Reset Offline

1. The return value of this API will continue to increase its attributes. Please use the correct compatible coding method to ensure that the code of the calling end will not throw errors when the return value attributes are increased!
2. The agent can enforce to hang up the phone and log out to offline status in any login status and any call status;
3. It can be used to reset the agent to offline during the agent status exception.

Example:

    agent.resetLogout(
        {
            success: function(event) {
                // do something ...
            },
            error: function(cause) {
                // Error, can't go on...
            },
        }
    )

Request param

Return value of success callback function

Return value of failure callback function

​

● Query Agent Login Status

1. The return value of this API will continue to increase its attributes. Please use the correct compatible coding method to ensure that the code of the calling end will not throw errors when the return value attributes are increased!
2. Query only the break status and custom break status set available to the agent.

Example:

    agent.queryStates(
        {
            success: function(event) {
                // do something ...
            },
            error: function(cause) {
                // Error, can't go on...
            },
        }
    )

Request param

Return value of success callback function

Table 1 states login status list

Return value of failure callback function

​

● Query Agent Answering Method

1. The return value of this API will continue to increase its attributes. Please use the correct compatible coding method to ensure that the code of the calling end will not throw errors when the return value attributes are increased!
2. Query the answering method set for which the agent has permission, and return the default answering method (in the admin console, setting the UI to modify the agent answering method permission will reset the default answering method).

Example:

    agent.queryPhoneType(
        {
            success: function(event) {
                // do something ...
            },
            error: function(cause) {
                // Error, can't go on...
            },
        }
    )

Request param

Return value of success callback function

Table 1 phoneTypes answering method list

Return value of failure callback function

​

● Query Enterprise Extension List

1. The return value of this API will continue to increase its attributes. Please use the correct compatible coding method to ensure that the code of the calling end will not throw errors when the return value attributes are increased!

Example:

    agent.queryUnusedExts(
        {
            currPage: 1,
            pageSize: 50,
            ext: '0001',
            success: function(event) {
                // do something ...
            },
            error: function(cause) {
                // Error, can't go on...
            },
        }
    )

Request param

Return value of success callback function

Table 1 exts description

Return value of failure callback function

​

● Query skill groups the agent can log in

1. The return value of this API will continue to increase its attributes. Please use the correct compatible coding method to ensure that the code of the calling end will not throw errors when the return value attributes are increased!
2. Query the call skill group of the agent that can be used for logging in. When “Call Function Setting\Agents select skill groups manually to log in” settings are enabled, data is returned according to the skill group configured by the agent. If the settings are not enabled, returned skill group data is blank (at this time, there is no need to pass skill group for logging in. The system will pass all skill groups added by the agent).

Example:

    agent.queryAgentJoinedQueues(
        {
            success: function(event) {
                // do something ...
            },
            error: function(cause) {
                // Error, can't go on...
            },
        }
    )

Request param

Return value of success callback function

Table 1 queues list of skill groups joined

Return value of failure callback function

​

● Query agent login info

1. The return value of this API will continue to increase its attributes. Please use the correct compatible coding method to ensure that the code of the calling end will not throw errors when the return value attributes are increased!

Example:

    agent.queryAgentLoginInfo(
        {
            success: function(event) {
                // do something ...
            },
            error: function(cause) {
                // Error, can't go on...
            },
        }
    )

Request param

Return value of success callback function

Table 1 phoneTypes answering method list

Table 2 receptionQueues list of receiving skill groups

Return value of failure callback function

​

● Query agent login data

1. The return value of this API will continue to increase its attributes. Please use the correct compatible coding method to ensure that the code of the calling end will not throw errors when the return value attributes are increased!

Example:

    agent.queryAgentCanJoinedInfo(
        {
            success: function(event) {
                // do something ...
            },
            error: function(cause) {
                // Error, can't go on...
            },
        }
    )

Request param

Return value of success callback function

Table 1 info

Table 2 phoneTypes answering method list

Table 3 checkableQueues list of skill groups joined

Table 4 Login status list

Return value of failure callback function

​

Call Operation

​

● Outbound

1. The return value of this API will continue to increase its attributes. Please use the correct compatible coding method to ensure that the code of the calling end will not throw errors when the return value attributes are increased!

Example:

    agent.makeCall(
        {
            otherDN: " 133****3333 ",
            privacyNumber: "XFHAOWHFEFLASJLKWJLD",
            ANI: " 01066666666 ",
            agentANI: " 01088888888 ",
            outboundRouteType: " 1 ",
            outboundPlanCode: "xxxxxxxxxxxxx",
            userData: {},
            success: function(event) {
                // do something ...
            },
            error: function(cause) {
                // Error, can't go on...
            },
        }
    )

Request param

​

● Reject

1. The return value of this API will continue to increase its attributes. Please use the correct compatible coding method to ensure that the code of the calling end will not throw errors when the return value attributes are increased!

Example:

    agent.rejectCall(
        {
            success: function(event) {
                // do something ...
            },
            error: function(cause) {
                // Error, can't go on...
            },
        }
    )

​

● Answer

1. The return value of this API will continue to increase its attributes. Please use the correct compatible coding method to ensure that the code of the calling end will not throw errors when the return value attributes are increased!

Example:

    agent.answer(
        {
            success: function(event) {
                // do something ...
            },
            error: function(cause) {
                // Error, can't go on...
            },
        }
    )

​

● Hang up

1. The return value of this API will continue to increase its attributes. Please use the correct compatible coding method to ensure that the code of the calling end will not throw errors when the return value attributes are increased!

Example:

    agent.hangup(
        {
            success: function(event) {
                // do something ...
            },
            error: function(cause) {
                // Error, can't go on...
            },
        }
    )

​

● Hold

1. The return value of this API will continue to increase its attributes. Please use the correct compatible coding method to ensure that the code of the calling end will not throw errors when the return value attributes are increased!
2. After temporarily hanging up the talk between the agent and the customer and holding, the customer will hear holding sound and the agent’s side is muted.
3. This operation supports 3 kinds of answering methods, including SIP phone; web page; cell phone.

Example:

    agent.holdCall(
        {
            success: function(event) {
                // do something ...
            },
            error: function(cause) {
                // Error, can't go on...
            },
        }
    )

​

● Cancel Call Holding

1. The return value of this API will continue to increase its attributes. Please use the correct compatible coding method to ensure that the code of the calling end will not throw errors when the return value attributes are increased!
2. After resuming the hung-up talk between the agent and the customer and canceling the hold, the talk resumes as normal.

Example:

    agent.retrieveCall(
        {
            success: function(event) {
                // do something ...
            },
            error: function(cause) {
                // Error, can't go on...
            },
        }
    )

​

● Mute

1. The return value of this API will continue to increase its attributes. Please use the correct compatible coding method to ensure that the code of the calling end will not throw errors when the return value attributes are increased!
2. Turn off the operation agent’s MIC so that no one else can hear the current agent. E.g.: When agent A inquires agent B, both agents can mute their MIC.
3. This operation is unavailable to the monitor initiator (the initiator’s MIC keeps off during the monitoring).
4. This operation supports 3 kinds of answering methods, including SIP phone; web page; cell phone.

Example:

    agent.muteCall(
        {
            success: function(event) {
                // do something ...
            },
            error: function(cause) {
                // Error, can't go on...
            },
        }
    )

​

● Unmute

1. The return value of this API will continue to increase its attributes. Please use the correct compatible coding method to ensure that the code of the calling end will not throw errors when the return value attributes are increased!
2. Unmute the MIC on the agent side, allowing others to resume normal talks with the agent.

Example:

    agent.unmute(
        {
            success: function(event) {
                // do something ...
            },
            error: function(cause) {
                // Error, can't go on...
            },
        }
    )

​

● Transfer

1. The return value of this API will continue to increase its attributes. Please use the correct compatible coding method to ensure that the code of the calling end will not throw errors when the return value attributes are increased!
2. Make direct call transfer of the customer to another skill group/another agent/phone number/extension number, and hang up the current agent’s call after successful operation. If the relay number has only 1 concurrent channel and the only channel is occupied by an inbound call, the number cannot be transferred to a third-party phone number (the transferred call will fail).

Example:

    agent.singleTransfer(
        {
            targetType: " 0 ",
            target: " 1002 ",
            success: function(event) {
                // do something ...
            },
            error: function(cause) {
                // Error, can't go on...
            },
        }
    )

Request param

​

● Inquiry

1. The return value of this API will continue to increase its attributes. Please use the correct compatible coding method to ensure that the code of the calling end will not throw errors when the return value attributes are increased!
2. Before inviting a third party (agent/3rd-party number) to join the current talk, inquire the third party and ask if it wants to join the talk.
3. If the relay number has only 1 concurrent channel and the only channel is occupied by an inbound call, the number cannot be used to inquire a third-party phone number (the inquired call will fail).

Example:

    agent.initiateConsult(
        {
            targetType: " 0 ",
            target: " 1002 ",
            success: function(event) {
                // do something ...
            },
            error: function(cause) {
                // Error, can't go on...
            },
        }
    )

Request param

​

● Inquiry Cancellation

1. The return value of this API will continue to increase its attributes. Please use the correct compatible coding method to ensure that the code of the calling end will not throw errors when the return value attributes are increased!
2. The initiator can cancel the inquiry before the inquired party (the 3rd party) is connected.

Example:

    agent.cancelConsult(
        {
            success: function(event) {
                // do something ...
            },
            error: function(cause) {
                // Error, can't go on...
            },
        }
    )

​

● Retrieve After Inquiry

1. The return value of this API will continue to increase its attributes. Please use the correct compatible coding method to ensure that the code of the calling end will not throw errors when the return value attributes are increased!
2. End the talk of the third party (agent/3rd-party number) and resume the talk between the previous agent and the customer. This API is also used for scenarios including “retrieval after inquiring the third party”.

Example:

    agent.retrieveConsult(
        {
            success: function(event) {
                // do something ...
            },
            error: function(cause) {
                // Error, can't go on...
            },
        }
    )

​

● Transfer After Inquiry

1. The return value of this API will continue to increase its attributes. Please use the correct compatible coding method to ensure that the code of the calling end will not throw errors when the return value attributes are increased!
2. After inquiring a third party (agent/3rd-party number), the talk is transferred to the third party, and the talk with the previous agent ends. This API is also used for scenarios including “transfer after inquiring the third party”.

Example:

    agent.consultTransfer(
        {
            success: function(event) {
                // do something ...
            },
            error: function(cause) {
                // Error, can't go on...
            },
        }
    )

​

● 3rd-Party Call After Inquiry

1. The return value of this API will continue to increase its attributes. Please use the correct compatible coding method to ensure that the code of the calling end will not throw errors when the return value attributes are increased!
2. After inquiring the third party (agent/3rd-party number), the third party agrees to join the three-person talk, and then the previous agent adds the third party into the current talk, forming a three-party talk.

Example:

    agent.consultConference(
        {
            success: function(event) {
                // do something ...
            },
            error: function(cause) {
                // Error, can't go on...
            },
        }
    )

​

● Send Satisfaction

1. The return value of this API will continue to increase its attributes. Please use the correct compatible coding method to ensure that the code of the calling end will not throw errors when the return value attributes are increased!
2. After the agent sends satisfaction, the system disconnects all agent-side channels (including monitoring, 3rd-party, etc.), keeps the customer-side channels, plays satisfaction evaluation, and hangs up all agent-side channels.

Example:

    agent.sendSatisfy(
        {
            success: function(event) {
                // do something ...
            },
            error: function(cause) {
                // Error, can't go on...
            },
        }
    )

​

● Extend Sorting Duration

1. The return value of this API will continue to increase its attributes. Please use the correct compatible coding method to ensure that the code of the calling end will not throw errors when the return value attributes are increased!
2. When agent call is in the sorting status, the sorting duration can be extended for 30-900s.

Example:

    agent.delayACW(
        {
            delayTime: 60,
            success: function(event) {
                // do something ...
            },
            error: function(cause) {
                // Error, can't go on...
            },
        }
    )

Request param

​

● End Sorting

1. The return value of this API will continue to increase its attributes. Please use the correct compatible coding method to ensure that the code of the calling end will not throw errors when the return value attributes are increased!
2. When agent call is in the sorting status, the status can be ended in advance.

Example:

    agent.completeACW(
        {
            success: function(event) {
                // do something ...
            },
            error: function(cause) {
                // Error, can't go on...
            },
        }
    )

​

● End Sorting and Set Occupied

1. The return value of this API will continue to increase its attributes. Please use the correct compatible coding method to ensure that the code of the calling end will not throw errors when the return value attributes are increased!
2. When agent call is in the sorting status, the status can be ended in advance and set as DND.

Example:

    agent.completeACWToBusy(
        {
            success: function(event) {
                // do something ...
            },
            error: function(cause) {
                // Error, can't go on...
            },
        }
    )

​

● Send Key

1. The return value of this API will continue to increase its attributes. Please use the correct compatible coding method to ensure that the code of the calling end will not throw errors when the return value attributes are increased!

Example:

    agent.sendDtmf(
        {
            dtmfDigits: '801#',
            success: function(event) {
                // do something ...
            },
            error: function(cause) {
                // Error, can't go on...
            },
        }
    )

Request param

​

Assistance Operation

​

● Query Agent Outbound Routing Rules

1. The return value of this API will continue to increase its attributes. Please use the correct compatible coding method to ensure that the code of the calling end will not throw errors when the return value attributes are increased!
2. After agent logs in, the outbound call routing rules set in the “Outbound Routing” of the agent can be queried.

Example:

    agent.queryRoutes(
        {
            success: function(event) {
                // do something ...
            },
            error: function(cause) {
                // Error, can't go on...
            },
        }
    )

Request param

Return value

Table 1 explicitrule display rule array description

Table 2 explicitschema display scheme array description

Table 3 explicitnumbers display number array description

Return value of failure callback function

​

● Modify Agent Outbound Routing Rules

1. The return value of this API will continue to increase its attributes. Please use the correct compatible coding method to ensure that the code of the calling end will not throw errors when the return value attributes are increased!
2. When the agent is available, the last used display rule of the agent can be switched.

Example:

    agent.setRoute(
        {
            explicitRule: " 1 ",
            explicitCode: "xxxxxxxx",
            explicitNumber: " 13333333333 ",
            success: function(event) {
                // do something ...
            },
            error: function(cause) {
                // Error, can't go on...
            },
        }
    )

Request param

Return value

Table 1 explicitrule display rule array description

Table 2 explicitschema display scheme array description

Table 3 explicitnumbers display number array description

Return value of failure callback function

​

● Query Enterprise Skill Group List

1. The return value of this API will continue to increase its attributes. Please use the correct compatible coding method to ensure that the code of the calling end will not throw errors when the return value attributes are increased!

Example:

    agent.queryQueues(
        {
            queue: 'group1',
            success: function(event) {
                // do something ...
            },
            error: function(cause) {
                // Error, can't go on...
            },
        }
    )

Request param

Return value of success callback function

Table 1 queues param description

Return value of failure callback function

​

● Query Enterprise Agent List

1. The return value of this API will continue to increase its attributes. Please use the correct compatible coding method to ensure that the code of the calling end will not throw errors when the return value attributes are increased!

Example:

    agent.queryAgents(
        {
            agentName: 'test_agent',
            agentState: ' 1 ',
            queueCode: ' 12345 ',
            success: function(event) {
                // do something ...
            },
            error: function(cause) {
                // Error, can't go on...
            },
        }
    )

Request param

Return value of success callback function

Table 1 queues param description

Return value of failure callback function

​

Supervisor Operation

​

● Enforce Logout

1. The return value of this API will continue to increase its attributes. Please use the correct compatible coding method to ensure that the code of the calling end will not throw errors when the return value attributes are increased!
2. The agent will be enforced to log out after the operation.

Example:

    agent.forceLogout(
        {
            targetAgentID: ' 1001 ',
            success: function(event) {
                // do something ...
            },
            error: function(cause) {
                // Error, can't go on...
            },
        }
    )

Request param

Return value of success callback function

Return value of failure callback function

​

● Enforce Occupied

1. The return value of this API will continue to increase its attributes. Please use the correct compatible coding method to ensure that the code of the calling end will not throw errors when the return value attributes are increased!
2. The agent will be enforced to be occupied after the operation.

Example:

    agent.forceBusy(
        {
            targetAgentID: ' 1001 ',
            success: function(event) {
                // do something ...
            },
            error: function(cause) {
                // Error, can't go on...
            },
        }
    )

Request param

Return value of success callback function

Return value of failure callback function

​

● Enforce Available

1. The return value of this API will continue to increase its attributes. Please use the correct compatible coding method to ensure that the code of the calling end will not throw errors when the return value attributes are increased!
2. The agent will be enforced to be ready after the operation.

Example:

    agent.forceReady(
        {
            targetAgentID: ' 1001 ',
            success: function(event) {
                // do something ...
            },
            error: function(cause) {
                // Error, can't go on...
            },
        }
    )

Request param

Return value of success callback function

Return value of failure callback function

​

Extension Function

​

● Query Skill Group Queuing No.

1. The return value of this API will continue to increase its attributes. Please use the correct compatible coding method to ensure that the code of the calling end will not throw errors when the return value attributes are increased!
2. Query the number of customers queuing for the skill group that the agent added.

Example:

    agent.queryCountsInQueue(
        {
            success: function(event) {
                // do something ...
            },
            error: function(cause) {
                // Error, can't go on...
            },
        }
    )

Request param

Return value of success callback function

Table 1 queues param description

Return value of failure callback function

​

● Subscribe to voice communication network quality data

1. The return value of this API will continue to increase its attributes. Please use the correct compatible coding method to ensure that the code of the calling end will not throw errors when the return value attributes are increased!
2. Only when the answering method is “web phone + SIP phone”, query the network delay from the agent to the communication service side (CTI).

Example:

    agent.on('EventJanusLatency', function (msg) {
        // do something
    })

Return value of success callback function