NotifyOnTaskClient : Client

  • Freigeben Version: Xanadu
  • Aktualisiert 1. August 2024
  • 15 Minuten Lesedauer
  • Die NotifyOnTaskClient- API bietet Methoden zum Senden von SMS-Nachrichten oder zum Starten/Verwalten einer Telefonkonferenz für verschiedene Telefoniedienstanbieter, z. B. Zoom und Webex.

    Jede UI kann die NotifyOnTaskClient- API durch explizites Einbinden des UI-Skripts NotifyOnTaskClient nutzen.

    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/die Stummschaltung aufheben
      • Teilnehmer aus einer Telefonkonferenz entfernen
      • einer Telefonkonferenz Teilnehmer hinzufügen
      • Starten Sie eine Telefonkonferenz
      • beenden Sie eine Telefonkonferenz

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

    NotifyOnTaskClient – addParticipants(Objektdaten)

    Fügt die angegebenen Teilnehmer zu einer angegebenen Telefonkonferenz hinzu.

    Tabelle : 1. Parameter
    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 geben den Datensatz an, dem die Arbeitsnotizen hinzugefügt werden sollen.

    Standardwert: false

    data.confId Zeichenfolge Erforderlich. Sys-ID der Telefonkonferenz. Die Sys-ID der Konferenz befindet sich in der Tabelle „Notify-Telefonkonferenz“ [notify_conference_call].
    Daten.Elemente Array Erforderlich. Informationen für jeden Teilnehmer, der in die Telefonkonferenz aufgenommen werden soll.

    Gültige Array-Werte:

    • id: Anwender-Sys-ID; befindet sich in der Tabelle „Benutzer“ [sys_User].
    • notifyParticipantId: Teilnehmer-Sys-ID; in der Tabelle „Teilnehmer benachrichtigen“ [notify_participant]
    • phoneNumber: Telefonnummer des Teilnehmers. Wenn dieser Wert in Verbindung mit id oder notifyParticipantIdübergeben wird, ersetzt dieser Wert die Telefonnummern im Benutzer-/Teilnehmerdatensatz und wird zum Tätigen des Anrufs verwendet.
    • email: E-Mail-Adresse des Teilnehmers.
    Daten.Nachricht Zeichenfolge Nachricht, die laut vorgelesen wird, wenn ein Benutzer den Anruf beantwortet, z. B. „P1-Incident wurde erstellt, melden Sie sich bei der Instanz an.“
    data.serviceProvider Zeichenfolge Erforderlich. Name des Service Providers für Konferenzen, 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 Tabelle „NotifyConference Call“ [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 Telefonkonferenz zum ersten Mal über eine Startaktion 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 ein „Problem“, der in der Telefonkonferenz behandelt wird.

    Dieser Tabellenname wird in der Spalte „Tabelle“ der Tabelle „NotifyConference Call“ [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 Telefonkonferenz zum ersten Mal über eine Startaktion erstellt wird. Bei Bedarf können Sie diesen Wert auch über diese Methode festlegen.

    Tabelle : 2. Ergebnisse
    Typ Beschreibung
    Objekt Ergebnisse der Konferenzaktion.

    <action.status: Status der Konferenzaktion.

    • Datentyp: Boolesch
    • Gültige Werte:
      • true: Konferenzaktion erfolgreich
      • false: Konferenzaktion fehlgeschlagen

    <action.successMessages: Erfolgsnachricht(en), wenn der Status „ wahr“ ist, sonst leer.

    • Datentyp: Array von Zeichenfolgen

    <action.warnMessages: Wenn der Status „ falsch“ ist, alle Warnmeldungen, die während der Verarbeitung ausgelöst werden.

    • Datentyp: Array von Zeichenfolgen

    <action.errorMessages: Wenn der Status „ falsch“ ist, alle Fehlermeldungen, die während der Verarbeitung ausgelöst werden.

    • Datentyp: Array von Zeichenfolgen
    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(Zeichenfolgenaktion, Objektdaten)

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

    Sie können einen neuen Telefonkonferenz starten und innerhalb eines einzigen Anrufs zu dieser Methode Teilnehmer 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 für Folgendes konfigurieren:
    • Speichern Sie im Datensatz der Telefonkonferenz Verweise auf den spezifischen Datensatz (Quelldatensatz), z. B. einen Incident oder ein Problem, der das Gesprächsthema für die Telefonkonferenz ist.
    • Mehrere Telefonkonferenzen für einen Quelldatensatz zulassen/nicht zulassen.
    • Protokolliert automatisch die Teilnehmer der Telefonkonferenz im Feld Arbeitsnotizen des Quelldatensatzes.
    • Lassen Sie sich eine Nachricht vorlesen, wenn ein Teilnehmer einen ausgehenden Anruf aus der Konferenz beantwortet.
    Tabelle : 3. Parameter
    Name Typ Beschreibung
    Aktion Zeichenfolge Definiert die auszuführende Telefonkonferenzaktion.
    Es folgen die verfügbaren Telefonkonferenzaktionen:
    • Start: Startet die in identifizierte Telefonkonferenz data.confId
    • end: Beendet die in identifizierte Telefonkonferenz data.confId
    • beitreten: Fügt den im Array [] angegebenen Teilnehmer der in data.itemsdata.confIdidentifizierten Telefonkonferenz hinzu.
    • multiJoin: Fügt die im Array [] angegebenen Teilnehmer der in data.itemsdata.confIdidentifizierten Telefonkonferenz hinzu.
    • SelfJoin: Fügt den aktuell angemeldeten Anwender zur Telefonkonferenz hinzu (Eintrag in data.items nicht erforderlich).
    • Kick: Entfernt den im Array data.items angegebenen Teilnehmer aus der Telefonkonferenz, die in data.confIdangegeben ist.
    • multiKick: Entfernt die im Array data.items angegebenen Teilnehmer aus der in data.confIdidentifizierten Telefonkonferenz.
    • mute: Schaltet den im Array [] angegebenen Teilnehmer in der in data.itemsdata.confIdidentifizierten Telefonkonferenz stumm.
    • multiMute: Schaltet die im Array [] angegebenen Teilnehmer in der in data.itemsdata.confIdidentifizierten Telefonkonferenz stumm.
    • unmute: Hebt die Stummschaltung des im Array [] angegebenen Teilnehmers in der in data.itemsdata.confIdidentifizierten Telefonkonferenz auf
    • multiUnmute: Hebt die Stummschaltung der im Array data.items angegebenen Teilnehmer aus der in data.confIdidentifizierten Telefonkonferenz auf
    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 geben den Datensatz an, dem die Arbeitsnotizen hinzugefügt werden sollen.

    Standardwert: false

    Aktionen, für die dieser Parameter gültig ist:

    • start
    • teilnehmen
    • multiJoin
    • SelfJoin
    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 geben den Datensatz an, der mehrere Telefonkonferenzen enthalten darf.

    Standardwert: false

    Aktionen, für die dieser Parameter gültig ist:

    • start
    data.confId Zeichenfolge Sys-ID der Telefonkonferenz.

    Die Sys-ID der Konferenz befindet sich in der Tabelle „Notify-Telefonkonferenz“ [notify_conference_call].

    Aktionen, für die dieser Parameter erforderlich ist:

    • end
    • teilnehmen
    • multiJoin
    • SelfJoin
    Hinweis:
    Für Teilnehmeraktionen wie „stummschalten“, „Stummschaltung aufheben“ und „Kick“ muss dieser Parameter nicht festgelegt werden, da die Methode diese Informationen aus der Tabelle „Teilnehmer der Notify-Telefonkonferenz“ [notify_participant] erhält.
    data.fromNumber Zeichenfolge Für die Telefonkonferenz anzurufende Service Provider-Nummer.

    Suchen Sie diesen Wert in der Spalte Nummer oder Telefonnummer der Tabelle „Notify-Telefonnummer“ [notify_number].

    Aktionen, für die dieser Parameter erforderlich ist:

    • start
    Daten.istNeueKonferenz Boolean Kennzeichnung, die angibt, ob es sich um eine neue oder eine vorhandene Telefonkonferenz handelt.

    Gültige Werte:

    • true: Neue Telefonkonferenz
    • false: Vorhandene Telefonkonferenz

    Standardwert: false

    Aktionen, für die dieser Parameter gültig ist:

    • start
    Daten.Nachricht Zeichenfolge Nachricht, die laut vorgelesen wird, wenn ein Benutzer 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:

    • start
    • teilnehmen
    • multiJoin
    Daten.Elemente Array Informationen für jeden Teilnehmer, der in die Telefonkonferenz aufgenommen werden soll.

    Gültige Array-Werte:

    • id: Sys-ID des Anwenders. befindet sich in der Tabelle „Benutzer“ [sys_User].

      Gültige Aktionen: „join“, „multiJoin“, „start“.

    • notifyParticipantId: Sys-ID des Notify-Teilnehmers. in der Tabelle „Teilnehmer benachrichtigen“ [notify_participant]

      Gültige Aktionen: beitreten, treten, multijoin, mute, starten, Stummschaltung aufheben

    • phoneNumber: Telefonnummer des Teilnehmers. Wenn dieser Wert in Verbindung mit id oder notifyParticipantIdübergeben wird, ersetzt dieser Wert die Telefonnummern im Benutzer-/Teilnehmerdatensatz und wird zum Tätigen des Anrufs verwendet.

      Gültige Aktionen: „join“, „multiJoin“, „start“.

    • email: E-Mail-Adresse des Teilnehmers.

      Gültige Aktionen: „join“, „multiJoin“, „start“.

    data.serviceProvider Zeichenfolge Erforderlich. Name des Service Providers für Konferenzen, z. B. Zoom oder Webex.

    Aktionen, für die dieser Parameter erforderlich ist:

    • alle
    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 Tabelle „NotifyConference Call“ [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:

    • 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 ein „Problem“, der in der Telefonkonferenz behandelt wird.

    Dieser Tabellenname wird in der Spalte „Tabelle“ der Tabelle „NotifyConference Call“ [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:

    • start
    Tabelle : 4. Ergebnisse
    Typ Beschreibung
    Objekt Ergebnisse der Konferenzaktion.

    <action.status: Status der Konferenzaktion.

    • Datentyp: Boolesch
    • Gültige Werte:
      • true: Konferenzaktion erfolgreich
      • false: Konferenzaktion fehlgeschlagen

    <action.successMessages: Erfolgsnachricht(en), wenn der Status „ wahr“ ist, sonst leer.

    • Datentyp: Array von Zeichenfolgen

    <action.warnMessages: Wenn der Status „ falsch“ ist, alle Warnmeldungen, die während der Verarbeitung ausgelöst werden.

    • Datentyp: Array von Zeichenfolgen

    <action.errorMessages: Wenn der Status „ falsch“ ist, 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 in einer Telefonkonferenz zu bearbeiten, 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(Object data)

    Beendet die angegebene Telefonkonferenz.

    Tabelle : 5. Parameter
    Name Typ Beschreibung
    data Objekt Objekt, das die Telefonkonferenz beschreibt.
    data.confId Zeichenfolge Sys-ID der Telefonkonferenz.
    data.serviceProvider Zeichenfolge Erforderlich. Name des Service Providers für Konferenzen, z. B. Zoom oder Webex.
    Tabelle : 6. Ergebnisse
    Typ Beschreibung
    Objekt Ergebnisse der Konferenzaktion.

    <action.status: Status der Konferenzaktion.

    • Datentyp: Boolesch
    • Gültige Werte:
      • true: Konferenzaktion erfolgreich
      • false: Konferenzaktion fehlgeschlagen

    <action.successMessages: Erfolgsnachricht(en), wenn der Status „ wahr“ ist, sonst leer.

    • Datentyp: Array von Zeichenfolgen

    <action.warnMessages: Wenn der Status „ falsch“ ist, alle Warnmeldungen, die während der Verarbeitung ausgelöst werden.

    • Datentyp: Array von Zeichenfolgen

    <action.errorMessages: Wenn der Status „ falsch“ ist, 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 der doConferenceAction()- Methode verwendet werden soll. Durch die Verwendung 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 die Vorlage dann im doConferenceAction()- Aufruf. Weitere Informationen zu den gültigen Parametern für die einzelnen Aktionen finden Sie unter doConferenceAction().

    Hinweis:
    Dies ist eine Hilfsmethode. Sie können dieses Objekt auch manuell erstellen und an die Methode „doConferenceAction() “ übergeben, um das gleiche Ergebnis zu erzielen.
    Tabelle : 7. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 8. Ergebnisse
    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 geben den Datensatz an, dem die Arbeitsnotizen hinzugefügt werden sollen.

    Standardwert: false

    Aktionen, für die dieser Parameter gültig ist:

    • start
    • teilnehmen
    • multiJoin
    • SelfJoin
    data.allowMulticonference 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 geben den Datensatz an, der mehrere Telefonkonferenzen enthalten darf.

    Standardwert: false

    Aktionen, für die dieser Parameter gültig ist:

    • start
    data.confId Sys-ID der Telefonkonferenz.

    Die Sys-ID der Konferenz befindet sich in der Tabelle „Notify-Telefonkonferenz“ [notify_conference_call].

    Aktionen, für die dieser Parameter erforderlich ist:

    • end
    • teilnehmen
    • multiJoin
    • SelfJoin
    Hinweis:
    Für Teilnehmeraktionen wie „stummschalten“, „Stummschaltung aufheben“ und „Kick“ muss dieser Parameter nicht festgelegt werden, da die Methode diese Informationen aus der Tabelle „Teilnehmer der Notify-Telefonkonferenz“ [notify_participant] erhält.
    data.fromNumber Für die Telefonkonferenz anzurufende Service Provider-Nummer.

    Suchen Sie diesen Wert in der Spalte Nummer oder Telefonnummer der Tabelle „Notify-Telefonnummer“ [notify_number].

    Aktionen, für die dieser Parameter erforderlich ist:

    • start
    Daten.istNeueKonferenz Kennzeichnung, die angibt, ob es sich um eine neue oder eine vorhandene Telefonkonferenz handelt.

    Gültige Werte:

    • true: Neue Telefonkonferenz
    • false: Vorhandene Telefonkonferenz

    Standardwert: false

    Aktionen, für die dieser Parameter gültig ist:

    • start
    Daten.Elemente Informationen für jeden Teilnehmer, der in die Telefonkonferenz aufgenommen werden soll.

    Gültige Array-Werte:

    • id: Sys-ID des Anwenders. befindet sich in der Tabelle „Benutzer“ [sys_User].

      Gültige Aktionen: „join“, „multiJoin“, „start“.

    • notifyParticipantId: Sys-ID des Notify-Teilnehmers. in der Tabelle „Teilnehmer benachrichtigen“ [notify_participant]

      Gültige Aktionen: beitreten, treten, multijoin, mute, starten, Stummschaltung aufheben

    • phoneNumber: Telefonnummer des Teilnehmers. Wenn dieser Wert in Verbindung mit id oder notifyParticipantIdübergeben wird, ersetzt dieser Wert die Telefonnummern im Benutzer-/Teilnehmerdatensatz und wird zum Tätigen des Anrufs verwendet.

      Gültige Aktionen: „join“, „multiJoin“, „start“.

    • email: E-Mail-Adresse des Teilnehmers.

      Gültige Aktionen: „join“, „multiJoin“, „start“.

    Daten.Nachricht Nachricht, die laut vorgelesen wird, wenn ein Benutzer 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:

    • start
    • teilnehmen
    • multiJoin
    data.serviceProvider Erforderlich. Name des Service Providers für Konferenzen, z. B. Zoom oder Webex.

    Aktionen, für die dieser Parameter erforderlich ist:

    • alle
    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 Tabelle „NotifyConference Call“ [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:

    • 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 ein „Problem“, der in der Telefonkonferenz behandelt wird.

    Dieser Tabellenname wird in der Spalte „Tabelle“ der Tabelle „NotifyConference Call“ [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:

    • 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.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 geben den Datensatz an, der mehrere Telefonkonferenzen enthalten darf.

    Standardwert: false

    data.fromNumber Zeichenfolge Erforderlich. Für die Telefonkonferenz anzurufende Service Provider-Nummer.

    Suchen Sie diesen Wert in der Spalte Nummer oder Telefonnummer der Tabelle „Notify-Telefonnummer“ [notify_number].

    Daten.Elemente Array Optional. Informationen für jeden Teilnehmer, der in die Telefonkonferenz aufgenommen werden soll.

    Gültige Array-Werte:

    • id: Anwender-Sys-ID; befindet sich in der Tabelle „Benutzer“ [sys_User].
    • notifyParticipantId: Teilnehmer-Sys-ID; in der Tabelle „Teilnehmer benachrichtigen“ [notify_participant]
    • phoneNumber: Telefonnummer des Teilnehmers. Wenn dieser Wert in Verbindung mit id oder notifyParticipantIdübergeben wird, ersetzt dieser Wert die Telefonnummern im Benutzer-/Teilnehmerdatensatz und wird zum Tätigen des Anrufs verwendet.
    • email: E-Mail-Adresse des Teilnehmers.
    Daten.Nachricht Zeichenfolge Optional. Nachricht, die laut vorgelesen wird, wenn ein Benutzer den Anruf beantwortet, z. B. „P1-Incident wurde erstellt, melden Sie sich bei der Instanz an.“
    data.serviceProvider Zeichenfolge Erforderlich. Name des Service Providers für Konferenzen, 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 Tabelle „NotifyConference Call“ [notify_conference_call] gespeichert und kann später nachverfolgt werden.

    Dieser Parameter wird in Verbindung mit den Parametern data.Table, data.addToWorkNotesund allowMulticonference verwendet.

    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 ein „Problem“, der in der Telefonkonferenz behandelt wird.

    Dieser Tabellenname wird in der Spalte „Tabelle“ der Tabelle „NotifyConference Call“ [notify_conference_call] gespeichert und kann nachverfolgt werden.

    Dieser Parameter wird in Verbindung mit den Parametern data.sysId, data.addToWorkNotesund allowMulticonference verwendet.

    Tabelle : 10. Ergebnisse
    Typ Beschreibung
    Objekt Ergebnisse der Konferenzaktion.

    <action.status: Status der Konferenzaktion.

    • Datentyp: Boolesch
    • Gültige Werte:
      • true: Konferenzaktion erfolgreich
      • false: Konferenzaktion fehlgeschlagen

    <action.successMessages: Erfolgsnachricht(en), wenn der Status „ wahr“ ist, sonst leer.

    • Datentyp: Array von Zeichenfolgen

    <action.warnMessages: Wenn der Status „ falsch“ ist, alle Warnmeldungen, die während der Verarbeitung ausgelöst werden.

    • Datentyp: Array von Zeichenfolgen

    <action.errorMessages: Wenn der Status „ falsch“ ist, alle Fehlermeldungen, die während der Verarbeitung ausgelöst werden.

    • Datentyp: Array von Zeichenfolgen
    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);
        });
    }