NotifyConferenceUtil - Scoped, Global
-
- UpdatedJan 30, 2025
- 14 minutes to read
- Yokohama
- API reference
The NotifyConferenceUtil API provides methods to manage Notify conference calls and SMS messages for various telephony service providers, such as Zoom and Webex.
Using the NotifyConferenceUtil API you can:
- Create new conference calls
- Add participants by phone number or user ID
- Remove participants from a conference call
- Mute participants in a conference call
- Unmute participants in a conference call
- Obtain the capabilities of a specified service provider
- End a conference call
You can use this API in both scoped and global scripts. To use this API you must activate the Conference Notify plugin (com.snc.notify) which requires a separate subscription. For details on activating this plugin, see Activate Notify.
NotifyConferenceUtils - NotifyConferenceUtils()
Instantiates a NotifyConferenceUtils object (constructor).
Name | Type | Description |
---|---|---|
None |
Example
NotifyConferenceUtils - addToConferenceByPhoneNumber(String toNumber, GlideRecord confGR)
Adds a participant to a specified conference call using their phone number to identify the participant.
Name | Type | Description |
---|---|---|
toNumber | String | Phone number of the participant to add to the conference call. |
confGR | GlideRecord | GlideRecord of the conference call to which to add the specified participant. Table: Notify Conference Call [notify_conference_call] |
Type | Description |
---|---|
Object | Results of the conference action.
|
Example
The following code example shows how to call this method.
NotifyConferenceUtils - addToConferenceByUserId(String userId, GlideRecord confGR)
Adds a participant to the conference call referenced by the passed in GlideRecord using their unique user identifier.
Name | Type | Description |
---|---|---|
userId | String | Sys ID of the participant to add to the specified conference call. Table: User [sys_user] |
confGR | GlideRecord | GlideRecord of the conference call to add the specified participant. Table: Notify Conference Call [notify_conference_call] |
Type | Description |
---|---|
Object | Results of the conference action.
|
Example
The following code example shows how to call this method.
NotifyConferenceUtils - doConferenceAction(String action, Object data)
Performs the specified conference call action, such as starting/ending a conference call or joining, removing, muting, or unmuting participants from a conference call.
- Save pointers in the conference call record to the specific record (source record), such as an incident or problem, that is the topic of discussion for the conference call.
- Allow/disallow multiple conference calls for a source record.
- Automatically log the participants that were in the conference call in the "Work Notes" field of the source record.
- Have a message read aloud when a participant answers an outgoing call from the conference.
Type | Description |
---|---|
Object | Results of the conference action.
|
Example
NotifyConferenceUtils - getConferenceInputDataTemplate()
Returns a JSON data template to use with the doConferenceAction() method. Using this template automatically structures the data object so that you don't have to manually create it.
Call this method prior to calling the doConferenceAction() method. For the desired conference call action, set the desired parameters within the template, and then pass the template in the doConferenceAction() call. For additional information on the valid parameters for each action, see doConferenceAction().
Name | Type | Description |
---|---|---|
None |
Example
NotifyConferenceUtils - getServiceProvidersCapabilities()
Returns the capabilities of all telephony service provider drivers in the instance.
- archive: archives the conference after it ends
- beepOnLeave: plays a "beep" tone when a participant leaves the conference call
- beepOnJoin: plays a "beep" tone when a participant joins the conference call
- end: ends the identified conference call
- filesharing: allows file sharing between participants
- join: adds a participant to a conference call
- kick: removes a participant from a conference call
- multiJoin: adds multiple participants to a conference call
- multiKick: removes multiple participants from a conference call
- muteOnJoin: mutes a participant when they initially join a conference call
- multiUnmute: unmutes multiple participants for a conference call
- record: records conference calls
- recording: provides an on-screen indicator when the conference call is being recorded
- screenSharing: allows participant screens to be shared with the group
- selfJoin: adds the current logged in user to a conference call
- speaking: provides an on-screen message as to who is currently speaking
- start: starts the identified conference call
- unmute: unmutes a participant in a conference call
Name | Type | Description |
---|---|---|
None |
Type | Description |
---|---|
Object | Key-value pairs of the status of each driver capability. Valid values:
|
Example
List driver capabilities for all telephony service provider drivers in the instance.
Output: The method returns a node similar to the following for each active telephony service provider within the instance.
NotifyConferenceUtils - isActionSupported(Number action)
Determines whether a Notify conference action is supported by a telephony service provider.
To use this method, you must first call the getServiceProviderCapabilities() method. This method returns an object that contains information about the availability of each possible Notify conference action for each service provider configured in your instance.
For example:
Name | Type | Description |
---|---|---|
action | Number | Value of the isSupported parameter returned by the getServiceProvidersCapabilities() method for a specific action and service provider. Note: Although the isSupported value may appear to be a
Boolean, it is actually a Number. Do not try and evaluate the capabilities as
Boolean values. Use this method as the associated values may be expanded in future
versions. |
Type | Description |
---|---|
Boolean | Flag that indicates whether the telephony service provider supports the
specified action. Valid values:
|
Example
NotifyConferenceUtils - kickByParticipantGR(GlideRecord notifyParticipantGR)
Removes the participant associated with the passed in GlideRecord from the current conference call.
Name | Type | Description |
---|---|---|
notifyParticipantGR | GlideRecord | GlideRecord object of the participant to remove from the conference call. Table: Notify Participant [notify_participant] |
Type | Description |
---|---|
Object | Results of the conference action.
|
Example
The following code example shows how to call this method.
NotifyConferenceUtils - muteByParticipantGR(GlideRecord notifyParticipantGR)
Mutes the participant associated with the passed in GlideRecord on the current conference call.
Name | Type | Description |
---|---|---|
notifyParticipantGR | Object | GlideRecord object of the participant to mute. Table: Notify Participant [notify_participant] |
Type | Description |
---|---|
Object | Results of the conference action.
|
Example
The following code example shows how to call this method.
NotifyConferenceUtils - unmuteByParticipantGR(GlideRecord notifyParticipantGR)
Unmutes the participant associated with the passed in GlideRecord on the current conference call.
Name | Type | Description |
---|---|---|
notifyParticipantGR | GlideRecord | GlideRecord object of the participant to unmute. These records are located in the Notify Participant [notify_participant] table. |
Type | Description |
---|---|
Object | Results of the conference action.
|
Example
On this page
- NotifyConferenceUtils - NotifyConferenceUtils()
- NotifyConferenceUtils - addToConferenceByPhoneNumber(String toNumber, GlideRecord
confGR)
- NotifyConferenceUtils - addToConferenceByUserId(String userId, GlideRecord confGR)
- NotifyConferenceUtils - doConferenceAction(String action, Object data)
- NotifyConferenceUtils - getConferenceInputDataTemplate()
- NotifyConferenceUtils - getServiceProvidersCapabilities()
- NotifyConferenceUtils - isActionSupported(Number action)
- NotifyConferenceUtils - kickByParticipantGR(GlideRecord notifyParticipantGR)
- NotifyConferenceUtils - muteByParticipantGR(GlideRecord notifyParticipantGR)
- NotifyConferenceUtils - unmuteByParticipantGR(GlideRecord notifyParticipantGR)