Einstieg

Installieren

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

Importieren

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

API Übersicht

login

Authentifizieren Sie den Benutzer mit Twilio Voice mithilfe eines Zugriffstokens.

Das Zugriffstoken sollte auf Ihrem Backend-Server mit Ihren Twilio-Zugangsdaten generiert werden. Dieses Token ist erforderlich, um Anrufe über Twilio Voice aufzunehmen und zu empfangen.

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

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

logout

Beenden Sie die Sitzung des aktuellen Benutzers und registrieren Sie sich nicht mehr bei Twilio Voice.

Dies wird alle aktiven Anrufe trennen und den Gerät von neuen Eingehende Anrufbenachrichtigungen abmelden.

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

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

isLoggedIn

Überprüfen Sie, ob der Benutzer derzeit angemeldet ist und ein gültiger Zugriffstoken besitzt.

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

Initiiere einen ausgehenden Anruf an eine Telefonnummer oder einen Kunden.

Der Benutzer muss angemeldet sein, bevor ein Anruf getätigt werden kann. Der Anruf wird über Ihre Twilio-Backend-Konfiguration weitergeleitet.

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

Akzeptiere einen eingehenden Anruf.

Dies sollte in Reaktion auf einen ‘callInviteReceived’-Ereignis aufgerufen werden.

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

Ablehnen Sie einen eingehenden Anruf.

Dies sollte in Reaktion auf einen ‘callInviteReceived’-Ereignis aufgerufen werden. Der Anrufer hört ein Besetztzeichen oder wird zur Mailbox umgeleitet.

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

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

endCall

Ein aktives Gespräch beenden.

Wenn callSid nicht bereitgestellt wird, beendet dies das derzeit aktive Gespräch.

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

Das Mikrofon während eines aktiven Gesprächs abschalten oder wieder eingeschalten.

Wenn abgeschaltet, hört die andere Partei kein Audio von Ihrem Mikrofon.

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

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

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

setSpeaker

Das Lautsprecher-Modus aktivieren oder deaktivieren.

Wenn aktiviert, wird das Audio über den Geräte-Lautsprecher statt über das Ohrhörer geleitet.

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

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

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

getCallStatus

Ermitteln Sie den aktuellen Status der aktiven Anrufverbindung.

Dies liefert Echtzeitinformationen über den Anrufzustand, den Mute-Zustand, den Halte-Zustand und die Anruf-Identifikatoren.

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

Überprüfen Sie, ob die Mikrofon-Berechtigung erteilt wurde.

Dies stellt die aktuelle Berechtigungsstatus überprüft, ohne eine Berechtigung zu beantragen.

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

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

requestMicrophonePermission

Bitten Sie den Benutzer um die Berechtigung für das Mikrofon.

Auf iOS und Android wird diese Anzeige, wenn noch keine Berechtigung erteilt wurde, das System-Berechtigungsdialog anzeigen. Wenn die Berechtigung zuvor abgelehnt wurde, muss der Benutzer sie möglicherweise in den Systemeinstellungen erteilen.

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

Typenverweis

CallInvite

Capacitor-Plugin zur Integration der Twilio Voice-Funktion in mobile Anwendungen.

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>;
}

Wahrheitsquelle

Diese Seite wird aus dem Plugin generiert. src/definitions.tsRe-run die Synchronisation, wenn die öffentliche API-Änderung upstream erfolgt ist.