React Native wrapper for Twilio Programmable Voice SDK
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 Quickstart tutorial from Twilio, because it makes very clear which setup steps are required.
npm install react-native-twilio-programmable-voice --save
CallKit
The current iOS portion of this library works through CallKit. Because of this the call flow is much simpler than on Android as CallKit handles the inbound calls answering, ignoring, or rejecting. Because of CallKit, the only event listeners present are "connectionDidConnect", "connectionDidDisconnect", and "callRejected."
VoIP Service Certificate
Twilio Programmable Voice for iOS utilizes Apple's VoIP Services and VoIP "Push Notifications" instead of GCM or FCM. You will need a VoIP Service Certificate from Apple to receive calls.
Setup GCM or FCM
You must download the file google-services.json from the Firebase console.
It contains keys and settings for all your applications under Firebase. This library obtains the resource senderID for registering for remote GCM from that file.
NOTE: To use a specific play-service-gcm version, update the compile instruction in your App's android/app/build.gradle (replace 10.2.0 with the version you prefer):
...
buildscript {
...
dependencies {
classpath 'com.google.gms:google-services:3.0.0'
}
}
...
dependencies {
...
compile project(':react-native-twilio-programmable-voice')
compile ('com.google.android.gms:play-services-gcm:10.2.0') {
force = true;
}
}
// this plugin looks for google-services.json in your project
apply plugin: 'com.google.gms.google-services'In your AndroidManifest.xml
.....
<uses-permission android:name="com.google.android.c2dm.permission.RECEIVE" />
<uses-permission android:name="android.permission.WAKE_LOCK" />
<permission
android:name="${applicationId}.permission.C2D_MESSAGE"
android:protectionLevel="signature" />
<uses-permission android:name="${applicationId}.permission.C2D_MESSAGE" />
<uses-permission android:name="android.permission.VIBRATE" />
<application ....>
<receiver
android:name="com.google.android.gms.gcm.GcmReceiver"
android:exported="true"
android:permission="com.google.android.c2dm.permission.SEND" >
<intent-filter>
<action android:name="com.google.android.c2dm.intent.RECEIVE" />
<action android:name="com.google.android.c2dm.intent.REGISTRATION" />
<category android:name="${applicationId}" />
</intent-filter>
</receiver>
<service android:name="com.hoxfon.react.TwilioVoice.gcm.GCMRegistrationService" />
<service
android:name="com.hoxfon.react.TwilioVoice.gcm.VoiceGCMListenerService"
android:exported="false" >
<intent-filter>
<action android:name="com.google.android.c2dm.intent.RECEIVE" />
</intent-filter>
</service>
<service
android:name="com.hoxfon.react.TwilioVoice.gcm.VoiceInstanceIDListenerService"
android:exported="false">
<intent-filter>
<action android:name="com.google.android.gms.iid.InstanceID" />
</intent-filter>
</service>
.....
In android/settings.gradle
...
include ':react-native-twilio-programmable-voice'
project(':react-native-twilio-programmable-voice').projectDir = file('../node_modules/react-native-twilio-programmable-voice/android')Register module (in MainApplication.java)
import com.hoxfon.react.TwilioVoice.TwilioVoicePackage; // <--- Import Package
public class MainApplication extends Application implements ReactApplication {
private final ReactNativeHost mReactNativeHost = new ReactNativeHost(this) {
@Override
protected boolean getUseDeveloperSupport() {
return BuildConfig.DEBUG;
}
@Override
protected List<ReactPackage> getPackages() {
return Arrays.<ReactPackage>asList(
new MainReactPackage(),
new TwilioVoicePackage() // <---- Add the Package
);
}
};
....
}import TwilioVoice from 'react-native-twilio-programmable-voice'
...
// initialize the Programmable Voice SDK passing an access token obtained from the server.
async function initTelephony() {
try {
const accessToken = await getAccessTokenFromServer()
const success = await TwilioVoice.initWithToken(accessToken)
} catch (err) {
console.err(err)
}
}
// iOS Only
function initTelephonyWithUrl(url) {
TwilioVoice.initWithTokenUrl(url)
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
TwilioVoice.addEventListener('deviceReady', deviceReadyHandler) // Android Only
TwilioVoice.addEventListener('deviceNotReady', deviceNotReadyHandler) // Android Only
TwilioVoice.addEventListener('deviceDidReceiveIncoming', deviceDidReceiveIncomingHandler) // Android Only
TwilioVoice.addEventListener('connectionDidConnect', connectionDidConnectHandler)
TwilioVoice.addEventListener('connectionDidDisconnect', connectionDidDisconnectHandler)
TwilioVoice.addEventListener('callRejected', callRejected) // iOS Only
...
// start a call
TwilioVoice.connect({To: '+61234567890'})
// hangupq
TwilioVoice.disconnect()
// accept an incoming call (Android only)
TwilioVoice.accept()
// reject an incoming call (Android only)
TwilioVoice.reject()
// ignore an incoming call (Android only)
TwilioVoice.ignore()
// mute or unmute the call
// mutedValue must be a boolean
TwilioVoice.setMuted(mutedValue)
TwilioVoice.sendDigits(digits)
TwilioVoice.requestPermission(GCM_sender_id) // Android only
// should be called after the app is initialized
// to catch incoming call when the app was in the background
// Android Only
TwilioVoice.getIncomingCall()
.then(incomingCall => {
if (incomingCall){
_deviceDidReceiveIncoming(incomingCall)
}
})react-native-push-notification
MIT