Avvio

Installare

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

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

Usa poi il seguente prompt:

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

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

bun add @capgo/capacitor-twilio-voice
bunx cap sync

Importa

import { CapacitorTwilioVoice } from '@capgo/capacitor-twilio-voice';

API Panoramica

login

Autentica l'utente con Twilio Voice utilizzando un token di accesso.

Il token di accesso dovrebbe essere generato sul tuo server backend utilizzando le tue credenziali di Twilio. Questo token è richiesto per effettuare e ricevere chiamate tramite Twilio Voice.

import { CapacitorTwilioVoice } from '@capgo/capacitor-twilio-voice';

const result = await CapacitorTwilioVoice.login({
  accessToken: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...'
});
console.log('Login successful:', result.success);

logout

Disconnetti l'utente corrente e disiscrivi da Twilio Voice.

Questo disconnetterà qualsiasi chiamata attiva e impedirà al dispositivo di ricevere nuove notifiche di chiamata in arrivo.

import { CapacitorTwilioVoice } from '@capgo/capacitor-twilio-voice';

const result = await CapacitorTwilioVoice.logout();
console.log('Logout successful:', result.success);

isLoggedIn

Verifica se l'utente è attualmente connesso e ha un token di accesso valido.

import { CapacitorTwilioVoice } from '@capgo/capacitor-twilio-voice';

const status = await CapacitorTwilioVoice.isLoggedIn();
if (status.isLoggedIn && status.hasValidToken) {
  console.log('User identity:', status.identity);
} else {
  // Re-authenticate the user
}

makeCall

Inizia una chiamata in uscita verso un numero di telefono o un client.

L'utente deve essere connesso prima di effettuare una chiamata. La chiamata sarà instradata attraverso la tua configurazione backend Twilio.

import { CapacitorTwilioVoice } from '@capgo/capacitor-twilio-voice';

// Call a phone number
const result = await CapacitorTwilioVoice.makeCall({
  to: '+1234567890'
});
console.log('Call SID:', result.callSid);

// Call another Twilio client with a readable name for CallKit Recents
await CapacitorTwilioVoice.makeCall({
  to: 'client:alice',
  displayName: 'Alice Smith'
});

// Call a PSTN number using a specific caller ID
await CapacitorTwilioVoice.makeCall({
  to: '+1234567890',
  callerId: '+10987654321'
});

acceptCall

Accetta una chiamata in arrivo.

Questa dovrebbe essere chiamata in risposta a un evento 'callInviteReceived'.

import { CapacitorTwilioVoice } from '@capgo/capacitor-twilio-voice';

CapacitorTwilioVoice.addListener('callInviteReceived', async (data) => {
  console.log('Incoming call from:', data.from);
  const result = await CapacitorTwilioVoice.acceptCall({
    callSid: data.callSid
  });
  console.log('Call accepted:', result.success);
});

rejectCall

Rifiuta una chiamata in arrivo.

Questa dovrebbe essere chiamata in risposta a un evento ‘chiamataInvitata’. Il chiamante sentirà un segnale di occupato o sarà diretto al messaggio vocale.

import { CapacitorTwilioVoice } from '@capgo/capacitor-twilio-voice';

CapacitorTwilioVoice.addListener('callInviteReceived', async (data) => {
  if (shouldRejectCall(data.from)) {
    await CapacitorTwilioVoice.rejectCall({
      callSid: data.callSid
    });
  }
});

endCall

Termina una chiamata attiva.

Se non viene fornito callSid, questa terminerà la chiamata attiva corrente.

import { CapacitorTwilioVoice } from '@capgo/capacitor-twilio-voice';

// End the current active call
await CapacitorTwilioVoice.endCall({});

// End a specific call
await CapacitorTwilioVoice.endCall({
  callSid: 'CA1234567890abcdef'
});

muteCall

Sorvieta o desorvieta il microfono durante una chiamata attiva.

Quando sorvieta, la parte opposta non sentirà audio dal tuo microfono.

import { CapacitorTwilioVoice } from '@capgo/capacitor-twilio-voice';

// Mute the microphone
await CapacitorTwilioVoice.muteCall({
  muted: true
});

// Unmute the microphone
await CapacitorTwilioVoice.muteCall({
  muted: false
});

setSpeaker

Abilita o disabilita il modo speakerphone.

Quando abilitato, l'audio verrà diretto attraverso lo speaker del dispositivo al posto dell'auricolare.

import { CapacitorTwilioVoice } from '@capgo/capacitor-twilio-voice';

// Enable speakerphone
await CapacitorTwilioVoice.setSpeaker({
  enabled: true
});

// Disable speakerphone
await CapacitorTwilioVoice.setSpeaker({
  enabled: false
});

getCallStatus

Ottenere lo stato attuale della chiamata in corso.

Ciò fornisce informazioni in tempo reale sullo stato della chiamata, lo stato del silenziamento, lo stato di sospensione e gli identificatori della chiamata.

import { CapacitorTwilioVoice } from '@capgo/capacitor-twilio-voice';

const status = await CapacitorTwilioVoice.getCallStatus();
if (status.hasActiveCall) {
  console.log('Call SID:', status.callSid);
  console.log('Call State:', status.callState);
  console.log('Is Muted:', status.isMuted);
  console.log('Is On Hold:', status.isOnHold);
}

checkMicrophonePermission

Verifica se è stato concesso il permesso per l'uso del microfono.

Ciò non richiede il permesso, ma solo verifica lo stato di permesso attuale.

import { CapacitorTwilioVoice } from '@capgo/capacitor-twilio-voice';

const result = await CapacitorTwilioVoice.checkMicrophonePermission();
if (!result.granted) {
  console.log('Microphone permission not granted');
}

requestMicrophonePermission

Richiedi l'autorizzazione all'uso del microfono all'utente.

Su iOS e Android, questo mostrerà il dialogo di autorizzazione del sistema se l'autorizzazione non è stata ancora concessa. Se l'autorizzazione è stata precedentemente negata, l'utente potrebbe doverla concedere nelle impostazioni del sistema.

import { CapacitorTwilioVoice } from '@capgo/capacitor-twilio-voice';

const result = await CapacitorTwilioVoice.requestMicrophonePermission();
if (result.granted) {
  console.log('Microphone permission granted');
} else {
  console.log('Microphone permission denied');
}

Riferimento di tipo

CallInvite

Capacitor plugin per l'integrazione della funzionalità di voce di Twilio nelle applicazioni mobili.

export interface CallInvite {
  /** Unique identifier for the incoming call invitation */
  callSid: string;
  /** Phone number or client identifier of the caller (may include custom caller name) */
  from: string;
  /** Phone number or client identifier being called */
  to: string;
  /** Custom parameters passed with the call invitation */
  customParams: Record<string, string>;
}

Fonte di verità

This page is generated from the plugin’s src/definitions.tsRiegenera la sincronizzazione quando le informazioni pubbliche API cambiano nell'area di origine.

Continua da Inizia a utilizzare

Se stai utilizzando Inizia a utilizzare per pianificare il dashboard e le API operazioni, connettilo con Utilizza @capgo/capacitor-twilio-voice per la capacità nativa in Utilizza @capgo/capacitor-twilio-voice, Panoramica di API per i dettagli di implementazione in Panoramica di API 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 in Dispositivi.