# 打开客服会话(选接)
# 接口说明
用于打开BC客服会话。
sdkInstance.openCustomerServiceConversation(options);
最低基础库版本要求
当用户客户端基础库版本过低时,调用 sdkInstance.openCustomerServiceConversation(options)
接口将中断用户当前操作并弹出升级提示,不会报错!
# 参数说明
参数说明如下表所示:
选项 | 类型 | 必填 | 默认值 | 说明 |
---|---|---|---|---|
sellerNickname | string | 是 | -- | 卖家昵称 |
forceH5 | boolean | 否 | false | 是否打开H5类型的页面 |
params | object | 否 | {} | 附加参数 |
params.itemId | string | 否 | -- | 商品ID,用来指定BC会话窗口要展示的商品;注意,这里的商品ID指的是在淘宝测注册的商品ID,一般为纯数字ID |
success | function | 否 | -- | 打开成功的回调函数 |
fail | function | 否 | -- | 打开失败的回调函数,返回错误信息 |
complete | function | 否 | -- | 打开完成的回调函数,成功或失败均会调用 |
# 返回值说明
WARNING
返回值格式:JSON
格式。
选项 | 类型 | 说明 |
---|---|---|
code | number | 响应状态码,为 0 时表示打开成功,其他非 0 状态码均表示打开失败 |
data | object / null | 打开失败时返回 null |
message | string | 打开成功或失败时的相应描述信息 |
# 示例代码
注:示例代码中的参数或选项均为演示数据,仅供参考,谢谢!
// 当用户客户端基础库版本过低时,调用此接口将中断用户当前操作并弹出升级提示,不会报错!
sdkInstance.openCustomerServiceConversation({
sellerNickname: "xxxxxxxxxx",
forceH5: false,
success: function(response) {
console.log(response);
},
fail: function(error) {
sdkInstance.modal.message(error.message);
},
complete: function(result) {
// do something here...
}
});