Inizia a utilizzare

Installa

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 disiscriviti da Twilio Voice.

Ciò disconnetterà eventuali chiamate attive 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 a un numero di telefono o a un cliente.

L'utente deve essere connesso prima di effettuare una chiamata. La chiamata verrà instradata attraverso la tua configurazione backend di 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.

Deve essere chiamato in risposta a un evento ‘callInviteReceived’. Il chiamante sentirà un segnale di occupato o sarà diretto alla segreteria.

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, si 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

Attiva o disattiva il microfono durante una chiamata attiva.

Quando è attivato, 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à routato attraverso lo speaker del dispositivo al posto dell'altoparlante.

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 corrente della chiamata attiva.

Questa fornisce informazioni in tempo reale sullo stato della chiamata, lo stato del silenzio, 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.

Questa 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

Richiedere il permesso all'utente per l'uso del microfono.

On iOS e Android, verrà visualizzato il dialogo di autorizzazione del sistema se non è stato ancora concesso il permesso. Se il permesso è stato precedentemente negato, l'utente potrebbe dover concederlo nei 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 al tipo

CallInvite

Capacitor plugin per l'integrazione della funzionalità di Voice di Twilio nei dispositivi 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>;
}

Punto di verità

Questa pagina è generata dal plugin’s src/definitions.tsRiavvia la sincronizzazione quando le modifiche pubbliche API sono state apportate in alto a valle.