Getting Started

__CAPGO_KEEP_11__

您可以使用我们的AI辅助设置来安装插件。使用以下命令将Capgo技能添加到您的AI工具中：

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

然后使用以下提示：

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-incoming-call-kit` plugin in my project.

如果您更喜欢手动设置，请按照以下命令安装插件并遵循以下平台特定的说明：

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, 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 对象。

平台注意事项

• 阅读 iOS 指南 在将 CallKit 集成到 PushKit 或 APNs 流程之前，
• 阅读 Android 指南 在 Android 14 和更高版本上依赖全屏意图之前，
• Web 不支持。

继续从 Getting Started

如果您正在使用 Getting Started 来规划仪表板和 API 操作，连接它与 使用 @capgo/capacitor-incoming-call-kit 使用 @capgo/capacitor-incoming-call-kit 的原生能力 API 概述 查看 API 概述 的实现细节 介绍 查看介绍的实现细节 API 键 为 API 键的实现细节提供键值对， 设备 为设备的实现细节提供键值对。