nixonsam / plivo-android-quickstart-app

Plivo Voice Quickstart for Android

Introduction

The Plivo Android SDK v2 allows you to make outgoing and receive incoming calls in your Android application. To get started with this quickstart application follow these steps.

• Outgoing Call: Follow the below steps to start making outbound calls
  • Install the Plivo Android SDK using gradle
  • Create Endpoints
  • Register and Unregister Endpoint
  • Run the app
  • Making an outgoing call
• Incoming Call: You can enable the application to receive incoming calls in the form of push notifications using Firebase.

System Requirements

• Android SDK supports x86, x86_64, arm64-v8a, armeabi-v7a architectures and Android OS 6 & above.
• You can use Android Studio or Eclipse to build this quickstart app.
• Plivo Android SDK supports IPv6 networks. Users can make and receive calls when their device is connected to a network that uses IPv4, IPv6, or both versions of the protocol.

Install the Plivo Android SDK using gradle

It's easy to install the Android sdk if you manage your dependencies using gradle. Simply add the following to your build.gradle under app folder and remove the aar file under plivo-android-quickstart-app/app/libs:

// Replace 2.0.16 with latest version
implementation 'com.plivo.endpoint:endpoint:2.0.16@aar'

If you don't want to use gradle, simply build project since we already have aar file by default under plivo-android-quickstart-app/app/libs.

SDK Reference - More documentation related to the Voice Android SDK

Sign up for an account

Register here to get your free Plivo account today.

Below are the steps that are to be followed to successfully Sign up for a free trial account.

1. Sign up with your corporate email address
2. You will receive an activation email from Plivo. Click on the link mentioned in the email to activate your account.
3. Enter an sms enabled, non-VOIP number to complete the phone verification.

Sign up with your corporate email address

If you are facing any issues while creating a Plivo account, you can reach out to our Support Team

Create Endpoints

You can create an endpoint from the Plivo Console and assign an application to make and receive calls after configuring the endpoint in the quickstart app.

Note: You can make use of the demo 'Direct Dial' app in your account for the endpoint which will allow you to make and receive calls for testing purposes.

Register and Unregister Endpoints

Implement SIP register to Plivo Communication Server

To register with Plivo's SIP and Media server , use a valid sip uri account from plivo web console

private Endpoint endpoint;
Endpoint endpoint = Endpoint.newInstance(true, this);

// To register with SIP Server
public void login(String username, String password) {
   endpoint.login(username, password);
}

// To register with SIP Server using device token for getting Push Notifications
public void login(String username, String password, String fcmToken) {
   endpoint.login(username, password, fcmToken);
}

// To register with SIP Server using device token and certificate id
public void login(String username, String password, String fcmToken, String certificateId) {
   endpoint.login(username, password, fcmToken, certificateId);
}

// To register with SIP Server using registration timeout
public void login(String username, String password, String regTimeout) {
   endpoint.login(username, password, regTimeout);
}

//To unregister with SIP Server
public void logout() {
   endpoint.logout();
}

If the registration to an endpoint succeeds the following delegate gets called

@Override
public void onLogin() {
   if (loginListener != null) loginListener.onLogin(true);
}

If the registration to an endpoint fails the following delegate gets called

@Override
public void onLoginFailed() {
   if (loginListener != null) loginListener.onLogin(false);
}

Run the app

• Clone the repo and open plivo-android-quickstart-app.
• Change sip endpoint username and password in Utils.
• Build and run the app.
• After successful login make VoiceCalls.

Making an outgoing call

Make an outgoing call with destination & headers:

Create PlivoOutgoingCall object , then make a call with destination and headers

public Outgoing getOutgoing() {
    return endpoint.createOutgoingCall();
}
    
private void makeCall(String phoneNum) {
    Outgoing outgoing = ((App) getApplication()).backend().getOutgoing();
    if (outgoing != null) {
        outgoing.call(phoneNum);
    }
}

Make an outgoing call with destination:

Calling this method on the PlivoOutgoing object with the SIP URI would initiate an outbound call.

public boolean call(String dest);

Make an outgoing call with destination & custom SIP headers:

Calling this method on the PlivoOutgoing object with the SIP URI would initiate an outbound call with custom SIP headers.

public boolean callH(String dest, Map<String, String> headers);

Receive an incoming call

To enable Pushkit Integration in the SDK: Login with registerToken, create FirebaseMessagingService class and implement relayVoipPushNotification method

//Register pushkit token using the login method as mentioned above
public void login(String username, String password, String fcmToken) {
   endpoint.login(username, password, fcmToken);
}

//Create a FirebaseMessagingService class and call relayIncomingPushData method
public class PlivoFCMService extends FirebaseMessagingService {
    @Override
    public void onMessageReceived(RemoteMessage remoteMessage) {
        super.onMessageReceived(remoteMessage);
        if (remoteMessage.getData() != null) {
            ((App) getApplication()).backend().relayIncomingPushData(new HashMap<>(remoteMessage.getData()));
            startActivity(new Intent(this, MainActivity.class)
                    .addFlags(Intent.FLAG_ACTIVITY_NEW_TASK)
            );
        }
    }
}

//receive and pass on (incoming call information or a message) to SDK using relayVoipPushNotification method.
public void relayIncomingPushData(HashMap<String, String> incomingData) {
    if (incomingData != null && !incomingData.isEmpty()) {
        endpoint.relayVoipPushNotification(incomingData);
    }
}

incomingData is the Map object forwarded by the firebase push notification. This will enable the application to receive incoming calls even the app is not in foreground.

incomingData is the Map object forwarded by the firebase push notification. This will enable the application to receive incoming calls even if the app is not in the foreground.

Please refer to this guide to learn about Generating VoIP Certificate

License

MIT