NotifyOnTaskClient - Client
-
- UpdatedJan 30, 2025
- 13 minutes to read
- Yokohama
- API reference
The NotifyOnTaskClient API provides methods for sending SMS messages or starting/managing a conference call for various telephony service providers, such as Zoom and Webex.
Any UI can consume the NotifyOnTaskClient API by explicitly including the NotifyOnTaskClient UI script.
Using the NotifyOnTaskClient API you can:
- Start a conference call
- End a conference call
- Add participants
- Perform actions that are available through the telephony driver such as:
- mute/unmute participants
- remove participants from a conference call
- add participants to a conference call
- start a conference call
- end a conference call
The Notify (com.snc.notify) plugin requires a separate subscription. For additional information on activating the Notify plugin, see Activate Notify.
NotifyOnTaskClient - addParticipants(Object data)
Adds the specified participants to a specified conference call.
Type | Description |
---|---|
Object | Results of the conference action.
|
Example
The following code example shows how to call this method.
NotifyOnTaskClient - 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
The following example shows how to create a function to call doConferenceAction() to manipulate the participants in a conference call by passing in the action and the participants.
NotifyOnTaskClient - endConference(Object data)
Terminates the specified conference call.
Name | Type | Description |
---|---|---|
data | Object | Object that describes the conference call. |
data.confId | String | Sys_id of the conference call. |
data.serviceProvider | String | Required. Name of conference service provider, such as Zoom or Webex. |
Type | Description |
---|---|
Object | Results of the conference action.
|
Example
NotifyOnTaskClient - getNotifyActionTemplate()
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
The following example shows how to call getNotifyActionTemplate() to obtain the data template necessary to define the actions for doConferenceAction().
NotifyOnTaskClient - start(Object data)
Starts a new conference call.
Type | Description |
---|---|
Object | Results of the conference action.
|
Example
The following code example shows how to call this method.