Getting Started

Copyprompt untuk menginstal langkah-langkah dan panduan markdown lengkap untuk plugin ini.

        Set up this Capacitor plugin in the project.

Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-incoming-call-kit`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/incoming-call-kit/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.

Pemasangan

Anda dapat menggunakan Pengaturan 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:

Instal paket

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

Sinkronkan proyek native
Jendela terminal
```
bunx cap sync
```
Pilih sumber ring 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:

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

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

Pilihan penting

callId: identifikasi stabil yang digunakan kembali kemudian dengan endCall()
timeoutMs: waktu tunggu tidak terjawab dengan upaya terbaik
extra: JSON arbitrer yang dikembalikan dalam payload pendengar
android.channelId And 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',
});

Model peristiwa

incomingCallDisplayed: antarmuka native ditampilkan dengan sukses
callAccepted: pengguna diterima dari antarmuka native
callDeclined: pengguna menolak sebelum bergabung
callEnded: aplikasi Anda atau platform mengakhiri panggilan yang sedang diikuti
callTimedOut: panggilan tetap tidak dijawab sampai timeoutMs

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

Baca

Petunjuk iOS sebelum menghubungkan CallKit ke dalam aliran PushKit atau APNs. Baca Panduan gaya Capgo sebelumnya
Read the Baca panduan Android sebelum mengandalkan intents layar penuh pada Android 14 dan setelahnya.
Web tidak didukung.

Teruskan dari Getting Started

Jika Anda menggunakan Getting Started untuk merencanakan dashboard dan API operasi, hubungkannya dengan Menggunakan @capgo/capacitor-incoming-call-kit untuk kemampuan asli dalam Menggunakan @capgo/capacitor-incoming-call-kit, API Ringkasan untuk detail implementasi di API Ringkasan Pendahuluan untuk detail implementasi di Pendahuluan API Kunci untuk detail implementasi di API Kunci, dan Perangkat untuk detail implementasi di Perangkat.