Call Capability (UI Phone Bar)

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.

ui-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.com/call-bar/6.3.2/tel-bar-sdk.js?sysnum=Your enterprise ID"></script>

Initialization

● Phone Bar Initialization

    window.sobotSccAgent.initTelBar({
        id: 'root',
        token: "xxxxxxxxx",
        companyId: "xxxxxxxxx",
        agent: " 1000 ", // Agent ID
        agentType: " 0 ",
        themeColor:{
            light: "#ffffff",
            dark: "#515A7C",
            darkContent: "#434A66",
        },
        appConfig:{
            showNetDelayInfo: true, // Network delay info
        },
        actionConfig:{
            transfer: true, // Transfer
            consult: true, // Inquiry
            keepContinue: true, // Hold (and cancel holding)
            stillVoice: true, // Mute (and unmute)
            extendBtn: true // Whether to display the Extend button
            acwToBusy: true, // End sorting and set occupied
            extendFinishTime: 60 , // Extend sorting duration, 60 by default
        },
        settingConfig:{
            readOnlyExt: false,
            showUnbind: true
        }
    })

Request Param params Description

Attribute	Name	Type	Nullable	Description
token	Login authentication	string	No	Agent login authentication (please refer to the Sobot API authentication file for the docking token method) Agent authorization API (agent token) should be docked
companyId	Company code	string	No	Company code
agent	Agent	string	No	Agent work no. or id.
agentType	API agent param type	string	No	0: Agent work no., 1: Agent id; Agent work no. by default when it is null.
id	Phone bar location	string	No	The location of phone bar on the page. E.g.: 'root', and the phone bar will be displayed in the element with the id as root.
themeColor	Phone bar pattern configuration	object	Yes	Customize the pattern of phone bar (e.g.: background color, separator, etc.). When it is blank, use the default configuration recommended by the system. See Table 1 below
appConfig	Assistance function configuration	object	Yes	Whether the phone bar needs to display and customize assistance functions (network delay, number of queuing customers, etc.). When it is blank, not display by default. See Table 2 below
actionConfig	Phone function configuration	object	Yes	Customize phone functions. When it is blank, use the default configuration recommended by the system. See Table 3 below
settingConfig	Setting function configuration	object	Yes	Customize setting functions. When it is blank, use the default configuration recommended by the system. See Table 4 below

Table 1 themeColor param description

Attribute	Name	Type	Nullable	Description
light	UI background color when no talk	string	Yes	UI background color (RGB color) when no talk. When it is blank, #FFFFFF by default.
dark	Main area background color in talk	string	Yes	Main area background color (RGB color) of phone bar in talk. When it is blank, #515A7C by default.
darkContent	Extension area background color in talk	string	Yes	Extension area background color (RGB color) of phone bar in talk. When it is blank, #434A66 by default.

Table 2 appConfig param description

Attribute	Name	Type	Nullable	Description
showNetDelayInfo	View the network delay	boolean	Yes	Whether to display the function icon. The icon is only visible when the answering method is web phone. false: Hide, true: Display. Display by default.

Table 3 actionConfig param description

Attribute	Name	Type	Nullable	Description
transfer	Transfer	boolean	Yes	Whether to display the operation button. false: Hide, true: Display. When it is blank, display by default.
consult	Inquiry	boolean	Yes	Whether to display the operation button. false: Hide, true: Display. When it is blank, display by default.
keepContinue	Hold (and cancel holding)	boolean	Yes	Whether to display the operation button. false: Hide, true: Display. When it is blank, display by default.
stillVoice	Mute (and unmute)	boolean	Yes	Whether to display the operation button. false: Hide, true: Display. When it is blank, display by default.
extendBtn	Extend sorting duration	boolean	Yes	Whether to display the operation button. false: Hide, true: Display. When it is blank, display by default.
acwToBusy	End sorting and set occupied	boolean	Yes	Whether to display the operation button. false: Hide, true: Display. When it is blank, display by default.
extendFinishTime	Extended time	number	Yes	Extend the sorting each time after configuration. 30-900s. When it is blank, 60s by default.

Table 4 settingConfig param description

Attribute	Name	Type	Nullable	Description
readOnlyExt	Modify extension no.	boolean	Yes	Modify Agent bind Ext. No 。 false: Modifiable: true: Read only. When it is blank, modifiable by default.
showUnbind	Unbind automatically after offline	boolean	Yes	Whether the UI displays the function. false: Hide, true: Display. When it is blank, display by default.

Call Operation

● Outbound

// Execute only after phone bar initialization
window.sobotAgent.makeCall({
    otherDN: " 133****3333 ",
    privacyNumber: "XFHAOWHFEFLASJLKWJLD",
    userData: {}
})

Request param

Attribute	Name	Type	Nullable	Description
otherDN	Customer Phone No.	string	No	Customer number displayed by UI.
privacyNumber	Customer no. encryption	string	Yes	Support making outbound calls with encrypted number; e.g.: XFHAOWHFEFLASJLKWJLD.
userData	Custom Data	object	Yes	Return the value in the call event. Store the value in the talk record. encodeURIComponent code is required