Getting Started

L'installazione

Puoi utilizzare la nostra configurazione assistita dall'IA per installare il plugin. Aggiungi le Capgo competenze al tuo strumento di AI utilizzando il seguente comando:

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

Poi utilizza il seguente prompt:

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

Se preferisci la configurazione manuale, installa il plugin eseguendo i seguenti comandi e segui le istruzioni specifiche del tuo platform qui sotto:

1. Installa il pacchetto

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

2. Sincronizza progetti nativi

   bunx cap sync

3. Scegli la tua fonte di suono Decidi se l'evento di chiamata in arrivo proviene dal tuo backend, un SDK come Twilio o Stream, o da un percorso di push nativo come FCM o PushKit.

Come si abbinano le integrazioni

Questo plugin gestisce solo la presentazione di chiamate in arrivo native. La tua app mantiene il controllo sul trasporto, l'autenticazione e la sessione media effettiva.

Il modello di produzione comune è:

1. Il tuo backend o il chiamante SDK emette un evento di squillo.
2. La tua app chiama showIncomingCall().
3. Il plugin presenta un'interfaccia di chiamata in arrivo nativa.
4. callAccepted insegna alla tua app di unirsi alla stanza o alla sessione VoIP effettiva.
5. callDeclined, callEndedo callTimedOut insegna alla tua app di pulire lo stato remoto.

Integrazione minima

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

Opzioni importanti

• callId: identificatore stabile riutilizzato in seguito con endCall()
• timeoutMsTimeout di attesa senza risposta
• extra: JSON arbitrario riprodotto indietro nei payload degli ascoltatori
• android.channelId e android.channelName: regolazione del canale di notifica Android
• android.showFullScreen: richiede l'attività di chiamata in anteprima a schermo intero Android
• ios.handleType: scegli generic, phoneNumber, o emailAddress per CallKit

Gestione delle chiamate attive

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

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

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

Modello di evento

• incomingCallDisplayedLa UI nativa è stata visualizzata con successo.
• callAccepted: l'utente ha accettato dall'interfaccia nativa
• callDeclined: l'utente ha rifiutato prima di unirsi
• callEnded: il tuo app o la piattaforma ha interrotto la chiamata tracciata
• callTimedOut: la chiamata è rimasta senza risposta fino a timeoutMs

Ogni evento porta il valore normalizzato call : Osservazioni della piattaforma extra object.

: Leggi il

• Leggi il : Guida iOS prima di collegare CallKit in un flusso PushKit o APNs.
• Leggi il Guida per Android prima di affidarti agli intenti a schermo intero su Android 14 e successive versioni.
• Non è supportato.

Prosegui dalla Guida Iniziale

Se stai utilizzando per pianificare il pannello di controllo e le operazioni __CAPGO_KEEP_0__, connettilo con per pianificare il dashboard e le API operazioni, connettilo con Utilizzando @capgo/capacitor-kit-di-chiamata-in-arrivo Per la capacità nativa in Utilizzo di @capgo/capacitor-incoming-call-kit, API Panoramica per i dettagli di implementazione in API Panoramica, Introduzione per i dettagli di implementazione in Introduzione, API Chiavi per i dettagli di implementazione in API Chiavi, e Dispositivi Per i dettagli di implementazione nei dispositivi.