Getting Started

インストール

AI-Assisted Setupを使用してプラグインをインストールできます。AIツールにCapgoスキルを追加するには、以下のコマンドを使用してください。

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.

Manual Setupを使用する場合は、以下のコマンドを実行してプラグインをインストールし、下記のプラットフォーム固有の手順に従ってください。

1. パッケージをインストール

   bun add @capgo/capacitor-incoming-call-kit

2. ネイティブプロジェクトを同期

   bunx cap sync

3. リングソースを選択 incoming-callイベントが、バックエンドから来るか、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 のフルスクリーンIncomingCallアクティビティを要求する
• 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ガイド PushKitまたはAPNsフローにCallKitを組み込む前に
• スタイルガイドを読みます。 Androidガイド Android 14以降のフルスクリーンインテントに頼る前に
• Webはサポートされていません。

Getting Startedから続けてください。

Getting Started CapgoのGetting Started を計画するダッシュボードとAPIの作業を接続する Using @capgo/capacitor-incoming-call-kit Using @capgo/capacitor-incoming-call-kitのネイティブ機能 APIの概要 APIの概要の実装詳細 導入 導入の実装詳細 APIのキー APIのキーと実装詳細 デバイス デバイスの実装詳細