Aller au contenu principal
@capgo/capacitor-twilio-voice Communication Open source

Twilio Voice Plugin Capacitor

Passez et recevez des appels VoIP avec Twilio Voice pour vos fonctionnalités d'appels in-app

Installer

bun add @capgo/capacitor-twilio-voice bunx cap sync
npm, pnpm ou yarn
  • npm install @capgo/capacitor-twilio-voice
  • pnpm add @capgo/capacitor-twilio-voice
  • yarn add @capgo/capacitor-twilio-voice

Guide

Comment utiliser Twilio Voice dans Capacitor

Utiliser @capgo/capacitor-twilio-voice

Intègre le SDK Twilio Voice dans Capacitor.

Installer

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

bunx cap sync copie le code natif du plugin dans vos projets natifs. Relancez-l’après chaque mise à jour du plugin.

Importer

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

Aperçu de API

Méthode Description
login Authentifiez l'utilisateur avec Twilio Voice via un access token.
logout Déconnecter l'utilisateur actuel et le désenregistrer de Twilio Voice.
isLoggedIn Vérifier si l’utilisateur est connecté et possède un token d’accès valide.
makeCall Passer un appel sortant vers un numéro de téléphone ou un client.
acceptCall Accepter un appel entrant.
rejectCall Rejeter un appel entrant.
endCall Terminer un appel actif.
muteCall Couper ou réactiver le micro pendant un appel en cours.
setSpeaker Activer ou désactiver le mode haut-parleur.
getCallStatus Récupérer le statut actuel de l'appel actif.
checkMicrophonePermission Vérifier si l'autorisation d'utiliser le microphone a été accordée.
requestMicrophonePermission Demander l’autorisation d’accès au micro à l’utilisateur.

Exemples

login()

Authentifiez l'utilisateur avec Twilio Voice via un access token.

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

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

logout()

Déconnecter l'utilisateur actuel et le désenregistrer de Twilio Voice.

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

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

isLoggedIn()

Vérifier si l’utilisateur est connecté et possède un token 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()

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

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()

Accepter un appel entrant.

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()

Rejeter un appel entrant.

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

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

Le tableau ci-dessus liste les 12 méthodes principales. Les helpers de listener et de version, ainsi que le contrat complet de chaque méthode, sont documentés dans la dépôt GitHub.

Écouter les événements

addListener renvoie un handle. Appelez handle.remove() lors du démontage de l'écran, ou CapacitorTwilioVoice.removeAllListeners() pour supprimer tous les listeners.

Référence complète

Continuer depuis « Utiliser @capgo/capacitor-twilio-voice »

Si vous utilisez Utiliser @capgo/capacitor-twilio-voice pour planifier le travail sur les plugins natifs, connectez-l’à @capgo/capacitor-twilio-voice pour les détails d’implémentation dans @capgo/capacitor-twilio-voice, Prise en main pour les détails d'implémentation dans Getting Started Capgo Répertoire des plugins pour le workflow produit dans Capgo Plugin Directory, Plugins Capacitor par Capgo pour les détails d'implémentation dans les plugins Capacitor par Capgo, et Ajouter ou mettre à jour des plugins pour les détails d'implémentation dans Adding or Updating Plugins.

FAQ

FAQ du plugin Twilio Voice

Comment installer le plugin Twilio Voice dans une app Capacitor ?

Exécutez « bun add @capgo/capacitor-twilio-voice » (ou « npm install @capgo/capacitor-twilio-voice »), puis « bunx cap sync » pour que les projets iOS et Android récupèrent le code natif code. Importez-le depuis « @capgo/capacitor-twilio-voice » dans le code de votre app.

@capgo/capacitor-twilio-voice fonctionne-t-il avec React, Vue et Angular ?

Oui. Twilio Voice est un package Capacitor, il fonctionne donc avec n’importe quel framework web exécuté dans Capacitor, y compris Ionic, React, Vue, Angular, Svelte et le JavaScript pur.

Quelle version de Capacitor @capgo/capacitor-twilio-voice prend-il en charge ?

Les plugins Capgo suivent la version majeure de Capacitor : utilisez la version majeure du plugin qui correspond à la version majeure de votre Capacitor (par exemple le plugin v8 avec Capacitor 8). Le tableau de compatibilité du README de GitHub recense les versions maintenues.

@capgo/capacitor-twilio-voice est-il gratuit et open source ?

Oui. Le code source code est public sur GitHub à l’adresse https://github.com/Cap-go/capacitor-twilio-voice/ et le package est gratuit à installer depuis npm. Les signalements de bugs et les pull requests sont les bienvenus.

Puis-je mettre à jour code qui utilise Twilio Voice sans passer par une revue de l’App Store ?

L'installation ou la mise à jour du plugin modifie le code natif, ce qui impose un nouveau build pour les stores. Ensuite, les changements JavaScript, HTML et CSS qui appellent le plugin peuvent être livrés instantanément via les live updates de Capgo.

Déployez les modifications Twilio Voice sans attendre la validation de l’application

Une fois le plugin intégré à votre build de store, Capgo live updates déploie vos changements JavaScript, HTML et CSS aux utilisateurs en quelques minutes.

Commencez avec Capgo