Getting Started

Installieren

Sie können unsere AI-gestützte Einrichtung verwenden, um das Plugin zu installieren. Fügen Sie die Capgo Fähigkeiten zu Ihrer KI-Tool mithilfe der folgenden Befehl hinzu:

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

Verwenden Sie dann die folgende Anfrage:

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

Wenn Sie eine manuelle Einrichtung bevorzugen, installieren Sie das Plugin, indem Sie die folgenden Befehle ausführen und die darunterstehenden plattform-spezifischen Anweisungen befolgen.

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 abzugeben.

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

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

logout

Abmelden Sie den aktuellen Benutzer und deaktivieren Sie Twilio Voice.

Dies wird alle aktiven Anrufe beenden und verhindern, dass das Gerät neue eingehende Anrufbenachrichtigungen erhält.

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 einen gültigen 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

Erstellen Sie einen Ausgeh-Anruf an eine Telefonnummer oder einen Client.

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

Ein eingehenden Anruf annehmen.

Dies sollte in Antwort 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

Ein eingehenden Anruf ablehnen.

Dies sollte in Antwort auf ein '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 aktiven Anruf beenden.

Wenn callSid nicht bereitgestellt wird, beendet dies den derzeit aktiven Anruf.

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

Mikrofon abschalten oder wieder einschalten während eines laufenden Anrufs.

Wenn das Mikrofon ausgeschaltet ist, hört die andere Seite 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

Sprecherfunkfunktion aktivieren oder deaktivieren.

Wenn aktiviert, wird das Audio über den Geräte-Sprecher 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 Mikrofonberechtigung erteilt wurde.

Dies fordert keine Erlaubnis an, sondern überprüft nur den aktuellen Zustand der Erlaubnis.

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

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

requestMicrophonePermission

Berechtigung zum Mikrofon von dem Benutzer anfordern.

Auf iOS und Android wird das Systemdialogfeld angezeigt, wenn die Erlaubnis noch nicht erteilt wurde. Wenn die Erlaubnis 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');
}

Typenreferenz

CallInvite

Capacitor-Plugin zur Integration der Twilio Voice-Funktionen 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>;
}

Quelle der Wahrheit

Diese Seite wurde aus dem Plugin generiert. src/definitions.tsRe-run die Synchronisierung, wenn die öffentliche API upstream geändert wird.

Fortsetzen Sie mit Getting Started

Wenn Sie das Plugin verwenden Getting Started um das Dashboard und die API-Operationen zu planen, verbinden Sie es mit Mit @capgo/capacitor-twilio-voice Für die native Fähigkeit in Mit @capgo/capacitor-twilio-voice, API-Übersicht Für die Implementierungsdetails in API-Übersicht, Einführung für die Implementierungsdetails in der Einführung, API Keys für die Implementierungsdetails in API Schlüsseln Geräte für die Implementierungsdetails in den Geräten.