电话条ui-sdk api设计

更新日志

版本号	时间	说明
---	---	---
6.2.0	2022-05-26	初始版本。
---	---	---

ui-sdk插件引用地址

<script type="text/javascript" src="https://static.soboten.com/call-bar/6.3.1/tel-bar-sdk.js"></script>

初始化

● 电话条初始化

    window.sobotAgent.initTelBar({
        id: 'root',
        token: "xxxxxxxxx",
        companyId: "xxxxxxxxx",
        agent: "1000", //座席ID
        agentType: "0",
        themeColor:{
            showLeftLine: true,
            showRightLine: true,
            light: "#ffffff",
            dark: "#515A7C",
            darkContent: "#434A66",
        },
        appConfig:{
            placement: 'right' //辅助功能位置
            showQueueInfo: true, //技能组排队信息
            showNetDelayInfo: true, // 网络延迟信息
        },
        actionConfig:{
            transfer: true, //转移
            consult: true, //咨询
            keepContinue: true, //保持（包含取消保持）
            stillVoice: true, //静音（包含取消静音)
            sendSatisfaction: true, //发送满意度
            extendBtn: true //是否显示延长按钮
            extendFinishTime: 60, //延长整理时长，默认60
        },
        settingConfig:{
            readOnlyExt: false,
            showUnbind: true
        }
    })

请求参数params说明

属性	名称	类型	可空	说明
token	登录鉴权	string	否	座席登录鉴权（对接token方式请参照智齿接口认证文档）
companyId	公司编码	string	否	公司编码
agent	座席	string	否	座席工号 或 座席id。
agentType	接口座席参数类别	string	否	0：座席工号；1：座席id；为空时默认为座席工号。
id	电话条位置	string	否	电话条在页面中的位置。例如：'root'，则电话条会展示在id为root的元素内。
themeColor	电话条样式配置	object	是	自定义电话条的样式（例如背景颜色、分割线等）。 为空时，使用系统推荐的默认配置。见下表1
appConfig	辅助功能配置	object	是	电话条是否需要显示辅助功能（网络延时、排队人数等），以及自定义辅助功能。 为空时，默认不显示。见下表2
actionConfig	电话功能配置	object	是	自定义电话功能。 为空时，使用系统推荐的默认配置。见下表3
settingConfig	设置功能配置	object	是	自定义设置功能。 为空时，使用系统推荐的默认配置。见下表4

表1 themeColor参数说明

属性	名称	类型	可空	说明
showLeftLine	左侧分割线	boolean	是	电话条（含辅助功能区域）最左侧是否需要显示分割线。 false：隐藏；true：显示。 默认隐藏。
showRightLine	右侧分割线	boolean	是	电话条（含辅助功能区域）最右侧是否需要显示分割线。 false：隐藏；true：显示。 默认隐藏。
light	未通话时UI背景色	string	是	未通话时UI背景颜色（RGB颜色）。 为空时，默认#FFFFFF。
dark	通话中主区域背景色	string	是	通话中电话条主区域的背景颜色（RGB颜色）。 为空时，默认#515A7C。
darkContent	通话中扩展区背景色	string	是	通话中电话条扩展区域的背景颜色（RGB颜色）。 为空时，默认#434A66。

表2 appConfig参数说明

属性	名称	类型	可空	说明
placement	显示位置	string	是	辅助功能显示在电话条的左侧还是右侧。 left：电话条左侧；right：电话条右侧。
showQueueInfo	查看排队人数	boolean	是	是否显示该功能图标。 false：隐藏；true：显示。 默认显示。
showNetDelayInfo	查看网络延时	boolean	是	是否显示该功能图标，改图标仅限接听方式为网页电话时可见。 false：隐藏；true：显示。 默认显示。

表3 actionConfig参数说明

属性	名称	类型	可空	说明
transfer	转移	boolean	是	是否显示操作按钮。 false：隐藏；true：显示。 为空时，默认显示。
consult	咨询	boolean	是	是否显示操作按钮。 false：隐藏；true：显示。 为空时，默认显示。
keepContinue	保持（包含取消保持）	boolean	是	是否显示操作按钮。 false：隐藏；true：显示。 为空时，默认显示。
stillVoice	静音（包含取消静音）	boolean	是	是否显示操作按钮。 false：隐藏；true：显示。 为空时，默认显示。
sendSatisfaction	发送满意度	boolean	是	是否显示操作按钮。 false：隐藏；true：显示。 为空时，默认显示。
extendBtn	延长整理时长	boolean	是	是否显示操作按钮。 false：隐藏；true：显示。 为空时，默认显示。
extendFinishTime	延长时间	number	是	配置后每次按此时间延长整理。 30-900秒。 为空时，默认60秒。

表4 settingConfig参数说明

属性	名称	类型	可空	说明
readOnlyExt	修改分机号	boolean	是	修改坐席绑定的分机号。 false：可改；true：只读。 为空时，默认可改。
showUnbind	离线后自动解绑	boolean	是	UI是否显示该功能。 false：隐藏；true：显示。 为空时，默认显示。

呼叫操作

● 外呼

//需要在电话条初始化后才能执行
window.sobotAgent.makeCall({
    otherDN: "133****3333",
    privacyNumber: "XFHAOWHFEFLASJLKWJLD",
    userData: {}
})

请求参数

属性	名称	类型	可空	说明
otherDN	客户号码	string	否	UI显示的客户号码。
privacyNumber	客户号码加密	string	是	支持加密号码外呼；例如：XFHAOWHFEFLASJLKWJLD；
userData	自定义数据	object	是	在电话事件中会返回该值。 在通话记录中会存储该值。 需要encodeURIComponent编码