浏览 SDKs · React Native
平台
SDKsReact Native商业版

发起群聊通话

使用 OpenIM React Native SDK 发起群聊音视频通话。

复制

调用 signalingInviteInGroup() 发起群聊音视频通话。groupID 用于标识发起通话的群组。inviteeUserIDList 指定本次邀请的群成员,不会自动邀请群内全部成员。

const roomCredentials = await OpenIMSDK.signalingInviteInGroup({
  invitation: {
    inviterUserID: currentUserID,
    inviteeUserIDList: memberUserIDs,
    groupID,
    roomID,
    timeout: 30,
    mediaType: 'video',
    sessionType: SessionType.Group,
    platformID: currentPlatform,
  },
});

参数说明

参数类型是否必填说明
invitationRtcInvite是本次通话邀请。
invitation.inviterUserIDstring是发起通话的当前用户 ID。
invitation.inviteeUserIDListstring[]是本次邀请的群成员用户 ID 列表。
invitation.groupIDstring是目标群组 ID。
invitation.roomIDstring是本次群聊通话的房间 ID。
invitation.timeoutnumber是邀请等待时长,单位为秒。
invitation.mediaTypestring是媒体类型,例如 audio 或 video。
invitation.sessionTypeSessionType是群聊传入 SessionType.Group。
invitation.platformIDPlatform是发起端平台;传入当前客户端对应的 Platform 枚举值。
invitation.customDatastring否随邀请传递的业务扩展字符串。
invitation.initiateTimenumber否邀请发起时间,Unix 毫秒时间戳。通常由通话流程维护,无需手动填写。
invitation.busyLineUserIDListstring[]否忙线用户列表。发起新邀请时通常不填写。
offlinePushInfoOfflinePush否被邀请用户离线时使用的推送内容。
offlinePushInfo.titlestring条件必填提供 offlinePushInfo 时填写推送标题。
offlinePushInfo.descstring条件必填提供 offlinePushInfo 时填写推送正文。
offlinePushInfo.exstring条件必填提供 offlinePushInfo 时填写扩展字符串;没有内容时传空字符串。
offlinePushInfo.iOSPushSoundstring条件必填提供 offlinePushInfo 时填写 iOS 推送声音。
offlinePushInfo.iOSBadgeCountboolean条件必填提供 offlinePushInfo 时说明是否更新 iOS 角标。

调用完成后返回 RtcInviteResults,其中包含 roomID、token、liveURL 和可选的 busyLineUserIDList。字段说明见发起单聊通话。

被邀请成员会通过 OnReceiveNewInvitation 收到 OnReceiveNewInvitationPayload。成员的接受、拒绝和离开状态见处理通话事件。