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

开始

GitHub

安装

标题为“安装”

您可以使用我们的 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. 选择呼叫铃声来源 决定呼叫事件是否来自您的后端、一个像Twilio或Stream这样的SDK，还是一个本地推送路径，如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 对象。

平台注意事项

标题为“平台注意事项”

继续从 Getting Started

继续从 Getting Started

如果您正在使用 Getting Started 来规划仪表板和API操作，连接它到 使用 @capgo/capacitor-incoming-call-kit 使用 @capgo/capacitor-incoming-call-kit API概述 Capgo API 简介 简介 Capgo __CAPGO_KEEP_0__ keys Capgo API keys 和 for the implementation detail in API Keys, and 编辑页面 上一个