# Function: joinVoIPChat
▸ joinVoIPChat(params?: JoinVoIPChatParams): Promise‹JoinVoIPChatRes›
加入 (创建) 实时语音通话
description
更多信息可见 {@link 实时语音指南 (opens new window)}
todo 更新上面文档的链接(目前仍使用的是 wx 文档)
# 参数:
| 属性 | 类型 | 描述 |
|---|---|---|
params? | JoinVoIPChatParams | 加入 (创建) 实时语音通话入参，有乐平台无需该参数 |
JoinVoIPChatParams
| 属性 | 类型 | 描述 |
|---|---|---|
groupId | string | 小游戏内此房间/群聊的 ID。 同一时刻传入相同 groupId 的用户会进入到同个实时语音房间。 |
handsFree? | boolean | 语音通话是否免提 |
muteConfig | MuteConfig | 静音设置 |
nonceStr | string | 验证所需的随机字符串 |
signature | string | 签名，用于验证小游戏的身份 |
timeStamp | number | 验证所需的时间戳 |
complete? | Method | 接口调用结束的回调函数（调用成功、失败都会执行） |
fail? | Method | 接口调用失败的回调函数 |
success? | Method | 接口调用成功的回调函数 |
# 返回值:
Promise‹JoinVoIPChatRes›