跳到主要内容
版本:3.x

Taro.join1v1Chat(option)

加入(创建)双人通话

支持情况:

参考文档

类型

(option: Option) => Promise<Promised>

参数

参数类型
optionOption

Caller

参数类型必填说明
nicknamestring昵称
headImagestring头像
openidstring小程序内 openid

Listener

参数类型必填说明
nicknamestring昵称
headImagestring头像
openidstring小程序内 openid

RoomType

参数说明
voice语音通话
video视频通话

Option

参数类型默认值必填说明
callerCaller呼叫方信息
listenerListener接听方信息
backgroundTypekeyof ColorType0窗口背景色
roomTypekeyof RoomType通话类型
minWindowTypekeyof ColorType1小窗样式
disableSwitchVoicebooleanfalse不允许切换到语音通话
complete(res: TaroGeneral.CallbackResult) => void接口调用结束的回调函数(调用成功、失败都会执行)
fail(res: TaroGeneral.CallbackResult) => void接口调用失败的回调函数
success(res: TaroGeneral.CallbackResult) => void接口调用成功的回调函数

ChatErrCode

参数说明
-20000未开通双人通话
-20001当前设备不支持
-20002正在通话中
-20003其它小程序正在通话中
-30000内部系统错误
-30001微信缺失相机权限
-30002微信缺失录音权限
-30003小程序缺失录音权限
-30004小程序缺失相机权限
-1当前已在房间内
-2录音设备被占用,可能是当前正在使用微信内语音通话或系统通话
-3加入会话期间退出(可能是用户主动退出,或者退后台、来电等原因),因此加入失败
-1000系统错误

FailCallbackResult

参数类型说明
errMsgstring错误信息
errCodekeyof ChatErrCode错误码

SuccessCallbackResult

参数类型说明
errCodenumber错误码
errMsgstring调用结果

Promised

FailCallbackResult | SuccessCallbackResult