Notify - Global

The Notify API allows you to interact with Notify calls and SMS messages using scripts.

Access the global Notify class and its associated methods in the SNC namespace.

Notify - call(String notifyPhoneNumber, String toPhoneNumber, GlideRecord conferenceCall, GlideRecord conferenceCallRecord, String userSysId, String groupSysId, GlideRecord sourceRecord)

Calls the specified E.164-compliant telephone number.

In addition, this method can automatically add the specified phone number to a specified conference call.

표 1. Parameters

Name	Type	Description
notifyPhoneNumber	String or NotifyPhoneNumber	Notify phone number from which to make the call. When you initiate a call, the outgoing call workflow for the number group associated with this number runs. Ensure this workflow includes a join conference call activity to connect the user to the conference call.
toPhoneNumber	String	Phone number to call. Called numbers are added to the conference call.
conferenceCall	GlideRecord	Optional. If this parameter is passed in, the callers identified in the toPhoneNumber parameter are automatically joined into the conference call identified by this record. GlideRecord for the Notify Call [notify_call] table that identifies the conference call record. This record is automatically added to the outgoing call workflow scratchpad as the workflow.scratchpad.conference_call variable.
userSysId	String	Optional. Unique identifier (sys_id) of the user associated with the call.
groupSysId	String	Optional. Unique identifier (sys_id) of the group associated with the call.
sourceRecord	GlideRecord	Optional. Source record that prompted this call.

표 2. Returns

Type	Description
void

This example illustrates how to initiate a call to another phone number.

var from = '[phone]';
var to = '[phone]';

// set up call
new SNC.Notify().call(from, to);

This example illustrates how to initiate a call to list of telephone numbers and automatically join those numbers into a new conference call.

var notify = new SNC.Notify();
var from = '[phone]';
var participants = ['[phone]', '[phone]', '[phone]'];

// set up a conference call
var conferenceCall = notify.conferenceCall();

// set up the outbound calls for all conference call participants
for (var i in participants) {
    var to = participants[i];
    notify.call(from, to, conferenceCall);
}

This example illustrates how to initiate a new conference call.

SNC.Notify.call('[phone]', '+91406XXXXXXX', SNC.Notify.conferenceCall(), null, null, null);

This example illustrates how to initiate new a conference call using a user record.

var sysUserGr = new GlideRecord('sys_user');
sysUserGr.get('active conference sys id');
 
if (conferenceGr.isValid) {
    SNC.Notify.call('[phone]', '+91406XXXXXXX', SNC.Notify.conferenceCall(), sysUserGr.getUniqueValue(), null, null);
}

This example illustrates how to initiate a new conference call with a user, group, and source record.

var sysUserGr = new GlideRecord('sys_user');
sysUserGr.get('active sys user sys id');
 
var sysUserGroupGr = new GlideRecord('sys_user_group');
sysUserGroupGr.get('active sys user group sys id');
 
var incidentGr = new GlideRecord('incident');
incidentGr.get('incident sys_id');
 
if (conferenceGr.isValid) {
    SNC.Notify.call('[phone]', '+91406XXXXXXX',
        SNC.Notify.conferenceCall(),
        sysUserGr.getUniqueValue(),
        sysUserGroupGr.getUniqueValue(),
        incidentGr.getUniqueValue());
}

Scoped equivalent

To use the call() method in a scoped application, use the corresponding scoped method: NotifyScoped - call().

Notify - conferenceCall(GlideRecord sourceRecord)

Creates a new conference call GlideRecord.

표 3. Parameters

Name	Type	Description
sourceRecord	GlideRecord	Optional. Record that initiated the request to create the conference call. Used to populate the source and table fields on notify_conference_call record.

표 4. Returns

Type	Description
GlideRecord	New Notify conference call [notify_conference_call] record.

var notify = new SNC.Notify();
var from = '[phone]';
var participants = ['[phone]', '[phone]', '[phone]'];

// set up a conference call
var conferenceCall = notify.conferenceCall();

// set up the outbound calls for all conference call participants
for (var i in participants) {
    var to = participants[i];
    notify.call(from, to, conferenceCall);
}

Scoped equivalent

To use the conferenceCall() method in a scoped application, use the corresponding scoped method: NotifyScoped - conferenceCall().

관련 참조

• Notify - call(String notifyPhoneNumber, String toPhoneNumber, GlideRecord conferenceCall, GlideRecord conferenceCallRecord, String userSysId, String groupSysId, GlideRecord sourceRecord)

Notify - dequeueCall(GlideRecord callRecord)

Resumes a call after it was put in a queue (on hold).

Use this method to resume calls that were put in a queue with the queueCall() method.

표 5. Parameters

Name	Type	Description
callRecord	GlideRecord	A GlideRecord object on the Notify Call [notify_call] table with the held call you want to resume.

표 6. Returns

Type	Description
void

The following example shows how to reactivate a call that was put on hold.

var notifyCallGr = new GlideRecord('notify_call');
notifyCallGr.get('active participant sys id');
 
if (notifyCallGr.isValid) {
    SNC.Notify.dequeueCall(notifyCallGr);
}

Scoped equivalent

To use the dequeueCall() method in a scoped application, use the corresponding scoped method: NotifyScoped - dequeueCall().

Notify - forwardCall(GlideRecord call, String destination, String dtmf)

Forwards the specified call to a different call recipient.

표 7. Parameters

Name	Type	Description
call	GlideRecord or String	Notify call record or the telephony provider call ID, of the call to be forwarded.
destination	GlideRecord or String	Notify phone number record or an E.164-compliant phone number, of the caller to which to forward the call.
dtmf	String	Dual Tone - Multi Frequency (DTMF) code to send upon call connection.

표 8. Returns

Type	Description
void

The following example shows how to forward a call to another phone number.

var callID = 'CA92374b5aa561dab476a7001db6026edc'; // Twilio Call ID
var phoneNumber = '+91406xxxxxxx';
var dtmfTones = null;
 
var notifyCallGr = new GlideRecord('notify_call');
notifyCallGr.get('active participant sys id');
 
if (notifyCallGr.isValid) {
    SNC.Notify.forwardCall(notifyCallGr(or) callID, phoneNumber, dtmfTones)
}

Scoped equivalent

To use the forwardCall() method in a scoped application, use the corresponding scoped method: NotifyScoped - forwardCall().

Notify - getAvailableClients(String notifyNumber)

Returns a list of client sessions that are available to receive calls.

표 9. Parameters

Name	Type	Description
notifyNumber	String	Valid Notify phone number.

표 10. Returns

Type	Description
GlideRecord	GlideRecord from the notify_client_session table for the specified phone number. Returns "0" if there are no available client sessions.

The following example shows how to use the getAvailableClients() method to index into the notify_client_session table and then iterate across all available Notify clients.

var clientSessionGr = SNC.Notify.getAvailableClients('+185xxxxxxxx'); 
// Here clientSessionGr is of type GlideRecord on 'notify_client_session' table.
 
var isLoggedInUserAvailable = false;
while (clientSessionGr.next()) {
  if (clientSessionGr.user == gs.getUserID())
    isLoggedInUserAvailable = clientSessionGr.available;
}
gs.info('isLoggedInUserAvailable - ' + isLoggedInUserAvailable);

Scoped equivalent

To use the getAvailableClients() method in a scoped application, use the corresponding scoped method: NotifyScoped - getAvailableClients().

Notify - getParentCallID(GlideRecord callRecord)

Returns the sys_id of a specified call's parent call.

Any call started by forwarding another call, such as with the Forward workflow activity, is considered a child of the original call. The original call is the parent call.

표 11. Parameters

Name	Type	Description
callRecord	GlideRecord	Record on the Notify Call [notify_call] table for which to return the call status.

표 12. Returns

Type	Description
String	Unique sys_id of the parent call record.

This example shows how to obtain the parent call of the specified call.

var callRecord = new GlideRecord('notify_call');
callRecord.get("0f4f5863ff13310014ecffffffffff28");

var notify = new SNC.Notify();
var parentCallID = notify.getParentCallID(callRecord);

Notify - getPhoneNumbers()

Returns all phone numbers and short codes available to Notify.

표 13. Parameters

Name	Type	Description
None

표 14. Returns

Type	Description
List	List of NotifyPhoneNumber objects, each object representing one phone number available to Notify.

var list = SNC.Notify.getPhoneNumbers();
for (var i = 0; i < list.size(); i++) {
    var num = list.get(i);
    gs.info(num.getNumber())
}

Scoped equivalent

To use the getPhoneNumbers() method in a scoped application, use the corresponding scoped method: NotifyScoped - getPhoneNumbers().

Notify - getTokens(GlideRecord, record)

Returns client tokens for any active telephony drivers for use in WebRTC or mobile clients.

표 15. Parameters

Name	Type	Description
record	GlideRecord	GlideRecord to use to identify the Notify client, such as a group record or a user record.

표 16. Returns

Type	Description
String	Web RTC tokens for the supported drivers, as a JSON string with the following format: {driverName1: "token1", driverName2: "token2"}, such as "TwilioDirect":"eyJhxxxx.eyJleHAiOiIxxxx.7fejxxx_mbLxxx"

This example shows how to obtain the client tokens for the currently logged in user.

// get Notify client Tokens per active Notify driver for the currently logged in user
var json = new SNC.Notify().getTokens();
 
// Parse the JSON that was return into a tokens object
var tokens = JSON.parse(json);

// Log line
gs.log('Notify client tokens for the currently logged in user');

 // iterate over the driver tokens
for (var driver in tokens) {
 	gs.log(driver + ' Driver token: ' + tokens[driver]);
}

This example shows how to obtain the client tokens for every Notify group.

// instantiate Notify
var notify = new SNC.Notify();
 
// get all Notify Groups
var notifyGroup = new GlideRecord("notify_group");
notifyGroup.query();
 
// iterate over all notify groups
while (notifyGroup.next()) {
  // generate Notify Client tokens per active Notify Driver for this group
  var json = notify.getTokens(notifyGroup);
  var tokens = JSON.parse(json);
 
  for (var driver in tokens) {
    gs.log(gs.getMessage("Notify Client token for {0} driver and Notify Group '{1}': {2}", [driver, notifyGroup.getValue('name'), tokens[driver]]));
  }
}

Scoped equivalent

To use the getTokens() method in a scoped application, use the corresponding scoped method: NotifyScoped - getTokens().

Notify - getTokenTTL(String owner)

Returns the maximum amount of time that a client session stays active for a specified telephony driver before automatically timing out.

표 17. Parameters

Name	Type	Description
owner	String	Name of the telephony driver for which to retrieve the session length. Valid values: Twilio: for the old driver TwilioDirect: for the new driver

표 18. Returns

Type	Description
Integer	Maximum length of the session (in seconds). Default: 1800 seconds

The following example shows how to properly call this method and the associated response. It also shows what is returned if an invalid driver is passed.

var owner = "TwilioDirect";  // Valid driver
var ttl = SNC.Notify.getTokenTTL(owner);
gs.info("Token TTL for " + owner + " --> " + ttl);
 
owner = "Abcxyz";  // Invalid driver
ttl = SNC.Notify.getTokenTTL(owner);
// For an invalid driver, we throw NoSuchNotifyDriverException saying that Abcxyzdriver is not available
// and return the default value of TTL
gs.info("Token TTL for " + owner + " --> " + ttl); 

Scoped equivalent

To use the getTokenTTL() method in a scoped application, use the corresponding scoped method: NotifyScoped - getAvailableClients().

Notify - hasCapability(String notifyPhoneNumber, String capability)

Determines whether the specified phone number has the specified capability.

The telephony driver associated with the phone number contains a list of all of the capabilities of the phone.

주:

In the base system, the Notify JS driver only has 'show_speakers' as a capability; this can be modified.

표 19. Parameters

Name	Type	Description
notifyPhoneNumber	String	Phone number for which to check for the specified capability.
capability	String	Capability to detect. The string text must be an exact match to what is in the phone.

표 20. Returns

Type	Description
Boolean	Flag that indicates whether the specified phone has the specified capability. true: phone has the capability false: phone does not have the capability

This example shows how to check if a phone has a specific capability.

// Each driver has a defined set of capabilities.

var capability = 'show_speakers';
gs.info(SNC.Notify.hasCapability('+185xxxxxxxx', capability)); // true
 
capability = 'send_sms';
gs.info(SNC.Notify.hasCapability('+185xxxxxxxx', capability)); // false

Scoped equivalent

To use the hasCapability() method in a scoped application, use the corresponding scoped method: NotifyScoped - hasCapability().

Notify - kick(GlideRecord participant)

Removes the specified caller from the current Notify conference call.

표 21. Parameters

Name	Type	Description
participant	GlideRecord	GlideRecord object containing the Notify Participant [notify_participant] record of the caller to remove from the conference call.

표 22. Returns

Type	Description
void

The following example shows how to remove a participant from a conference call.

var notifyParticipantGr = new GlideRecord('notify_participant');
notifyParticipantGr.get('active participant sys id');
 
if (notifyParticipantGr.isValid) {
    SNC.Notify.kick(notifyParticipantGr);
}

Scoped equivalent

To use the kick() method in a scoped application, use the corresponding scoped method: NotifyScoped - kick().

Notify - modifyCall(GlideRecord callRecord, NotifyAction notifyAction)

Performs one or more actions on an active Notify phone call.

Available actions that you can perform on calls include queuing or dequeueing the call, reading text, playing audio, or forwarding the call. You can also create custom actions Call the modifyCall() method after you have specified all the actions that you want to apply to the specified call. Refer to the NotifyAction API documentation for more information about available actions.

표 23. Parameters

Name	Type	Description
callRecord	GlideRecord	Notify Call [notify_call] record of the call for which to apply the actions.
notifyAction	NotifyAction	NotifyAction object describing one or more actions to perform on the call. Create this object by calling one or more of the NotifyAction() methods.

표 24. Returns

Type	Description
void

This example shows how to modify a call.

// get the most recent call record
var callRecord = new GlideRecord('notify_call');
callRecord.orderByDesc('sys_created_on');
callRecord.query();
 
if (callRecord.next()) {
    // instantiate notify action container class
    var notifyAction = new SNC.NotifyAction();
    // The call is already in progress. Now, we want to modify the call behavior by putting this call in a queue.
    // So, we add a queue action to queue the call
    notifyAction.addQueue('my fancy queue');
   
    // modify the call by passing in the above action, putting the call in a queue
    new SNC.Notify().modifyCall(callRecord, notifyAction);
} else {
    gs.log('no such call record');
}

Scoped equivalent

To use the modifyCall() method in a scoped application, use the corresponding scoped method: NotifyScoped - modifyCall().

Notify - mute(GlideRecord participantRecord)

Mutes the specified conference call participant.

표 25. Parameters

Name	Type	Description
participantRecord	GlideRecord	GlideRecord from the notify_participant table for the participant to mute.

표 26. Returns

Type	Description
void

The following example shows how to mute a caller.

var notifyParticipantGr = new GlideRecord('notify_participant');
notifyParticipantGr.get('active participant sys id');
 
if (notifyParticipantGr.isValid) {
    SNC.Notify.mute(notifyParticipantGr);
}

Scoped equivalent

To use the mute() method in a scoped application, use the corresponding scoped method: NotifyScoped - mute().

Notify - queueCall(GlideRecord callRecord)

Puts the specified call into a queue (on hold).

Resume a queued call using the dequeueCall() method.

표 27. Parameters

Name	Type	Description
callRecord	GlideRecord	GlideRecord object of the Notify Call record (notify_call table) to put on hold.

표 28. Returns

Type	Description
void

The following example shows how to put a call on hold (in the queue).

var notifyCallGr = new GlideRecord('notify_call');
notifyCallGr.get('active participant sys id');
 
if (notifyCallGr.isValid) {
    SNC.Notify.queueCall(notifyCallGr);
}

Scoped equivalent

To use the queueCall() method in a scoped application, use the corresponding scoped method: NotifyScoped - queueCall().

Notify - sendBulkSMS(String notifyPhoneNumber, Array toPhoneNumbers, String messageBody, GlideRecord source)

Sends a specified SMS message to the specified list of Notify clients (phone numbers).

표 29. Parameters

Name	Type	Description
notifyPhoneNumber	String	Notify phone number from which the SMS message is being sent.
toPhoneNumbers	Array of Strings	Comma-separated list of phone numbers to which to send the SMS message. Format: E.164
messageBody	String	SMS text to send.
source	GlideRecord	Source record that prompted this SMS message, such as an incident.

표 30. Returns

Type	Description
String	Null

The following example shows how to send a bulk SMS message.

var incidentGr = new GlideRecord('incident');
incidentGr.get(active incident sys_id');
if (incidentGr.isValid()) {
    SNC.Notify.sendBulkSMS('[phone]', ['+919885XXXXXX', '+919775XXXXXX'], 'Test automation message', incidentGr);
}

Scoped equivalent

To use the sendBulkSMS() method in a scoped application, use the corresponding scoped method: NotifyScoped - sendBulkSMS().

Notify - sendSMS(String notifyPhoneNumber, String toPhoneNumber, String messageBody, GlideRecord source)

Sends an SMS text message to an E.164-compliant phone number.

This method creates a new record on the Notify Message [notify_message] table and associates it with the source record.

표 31. Parameters

Name	Type	Description
notifyPhoneNumber	String	Notify phone number from which the SMS message is being sent.
toPhoneNumber	String	E.164-compliant phone number to which to send the SMS message.
messageBody	String	Body of the SMS text message.
source	GlideRecord	Source record that prompted this SMS message, such as an incident.

표 32. Returns

Type	Description
String	Unique message SID; stored in the Notify Message [notify_message] record as message_id.

The following example shows how to send an SMS message.

var incidentGr = new GlideRecord('incident');
incidentGr.get('active incident sys_id');
if (incidentGr.isValid()) {
    SNC.Notify.sendSMS('[phone]', '+919885XXXXXX', 'Test automation message', incidentGr);
}

Scoped equivalent

To use the sendSMS() method in a scoped application, use the corresponding scoped method: NotifyScoped - sendSMS().

Notify - unmute(GlideRecord participantRecord)

Unmutes the specified conference call participant.

표 33. Parameters

Name	Type	Description
participantRecord	GlideRecord	GlideRecord from the notify_participant table for the participant to unmute.

표 34. Returns

Type	Description
void

The following example shows how to unmute a caller.

var notifyParticipantGr = new GlideRecord('notify_participant');
notifyParticipantGr.get('active participant sys id');
 
if (notifyParticipantGr.isValid) {
    SNC.Notify.unmute(notifyParticipantGr);
}

Scoped equivalent

To use the unmute() method in a scoped application, use the corresponding scoped method: NotifyScoped - unmute().