React Native wrapper for Twilio Programmable Voice SDK
This is a React-Native wrapper for Twilio Programmable Voice SDK which lets you make and receive calls from your React-Native App. This module is not affiliated with nor officially maintained by Twilio, and it is maintained by open source contributors.
The module implements react-native autolinking as many other native libraries > react-native 0.60.0, therefore it doesn't need to be linked manually.
Android: update Firebase Messaging to 17.6.+. Remove the following block from your application's
AndroidManifest.xmlif you are migrating from v3.
Android X is supported.
Data passed to the event
deviceDidReceiveIncomingdoes not contain the key
call_state, because state of Call Invites was removed in Twilio Android and iOS SDK v3.0.0
iOS: params changes for
connectionDidConnectand
connectionDidDisconnect
to => callto from => callfrom error => err
New features
Twilio Programmable Voice SDK v3.0.0 handles call invites directly and makes it easy to distinguish a call invites from an active call, which previously was confusing. To ensure that an active call is displayed when the app comes to foreground you should use the promise
getActiveCall(). To ensure that a call invite is displayed when the app comes to foreground use the promise
getCallInvite(). Please note that call invites don't have a
call_statefield.
You should use
hold()to put a call on hold.
You can be notified when a call is
ringingby listening for
callStateRingingevents.
iOS application can now receive the following events, that in v3 where only dispatched to Android:
initializedinstead of
initilized
connectionDidConnectreturns the same properties as Android move property
to=>
call_tomove property
from=>
call_from
Before starting, we recommend you get familiar with Twilio Programmable Voice SDK. It's easier to integrate this module into your react-native app if you follow the Quick start tutorial from Twilio, because it makes very clear which setup steps are required.
npm install react-native-twilio-programmable-voice --save
CLI autolink feature links the module while building the app.
react-native link react-native-twilio-programmable-voice
If you can't or don't want to use autolink, you can also manually link the library using the instructions below (click on the arrow to show them):
Follow the instructions in the React Native documentation to manually link the framework
After you have linked the library with react-native link react-native-twilio-programmable-voice
check that libRNTwilioVoice.a
is present under YOUR_TARGET > Build Phases > Link Binaries With Libraries. If it is not present you can add it using the + sign at the bottom of that list.
Edit your
Podfileto include TwilioVoice framework
source 'https://github.com/cocoapods/specs'min version for TwilioVoice to work
platform :ios, '10.0'
target do ... pod 'TwilioVoice', '~> 5.2.0' ... end
cd ios/ && pod install
The iOS library works through CallKit and handling calls is much simpler than the Android implementation as CallKit handles the inbound calls answering, ignoring, or rejecting. Outbound calls must be controlled by custom React-Native screens and controls.
To pass caller's name to CallKit via Voip push notification add custom parameter 'CallerName' to Twilio Dial verb.
Client NAME TO DISPLAY
Twilio Programmable Voice for iOS utilizes Apple's VoIP Services and VoIP "Push Notifications" instead of FCM. You will need a VoIP Service Certificate from Apple to receive calls. Follow the official Twilio instructions to complete this step.
Setup FCM
You must download the file
google-services.jsonfrom the Firebase console. It contains keys and settings for all your applications under Firebase. This library obtains the resource
senderIDfor registering for remote GCM from that file.
android/build.gradle
buildscript { dependencies { // override the google-service version if needed // https://developers.google.com/android/guides/google-services-plugin classpath 'com.google.gms:google-services:4.3.3' } }// this plugin looks for google-services.json in your project apply plugin: 'com.google.gms.google-services'
AndroidManifest.xml
<application ....> <!-- Twilio Voice --> <!-- [START fcm_listener] --> <service android:name="com.hoxfon.react.RNTwilioVoice.fcm.VoiceFirebaseMessagingService"> <intent-filter> <action android:name="com.google.firebase.MESSAGING_EVENT"></action> </intent-filter> </service> <!-- [END fcm_listener] -->
If you can't or don't want to use autolink, you can also manually link the library using the instructions below (click on the arrow to show them):
Make the following changes:
android/settings.gradle
include ':react-native-twilio-programmable-voice'
project(':react-native-twilio-programmable-voice').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-twilio-programmable-voice/android')
android/app/build.gradle
dependencies {
implementation project(':react-native-twilio-programmable-voice')
}
android/app/src/main/.../MainApplication.java
On top, where imports are:
```java import com.hoxfon.react.RNTwilioVoice.TwilioVoicePackage; // getPackages() { return Arrays.asList( new MainReactPackage(), new TwilioVoicePackage() //
import TwilioVoice from 'react-native-twilio-programmable-voice'// ...
// initialize the Programmable Voice SDK passing an access token obtained from the server. // Listen to deviceReady and deviceNotReady events to see whether the initialization succeeded. async function initTelephony() { try { const accessToken = await getAccessTokenFromServer() const success = await TwilioVoice.initWithToken(accessToken) } catch (err) { console.err(err) } }
function initTelephonyWithToken(token) { TwilioVoice.initWithAccessToken(token)
// iOS only, configure CallKit try { TwilioVoice.configureCallKit({ appName: 'TwilioVoiceExample', // Required param imageName: 'my_image_name_in_bundle', // OPTIONAL ringtoneSound: 'my_ringtone_sound_filename_in_bundle' // OPTIONAL }) } catch (err) { console.err(err) }
}
// add listeners (flowtype notation) TwilioVoice.addEventListener('deviceReady', function() { // no data }) TwilioVoice.addEventListener('deviceNotReady', function(data) { // { // err: string // } }) TwilioVoice.addEventListener('connectionDidConnect', function(data) { // { // call_sid: string, // Twilio call sid // call_state: 'CONNECTED' | 'ACCEPTED' | 'CONNECTING' | 'RINGING' | 'DISCONNECTED' | 'CANCELLED', // call_from: string, // "+441234567890" // call_to: string, // "client:bob" // } }) TwilioVoice.addEventListener('connectionIsReconnecting', function(data) { // { // call_sid: string, // Twilio call sid // call_from: string, // "+441234567890" // call_to: string, // "client:bob" // } }) TwilioVoice.addEventListener('connectionDidReconnect', function(data) { // { // call_sid: string, // Twilio call sid // call_from: string, // "+441234567890" // call_to: string, // "client:bob" // } }) TwilioVoice.addEventListener('connectionDidDisconnect', function(data: mixed) { // | null // | { // err: string // } // | { // call_sid: string, // Twilio call sid // call_state: 'CONNECTED' | 'ACCEPTED' | 'CONNECTING' | 'RINGING' | 'DISCONNECTED' | 'CANCELLED', // call_from: string, // "+441234567890" // call_to: string, // "client:bob" // err?: string, // } }) TwilioVoice.addEventListener('callStateRinging', function(data: mixed) { // { // call_sid: string, // Twilio call sid // call_state: 'CONNECTED' | 'ACCEPTED' | 'CONNECTING' | 'RINGING' | 'DISCONNECTED' | 'CANCELLED', // call_from: string, // "+441234567890" // call_to: string, // "client:bob" // } }) TwilioVoice.addEventListener('callInviteCancelled', function(data: mixed) { // { // call_sid: string, // Twilio call sid // call_from: string, // "+441234567890" // call_to: string, // "client:bob" // } })// iOS Only TwilioVoice.addEventListener('callRejected', function(value: 'callRejected') {})
TwilioVoice.addEventListener('deviceDidReceiveIncoming', function(data) { // { // call_sid: string, // Twilio call sid // call_from: string, // "+441234567890" // call_to: string, // "client:bob" // } })
// Android Only TwilioVoice.addEventListener('proximity', function(data) { // { // isNear: boolean // } })
// Android Only TwilioVoice.addEventListener('wiredHeadset', function(data) { // { // isPlugged: boolean, // hasMic: boolean, // deviceName: string // } })
// ...
// start a call TwilioVoice.connect({To: '+61234567890'})
// hangup TwilioVoice.disconnect()
// accept an incoming call (Android only, in iOS CallKit provides the UI for this) TwilioVoice.accept()
// reject an incoming call (Android only, in iOS CallKit provides the UI for this) TwilioVoice.reject()
// ignore an incoming call (Android only) TwilioVoice.ignore()
// mute or un-mute the call // mutedValue must be a boolean TwilioVoice.setMuted(mutedValue)
// put a call on hold TwilioVoice.hold(holdValue)
// send digits TwilioVoice.sendDigits(digits)
// Ensure that an active call is displayed when the app comes to foreground TwilioVoice.getActiveCall() .then(activeCall => { if (activeCall){ _displayActiveCall(activeCall) } })
// Ensure that call invites are displayed when the app comes to foreground TwilioVoice.getCallInvite() .then(callInvite => { if (callInvite){ _handleCallInvite(callInvite) } })
// Unregister device with Twilio (iOS only) TwilioVoice.unregister()
There is no need to ask permissions to contribute. Just open an issue or provide a PR. Everybody is welcome to contribute.
ReactNative success is directly linked to its module ecosystem. One way to make an impact is helping contributing to this module or another of the many community lead ones.
iOS changelog Android changelog
react-native-push-notification
MIT