跳过内容
Capgo - 实时更新 Capacitor 应用程序 Capgo

开始使用

  1. 安装包

    终端窗口
    bun add @capgo/capacitor-incoming-call-kit

  2. 同步本地项目

    终端窗口
    bunx cap sync

  3. 选择您的环源 决定是否来自您的后端、一个像Twilio或Stream这样的SDK，还是一个本地推送路径，如FCM或PushKit。

整合的如何协同工作

标题：整合的如何协同工作

此插件仅拥有本地来电显示。您的应用程序仍拥有传输、身份验证和实际媒体会话。

生产模式的共同模式是：

  1. 您的后端或调用 SDK 发出一个环事件。
  2. 您的应用程序调用 showIncomingCall().
  3. 插件呈现本机 incoming-call UI。
  4. callAccepted 告诉您的应用程序加入实际房间或 VoIP 会话。
  5. 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: 监听器载荷中反射回任意 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 对象。

平台备注

Section titled “平台备注”