频道相关

更新时间: 2023/03/28 02:20:10

创建频道

  • callEx:呼叫并加入频道: 创建一个频道, 己方加入,并邀请对方加入音视频的频道。注: 组合接口, 等效于 create 创建频道 + join 加入频道 + invite 邀请他人进入频道
  • 示例代码
jslet params = {
  type: 1,
  toAccid: 'OTHER_ACCOUNT_ID',
  requestId: 'xxx'
}
try {
  const data = await nim.signaling.callEx(params)
  const channelInfo = data.channelInfo
  console.warn('创建频道成功,data:', data, 'channelId 为', channelInfo.channelId, 'name 为', channelInfo.name)
} catch (error) {
  console.warn('创建频道失败,error:', error)
  if (error.code == 10405) {
    console.warn('频道已存在,请勿重复创建')
  }
}

关闭频道

  • close:该接口可以由创建者和频道内所有成员调用,无权限限制。调用该接口成功后,其他所有频道内的成员都会收到频道结束的通知,被动离开频道。此时其他成员不需要调用离开接口,也不会收到别人的离开通知。
  • 示例代码
js// 注意 channelId 是上文 callEx 创建时得到的
let params = {
  channelId: 'CHANNEL_ID'
}
try {
  await nim.signaling.close(params)
  console.warn('关闭频道成功')
} catch (error) {
  console.warn('关闭频道失败,error:', error)
  if (error.code == 10406) {
    console.warn('不在频道内,无法关闭')
  }
}

离开频道

  • leave:该接口用于自己退出频道,但不对频道进行销毁,频道中的其他人会收到该账号离开频道的通知
  • 示例代码
jslet params = {
  channelId: 'CHANNEL_ID'
}
try {
  await nim.signaling.leave(params)
  console.warn('离开频道成功')
} catch (error) {
  console.warn('离开频道失败,error:', error)
  if (error.code == 10406) {
    console.warn('不在频道内')
  }
}

查询频道信息

  • queryInfo:该接口根据频道名称查询频道里的用户信息
  • 示例代码
js// name 为上文 callEx 创建时得到的 name
let params = {
  name: 'CHANNEL_NAME'
}
try {
  let data = await nim.signaling.queryInfo(params)
  console.warn('查询频道信息成功,data:', data)
} catch (error) {
  console.warn('查询频道信息失败,error:', error)
  if (error.code == 10404) {
    console.warn('频道不存在')
  }
}
此文档是否对你有帮助?
有帮助
去反馈
  • 创建频道
  • 关闭频道
  • 离开频道
  • 查询频道信息