Démarrage

Installer

Vous pouvez utiliser notre configuration assistée par l'IA pour installer le plugin. Ajoutez les Capgo compétences à votre outil IA à l'aide de la commande suivante :

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

Ensuite, utilisez la prompt suivante :

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

Si vous préférez la configuration manuelle, installez le plugin en exécutant les commandes suivantes et suivez les instructions spécifiques à la plateforme ci-dessous :

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

Importer

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

API Vue d'ensemble

login

Authentifier l'utilisateur avec Twilio Voice à l'aide d'un jeton d'accès.

Le jeton d'accès doit être généré sur votre serveur backend à l'aide de vos informations de compte Twilio. Ce jeton est requis pour passer et recevoir des appels à l'aide de Twilio Voice.

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

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

logout

Se déconnecter de l'utilisateur actuel et se désinscrire de Twilio Voice.

Cela déconnectera tout appel actif et arrêtera le dispositif de recevoir de nouvelles notifications d'appel entrant.

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

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

isLoggedIn

Vérifiez si l'utilisateur est actuellement connecté et dispose d'un jeton d'accès valide.

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

Initiez un appel sortant vers un numéro de téléphone ou un client.

L'utilisateur doit être connecté avant de passer un appel. L'appel sera acheminé à travers votre configuration de 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

Acceptez un appel entrant.

Cette méthode doit être appelée en réponse à un événement « appelInviteReçu ».

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

Refusez un appel entrant.

Cette fonction doit être appelée en réponse à un événement ‘callInviteReceived’. L’appelant entendra un signal d'occupation ou sera redirigé vers le messagerie vocale.

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

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

endCall

Terminer une appelle active.

Si callSid n'est pas fourni, cela terminera l'appel actuellement en cours.

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

Mettre au silence ou démettre le micro pendant une appelle active.

Lorsque la fonction est mise au silence, la partie adverse ne peut pas entendre l'audio provenant de votre micro.

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

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

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

setSpeaker

Activer ou désactiver le mode haut-parleur.

When activé, l'audio sera routé vers le haut-parleur du dispositif au lieu de l'écouteur.

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

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

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

getCallStatus

Obtenez l'état actuel de l'appel en cours.

Cette fonction fournit des informations en temps réel sur l'état de l'appel, le statut de la sourdine, le statut de mise en attente et les identifiants de l'appel.

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

Vérifiez si la permission de micro est accordée.

Cette fonction ne demande pas la permission, elle vérifie uniquement le statut de permission actuel.

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

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

requestMicrophonePermission

Demandez la permission de micro à l'utilisateur.

On iOS et Android, cela affichera le dialogue de permission système si la permission n'a pas encore été accordée. Si la permission a été refusée précédemment, l'utilisateur doit peut-être la concéder dans les paramètres système.

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

Référence de type

CallInvite

Capacitor plugin pour intégrer la fonctionnalité de la voix Twilio dans les applications mobiles.

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

Source de vérité

Cette page est générée à partir du plugin's src/definitions.ts. Re-run la synchronisation lorsque les modifications publiques API se produisent en amont.

Continuez de la section « Getting Started »

Si vous utilisez Démarrage pour planifier le tableau de bord et les opérations API, connectez-l’avec Utilisation de @capgo/capacitor-twilio-voice pour la capacité native dans Utilisation de @capgo/capacitor-twilio-voice, Vue d'ensemble de API pour les détails d'implémentation dans Vue d'ensemble de API, Introduction pour les détails d'implémentation dans Introduction, Clés de API pour les détails d'implémentation dans Clés de API, Appareils pour le détail d'implémentation dans Appareils.