跳过内容

开始

  1. 安装包

    终端窗口
    bun add @capgo/capacitor-incoming-call-kit
  2. 同步本机项目

    终端窗口
    bunx cap sync
  3. 选择您的环回源 决定是否来自您的后端、SDK(如Twilio或Stream)还是原生推送路径(如FCM或PushKit)的来电事件。

此插件仅负责原生来电呈现。您的应用程序仍负责传输、身份验证和实际媒体会话。

常见的生产模式是:

  1. 您的后端或呼叫SDK发出一个环事件。
  2. 您的应用程序调用 showIncomingCall().
  3. 插件呈现原生来电UI。
  4. callAccepted 告诉您的应用程序加入实际房间或VoIP会话。
  5. callDeclined, callEndedcallTimedOut 告知您的应用程序清除远程状态。
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: 在监听器负载中回显任意 JSON
  • android.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 不支持。