开始
复制一个设置提示,包括安装步骤和此插件的完整 Markdown 指南。
Set up this Capacitor plugin in the project.
Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-incoming-call-kit`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/incoming-call-kit/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.
-
安装包
终端窗口 bun add @capgo/capacitor-incoming-call-kit -
同步本机项目
终端窗口 bunx cap sync -
选择您的环回源 决定是否来自您的后端、SDK(如Twilio或Stream)还是原生推送路径(如FCM或PushKit)的来电事件。
如何集成
标题:如何集成此插件仅负责原生来电呈现。您的应用程序仍负责传输、身份验证和实际媒体会话。
常见的生产模式是:
- 您的后端或呼叫SDK发出一个环事件。
- 您的应用程序调用
showIncomingCall(). - 插件呈现原生来电UI。
callAccepted告诉您的应用程序加入实际房间或VoIP会话。callDeclined,callEnded或callTimedOut告知您的应用程序清除远程状态。
最小化集成
标题:最小化集成import { IncomingCallKit } from '@capgo/capacitor-incoming-call-kit';
await IncomingCallKit.requestPermissions();await IncomingCallKit.requestFullScreenIntentPermission();
await IncomingCallKit.addListener('callAccepted', async ({ call }) => { console.log('Accepted', call.callId, call.extra); // Start or join your real call session here.});
await IncomingCallKit.addListener('callDeclined', ({ call }) => { console.log('Declined', call.callId); // Tell your backend or SDK that the user declined.});
await IncomingCallKit.addListener('callTimedOut', ({ call }) => { console.log('Timed out', call.callId); // Clear ringing state in your backend or SDK.});
await IncomingCallKit.showIncomingCall({ callId: 'call-42', callerName: 'Ada Lovelace', handle: '+39 555 010 020', appName: 'Capgo Phone', hasVideo: true, timeoutMs: 45_000, extra: { roomId: 'room-42', callerUserId: 'user_ada', }, android: { channelId: 'calls', channelName: 'Incoming Calls', showFullScreen: true, }, ios: { handleType: 'phoneNumber', },});重要选项
标题:重要选项callId: 稳定标识符稍后重用endCall()timeoutMs: 最佳努力未回答超时extra: 在监听器负载中回显任意 JSONandroid.channelId并且android.channelName: Android 通知频道调谐android.showFullScreen: 请求 Android 全屏 incoming-call 活动ios.handleType: 选择generic,phoneNumber, 或emailAddress用于 CallKit
管理活跃的呼叫
标题:管理活跃的呼叫const { calls } = await IncomingCallKit.getActiveCalls();
await IncomingCallKit.endCall({ callId: 'call-42', reason: 'remote-ended',});
await IncomingCallKit.endAllCalls({ reason: 'session-reset',});事件模型
标题:事件模型incomingCallDisplayed: 本地 UI 已成功显示callAccepted: 用户从本地 UI 中接受callDeclined: 用户在加入之前拒绝callEnded: 您的应用程序或平台已结束跟踪的呼叫callTimedOut: 等待呼叫未接通timeoutMs
每个事件都携带了标准化的 call 数据载荷和您的原始 extra 对象。
平台注意事项
标题为“平台注意事项”的部分- 阅读 iOS 指南 在将 CallKit 集成到 PushKit 或 APNs 流程之前,
- 阅读 Android 指南 在 Android 14 或更高版本上依赖全屏意图之前,
- Web 不支持。