NotifyClient- Client

The NotifyClient API provides methods that enable you to use Notify telephony functionality, such as making and receiving calls from a web browser.

Several NotifyClient methods take a callback function as a parameter. Because NotifyClient method calls are made asynchronously, these methods can't return a value directly. Use the callback function to parse the returned data, such as by assigning variables or making other API calls.

Parent Topic:Client API reference

NotifyClient - Client(Object notifyConfig, Boolean initializeVendorClientLazily)

Instantiates a new Notify WebRTC Client object.

The following example shows how to create the NotifyClient constructor, register various event listeners, and initialize the client driver.

jQuery(function () {

  var notifyConfig = {
    autoLoadScriptResources: true // This will take care of auto loading the JS resources needed by the client (if any)
  };
  var client = new SNC.Notify.Client(notifyConfig, true); // The second argument ensures that the proper vendor for the given number is auto determined
  client.setCallerId('valid_notify_long_number', function () {
    // This is called after the vendor has been determined.

    if (!notifyConfig.vendor) // Means this number has no compatible vendor
      return;

    client.addEventListener(SNC.Notify.STD_EVENTS.ONLINE, function () {
      // Ability to call is available
    });
    client.addEventListener(SNC.Notify.STD_EVENTS.OFFLINE, function () {
      // Ability to call is _not_ available right now
    });
    client.addEventListener(SNC.Notify.STD_EVENTS.ERROR, function (msg, code) {
      // Some error happened
    });
      //... register other event handlers here
      //Show UI elements which can be used to invoke client.call() and other APIs
    client.init(); // This is important to call this.
    });
});

NotifyClient - addEventListener(String event, Function fn)

Registers an event handler to listen for changes in a Notify client.

Using this method you can register multiple listeners. Each listener must be a separate method call.

This example shows how to register multiple listeners.

jQuery(function () {

  var notifyConfig = {
    autoLoadScriptResources: true // This will take care of auto loading the JS resources needed by the client (if any)
  };
  var client = new SNC.Notify.Client(notifyConfig, true); // The second argument ensures that the proper client for the given number is auto determined
  client.setCallerId('valid_notify_long_number', function () {
    // This is called after the client has been determined.

    if (!notifyConfig.vendor) // Means this number has no compatible client
      return;

    client.addEventListener(SNC.Notify.STD_EVENTS.ONLINE, function () {
      // Ability to call is available
    });
    client.addEventListener(SNC.Notify.STD_EVENTS.OFFLINE, function () {
      // Ability to call is _not_ available right now
    });
    client.addEventListener(SNC.Notify.STD_EVENTS.ERROR, function (msg, code) {
      // Some error happened
    });
      //... register other event handlers here

    client.init(); // This is important to call this.
    });
});

This example shows how to de-register a listener.

var dereg = notifyClient.addEventListener(SNC.Notify.STD_EVENTS.ONLINE, function () {
 ... 
 }); 
 dereg(); 
  // The event listener function is no longer triggered.

NotifyClient - call(Object identifier)

Calls the specified phone number or the phone number associated with a specified user.

Note: When checking the status of a call/connection, always compare against the constants provided by SNC.Notify.Status.

This example demonstrates passing a phone number as the function parameter.

notifyClient.call({
    phoneNumber: "+18001112223"
});

This example demonstrates passing a user record sys_id as the function parameter.

notifyClient.call({
    userId: "6816f79cc0a8016401c5a33be04be441"
});

This example shows a button click handler.

$j("#pickupCallBtn").on("click", function() {
    notifyClient.hangupCall();
});

This example shows an event handler.

onConnect: function(status) {  
  // webRTC receives a call connection event (incoming or outgoing).
  if (status == SNC.Notify.Status.OPEN) {
    setStatus(getTimeStamp() + " -- Successfully established call");
    showHangupButton();
  }
},

NotifyClient - destroy()

Kills the current Notify client, rendering it unusable.

NotifyClient - forwardCall(Object argument)

Forwards an ongoing incoming or outgoing phone call to either a different phone number or a different WebRTC client.

This example demonstrates forwarding a call to a different phone number. The dtmf attribute allows you to send DTMF dial tones to the receiving number.

var arg = {
    type: "number",
    id: "+17012345678",
    dtmf: "1234"
}
client.forwardCall(arg);

This example demonstrates forwarding a call to a different Notify client.

var arg = {
    type: "userId",
    id: "6816f79cc0a8016401c5a33be04be441"
}
client.forwardCall(arg);

NotifyClient - getAvailableClients(Function callback)

Returns a list of clients available to accept calls.

This method excludes the current client from the list. The equivalent Notify-getAvailableClients() method does not filter any user.

[{
    sys_id: "...",  // user's sys_id
    name: "..." // user's name
}]

NotifyClient - getParentId(String callId, Function callback)

Returns the parent call identifier for a specified call identifier, if one exists.

Depending on the telephony provider, there may be a delay before the parent call identifier is returned; therefore you must provide a callback function.

This example shows how to use this method to obtain the parent call identifier.

notifyClient.getParentId( callId, function(jsonObj) {} );

This example shows the contents of the jsonObj parameter.

{
    parentId: "xyz",
    error: "msg"
}

NotifyClient - getStatus()

Returns the normalized status of the current call.

This example shows how to obtain the status of the current Notify client.

clientStatus = notifyClient.getStatus();

NotifyClient - hangupCall()

End the current call.

This example how to hang up a call.

$j("#pickupCallBtn").on("click", function() {
    notifyClient.hangupCall();
});

NotifyClient - init()

Initializes the client driver.

For example, when using the Twilio client, it invokes the method Twilio.Device.setup(). Call this method after the user has interacted with the page. This initialization process is asynchronous, therefore, you must provide an ONLINE event handler. This handler is called when the setup process is complete and the system is ready to take or make calls.

This example shows how to initialize the Notify client.

$j(function() {
  notifyClient = new SNC.Notify.Client( notifyConfig );
  notifyClient.setCallerId( '+31858889170' );
  notifyClient.init();
});

NotifyClient - mute(Boolean muted)

Mute or unmute the current client.

This example shows how to send mute the current call.

notifyClient.mute( "true" );

NotifyClient - pickupCall()

Answers and connects to an incoming call from a WebRTC client.

Call this method when there is a notification of an incoming call.

This example shows how to pickup a call.

$j("#pickupCallBtn").on("click", function() {
    notifyClient.pickupCall();
});

NotifyClient - sendDtmf(String digits)

Send one or more DTMF-valid digits over the current call.

This example shows how to send DTMF signals to the current call.

notifyClient.SendDtmf( "1246AF" ) {} );

NotifyClient - setCallerId(String value, Function autoSelectVendorCallback)

Sets the caller ID for the current client session.

You can change or update the caller ID at any time however, the caller ID must belong to the same vendor.

This example shows how to set the caller ID. This example assumes that the vendor is set in the constructor.

$j(function() {
  notifyClient = new SNC.Notify.Client( notifyConfig );
  notifyClient.setCallerId( '+31858889170' );
  notifyClient.init();
});

NotifyClient - setClientAvailable(Boolean available)

Sets the availability of an active WebRTC client agent.

This type of availability is different than an agent being in a call. In this case, an active WebRTC client may be connected and not on a call, but may not want to receive calls.

Calling this method updates the Available field value on the Notify Client Connected Session [notify_client_session] record associated with this client session. You can get a list of available clients using the getAvailableClients() method.