Aller au contenu

Prise en main

GitHub

Vous pouvez utiliser notre configuration assistée par IA pour installer le plugin. Ajoutez les skills Capgo à votre outil d'IA avec la commande suivante :

Fenêtre de terminal
npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

Utilisez ensuite le prompt suivant :

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 une installation manuelle, installez le plugin en exécutant les commandes suivantes et suivez les instructions spécifiques à chaque plateforme ci-dessous :

Fenêtre de terminal
npm install @capgo/capacitor-twilio-voice
npx cap sync
import { CapacitorTwilioVoice } from '@capgo/capacitor-twilio-voice';
import { CapacitorTwilioVoice } from '@capgo/capacitor-twilio-voice';
await CapacitorTwilioVoice.login({ accessToken: tokenFromBackend });
await CapacitorTwilioVoice.makeCall({ to: '+15551234567' });
  • TTL du token: rafraîchir les tokens Twilio avant expiration.
  • Entrant: configurer les push VoIP sur iOS.
  • Permission micro: à demander avant de passer des appels.

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

L'access token doit être généré sur votre serveur backend à l'aide de vos identifiants Twilio. Ce token est indispensable pour passer et recevoir des appels via Twilio Voice.

import { CapacitorTwilioVoice } from '@capgo/capacitor-twilio-voice';
const result = await CapacitorTwilioVoice.login({
accessToken: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...'
});
console.log('Login successful:', result.success);

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

Cela coupera tous les appels en cours et empêchera l'appareil de recevoir de nouvelles notifications d'appels entrants.

import { CapacitorTwilioVoice } from '@capgo/capacitor-twilio-voice';
const result = await CapacitorTwilioVoice.logout();
console.log('Logout successful:', result.success);

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
}

Passer 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 routé via votre configuration 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'
});

Accepter un appel entrant.

Cette méthode doit être appelée en réponse à un événement « 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);
});

Rejeter un appel entrant.

Cette méthode doit être appelée en réponse à un événement « callInviteReceived ». L’appelant entendra une tonalité d’occupation ou sera redirigé vers la messagerie vocale.

import { CapacitorTwilioVoice } from '@capgo/capacitor-twilio-voice';
CapacitorTwilioVoice.addListener('callInviteReceived', async (data) => {
if (shouldRejectCall(data.from)) {
await CapacitorTwilioVoice.rejectCall({
callSid: data.callSid
});
}
});

Terminer un appel actif.

Si callSid n’est pas fourni, cela mettra fin à l’appel 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'
});

Couper ou réactiver le micro pendant un appel en cours.

Lorsqu'elle est activée, l'autre partie n'entendra pas le son 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
});

Activer ou désactiver le mode haut-parleur.

Une fois activé, l'audio sera diffusé par le haut-parleur de l'appareil 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
});

Récupérer le statut actuel de l'appel actif.

Cela fournit des informations en temps réel sur l'état de l'appel, le statut de sourdine, la 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);
}

Vérifier si l'autorisation d'utiliser le microphone a été accordée.

Cette méthode ne demande pas l'autorisation, elle vérifie uniquement le statut actuel.

import { CapacitorTwilioVoice } from '@capgo/capacitor-twilio-voice';
const result = await CapacitorTwilioVoice.checkMicrophonePermission();
if (!result.granted) {
console.log('Microphone permission not granted');
}

Demander l’autorisation d’accès au micro à l’utilisateur.

Sur iOS et Android, cela affiche la boîte de dialogue d’autorisation système si la permission n’a pas encore été accordée. Si elle a été refusée auparavant, l’utilisateur devra peut-être l’accorder dans les réglages 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');
}

Plugin Capacitor pour intégrer les fonctionnalités Twilio Voice 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>;
}

Cette page est générée à partir de src/definitions.ts. Relancez la synchronisation lorsque l’API public change en amont.

Si vous utilisez Prise en main pour planifier les opérations du dashboard et de API, connectez-l’avec Utiliser @capgo/capacitor-twilio-voice pour la fonctionnalité native dans Utilisation de @capgo/capacitor-twilio-voice, Aperçu de API pour les détails d'implémentation dans « Vue d'ensemble de API », Introduction pour les détails d'implémentation dans l'introduction, Clés API pour les détails d'implémentation dans « Clés API », et Appareils pour les détails d'implémentation dans Devices.