clevertap-directcall-sdk v0.0.1

CleverTap Direct Call Web SDK

👋 Introduction

CleverTap provides In-App calls via its Direct Call Web SDK, which means you can make calls on any webpage if a device has an internet connection and the Direct Call Web SDK. This section shows how to integrate the Direct Call Web SDK and manage calls.

Integrate the Direct Call Web SDK

Using the Node Package Manager (NPM)

You can add the Direct Call Web SDK as an npm to your web app.

Step 1: Use the following npm command to install the package:

 npm install clevertap-directcall-sdk --save

Step 2: Import the installed package as below:

import {initDirectCall} from 'clevertap-directcall-sdk'

Step 3: Initialize and Authenticate the SDK

let DirectCallClient

initDirectCall(
  {
    accountId: <string>,
    apikey: <string>,
    cuid: <string>,
    clevertap: <clevertap sdk instance>,
    name: <string / optional>,
    ringtone: <string / optional>
  }
).then(client => DirectCallClient = client)
.catch(err => console.log(err))

The options parameter in the initDirectCall function expects a JSON object with the following properties:

Make a Call

The dialing screen displays when the DirectCallClient from the init()function invokes the call() method to make an outbound call. This method returns a promise object whose then() and catch() can be utilized for the following scenarios:

Scenario 1:

When the call is answered, the outgoing call screen transitions into the ongoing call screen. After the transition, the then() method receives an over status and indicates that the call is completed successfully.

Scenario 2:

The declined and missed statuses received by the catch() method indicate whether the receiver rejected the call (decline) or did not answer the call (miss).

The call() parameters are as follows:

Hangup Call

This functionality depends on user behaviour i.e. if one of the user in a call presses the hangup button on the ongoing call screen, the call termination by default is managed by the sdk.

Only in the case of a metered call, when a business wants to end a call after a specific duration, then they must maintain a timer in the app and call the DirectCallClient.hangup() function programatically at an appropriate time.

DirectCallClient.hangup()

Logout the SDK

Logout the DirectCallClient via calling DirectCallClient.logout() method. It ends all the connections, and to make a new call, you must repeat the Initialization and Authentication steps.

DirectCallClient.logout()

Examples

via NPM

  import {initDirectCall} from 'clevertap-directcall-sdk'
  let DirectCallClient
  //initiate the sdk
  initDirectCall({
      accountId, //string, required
      apikey, // string, required
      cuid, // string,required
      clevertap, // clevertap instance, required
      name, // string, optional
      ringtone // string, optional
  }).then(client => DirectCallClient = client).catch(err => console.error(err))

  // make a call
  function call() {
      let callOptions = {
        receiver_image: "", // optional, string
        initiator_image: "" // optional, string
      };

      /**
       * callee {string, required}: cuid whom you are calling
       * context {reason, required}: reason of call
       * callOptions {optional}
       * */
      DirectCallClient.call(callee, context,calloptions)
        .then((response) => {
          console.log("Call response : ", response);
        })
        .catch((error) => {
          console.error(error);
        });
    }

    // Hangup a call automatically after 20000ms 
    setTimeout((DirectCallClient.hangup()), 20000)

    // Logout the sdk 
    let logout = function () {
      DirectCallClient.logout();
    }

Errors

FAQ

Q. Is Direct Call accountId and apikey the same as CleverTap's accountId and token? A. No. Direct Call accountId and apikey are different from CleverTap's accountId and token. You can find these details under your dashboard's Direct Call section.

Q. I am getting an EER_MISSING_CT_IDerror even after passing the correct CleverTap instance to the directcall-sdk?

A. This error occurs due to the following reasons:

• The CleverTap SDK's region and accountId parameters are incorrect.
• CleverTap SDK is not initialized. Recheck these details and if this issue persists, raise an issue at CleverTap Support.