Getting Started

__CAPGO_KEEP_0__

AI-Assisted セットアップを使用してプラグインをインストールできます。次のコマンドを使用して、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.

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

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

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

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

   bunx cap sync

3. RING ソースを選択 SDK またはネイティブ プッシュ パスから Ring イベントが発生するかどうかを決定します。

統合の構成

このプラグインは、ネイティブの Ring 表示のみを管理します。アプリは、トランスポート、認証、実際のメディア セッションを管理します。

一般的なプロダクション パターンは:

1. バックエンドまたは Ring イベントを発行する SDK が Ring イベントを発行します。
2. アプリは Ring イベントを呼び出します。 showIncomingCall().
3. プラグインはネイティブの Ring 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: __CAPGO_KEEP_0__ がかかってきた電話は、返事が来るまで timeoutMs

各イベントには、正規化された call ペイロードと元の extra オブジェクトが含まれます。

プラットフォームに関する注意

• PushKit または APNs フローに CallKit を組み込む前に iOS ガイドを読みましょう。 Android 14 以降でフルスクリーン インテントに依存する前に
• Android ガイドを読みましょう。 __CAPGO_KEEP_0__ __CAPGO_KEEP_0__
• Webはサポートされていません。

Getting Startedから続けてください

Capacitorを使用している場合 Getting Started Capacitorを使用してダッシュボードとAPIの操作を計画するには、APIをCapacitorに接続します。 @capgo/capacitor-incoming-call-kitを使用します @capgo/capacitor-incoming-call-kitのnative capabilityの詳細 APIの概要 APIの実装詳細 導入 導入の実装詳細 API キー API キーとその実装詳細のための デバイス デバイスの実装詳細のための