抖音开放平台Logo
开发者文档
控制台

tt.openCustomerServiceConversation

收藏
我的收藏

基础库 2.66.1 开始支持本方法,这是一个异步方法。

平台提供的小游戏客服能力,按钮界面由开发者绘制后,点击调用该 api 可拉起客服界面

前提条件

使用抖音IM客服需要先绑定抖音号,详情请查看:抖音客服能力介绍

业务背景
使用限制

本方法仅支持抖音&抖 lite,其他宿主请使用 tt.createContactButton 接入客服

注意事项
  • 用户必须在登录状态下才能调起IM客服,否则会出现返回成功,但是前端无响应的问题
  • 该 API 必须要由用户点击触发,只能在 tt.onTouchEnd 的回调里面同步调用该 API
  • 若当前登录的用户与被绑定的抖音号相同,无法拉起 im 客服
相关教程

语法

tt.openCustomerServiceConversation(options)

参数说明

options 为 object 类型,属性如下:

属性名类型默认值必填说明最低支持版本
typenumber1

1 :小 6 客服

2 :  抖音IM 客服(仅支持抖音)

2.66.1
sessionFromstring

保留字段,暂时可以不填

2.66.1
successfunction
接口调用成功的回调函数
2.66.1
failfunction
接口调用失败的回调函数
2.66.1
completefunction
接口调用结束的回调函数(调用成功、失败都会执行)
2.66.1

回调成功

object 类型,属性如下:

属性名类型说明最低支持版本
errMsgstring
"openCustomerServiceConversation:ok"
2.66.1

回调失败

object 类型,属性如下:

属性名类型说明最低支持版本
errMsgstring
"openCustomerServiceConversation:fail" + 详细错误信息
2.66.1

代码示例

tt.openCustomerServiceConversation({ type: 2, // im 客服 success(res) { console.log(res); }, fail(res) { console.log(res); }, });