快速开始

集成 SDK

导入 SDK

选择以下任一方式导入 Call Kit:

初始化带有呼叫邀请功能的 Call Kit

初始化 Call Kit，并添加呼叫邀请插件:

生成一个Kit Token
在以下代码中填写所需参数

说明

以下示例代码展示了在客户端生成 Kit Token 的方法，可用于测试 Call Kit。但是，在您的 App 正式上线时，建议参考使用 Kit Token 鉴权文档在服务端生成 Kit Token，以避免安全风险。
UIKit 默认语言为英文，如需修改为中文，可以通过 setCallInvitationConfig 接口设置 language 参数。

// 调用方法生成一个Token。
// @param 1: appID
// @param 2: serverSecret
// @param 3: 房间ID
// @param 4: 用户ID
// @param 5: 用户名
const userID = ""; 
const userName = "userName" + userID;
const appID = 0;
const serverSecret = "";
const TOKEN = ZegoUIKitPrebuilt.generateKitTokenForTest(appID, serverSecret,null, userID, userName);

const zp = ZegoUIKitPrebuilt.create(TOKEN);
zp.addPlugins({ ZIM });

// 设置语言为中文
zp.setCallInvitationConfig({
    ...
    language: ZegoUIKitLanguage.CHS,    
    ...
})

// 调用方法生成一个Token。
// @param 1: appID
// @param 2: serverSecret
// @param 3: 房间ID
// @param 4: 用户ID
// @param 5: 用户名
const userID = ""; 
const userName = "userName" + userID;
const appID = 0;
const serverSecret = "";
const TOKEN = ZegoUIKitPrebuilt.generateKitTokenForTest(appID, serverSecret,null, userID, userName);

const zp = ZegoUIKitPrebuilt.create(TOKEN);
zp.addPlugins({ ZIM });

// 设置语言为中文
zp.setCallInvitationConfig({
    ...
    language: ZegoUIKitLanguage.CHS,    
    ...
})

设置按钮触发事件

设置一个按钮，并为呼叫邀请添加一个按钮点击事件。

您可以自定义上一步设置的按钮位置，并传入呼叫目标用户的 ID。

HTML

<button onclick="invite()">invite</button>

<button onclick="invite()">invite</button>

运行和测试

至此，你已经完成了所有的步骤！

现在你可以使用你熟悉的服务器在浏览器中启动和运行项目。

资源

在线编程

点击这里在线编码并查看它的运行情况。

在线体验

点击这里尝试实时演示。

自定义呼叫邀请用户界面

自定义呼叫邀请配置

自定义铃声

自定义事件回调

Reference

sendCallInvitation

接口说明

发送呼叫邀请。

函数原型：

sendCallInvitation(params: {
    callees: ZegoUser[];
    callType: ZegoInvitationType;
    timeout?: number;
    roomID?: string;
    data?: string;
    notificationConfig?: ZegoSignalingPluginNotificationConfig;
}): Promise<{
    errorInvitees: ZegoUser[];
}>;

sendCallInvitation(params: {
    callees: ZegoUser[];
    callType: ZegoInvitationType;
    timeout?: number;
    roomID?: string;
    data?: string;
    notificationConfig?: ZegoSignalingPluginNotificationConfig;
}): Promise<{
    errorInvitees: ZegoUser[];
}>;

参数说明：

参数	类型	是否必填	说明
callees	ZegoUser[]	是	被叫用户列表，最多可邀请不超过 9 名用户。
callType	ZegoInvitationType	是	呼叫类型。
timeout	number	否	等待用户响应邀请时长，单位为秒，取值范围为 [1, 600]。默认为 90。
roomID	string	否	房间 ID，由开发者自己生成，最大长度为 128 字节的字符串。仅支持数字，英文字符和 '~', '!', '@', '#', '$', '', '^', '&', '*', '(', ')', '_', '+', '=', '-', ', ';', '’', ',', '.', '<', '>', '/'。
data	string	否	扩展字段。
notificationConfig	ZegoSignalingPluginNotificationConfig	否	离线推送配置。

ZegoUser

类型描述：用户信息类。

参数说明：

属性/方法	类型	是否必选	描述
userID	string	是	用户唯一标识，由开发者自定义，最长不超过 32 字节，仅支持数字，英文字符和 '!', '#', '$', '&', '(', ')', '+', '-', ':', ';', '<', '=', '.', '>', '?', '@', '[', ']', '^', '_', '{', '}', '
userName	string	否	用户的名称。最长不超过 256 字节。
avatar	string	否	设置呼叫页用户头像。
setUserAvatar	(avatar: string) => void	否	传入图片资源地址设置用户头像的方法。

ZegoInvitationType

类型描述：通话邀请类型枚举类。
枚举说明：

枚举	枚举值	描述
VoiceCall	0	语音通话。
VideoCall	1	视频通话。

ZegoSignalingPluginNotificationConfig

类型描述：离线邀请配置类。
枚举说明：

属性	类型	是否必选	描述
resourcesID	string	否	一个可映射多个厂商进阶推送配置的英文字符串，长度不超过 32 个字，由开发者自定义。使用此字段，可将多个厂商的推送配置抽象为一种您自定的推送策略。具体介绍请参考即时通讯 - resourceID 说明。
title	string	否	推送标题。
message	string	否	推送的内容。