NotifyOnTaskClient – Client

Die NotifyOnTaskClient Die API bietet Methoden zum Senden von SMS-Nachrichten oder zum Starten/Verwalten einer Telefonkonferenz für verschiedene Telefondienstanbieter, z. B. Zoom Und Webex.

Jede Anwenderoberfläche kann verbrauchen NotifyOnTaskClient API durch explizite Einbeziehung des UI-Skripts NotifyOnTaskClient.

Mit NotifyOnTaskClient API Sie können:

• Konferenzanruf starten
• Telefonkonferenz beenden
• Teilnehmer hinzufügen
• Führen Sie Aktionen aus, die über den Telefonie-Treiber verfügbar sind, z. B.:
  • Stummschaltung von Teilnehmern aufheben
  • Entfernen Sie Teilnehmer aus einer Telefonkonferenz
  • Fügen Sie einer Telefonkonferenz Teilnehmer hinzu
  • Starten Sie eine Telefonkonferenz
  • Beenden Sie eine Telefonkonferenz

Das Notify-Plugin (com.snc.notify) erfordert ein separates Abonnement. Weitere Informationen zum Aktivieren des Notify-Plugins finden Sie unter Aktivieren Sie Notify .

NotifyOnTaskClient – addParticipants (Objektdaten)

Fügt die angegebenen Teilnehmer einer angegebenen Telefonkonferenz hinzu.

Tabelle : 1. Parameter

Name	Typ	Beschreibung
data	Objekt	Objekt, das die Telefonkonferenz beschreibt.
Data.addToArbeitsnotizen	Boolean	Kennzeichnung, die angibt, ob im Feld Arbeitsnotizen des zugehörigen Datensatzes Informationen zu den Teilnehmern hinzugefügt werden sollen, die in der Telefonkonferenz enthalten waren. Damit diese Funktionalität funktioniert, müssen Sie auch Werte in angeben data.tableUnd data.sysIdParameter. Diese Parameter identifizieren den Datensatz, in dem die Arbeitsnotizen hinzugefügt werden sollen. Standardwert: false
Daten.Konfid	Zeichenfolge	SYS_ID der Telefonkonferenz. Tabelle: Notify-Telefonkonferenz [Notify_Conference_call]
data.items	Array	Informationen, die jeder Teilnehmer in die Telefonkonferenz aufnehmen soll. "items": [ "email": "String", "id": "String", "notifyParticipantId": "String", "phoneNumber": "String" ]
data.items.email	Zeichenfolge	E-Mail-Adresse des Teilnehmers.
data.items.id	Zeichenfolge	Anwender-sys_ID Tabelle: Anwender [sys_User]
data.items.notifyParticipantId	Zeichenfolge	Sys_ID des Teilnehmers Tabelle: Notify-Teilnehmer [Notify_participant]
data.items.phoneNumber	Zeichenfolge	Telefonnummer des Teilnehmers. Ob dieser Wert in Verbindung mit übergeben wird idOder notifyParticipantIdParameter: Dieser Wert ersetzt die Telefonnummern im Anwender-/Teilnehmerdatensatz und wird zum Tätigen des Anrufs verwendet.
Daten.Nachricht	Zeichenfolge	Nachricht, die laut vorgelesen wird, wenn ein Anwender den Anruf beantwortet, z. B. „P1-Incident wurde erstellt, melden Sie sich bei der Instanz an.“
data.serviceProvider	Zeichenfolge	Erforderlich. Name des Konferenzservice Providers, z. B. Zoom oder Webex.
Daten.sysId	Zeichenfolge	SYS_ID des Quelldatensatzes, der der Telefonkonferenz zugeordnet werden soll. Wenn beispielsweise eine Telefonkonferenz gehalten 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 Tabelle „NotifyConference-Anruf“ [Notify_Conference_call] gespeichert und kann später nachverfolgt werden. Dieser Parameter wird in Verbindung mit verwendet data.Table, data.addToWorkNotes, Und allowMulticonferenceParameter. Sie sollten diesen Wert konfigurieren, wenn die Telefonkonferenz anfänglich über eine Aktion „Start“ erstellt wird. Bei Bedarf können Sie diesen Wert auch über diese Methode festlegen.
Daten.Tabelle	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 „Problem“, der das Diskussionsthema in der Telefonkonferenz ist. Dieser Tabellenname wird in der Tabellenspalte der Tabelle NotifyConference Call [Notify_Conference_call] gespeichert und kann nachverfolgt werden. Dieser Parameter wird in Verbindung mit verwendet data.sysId, data.addToWorkNotes, Und allowMulticonferenceParameter. Sie sollten diesen Wert konfigurieren, wenn die Telefonkonferenz anfänglich über eine Aktion „Start“ erstellt wird. Bei Bedarf können Sie diesen Wert auch über diese Methode festlegen.

Tabelle : 2. Rückgaben

Typ

Beschreibung

Objekt

Ergebnisse der Konferenzaktion. <action>.Status : Status der Konferenzaktion. Datentyp: Boolesch Mögliche Werte: Wahr: Konferenzaktion erfolgreich Falsch: Konferenzaktion fehlgeschlagen <action>.Erfolgsnachrichten : Wenn Status Ist „wahr“, Erfolgsmeldung(en), andernfalls leer. Datentyp: Array von Zeichenfolgen <action>.Warnmeldungen : Wenn Status Ist „falsch“, alle während der Verarbeitung ausgelösten Warnmeldungen. Datentyp: Array von Zeichenfolgen <action>.Fehlernachrichten : Wenn Status Ist „falsch“, alle Fehlermeldungen, die während der Verarbeitung ausgelöst werden. Datentyp: Array von Zeichenfolgen

Das folgende Codebeispiel zeigt, wie diese Methode aufgerufen wird.

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: '[phone]' });
    data.items.push({ email: '[e-mail]' });

    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 (Zeichenfolgenaktion, Objektdaten)

Führt die angegebene Telefonkonferenz-Aktion aus, z. B. Starten/Beenden einer Telefonkonferenz oder Beitritt, Entfernen, Stummschalten oder Aufheben der Stummschaltung von Teilnehmern aus einer Telefonkonferenz.

Sie können eine neue Telefonkonferenz starten und Teilnehmer innerhalb eines einzigen Anrufs zu dieser Methode hinzufügen oder die Methode mehrmals aufrufen, um den Anruf zu starten und die Teilnehmer dann separat zu verwalten. Darüber hinaus können Sie die Methode über das übergebene Datenobjekt konfigurieren, um:

• Speichern Sie Zeiger im Telefonkonferenzdatensatz in dem spezifischen Datensatz (Quelldatensatz), z. B. einem Incident oder Problem, der das Diskussionsthema für die Telefonkonferenz ist.
• Mehrere Telefonkonferenzen für einen Quelldatensatz zulassen/nicht zulassen.
• Protokollieren Sie die Teilnehmer, die sich an der Telefonkonferenz befanden, automatisch in Arbeitsnotizen Feld des Quelldatensatzes.
• Lassen Sie eine Nachricht laut vorlesen, wenn ein Teilnehmer einen ausgehenden Anruf aus der Konferenz beantwortet.

Tabelle : 3. Parameter

Name	Typ	Beschreibung
Aktion	Zeichenfolge	Definiert die auszuführende Telefonkonferenz-Aktion. Im Folgenden sind die verfügbaren Telefonkonferenzaktionen aufgeführt: Ende: Beendet die in identifizierte Telefonkonferenz data.confId. Beitreten: Fügt den in angegebenen Teilnehmer hinzu data.itemsArray für die in identifizierte Telefonkonferenz data.confId. Kick: Entfernt den in angegebenen Teilnehmer data.itemsArray aus der in identifizierten Telefonkonferenz data.confId. MultiJoin: Fügt die in angegebenen Teilnehmer hinzu data.itemsArray für die in identifizierte Telefonkonferenz data.confId MultiKick: Entfernt die in angegebenen Teilnehmer data.itemsArray aus der in identifizierten Telefonkonferenz data.confId. Multistummschaltung: Schaltet die in angegebenen Teilnehmer stumm data.itemsArray in der in identifizierten Telefonkonferenz data.confId. Mehrfache Stummschaltung: Hebt die Stummschaltung der in angegebenen Teilnehmer auf data.itemsArray aus der in identifizierten Telefonkonferenz data.confId. Stummschalten: Schaltet den in angegebenen Teilnehmer stumm data.itemsArray in der in identifizierten Telefonkonferenz data.confId. SelfJoin: Fügt der Telefonkonferenz den derzeit angemeldeten Anwender hinzu (kein Eintrag in data.itemsErforderlich.) Start: Startet die in identifizierte Telefonkonferenz data.confId. Stummschaltung aufheben: Hebt die Stummschaltung des in angegebenen Teilnehmers auf data.itemsArray aus der in identifizierten Telefonkonferenz data.confId.
Daten	Objekt	Objekt, das die Telefonkonferenz beschreibt.
Data.addToArbeitsnotizen	Boolean	Kennzeichnung, die angibt, ob im Feld Arbeitsnotizen des zugehörigen Datensatzes Informationen zu den Teilnehmern hinzugefügt werden sollen, die in der Telefonkonferenz enthalten waren. Damit diese Funktionalität funktioniert, müssen Sie auch Werte in angeben data.tableUnd data.sysIdParameter. Diese Parameter identifizieren den Datensatz, in dem die Arbeitsnotizen hinzugefügt werden sollen. Standardwert: false Aktionen, für die dieser Parameter gültig ist: teilnehmen MultiJoin SelfJoin Start
Data.allowMultiConference	Boolean	Kennzeichnung, die angibt, ob mehrere Telefonkonferenzen für einen bestimmten Datensatz gleichzeitig zugelassen werden sollen. Damit diese Funktionalität funktioniert, müssen Sie auch Werte in angeben data.tableUnd data.sysIdParameter. Diese Parameter identifizieren den Datensatz, der mehrere Telefonkonferenzen haben darf. Standardwert: false Aktionen, für die dieser Parameter gültig ist: Start
Daten.Konfid	Zeichenfolge	SYS_ID der Telefonkonferenz. Tabelle: Notify-Telefonkonferenz [Notify_Conference_call] Aktionen, für die dieser Parameter erforderlich ist: Ende teilnehmen MultiJoin SelfJoin Hinweis: Für Teilnehmeraktionen wie Stummschaltung, Stummschaltung aufheben und Kick muss dieser Parameter nicht festgelegt werden, da die Methode diese Informationen aus der Tabelle Notify-Konferenzanruf-Teilnehmer [Notify_participant] abruft.
data.fromNumber	Zeichenfolge	Nummer des Service Providers, der für die Telefonkonferenz angerufen werden soll. Suchen Sie diesen Wert in der Spalte Nummer oder Telefonnummer der Tabelle Notify Phone Number [Notify_number]. Aktionen, für die dieser Parameter erforderlich ist: Start
Data.isNeuKonferenz	Boolean	Kennzeichnung, die angibt, ob es sich um eine neue oder eine vorhandene Telefonkonferenz handelt. Gültige Werte: Wahr: Neue Telefonkonferenz Falsch: Vorhandene Telefonkonferenz Standardwert: false Aktionen, für die dieser Parameter gültig ist: Start
Daten.Nachricht	Zeichenfolge	Nachricht, die laut vorgelesen wird, wenn ein Anwender den Anruf beantwortet, z. B. „P1-Incident wurde erstellt, melden Sie sich bei der Instanz an.“ Aktionen, für die dieser Parameter gültig ist: teilnehmen MultiJoin Start
data.items	Array	Informationen, die jeder Teilnehmer in die Telefonkonferenz aufnehmen soll. Gültige Array-Werte: id: SYS_ID des Anwenders; befindet sich in der Anwendertabelle [sys_User]. Gültige Aktionen: Join, MultiJoin, Start NotifyParticipantId: SYS-ID des Notify-Teilnehmers; befindet sich in der Notify-Teilnehmer-Tabelle [Notify_participant]. Gültige Aktionen: Beitreten, Kick, MultiJoin, Stummschaltung, Start, Stummschaltung aufheben Telefonnummer: Telefonnummer des Teilnehmers. Ob dieser Wert in Verbindung mit übergeben wird idOder notifyParticipantId, Dieser Wert ersetzt die Telefonnummern im Anwender-/Teilnehmerdatensatz und wird zum Tätigen des Anrufs verwendet. Gültige Aktionen: Join, MultiJoin, Start E-Mail: E-Mail-Adresse des Teilnehmers. Gültige Aktionen: Join, MultiJoin, Start
data.serviceProvider	Zeichenfolge	Erforderlich. Name des Konferenzservice Providers, z. B. Zoom oder Webex. Aktionen, für die dieser Parameter erforderlich ist: alle
Daten.sysId	Zeichenfolge	SYS_ID des Quelldatensatzes, der der Telefonkonferenz zugeordnet werden soll. Wenn beispielsweise eine Telefonkonferenz gehalten 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 Tabelle „NotifyConference-Anruf“ [Notify_Conference_call] gespeichert und kann später nachverfolgt werden. Dieser Parameter wird in Verbindung mit verwendet data.Table, data.addToWorkNotes, Und allowMulticonferenceParameter. Aktionen, für die dieser Parameter gültig ist: Start
Daten.Tabelle	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 „Problem“, der das Diskussionsthema in der Telefonkonferenz ist. Dieser Tabellenname wird in der Tabellenspalte der Tabelle NotifyConference Call [Notify_Conference_call] gespeichert und kann nachverfolgt werden. Dieser Parameter wird in Verbindung mit verwendet data.sysId, data.addToWorkNotes, Und allowMulticonferenceParameter. Aktionen, für die dieser Parameter gültig ist: Start

Tabelle : 4. Rückgaben

Typ

Beschreibung

Objekt

Ergebnisse der Konferenzaktion. <action>.Status : Status der Konferenzaktion. Datentyp: Boolesch Mögliche Werte: Wahr: Konferenzaktion erfolgreich Falsch: Konferenzaktion fehlgeschlagen <action>.Erfolgsnachrichten : Wenn Status Ist „wahr“, Erfolgsmeldung(en), andernfalls leer. Datentyp: Array von Zeichenfolgen <action>.Warnmeldungen : Wenn Status Ist „falsch“, alle während der Verarbeitung ausgelösten Warnmeldungen. Datentyp: Array von Zeichenfolgen <action>.Fehlernachrichten : Wenn Status Ist „falsch“, alle Fehlermeldungen, die während der Verarbeitung ausgelöst werden. Datentyp: Array von Zeichenfolgen

Das folgende Beispiel zeigt, wie Sie eine Funktion zum Aufrufen von doConferenceAction() erstellen, um die Teilnehmer an einer Telefonkonferenz zu manipulieren, indem Sie die Aktion und die Teilnehmer übergeben.

/**
 * 
 * @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 (Objektdaten)

Beendet die angegebene Telefonkonferenz.

Tabelle : 5. Parameter

Name	Typ	Beschreibung
data	Objekt	Objekt, das die Telefonkonferenz beschreibt.
Daten.Konfid	Zeichenfolge	SYS_ID der Telefonkonferenz.
data.serviceProvider	Zeichenfolge	Erforderlich. Name des Konferenzservice Providers, z. B. Zoom oder Webex.

Tabelle : 6. Ergebnisse

Typ

Beschreibung

Objekt

Ergebnisse der Konferenzaktion. <action>.Status : Status der Konferenzaktion. Datentyp: Boolesch Mögliche Werte: Wahr: Konferenzaktion erfolgreich Falsch: Konferenzaktion fehlgeschlagen <action>.Erfolgsnachrichten : Wenn Status Ist „wahr“, Erfolgsmeldung(en), andernfalls leer. Datentyp: Array von Zeichenfolgen <action>.Warnmeldungen : Wenn Status Ist „falsch“, alle während der Verarbeitung ausgelösten Warnmeldungen. Datentyp: Array von Zeichenfolgen <action>.Fehlernachrichten : Wenn Status Ist „falsch“, alle Fehlermeldungen, die während der Verarbeitung ausgelöst werden. Datentyp: Array von Zeichenfolgen

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 verwendet werden soll DoConferenceAction() Methode. Wenn Sie diese Vorlage verwenden, wird das Datenobjekt automatisch so strukturiert, dass Sie es nicht manuell erstellen müssen.

Rufen Sie diese Methode auf, bevor Sie aufrufen DoConferenceAction() Methode. Legen Sie für die gewünschte Telefonkonferenz-Aktion die gewünschten Parameter in der Vorlage fest, und übergeben Sie die Vorlage dann in DoConferenceAction() Rufen Sie an. Weitere Informationen zu den gültigen Parametern für jede Aktion finden Sie unter DoConferenceAction() .

Hinweis:

Dies ist eine Hilfsmethode. Sie können dieses Objekt auch manuell erstellen und an übergeben DoConferenceAction() Methode und haben das gleiche Ergebnis.

Tabelle : 7. Parameter

Name	Typ	Beschreibung
Keine

Tabelle : 8. Ergebnisse

Typ	Beschreibung
Daten	Objekt, das die Telefonkonferenz beschreibt.
Data.addToArbeitsnotizen	Kennzeichnung, die angibt, ob im Feld Arbeitsnotizen des zugehörigen Datensatzes Informationen zu den Teilnehmern hinzugefügt werden sollen, die in der Telefonkonferenz enthalten waren. Damit diese Funktionalität funktioniert, müssen Sie auch Werte in angeben data.tableUnd data.sysIdParameter. Diese Parameter identifizieren den Datensatz, in dem die Arbeitsnotizen hinzugefügt werden sollen. Standardwert: false Aktionen, für die dieser Parameter gültig ist: teilnehmen MultiJoin SelfJoin Start
Data.allowMultConference	Kennzeichnung, die angibt, ob mehrere Telefonkonferenzen für einen bestimmten Datensatz gleichzeitig zugelassen werden sollen. Damit diese Funktionalität funktioniert, müssen Sie auch Werte in angeben data.tableUnd data.sysIdParameter. Diese Parameter identifizieren den Datensatz, der mehrere Telefonkonferenzen haben darf. Standardwert: false Aktionen, für die dieser Parameter gültig ist: Start
Daten.Konfid	SYS_ID der Telefonkonferenz. Tabelle: Notify-Telefonkonferenz [Notify_Conference_call] Aktionen, für die dieser Parameter erforderlich ist: Ende teilnehmen MultiJoin SelfJoin Hinweis: Für Teilnehmeraktionen wie Stummschaltung, Stummschaltung aufheben und Kick muss dieser Parameter nicht festgelegt werden, da die Methode diese Informationen aus der Tabelle Notify-Konferenzanruf-Teilnehmer [Notify_participant] abruft.
data.fromNumber	Nummer des Service Providers, der für die Telefonkonferenz angerufen werden soll. Suchen Sie diesen Wert in der Spalte Nummer oder Telefonnummer der Tabelle Notify Phone Number [Notify_number]. Aktionen, für die dieser Parameter erforderlich ist: Start
Data.isNeuKonferenz	Kennzeichnung, die angibt, ob es sich um eine neue oder eine vorhandene Telefonkonferenz handelt. Gültige Werte: Wahr: Neue Telefonkonferenz Falsch: Vorhandene Telefonkonferenz Standardwert: false Aktionen, für die dieser Parameter gültig ist: Start
data.items	Informationen, die jeder Teilnehmer in die Telefonkonferenz aufnehmen soll. Gültige Array-Werte: id: SYS_ID des Anwenders; befindet sich in der Anwendertabelle [sys_User]. Gültige Aktionen: Join, MultiJoin, Start NotifyParticipantId: SYS-ID des Notify-Teilnehmers; befindet sich in der Notify-Teilnehmer-Tabelle [Notify_participant]. Gültige Aktionen: Beitreten, Kick, MultiJoin, Stummschaltung, Start, Stummschaltung aufheben Telefonnummer: Telefonnummer des Teilnehmers. Ob dieser Wert in Verbindung mit übergeben wird idOder notifyParticipantId, Dieser Wert ersetzt die Telefonnummern im Anwender-/Teilnehmerdatensatz und wird zum Tätigen des Anrufs verwendet. Gültige Aktionen: Join, MultiJoin, Start E-Mail: E-Mail-Adresse des Teilnehmers. Gültige Aktionen: Join, MultiJoin, Start
Daten.Nachricht	Nachricht, die laut vorgelesen wird, wenn ein Anwender den Anruf beantwortet, z. B. „P1-Incident wurde erstellt, melden Sie sich bei der Instanz an.“ Aktionen, für die dieser Parameter gültig ist: teilnehmen MultiJoin Start
data.serviceProvider	Erforderlich. Name des Konferenzservice Providers, z. B. Zoom oder Webex. Aktionen, für die dieser Parameter erforderlich ist: alle
Daten.sysId	SYS_ID des Quelldatensatzes, der der Telefonkonferenz zugeordnet werden soll. Wenn beispielsweise eine Telefonkonferenz gehalten 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 Tabelle „NotifyConference-Anruf“ [Notify_Conference_call] gespeichert und kann später nachverfolgt werden. Dieser Parameter wird in Verbindung mit verwendet data.Table, data.addToWorkNotes, Und allowMulticonferenceParameter. Aktionen, für die dieser Parameter gültig ist: Start
Daten.Tabelle	Tabelle, die den Quelldatensatz enthält, der der Telefonkonferenz zugeordnet werden soll. Ein Quelldatensatz kann ein beliebiger Datensatz sein, z. B. ein „Incident“ oder „Problem“, der das Diskussionsthema in der Telefonkonferenz ist. Dieser Tabellenname wird in der Tabellenspalte der Tabelle NotifyConference Call [Notify_Conference_call] gespeichert und kann nachverfolgt werden. Dieser Parameter wird in Verbindung mit verwendet data.sysId, data.addToWorkNotes, Und allowMulticonferenceParameter. Aktionen, für die dieser Parameter gültig ist: Start

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 (Objektdaten)

Startet eine neue Telefonkonferenz.

Tabelle : 9. Parameter

Name	Typ	Beschreibung
data	Objekt	Objekt, das die Telefonkonferenz beschreibt.
Data.addToArbeitsnotizen	Boolean	Optional.Kennzeichnung, die angibt, ob im Feld Arbeitsnotizen des zugehörigen Datensatzes Informationen zu den Teilnehmern hinzugefügt werden sollen, die in der Telefonkonferenz enthalten waren. Damit diese Funktionalität funktioniert, müssen Sie auch Werte für angeben data.tableUnd data.sysIdParameter zur Identifizierung des Datensatzes, 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 zugelassen werden sollen. Damit diese Funktionalität funktioniert, müssen Sie auch Werte in angeben data.tableUnd data.sysIdParameter. Diese Parameter identifizieren den Datensatz, der mehrere Telefonkonferenzen haben darf. Standardwert: false
data.fromNumber	Zeichenfolge	Erforderlich. Nummer des Service Providers, der für die Telefonkonferenz angerufen werden soll. Suchen Sie diesen Wert in der Spalte Nummer oder Telefonnummer der Tabelle Notify Phone Number [Notify_number].
data.items	Array	Optional. Informationen, die jeder Teilnehmer in die Telefonkonferenz aufnehmen soll. "items": [ "email": "String", "id": "String", "notifyParticipantId": "String", "phoneNumber": "String" ]
data.items.email	Zeichenfolge	E-Mail-Adresse des Teilnehmers.
data.items.id	Zeichenfolge	Anwender-sys_ID Tabelle: Anwender [sys_User]
data.items.notifyParticipantId	Zeichenfolge	Sys_ID des Teilnehmers Tabelle: Notify-Teilnehmer [Notify_participant]
data.items.phoneNumber	Zeichenfolge	Telefonnummer des Teilnehmers. Ob dieser Wert in Verbindung mit übergeben wird idOder notifyParticipantIdParameter: Dieser Wert ersetzt die Telefonnummern im Anwender-/Teilnehmerdatensatz und wird zum Tätigen des Anrufs verwendet.
Daten.Nachricht	Zeichenfolge	Optional. Nachricht, die laut vorgelesen wird, wenn ein Anwender den Anruf beantwortet, z. B. „P1-Incident wurde erstellt, melden Sie sich bei der Instanz an.“
data.serviceProvider	Zeichenfolge	Erforderlich. Name des Konferenzservice Providers, z. B. Zoom oder Webex.
Daten.sysId	Zeichenfolge	Optional. SYS_ID des Quelldatensatzes, der der Telefonkonferenz zugeordnet werden soll. Wenn beispielsweise eine Telefonkonferenz gehalten 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 Tabelle „NotifyConference-Anruf“ [Notify_Conference_call] gespeichert und kann später nachverfolgt werden. Dieser Parameter wird in Verbindung mit verwendet data.Table, data.addToWorkNotes, Und allowMulticonferenceParameter.
Daten.Tabelle	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 „Problem“, der das Diskussionsthema in der Telefonkonferenz ist. Dieser Tabellenname wird in der Tabellenspalte der Tabelle NotifyConference Call [Notify_Conference_call] gespeichert und kann nachverfolgt werden. Dieser Parameter wird in Verbindung mit verwendet data.sysId, data.addToWorkNotes, Und allowMulticonferenceParameter.

Tabelle : 10. Ergebnisse

Typ

Beschreibung

Objekt

Ergebnisse der Konferenzaktion. <action>.Status : Status der Konferenzaktion. Datentyp: Boolesch Mögliche Werte: Wahr: Konferenzaktion erfolgreich Falsch: Konferenzaktion fehlgeschlagen <action>.Erfolgsnachrichten : Wenn Status Ist „wahr“, Erfolgsmeldung(en), andernfalls leer. Datentyp: Array von Zeichenfolgen <action>.Warnmeldungen : Wenn Status Ist „falsch“, alle während der Verarbeitung ausgelösten Warnmeldungen. Datentyp: Array von Zeichenfolgen <action>.Fehlernachrichten : Wenn Status Ist „falsch“, alle Fehlermeldungen, die während der Verarbeitung ausgelöst werden. Datentyp: Array von Zeichenfolgen

Das folgende Codebeispiel zeigt, wie diese Methode aufgerufen wird.

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: '[phone]' });
    data.items.push({ email: '[e-mail]' });

    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);
    });
}