react-native-voips-calls

v1.1.4

Published

a year ago

webrtc background supported call notifications

Downloads

react-native-voips-call

Getting started

Npm

$ npm install react-native-voips-calls --save

Yarn

$ yarn add react-native-voips-calls

Mostly automatic installation RN < 0.60.x

$ react-native link react-native-voips-calls

ios Installation

$ cd ios && pod install

Link required libraries Click on Build Phases tab, then open Link Binary With Libraries.

Add CallKit.framework and Intents.framework (and mark it Optional).

alt text

Usage of RNVoip Call

`import this package as your needed places`

import RNVoipCall from "react-native-voips-calls";

1. initialize Call (IOS Required)

    let options = {
      appName:'RNVoip App', // Required
      imageName:  'logo',  //string (optional) in ios Resource Folder
      ringtoneSound : '', //string (optional) If provided, it will be played when incoming calls received
      includesCallsInRecents: false, // boolean (optional) If provided, calls will be shown in the recent calls
      supportsVideo : true //boolean (optional) If provided, whether or not the application supports video calling (Default: true)
    }
    // Initlize Call Kit IOS is Required
    RNVoipCall.initializeCall(options).then(()=>{
     //Success Call Back
    }).catch(e=>console.log(e));

2. display Incoming Call

let callOptions = {
  callerId: "825f4094-a674-4765-96a7-1ac512c02a71", // Important uuid must in this format
  ios: {
    phoneNumber: "12344", // Caller Mobile Number
    name: "RNVoip", // caller Name
    hasVideo: true,
  },
  android: {
    ringtuneSound: true, // default true
    ringtune: "ringtune", // add file inside Project_folder/android/app/res/raw
    duration: 20000, // default 30000
    vibration: true, // default is true
    channel_name: "call1asd", //
    notificationId: 1121,
    notificationTitle: "Incoming Call",
    notificationBody: "Some One is Calling...",
    answerActionTitle: "Answer",
    declineActionTitle: "Decline",
  },
};

RNVoipCall.displayIncomingCall(callOptions)
  .then((data) => {
    console.log(data);
  })
  .catch((e) => console.log(e));

3. call End

RNVoipCall.endCall(uuid); // End specific Call
RNVoipCall.endAllCalls(); // End All Calls

4. Call Answer Event

RNVoipCall.onCallAnswer((data) => {
  //Remove endCall listener when a call is coming
  RNVoipCall.onRemoveEndCallListener();
  console.log(data);
});

5. Call End Event

RNVoipCall.onEndCall((data) => {
  console.log(data);
});

6.Check Call Active (Ios Only)

RNVoipCall.isCallActive(uuid);

7. Event Listener (Ios only)

RNVoipCall.addEventListener(
  "didDisplayIncomingCall",
  ({
    error,
    callUUID,
    handle,
    localizedCallerName,
    hasVideo,
    fromPushKit,
    payload,
  }) => {}
);

RNVoipCall.addEventListener("didActivateAudioSession", () => {
  // you might want to do following things when receiving this event:
  // - Start playing ringback if it is an outgoing call
});

RNVoipCall.addEventListener(
  "didPerformSetMutedCallAction",
  ({ muted, callUUID }) => {}
);

8. call back on android app in background state (Android only)

RNVoipCall.getInitialNotificationActions()
  .then((data) => console.log(data))
  .catch((e) => console.log(e));

9. Event Listener (Android only)

//app open Automatically when Call recived
RNVoipCall.onCallOpenAppEvent((event) => {});
// on click call Notification
RNVoipCall.onCallNotificationOpen((event) => {});
// missed call notification taped
RNVoipCall.onMissedCallOpen((event) => {});

10. Play and stop ringtune (Android only)

RNVoipCall.playRingtune("ringtune", true); // param1 -> name of the ringtune in inside Project_folder/android/app/res/raw , param2 -> play ringtune as loop
RNVoipCall.stopRingtune();

Usage (Background Integration)

1. IOS

1.1 Configure Voip Service to App

please Refer and Configure Apple Voice Over IP
Make sure you enabled the folowing in Xcode -> Signing & Capabilities:

2.1) Background Modes -> Voice over IP enabled 2.2 )Capability -> Push Notifications 2.3) Add PushKit.framework

alt text

Add Following Code to Xcode -> project_folder -> AppDelegate.m


...

#import "RNVoipCall.h"                          /* <------ add this line */
#import <PushKit/PushKit.h>                    /* <------ add this line */
#import "RNVoipPushKit.h"                     /* <------ add this line */

@implementation AppDelegate

....

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
{
    ....
}


// --- Handle updated push credentials
- (void)pushRegistry:(PKPushRegistry *)registry didUpdatePushCredentials:(PKPushCredentials *)credentials forType:(PKPushType)type {
  // Register VoIP push token (a property of PKPushCredentials) with server
  [RNVoipPushKit didUpdatePushCredentials:credentials forType:(NSString *)type];
}

- (void)pushRegistry:(PKPushRegistry *)registry didInvalidatePushTokenForType:(PKPushType)type
{
  // --- The system calls this method when a previously provided push token is no longer valid for use. No action is necessary on your part to reregister the push type. Instead, use this method to notify your server not to send push notifications using the matching push token.
}


// --- Handle incoming pushes (for ios <= 10)
- (void)pushRegistry:(PKPushRegistry *)registry didReceiveIncomingPushWithPayload:(PKPushPayload *)payload forType:(PKPushType)type {
   NSLog(@"Ajith");



  [RNVoipPushKit didReceiveIncomingPushWithPayload:payload forType:(NSString *)type];
}

// --- Handle incoming pushes (for ios >= 11)
- (void)pushRegistry:(PKPushRegistry *)registry didReceiveIncomingPushWithPayload:(PKPushPayload *)payload forType:(PKPushType)type withCompletionHandler:(void (^)(void))completion {



  NSString *callerName = @"RNVoip is Calling";
  NSString *callerId = [[[NSUUID UUID] UUIDString] lowercaseString];
  NSString *handle = @"1234567890";
  NSString *handleType = @"generic";
  BOOL hasVideo = false;


  @try {
    if([payload.dictionaryPayload[@"data"] isKindOfClass:[NSDictionary class]]){
      NSDictionary *dataPayload = payload.dictionaryPayload[@"data"];

      callerName = [dataPayload[@"name"] isKindOfClass:[NSString class]] ?  [NSString stringWithFormat: @"%@ is Calling", dataPayload[@"name"]] : @"RNVoip is Calling";

      callerId = [dataPayload[@"uuid"] isKindOfClass:[NSString class]] ?  dataPayload[@"uuid"] : [[[NSUUID UUID] UUIDString] lowercaseString];

      handle = [dataPayload[@"handle"] isKindOfClass:[NSString class]] ?  dataPayload[@"handle"] : @"1234567890";

      handleType = [dataPayload[@"handleType"] isKindOfClass:[NSString class]] ?  dataPayload[@"handleType"] : @"generic";

      hasVideo = dataPayload[@"hasVideo"] ? true : false;

    }
  } @catch (NSException *exception) {

    NSLog(@"Error PushKit payload %@", exception);

  } @finally {


    NSLog(@"RNVoip caller id ===> %@    callerNAme  ==> %@ handle  ==> %@",callerId, callerName, hasVideo ? @"true": @"false");

    NSDictionary *extra = [payload.dictionaryPayload valueForKeyPath:@"data"];

    [RNVoipCall reportNewIncomingCall:callerId handle:handle handleType:handleType hasVideo:hasVideo localizedCallerName:callerName fromPushKit: YES payload:extra withCompletionHandler:completion];

    [RNVoipPushKit didReceiveIncomingPushWithPayload:payload forType:(NSString *)type];

  }
}

@end

Add Following Code to Xcode -> project_folder -> info.plist

<key>UIBackgroundModes</key>
<array>
    <string>audio</string>
    <string>voip</string>
    <string>fetch</string>
    <string>remote-notification</string>
</array>

IosPushKitHandler.js

import React, { useEffect, useState } from "react";
import { View, Text, Platform, Button } from "react-native";
import RNVoipCall, { RNVoipPushKit } from "react-native-voip-call";

const IsIos = Platform.OS === "ios";

const log = (data) => console.log("RNVoipCall===> ", data);

const IosPushKitHandler = () => {
  const [pushkitToken, setPushkitToken] = useState("");

  useEffect(() => {
    iosPushKit();
  }, []);

  const iosPushKit = () => {
    if (IsIos) {
      //For Push Kit
      RNVoipPushKit.requestPermissions(); // --- optional, you can use another library to request permissions

      //Ios PushKit device token Listener
      RNVoipPushKit.getPushKitDeviceToken((res) => {
        if (res.platform === "ios") {
          setPushkitToken(res.deviceToken);
        }
      });

      //On Remote Push notification Received in Forground
      RNVoipPushKit.RemotePushKitNotificationReceived((notification) => {
        log(notification);
      });
    }
  };

  return (
    <View>
      <Text>{"push kit token:" + pushkitToken}</Text>
    </View>
  );
};

export default IosPushKitHandler;

Create pem file for push please Refer generate Cretificate , convert p12 to pem
send push sendPush.php

2. Android

Configure and install below 2 packages

# Install & setup the app module
yarn add @react-native-firebase/app

# Install the messaging module
yarn add @react-native-firebase/messaging

# If you're developing your app using iOS, run this command
cd ios/ && pod install

Installation

Add the below code to index.js in Root folder

import messaging from "@react-native-firebase/messaging";
import RNVoipCall from "react-native-voip-call";

messaging().setBackgroundMessageHandler(async (remoteMessage) => {
  console.log("Message handled in the background!", remoteMessage);
  if (Platform.OS === "android") {
    let data;
    if (remoteMessage.data) {
      data = remoteMessage.data;
    }
    if (data && data.type === "call" && data.uuid) {
      let callOptions = {
        callerId: data.uuid, // Important uuid must in this format
        ios: {
          phoneNumber: "12344", // Caller Mobile Number
          name: data.name, // caller Name
          hasVideo: true,
        },
        android: {
          ringtuneSound: true, // default true
          ringtune: "ringtune", // add file inside Project_folder/android/app/res/raw --Formats--> mp3,wav
          duration: 30000, // default 30000
          vibration: true, // default is true
          channel_name: "call", //
          notificationId: 1123,
          notificationTitle: "Incoming Call",
          notificationBody: data.name + " is Calling...",
          answerActionTitle: "Answer",
          declineActionTitle: "Decline",
        },
      };
      RNVoipCall.displayIncomingCall(callOptions)
        .then((data) => {
          console.log(data);
        })
        .catch((e) => console.log(e));
    }
  }
});

push payload

{
  "to":"asgvdsdjhsfdsfd....", //device token
  "data":{
    "priority":"high", // Android required for background Notification
     "uuid":"uuid of user",
     "name":"RNVoip",
     "type":"call" // to identify reciving call Notification

  }

}

Demo

| ios | Android | android( Lockscreen) | | --------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | | | | |

Author

Deepika Srinivasan

Ajith A B

licenses

MIT

Initial credits goes to https://github.com/ajith-ab/react-native-voip-call. Created this package to support new releases as the original package is not supporting any updates.