Pembukaan

Instalasi

Anda dapat menggunakan Pengaturan Setup Bantu AI kami untuk menginstal plugin. Tambahkan Capgo kemampuan ke alat AI Anda menggunakan perintah berikut:

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

Lalu gunakan prompt berikut:

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

Jika Anda lebih suka Pengaturan Manual, instal plugin dengan menjalankan perintah-perintah berikut dan ikuti instruksi spesifik platform di bawah ini:

1. Instal paket

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

2. Sinkronkan proyek native

   bunx cap sync

3. Pilih sumber ring Anda Putuskan apakah event panggilan masuk berasal dari backend Anda, sebuah SDK seperti Twilio atau Stream, atau jalur push native seperti FCM atau PushKit.

Bagaimana integrasi ini berfungsi

Plugin ini hanya mengelola presentasi panggilan masuk native. Aplikasi Anda masih mengelola transportasi, autentikasi, dan sesi media yang sebenarnya.

Polanya produksi yang umum adalah:

1. Backend atau SDK Anda yang mengeluarkan event ring.
2. Aplikasi Anda menghubungi showIncomingCall().
3. Plugin ini menampilkan UI panggilan masuk asli.
4. callAccepted menginformasikan aplikasi Anda untuk bergabung dengan ruang atau sesi VoIP yang sebenarnya.
5. callDeclined, callEnded, atau callTimedOut menginformasikan aplikasi Anda untuk membersihkan status remote.

Integrasi minimal

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',
  },
});

Opsi penting

• callId: identifikasi stabil yang digunakan kembali kemudian dengan endCall()
• timeoutMs: waktu tunggu tidak terjawab dengan upaya terbaik
• extra: JSON arbitrer yang dipantulkan kembali dalam payload pendengar
• android.channelId dan android.channelName: Pengaturan saluran notifikasi Android
• android.showFullScreen: meminta aktivitas panggilan masuk layar penuh Android
• ios.handleType: pilih generic, phoneNumber, atau emailAddress untuk Kit Panggilan

Pengelolaan panggilan aktif

const { calls } = await IncomingCallKit.getActiveCalls();

await IncomingCallKit.endCall({
  callId: 'call-42',
  reason: 'remote-ended',
});

await IncomingCallKit.endAllCalls({
  reason: 'session-reset',
});

Salin ke clipboard

• incomingCallDisplayedPengelolaan panggilan aktif
• callAccepted: pengguna diterima dari antarmuka native
• callDeclined: pengguna menolak sebelum bergabung
• callEnded: aplikasi Anda atau platform mengakhiri panggilan yang diikuti
• callTimedOut: panggilan tetap tidak dijawab sampai timeoutMs

Setiap event membawa payload yang dinormalisasi dan objek asli Anda. call Catatan Platform extra Bab berjudul “Catatan Platform”

Baca

• sebelum menghubungkan CallKit ke dalam aliran PushKit atau APNs. __CAPGO_KEEP_0__ __CAPGO_KEEP_0__
• Read the Baca Panduan Android guide
• Petunjuk Android

sebelum mengandalkan intents layar penuh pada Android 14 dan seterusnya.

Teruskan dari Getting Started Teruskan dari Getting Started to plan dashboard and API operations, connect it with Using @capgo/capacitor-incoming-call-kit for the native capability in Using @capgo/capacitor-incoming-call-kit, Menggunakan @API/__CAPGO_KEEP_1__-incoming-call-kit untuk kemampuan asli dalam Menggunakan @API/__CAPGO_KEEP_1__-incoming-call-kit, untuk detail implementasi di API Panduan Umum, Pendahuluan untuk detail implementasi di Pendahuluan, API Kunci untuk detail implementasi di API Kunci, dan Peralatan untuk detail implementasi di Peralatan.