NotifyOnTaskClient – Client
Die NotifyOnTaskClient- API bietet Methoden zum Senden von SMS-Nachrichten oder zum Starten/Verwalten einer Telefonkonferenz für verschiedene Telefoniedienstanbieter wie Zoom und WebEx.
Jede Benutzeroberfläche kann die NotifyOnTaskClient- API verwenden, indem das NotifyOnTaskClient-UI-Skript explizit eingebunden wird.
Mit der NotifyOnTaskClient- API können Sie:
- Konferenzanruf starten
- Telefonkonferenz beenden
- Teilnehmer hinzufügen
- Führen Sie Aktionen aus, die über den Telefonietreiber verfügbar sind, z. B.:
- Teilnehmer stummschalten bzw. die Stummschaltung aufheben
- Entfernen Sie Teilnehmer aus einer Telefonkonferenz
- Einer Telefonkonferenz Teilnehmer hinzufügen
- Telefonkonferenz starten
- Telefonkonferenz beenden
Das Notify-Plugin (com.snc.notify) erfordert ein separates Abonnement. Weitere Informationen zum Aktivieren des Notify-Plugins finden Sie unter Notify aktivieren.
NotifyOnTaskClient – addParticipants(Object data)
Fügt die angegebenen Teilnehmer einer angegebenen Telefonkonferenz hinzu.
| Name | Typ | Beschreibung |
|---|---|---|
| data | Objekt | Objekt, das die Telefonkonferenz beschreibt. |
| data.addToWorkNotes | Boolean | Kennzeichnung, die angibt, ob Informationen zu den Teilnehmern, die in die Telefonkonferenz einbezogen wurden, im Feld „Arbeitsnotizen“ des zugeordneten Datensatzes hinzugefügt werden sollen. Damit diese Funktionalität funktioniert, müssen Sie auch Werte in den Parametern data.table und data.sysId angeben. Diese Parameter identifizieren den Datensatz, in dem die Arbeitsnotizen hinzugefügt werden sollen. Standardwert: false |
| data.confId | Zeichenfolge | Erforderlich. Sys-ID der Telefonkonferenz. Die Konferenz-Sys-ID befindet sich in der Notify-Telefonkonferenztabelle [notify_conference_call]. |
| data.items | Array | Erforderlich. Informationen für jeden Teilnehmer, der in die Telefonkonferenz aufgenommen werden soll. Gültige Array-Werte:
|
| data.message | Zeichenfolge | Nachricht, die laut vorgelesen wird, wenn ein Benutzer den Anruf entgegennimmt, z. B. „P1-Incident wurde erstellt, melden Sie sich bei der Instanz an.“ |
| data.serviceProvider | Zeichenfolge | Erforderlich. Name des Konferenzserviceanbieters, z. B. Zoom oder Webex. |
| data.sysId | Zeichenfolge | Sys-ID des Quelldatensatzes, der der Telefonkonferenz zugeordnet werden soll. Wenn beispielsweise eine Telefonkonferenz abgehalten wird, um einen bestimmten Incident oder ein bestimmtes Problem zu besprechen, geben Sie die Sys-ID des Incident- oder Problemdatensatzes in diesen Wert ein. Diese Sys-ID wird in der Spalte „Quelle“ der NotifyConference-Anruftabelle [notify_conference_call] gespeichert und kann später nachverfolgt werden. Dieser Parameter wird in Verbindung mit den Parametern data.Table, data.addToWorkNotesund allowMulticonference verwendet. Sie sollten diesen Wert konfigurieren, wenn die Konferenzschaltung anfänglich durch eine Startaktion erstellt wird. Bei Bedarf können Sie diesen Wert auch über diese Methode festlegen. |
| data.table | Zeichenfolge | Tabelle, die den Quelldatensatz enthält, der der Telefonkonferenz zugeordnet werden soll. Ein Quelldatensatz kann ein beliebiger Datensatz sein, z. B. ein „Incident“ oder ein „Problem“, der in der Telefonkonferenz besprochen wird. Dieser Tabellenname wird in der Spalte Tabelle der NotifyConference-Anruftabelle [notify_conference_call] gespeichert und kann nachverfolgt werden. Dieser Parameter wird in Verbindung mit den Parametern data.sysId, data.addToWorkNotesund allowMulticonference verwendet. Sie sollten diesen Wert konfigurieren, wenn die Konferenzschaltung anfänglich durch eine Startaktion erstellt wird. Bei Bedarf können Sie diesen Wert auch über diese Methode festlegen. |
| Typ | Beschreibung |
|---|---|
| Objekt | Ergebnisse der Konferenzaktion. <action
<action
<action
<action
|
Beispiel
function addToConferenceCall() {
var data = NotifyOnTaskClient.getNotifyActionTemplate();
data.serviceProvider = 'Telephony'; // e.g 'Zoom', 'WebEx'
data.confId = 'Active conference sysId';
data.items.push({ id: 'userSysId' });
data.items.push({ phoneNumber: '+917799555331' });
data.items.push({ email: 'yln99518@gmail.com' });
NotifyOnTaskClient.addParticipants(data).then(function (result) {
var joinActionResult = result[0];
if(joinActionResult.status) {
joinActionResult.successMessages.forEach(function(msg) {
console.log(msg);
});
return;
}
joinActionResult.warnMessages.forEach(function(msg) {
console.warn(msg);
});
joinActionResult.errorMessages.forEach(function(msg) {
console.error(msg);
});
}, function (errMsg) {
console.log(errMsg);
});
}
NotifyOnTaskClient – doConferenceAction(String action, Object data)
Führt die angegebene Telefonkonferenzaktion aus, z. B. Starten/Beenden einer Telefonkonferenz oder Beitritt zu, Entfernen, Stummschalten oder Aufheben der Stummschaltung von Teilnehmern aus einer Telefonkonferenz.
- Speichern Sie im Konferenzschaltungsdatensatz Verweise auf den spezifischen Datensatz (Quelldatensatz), z. B. einen Incident oder ein Problem, der das Gesprächsthema für die Konferenzschaltung ist.
- Mehrere Telefonkonferenzen für einen Quelldatensatz zulassen/verbieten.
- Protokollieren Sie die Teilnehmer, die an der Telefonkonferenz teilgenommen haben, automatisch im Feld Arbeitsnotizen des Quelldatensatzes.
- Lassen Sie eine Nachricht vorlesen, wenn ein Teilnehmer einen ausgehenden Anruf aus der Konferenz beantwortet.
| Name | Typ | Beschreibung |
|---|---|---|
| Aktion | Zeichenfolge | Definiert die auszuführende Telefonkonferenzaktion. Die folgenden Aktionen sind für Telefonkonferenzen verfügbar:
|
| Daten | Objekt | Objekt, das die Telefonkonferenz beschreibt. |
| data.addToWorkNotes | Boolean | Kennzeichnung, die angibt, ob Informationen zu den Teilnehmern, die in die Telefonkonferenz einbezogen wurden, im Feld „Arbeitsnotizen“ des zugeordneten Datensatzes hinzugefügt werden sollen. Damit diese Funktionalität funktioniert, müssen Sie auch Werte in den Parametern data.table und data.sysId angeben. Diese Parameter identifizieren den Datensatz, in dem die Arbeitsnotizen hinzugefügt werden sollen. Standardwert: false Aktionen, für die dieser Parameter gültig ist:
|
| data.allowMulticonference | Boolean | Kennzeichnung, die angibt, ob mehrere Telefonkonferenzen für einen bestimmten Datensatz gleichzeitig zulässig sind. Damit diese Funktionalität funktioniert, müssen Sie auch Werte in den Parametern data.table und data.sysId angeben. Diese Parameter identifizieren den Datensatz, der mehrere Telefonkonferenzen enthalten darf. Standardwert: false Aktionen, für die dieser Parameter gültig ist:
|
| data.confId | Zeichenfolge | Sys-ID der Telefonkonferenz. Die Konferenz-Sys-ID befindet sich in der Notify-Telefonkonferenztabelle [notify_conference_call]. Aktionen, für die dieser Parameter erforderlich ist:
Hinweis: Für Teilnehmeraktionen wie Stummschalten, Aufheben der Stummschaltung und Kick muss dieser Parameter nicht festgelegt werden, da die Methode diese Informationen aus der Notify-Telefonkonferenzteilnehmer-Tabelle [notify_participant] erhält. |
| data.fromNumber | Zeichenfolge | Service Provider-Nummer, die für die Telefonkonferenz verwendet werden soll. Suchen Sie diesen Wert in der Spalte „Nummer“ oder „Telefonnummer“ der Tabelle „Notify-Telefonnummer“ [notify_number]. Aktionen, für die dieser Parameter erforderlich ist:
|
| data.isNewConference | Boolean | Kennzeichnung, die angibt, ob es sich um eine neue oder eine vorhandene Telefonkonferenz handelt. Gültige Werte:
Standardwert: false Aktionen, für die dieser Parameter gültig ist:
|
| data.message | Zeichenfolge | Nachricht, die laut vorgelesen wird, wenn ein Benutzer den Anruf entgegennimmt, z. B. „P1-Incident wurde erstellt, melden Sie sich bei der Instanz an.“ Aktionen, für die dieser Parameter gültig ist:
|
| data.items | Array | Informationen für jeden Teilnehmer, der in die Telefonkonferenz aufgenommen werden soll. Gültige Array-Werte:
|
| data.serviceProvider | Zeichenfolge | Erforderlich. Name des Konferenzserviceanbieters, z. B. Zoom oder Webex. Aktionen, für die dieser Parameter erforderlich ist:
|
| data.sysId | Zeichenfolge | Sys-ID des Quelldatensatzes, der der Telefonkonferenz zugeordnet werden soll. Wenn beispielsweise eine Telefonkonferenz abgehalten wird, um einen bestimmten Incident oder ein bestimmtes Problem zu besprechen, geben Sie die Sys-ID des Incident- oder Problemdatensatzes in diesen Wert ein. Diese Sys-ID wird in der Spalte „Quelle“ der NotifyConference-Anruftabelle [notify_conference_call] gespeichert und kann später nachverfolgt werden. Dieser Parameter wird in Verbindung mit den Parametern data.Table, data.addToWorkNotesund allowMulticonference verwendet. Aktionen, für die dieser Parameter gültig ist:
|
| data.table | Zeichenfolge | Tabelle, die den Quelldatensatz enthält, der der Telefonkonferenz zugeordnet werden soll. Ein Quelldatensatz kann ein beliebiger Datensatz sein, z. B. ein „Incident“ oder ein „Problem“, der in der Telefonkonferenz besprochen wird. Dieser Tabellenname wird in der Spalte Tabelle der NotifyConference-Anruftabelle [notify_conference_call] gespeichert und kann nachverfolgt werden. Dieser Parameter wird in Verbindung mit den Parametern data.sysId, data.addToWorkNotesund allowMulticonference verwendet. Aktionen, für die dieser Parameter gültig ist:
|
| Typ | Beschreibung |
|---|---|
| Objekt | Ergebnisse der Konferenzaktion. <action
<action
<action
<action
|
Das folgende Beispiel zeigt, wie eine Funktion zum Aufrufen von doConferenceAction() erstellt wird, um die Teilnehmer in einer Telefonkonferenz zu manipulieren, indem die Aktion und die Teilnehmer übergeben werden.
/**
*
* @param {string} action - action to perform on the conference object or participant object
* @param {Array} participants;
*/
function doConferenceAction(action, participants) {
var data = NotifyOnTaskClient.getNotifyActionTemplate();
data.serviceProvider = 'Telephony'; // e.g 'Zoom', 'WebEx'
data.confId = 'Active conference sysId';
data.items = participants;
NotifyOnTaskClient.doConferenceAction(action, data).then(function (result) {
var kickActionResult = result[0];
if (kickActionResult.status)
console.log(action + ' succeeded');
else {
kickActionResult.warnMessages.forEach(function (msg) {
console.warn(msg);
});
kickActionResult.errorMessages.forEach(function (msg) {
console.error(msg);
});
}
}, function (errMsg) {
console.log(errMsg)
});
}
// kick participants
doConferenceAction('kick', [{notifyParticipantId: 'notifyParticipantSysId'}]);
// kick multiple participants
doConferenceAction('multiKick',
[{notifyParticipantId: 'notifyParticipantSysId'},
{notifyParticipantId: 'notifyParticipantSysId'}]);
// Mute participants
doConferenceAction('mute', [{notifyParticipantId: 'notifyParticipantSysId'}]);
doConferenceAction('mute', [{notifyParticipantId: 'notifyParticipantSysId'}]);
doConferenceAction('multiMute',
[{notifyParticipantId: 'notifyParticipantSysId'},
{notifyParticipantId: 'notifyParticipantSysId'}]);
// self join to any confernece.
doConferenceAction('selfJoin', [{id: 'logged in userId'}]);
NotifyOnTaskClient – endConference(Object data)
Beendet die angegebene Telefonkonferenz.
| Name | Typ | Beschreibung |
|---|---|---|
| data | Objekt | Objekt, das die Telefonkonferenz beschreibt. |
| data.confId | Zeichenfolge | Sys-ID der Telefonkonferenz. |
| data.serviceProvider | Zeichenfolge | Erforderlich. Name des Konferenzserviceanbieters, z. B. Zoom oder Webex. |
| Typ | Beschreibung |
|---|---|
| Objekt | Ergebnisse der Konferenzaktion. <action
<action
<action
<action
|
Beispiel
function endConferenceCall() {
var data = NotifyOnTaskClient.getNotifyActionTemplate();
data.serviceProvider = 'Telephony'; // e.g 'Zoom', 'WebEx'
data.confId = 'Active conference sysId';
NotifyOnTaskClient.endConference(data).then(function (result) {
var endActionResult = result[0];
if (endActionResult.status)
console.log('Conference has been ended');
else {
endActionResult.warnMessages.forEach(function (msg) {
console.warn(msg);
});
endActionResult.errorMessages.forEach(function (msg) {
console.error(msg);
});
}
}, function (errMsg) {
console.log(errMsg);
});
}
NotifyOnTaskClient – getNotifyActionTemplate()
Gibt eine JSON-Datenvorlage zurück, die mit der doConferenceAction()- Methode verwendet werden soll. Mit dieser Vorlage wird das Datenobjekt automatisch strukturiert, sodass Sie es nicht manuell erstellen müssen.
Rufen Sie diese Methode auf, bevor Sie die doConferenceAction()- Methode aufrufen. Legen Sie für die gewünschte Telefonkonferenzaktion die gewünschten Parameter in der Vorlage fest, und übergeben Sie dann die Vorlage im doConferenceAction()- Aufruf. Weitere Informationen zu den gültigen Parametern für die einzelnen Aktionen finden Sie unter doConferenceAction().
| Name | Typ | Beschreibung |
|---|---|---|
| Keine |
| Typ | Beschreibung |
|---|---|
| Daten | Objekt, das die Telefonkonferenz beschreibt. |
| data.addToWorkNotes | Kennzeichnung, die angibt, ob Informationen zu den Teilnehmern, die in die Telefonkonferenz einbezogen wurden, im Feld „Arbeitsnotizen“ des zugeordneten Datensatzes hinzugefügt werden sollen. Damit diese Funktionalität funktioniert, müssen Sie auch Werte in den Parametern data.table und data.sysId angeben. Diese Parameter identifizieren den Datensatz, in dem die Arbeitsnotizen hinzugefügt werden sollen. Standardwert: false Aktionen, für die dieser Parameter gültig ist:
|
| data.allowMultconference | Kennzeichnung, die angibt, ob mehrere Telefonkonferenzen für einen bestimmten Datensatz gleichzeitig zulässig sind. Damit diese Funktionalität funktioniert, müssen Sie auch Werte in den Parametern data.table und data.sysId angeben. Diese Parameter identifizieren den Datensatz, der mehrere Telefonkonferenzen enthalten darf. Standardwert: false Aktionen, für die dieser Parameter gültig ist:
|
| data.confId | Sys-ID der Telefonkonferenz. Die Konferenz-Sys-ID befindet sich in der Notify-Telefonkonferenztabelle [notify_conference_call]. Aktionen, für die dieser Parameter erforderlich ist:
Hinweis: Für Teilnehmeraktionen wie Stummschalten, Aufheben der Stummschaltung und Kick muss dieser Parameter nicht festgelegt werden, da die Methode diese Informationen aus der Notify-Telefonkonferenzteilnehmer-Tabelle [notify_participant] erhält. |
| data.fromNumber | Service Provider-Nummer, die für die Telefonkonferenz verwendet werden soll. Suchen Sie diesen Wert in der Spalte „Nummer“ oder „Telefonnummer“ der Tabelle „Notify-Telefonnummer“ [notify_number]. Aktionen, für die dieser Parameter erforderlich ist:
|
| data.isNewConference | Kennzeichnung, die angibt, ob es sich um eine neue oder eine vorhandene Telefonkonferenz handelt. Gültige Werte:
Standardwert: false Aktionen, für die dieser Parameter gültig ist:
|
| data.items | Informationen für jeden Teilnehmer, der in die Telefonkonferenz aufgenommen werden soll. Gültige Array-Werte:
|
| data.message | Nachricht, die laut vorgelesen wird, wenn ein Benutzer den Anruf entgegennimmt, z. B. „P1-Incident wurde erstellt, melden Sie sich bei der Instanz an.“ Aktionen, für die dieser Parameter gültig ist:
|
| data.serviceProvider | Erforderlich. Name des Konferenzserviceanbieters, z. B. Zoom oder Webex. Aktionen, für die dieser Parameter erforderlich ist:
|
| data.sysId | Sys-ID des Quelldatensatzes, der der Telefonkonferenz zugeordnet werden soll. Wenn beispielsweise eine Telefonkonferenz abgehalten wird, um einen bestimmten Incident oder ein bestimmtes Problem zu besprechen, geben Sie die Sys-ID des Incident- oder Problemdatensatzes in diesen Wert ein. Diese Sys-ID wird in der Spalte „Quelle“ der NotifyConference-Anruftabelle [notify_conference_call] gespeichert und kann später nachverfolgt werden. Dieser Parameter wird in Verbindung mit den Parametern data.Table, data.addToWorkNotesund allowMulticonference verwendet. Aktionen, für die dieser Parameter gültig ist:
|
| data.table | Tabelle, die den Quelldatensatz enthält, der der Telefonkonferenz zugeordnet werden soll. Ein Quelldatensatz kann ein beliebiger Datensatz sein, z. B. ein „Incident“ oder ein „Problem“, der in der Telefonkonferenz besprochen wird. Dieser Tabellenname wird in der Spalte Tabelle der NotifyConference-Anruftabelle [notify_conference_call] gespeichert und kann nachverfolgt werden. Dieser Parameter wird in Verbindung mit den Parametern data.sysId, data.addToWorkNotesund allowMulticonference verwendet. Aktionen, für die dieser Parameter gültig ist:
|
Das folgende Beispiel zeigt, wie getNotifyActionTemplate() aufgerufen wird, um die Datenvorlage zu erhalten, die zum Definieren der Aktionen für doConferenceAction() erforderlich ist.
/**
*
* @param {string} action - action to perform on the conference object or participant object
* @param {Array} participants;
*/
function doConferenceAction(action, participants) {
var data = NotifyOnTaskClient.getNotifyActionTemplate();
data.serviceProvider = 'Telephony'; // e.g 'Zoom', 'WebEx'
data.confId = 'Active conference sysId';
data.items = participants;
NotifyOnTaskClient.doConferenceAction(action, data).then(function (result) {
var kickActionResult = result[0];
if (kickActionResult.status)
console.log(action + ' succeeded');
else {
kickActionResult.warnMessages.forEach(function (msg) {
console.warn(msg);
});
kickActionResult.errorMessages.forEach(function (msg) {
console.error(msg);
});
}
}, function (errMsg) {
console.log(errMsg)
});
}
// kick participants
doConferenceAction('kick', [{notifyParticipantId: 'notifyParticipantSysId'}]);
// kick multiple participants
doConferenceAction('multiKick',
[{notifyParticipantId: 'notifyParticipantSysId'},
{notifyParticipantId: 'notifyParticipantSysId'}]);
// Mute participants
doConferenceAction('mute', [{notifyParticipantId: 'notifyParticipantSysId'}]);
doConferenceAction('mute', [{notifyParticipantId: 'notifyParticipantSysId'}]);
doConferenceAction('multiMute',
[{notifyParticipantId: 'notifyParticipantSysId'},
{notifyParticipantId: 'notifyParticipantSysId'}]);
// self join to any confernece.
doConferenceAction('selfJoin', [{id: 'logged in userId'}]);
NotifyOnTaskClient – start(Object data)
Startet eine neue Telefonkonferenz.
| Name | Typ | Beschreibung |
|---|---|---|
| data | Objekt | Objekt, das die Telefonkonferenz beschreibt. |
| data.addToWorkNotes | Boolean | Optional.Kennzeichnung, die angibt, ob Informationen zu den Teilnehmern, die in die Telefonkonferenz einbezogen wurden, im Feld „Arbeitsnotizen“ des zugeordneten Datensatzes hinzugefügt werden sollen. Damit diese Funktionalität funktioniert, müssen Sie auch Werte für die Parameter data.table und data.sysId angeben, um den Datensatz zu identifizieren, in dem die Arbeitsnotizen hinzugefügt werden sollen. Standardwert: false |
| data.allowMulticonference | Boolean | Optional. Kennzeichnung, die angibt, ob mehrere Telefonkonferenzen für einen bestimmten Datensatz gleichzeitig zulässig sind. Damit diese Funktionalität funktioniert, müssen Sie auch Werte in den Parametern data.table und data.sysId angeben. Diese Parameter identifizieren den Datensatz, der mehrere Telefonkonferenzen enthalten darf. Standardwert: false |
| data.fromNumber | Zeichenfolge | Erforderlich. Service Provider-Nummer, die für die Telefonkonferenz verwendet werden soll. Suchen Sie diesen Wert in der Spalte „Nummer“ oder „Telefonnummer“ der Tabelle „Notify-Telefonnummer“ [notify_number]. |
| data.items | Array | Optional. Informationen für jeden Teilnehmer, der in die Telefonkonferenz aufgenommen werden soll. Gültige Array-Werte:
|
| data.message | Zeichenfolge | Optional. Nachricht, die laut vorgelesen wird, wenn ein Benutzer den Anruf entgegennimmt, z. B. „P1-Incident wurde erstellt, melden Sie sich bei der Instanz an.“ |
| data.serviceProvider | Zeichenfolge | Erforderlich. Name des Konferenzserviceanbieters, z. B. Zoom oder Webex. |
| data.sysId | Zeichenfolge | Optional. Sys-ID des Quelldatensatzes, der der Telefonkonferenz zugeordnet werden soll. Wenn beispielsweise eine Telefonkonferenz abgehalten wird, um einen bestimmten Incident oder ein bestimmtes Problem zu besprechen, geben Sie die Sys-ID des Incident- oder Problemdatensatzes in diesen Wert ein. Diese Sys-ID wird in der Spalte „Quelle“ der NotifyConference-Anruftabelle [notify_conference_call] gespeichert und kann später nachverfolgt werden. Dieser Parameter wird in Verbindung mit den Parametern data.Table, data.addToWorkNotesund allowMulticonference verwendet. |
| data.table | Zeichenfolge | Optional. Tabelle, die den Quelldatensatz enthält, der der Telefonkonferenz zugeordnet werden soll. Ein Quelldatensatz kann ein beliebiger Datensatz sein, z. B. ein „Incident“ oder ein „Problem“, der in der Telefonkonferenz besprochen wird. Dieser Tabellenname wird in der Spalte Tabelle der NotifyConference-Anruftabelle [notify_conference_call] gespeichert und kann nachverfolgt werden. Dieser Parameter wird in Verbindung mit den Parametern data.sysId, data.addToWorkNotesund allowMulticonference verwendet. |
| Typ | Beschreibung |
|---|---|
| Objekt | Ergebnisse der Konferenzaktion. <action
<action
<action
<action
|
Beispiel
function startConferenceCall() {
var data = NotifyOnTaskClient.getNotifyActionTemplate();
data.table = 'incident';
data.sysId = '1234';
data.serviceProvider = serviceProvider;
data.addToWorkNotes = true;
data.fromNumber = 'Telephony Number';
data.items.push({ id: 'userSysId' });
data.items.push({ phoneNumber: '+917799555332' });
data.items.push({ email: 'yln99517@gmail.com' });
NotifyOnTaskClient.start(data).then(function (result) {
var startActionResult = result[0];
if(startActionResult.status) {
startActionResult.successMessages.forEach(function(msg) {
console.log(msg);
});
return;
}
startActionResult.warnMessages.forEach(function(msg) {
console.warn(msg);
});
startActionResult.errorMessages.forEach(function(msg) {
console.error(msg);
});
}, function (errMsg) {
console.log(errMsg);
});
}