---
sourceDocument: Yokohama-API-Referenz
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/de-DE/yokohama/api-reference

 Release :

    - yokohama

ft:locale :

    - de-DE

ft:publication_title :

    - Yokohama-API-Referenz

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# BenachrichtigungOnTaskClient -- Client

# BenachrichtigungOnTaskClient -- Client {#ariaid-title1}

* Freigeben Version: Yokohama
* 
* Aktualisiert 30. Januar 2025
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 15 Minuten Lesedauer

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

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

Mit BenachrichtigungOnTaskClient API, die Sie:  
* 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 Teilnehmer zu einer Telefonkonferenz hinzu
  * Starten Sie eine Telefonkonferenz
  * Beenden Sie eine Telefonkonferenz
  {#NotifyOnTaskClient__ul_e5f_pqy_4hb}
{#NotifyOnTaskClient__ul_qvb_kqy_4hb}

Das Notify-Plugin (com.snc.notify) erfordert ein separates Abonnement. Weitere Informationen zum Aktivieren des Notify-Plugins finden Sie unter [Aktivieren Sie Notify](https://www.servicenow.com/docs/access?context=t_ActivateNotify&version=yokohama&pubname=yokohama-servicenow-platform&ft:locale=en-US).

## NotifyOnTaskClient -- addParticipants (Objektdaten) {#ariaid-title2}

Fügt die angegebenen Teilnehmer einer angegebenen Telefonkonferenz hinzu.
{#NClient-addParticipants_O__dataObject-table-NConf__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Daten | Objekt | Objekt, das die Telefonkonferenz beschreibt. |
| Data.addToArbeitsnotizen | Boolean | Kennzeichnung, die angibt, ob Informationen zu den Teilnehmern, die in der Telefonkonferenz enthalten waren, im Feld „Arbeitsnotizen" des zugehörigen Datensatzes hinzugefügt werden sollen. 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. Standard: Falsch |
| Daten.Konfid | Zeichenfolge | SYS_ID der Telefonkonferenz. Tabelle: Notify-Telefonkonferenz \[Notify_Conference_call\] |
| data.items | Array | Informationen für jeden Teilnehmer, die in die Telefonkonferenz aufgenommen werden sollen. "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 entweder übergeben wird idOder notifyParticipantIdParameter: Dieser Wert ersetzt die Telefonnummern im Anwender-/Teilnehmerdatensatz und wird verwendet, um den Anruf zu tätigen. |
| Daten.Nachricht | Zeichenfolge | Nachricht, die laut gelesen 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 „Benachrichtigungs-Konferenzanruf" \[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 : 1. Parameter]

{#NClient-addParticipants_O__dataObject-table-NConf} {#NClient-addParticipants_O__table_rpj_1y5_nhb__entry__2}

| Typ | Beschreibung |
|-|-|
| Objekt | Ergebnisse der Konferenzaktion. `<action>.Status `: Status der Konferenzaktion. * Datentyp: Boolescher Wert * Mögliche Werte: * Wahr: Konferenzaktion erfolgreich * Falsch: Konferenzaktion fehlgeschlagen {#NClient-addParticipants_O__ul_w5y_hyt_b3b} {#NClient-addParticipants_O__ul_psg_gyt_b3b} `<action>.Erfolgsnachrichten `: Wenn <var class="keyword varname">Status </var>Ist „wahr", Erfolgsmeldung(en), andernfalls leer. * Datentyp: Array von Zeichenfolgen {#NClient-addParticipants_O__ul_qm2_myt_b3b} `<action>.Warnmeldungen `: Wenn <var class="keyword varname">Status </var>Ist „falsch", alle während der Verarbeitung ausgelösten Warnmeldungen. * Datentyp: Array von Zeichenfolgen {#NClient-addParticipants_O__ul_xbz_nyt_b3b} `<action>.Fehlermeldungen `: Wenn <var class="keyword varname">Status </var>Ist „falsch", alle Fehlermeldungen, die während der Verarbeitung ausgelöst werden. * Datentyp: Array von Zeichenfolgen {#NClient-addParticipants_O__ul_tht_4yt_b3b} |
[Tabelle : 2. Rückgaben]

{#NClient-addParticipants_O__table_rpj_1y5_nhb}  
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: '+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) {#ariaid-title3}

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 einzelnen 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 über das übergebene Datenobjekt die Methode konfigurieren, um:

* Speichern Sie Zeiger im Telefonkonferenzdatensatz im spezifischen Datensatz (Quelldatensatz), z. B. einen Incident oder ein 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 sich eine Nachricht laut vorlesen, wenn ein Teilnehmer einen ausgehenden Anruf aus der Konferenz beantwortet.
{#NClient-doConferenceAction_S_O__ul_rqn_z2y_vhb}
{#NClient-doConferenceAction_S_O__table_qqs_vdv_nhb__entry__3}{#NClient-doConferenceAction_S_O__data.addToWorkNotes-p-NConf}{#NClient-doConferenceAction_S_O__data.allowMulticonference-p-NConf}{#NClient-doConferenceAction_S_O__data.confId-p-NConf}{#NClient-doConferenceAction_S_O__data.fromNumber-p-NConf}{#NClient-doConferenceAction_S_O__data.isNewConference-p-NConf}{#NClient-doConferenceAction_S_O__data.message-p-NConf}{#NClient-doConferenceAction_S_O__data.items-p-NConf}{#NClient-doConferenceAction_S_O__data.serviceProvider-p-NConf}{#NClient-doConferenceAction_S_O__data.sys_id-p-NConf}{#NClient-doConferenceAction_S_O__data.table-p-NConf}

| 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. * MultiUnstummschaltung: 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. {#NClient-doConferenceAction_S_O__ul_pq5_qfv_nhb} |
| Daten | Objekt | Objekt, das die Telefonkonferenz beschreibt. |
| Data.addToArbeitsnotizen | Boolean | Kennzeichnung, die angibt, ob Informationen zu den Teilnehmern, die in der Telefonkonferenz enthalten waren, im Feld „Arbeitsnotizen" des zugehörigen Datensatzes hinzugefügt werden sollen. 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.{#NClient-doConferenceAction_S_O__data.addToWorkNotes2-p-NConf} Standard: Falsch Aktionen, für die dieser Parameter gültig ist: * teilnehmen * MultiJoin * SelfJoin * start {#NClient-doConferenceAction_S_O__ul_kwg_ktx_vhb} |
| Data.allowMultikonferenz | 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, für den mehrere Telefonkonferenzen zulässig sind.{#NClient-doConferenceAction_S_O__data.allowMulticonference2-p-NConf} Standard: Falsch Aktionen, für die dieser Parameter gültig ist: * start {#NClient-doConferenceAction_S_O__ul_ay4_mtx_vhb} |
| Daten.Konfid | Zeichenfolge | SYS_ID der Telefonkonferenz. Tabelle: Notify-Telefonkonferenz \[Notify_Conference_call\]{#NClient-doConferenceAction_S_O__data.confId2-p-NConf} Aktionen, für die dieser Parameter erforderlich ist: * end * teilnehmen * MultiJoin * SelfJoin {#NClient-doConferenceAction_S_O__ul_afs_qsx_vhb} 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 \[Notify_participant\] abruft. |
| data.fromNumber | Zeichenfolge | Service Provider-Nummer, an die für die Telefonkonferenz gerufen werden soll. Suchen Sie diesen Wert in der Spalte „Nummer" oder „Telefonnummer" der Tabelle „Notify-Telefonnummer" \[Notify_number\].{#NClient-doConferenceAction_S_O__data.fromNumber2-p-NConf} Aktionen, für die dieser Parameter erforderlich ist: * start {#NClient-doConferenceAction_S_O__ul_exs_stx_vhb} |
| 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 {#NClient-doConferenceAction_S_O__ul_q1m_wbv_nhb} Standard: Falsch Aktionen, für die dieser Parameter gültig ist: * start {#NClient-doConferenceAction_S_O__ul_d1d_stx_vhb} |
| Daten.Nachricht | Zeichenfolge | Nachricht, die laut gelesen 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 {#NClient-doConferenceAction_S_O__ul_jnl_ntx_vhb} |
| data.items | Array | Informationen für jeden Teilnehmer, die in die Telefonkonferenz aufgenommen werden sollen. 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 entweder übergeben wird idOder notifyParticipantId, Dieser Wert ersetzt die Telefonnummern im Anwender-/Teilnehmerdatensatz und wird verwendet, um den Anruf zu tätigen. Gültige Aktionen: Join, MultiJoin, Start * E-Mail: E-Mail-Adresse des Teilnehmers.Gültige Aktionen: Join, MultiJoin, Start {#NClient-doConferenceAction_S_O__ul_qzh_pqt_rhb} |
| data.serviceProvider | Zeichenfolge | Erforderlich. Name des Konferenzservice Providers, z. B. Zoom oder Webex. Aktionen, für die dieser Parameter erforderlich ist: * alle {#NClient-doConferenceAction_S_O__ul_vwb_psx_vhb} |
| 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 „Benachrichtigungs-Konferenzanruf" \[Notify_Conference_call\] gespeichert und kann später nachverfolgt werden. {#NClient-doConferenceAction_S_O__data.sys_id-p2-NConf} Dieser Parameter wird in Verbindung mit verwendet data.Table, data.addToWorkNotes, Und allowMulticonferenceParameter. {#NClient-doConferenceAction_S_O__data.sys_id-p3-NConf} Aktionen, für die dieser Parameter gültig ist: * start {#NClient-doConferenceAction_S_O__ul_h3l_qsx_vhb} |
| 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.{#NClient-doConferenceAction_S_O__data.table-p2-NConf} Dieser Parameter wird in Verbindung mit verwendet data.sysId, data.addToWorkNotes, Und allowMulticonferenceParameter.{#NClient-doConferenceAction_S_O__data.table-p3-NConf} Aktionen, für die dieser Parameter gültig ist: * start {#NClient-doConferenceAction_S_O__ul_mj1_4sx_vhb} |
[Tabelle : 3. Parameter]

{#NClient-doConferenceAction_S_O__table_qqs_vdv_nhb} {#NClient-doConferenceAction_S_O__table_rqs_vdv_nhb__entry__2}

| Typ | Beschreibung |
|-|-|
| Objekt | Ergebnisse der Konferenzaktion. `<action>.Status `: Status der Konferenzaktion. * Datentyp: Boolescher Wert * Mögliche Werte: * Wahr: Konferenzaktion erfolgreich * Falsch: Konferenzaktion fehlgeschlagen {#NClient-doConferenceAction_S_O__ul_w5y_hyt_b3b} {#NClient-doConferenceAction_S_O__ul_psg_gyt_b3b} `<action>.Erfolgsnachrichten `: Wenn <var class="keyword varname">Status </var>Ist „wahr", Erfolgsmeldung(en), andernfalls leer. * Datentyp: Array von Zeichenfolgen {#NClient-doConferenceAction_S_O__ul_qm2_myt_b3b} `<action>.Warnmeldungen `: Wenn <var class="keyword varname">Status </var>Ist „falsch", alle während der Verarbeitung ausgelösten Warnmeldungen. * Datentyp: Array von Zeichenfolgen {#NClient-doConferenceAction_S_O__ul_xbz_nyt_b3b} `<action>.Fehlermeldungen `: Wenn <var class="keyword varname">Status </var>Ist „falsch", alle Fehlermeldungen, die während der Verarbeitung ausgelöst werden. * Datentyp: Array von Zeichenfolgen {#NClient-doConferenceAction_S_O__ul_tht_4yt_b3b} |
[Tabelle : 4. Rückgaben]

{#NClient-doConferenceAction_S_O__table_rqs_vdv_nhb}  
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) {#ariaid-title4}

Beendet die angegebene Telefonkonferenz.
{#NClient-endConference_O__entry__3}{#NClient-endConference_O__data-row-NConf}{#NClient-endConference_O__data.confId-row-NConf}

| Name | Typ | Beschreibung |
|-|-|-|
| Daten | 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 : 5. Parameter]

{#NClient-endConference_O__table_dqd_qcv_nhb__entry__2}

| Typ | Beschreibung |
|-|-|
| Objekt | Ergebnisse der Konferenzaktion. `<action>.Status `: Status der Konferenzaktion. * Datentyp: Boolescher Wert * Mögliche Werte: * Wahr: Konferenzaktion erfolgreich * Falsch: Konferenzaktion fehlgeschlagen {#NClient-endConference_O__ul_w5y_hyt_b3b} {#NClient-endConference_O__ul_psg_gyt_b3b} `<action>.Erfolgsnachrichten `: Wenn <var class="keyword varname">Status </var>Ist „wahr", Erfolgsmeldung(en), andernfalls leer. * Datentyp: Array von Zeichenfolgen {#NClient-endConference_O__ul_qm2_myt_b3b} `<action>.Warnmeldungen `: Wenn <var class="keyword varname">Status </var>Ist „falsch", alle während der Verarbeitung ausgelösten Warnmeldungen. * Datentyp: Array von Zeichenfolgen {#NClient-endConference_O__ul_xbz_nyt_b3b} `<action>.Fehlermeldungen `: Wenn <var class="keyword varname">Status </var>Ist „falsch", alle Fehlermeldungen, die während der Verarbeitung ausgelöst werden. * Datentyp: Array von Zeichenfolgen {#NClient-endConference_O__ul_tht_4yt_b3b} |
[Tabelle : 6. Rückgaben]

{#NClient-endConference_O__table_dqd_qcv_nhb}  

    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() {#ariaid-title5}

Gibt eine JSON-Datenvorlage zurück, die mit verwendet werden soll DoConferenceAction() Methode. Mit dieser Vorlage wird das Datenobjekt automatisch strukturiert, sodass 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()](https://servicenow-prod.fluidtopics.net/fZP_wUAG2irt6cp5wchXyw#NotifyOnTaskClient "Die BenachrichtigungOnTaskClient Die API bietet Methoden zum Senden von SMS-Nachrichten oder zum Starten/Verwalten einer Telefonkonferenz für verschiedene Telefondienstanbieter, z. B. ZoomUnd Webex.").  
Hinweis:  
Dies ist eine Hilfsmethode. Sie können dieses Objekt auch manuell erstellen und an übergeben DoConferenceAction() Methode und haben das gleiche Ergebnis.
{#NClient-getNotifyActionTemplate__table_azh_qyg_nhb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Keine |   |   |
[Tabelle : 7. Parameter]

{#NClient-getNotifyActionTemplate__table_azh_qyg_nhb} {#NClient-getNotifyActionTemplate__table_c2h_cwd_vhb__entry__2}{#NClient-getNotifyActionTemplate__data.addToWorkNotes-p-NConf}{#NClient-getNotifyActionTemplate__data.allowMulticonference-p-NConf}{#NClient-getNotifyActionTemplate__data.confId-p-NConf}{#NClient-getNotifyActionTemplate__data.fromNumber-p-NConf}{#NClient-getNotifyActionTemplate__data.isNewConference-p-NConf}{#NClient-getNotifyActionTemplate__data.items-p-NConf}{#NClient-getNotifyActionTemplate__data.message-p-NConf}{#NClient-getNotifyActionTemplate__data.serviceProvider-p-NConf}{#NClient-getNotifyActionTemplate__data.sys_id-p-NConf}{#NClient-getNotifyActionTemplate__data.table-p-NConf}

| Typ | Beschreibung |
|-|-|
| Daten | Objekt, das die Telefonkonferenz beschreibt. |
| Data.addToArbeitsnotizen | Kennzeichnung, die angibt, ob Informationen zu den Teilnehmern, die in der Telefonkonferenz enthalten waren, im Feld „Arbeitsnotizen" des zugehörigen Datensatzes hinzugefügt werden sollen. 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.{#NClient-getNotifyActionTemplate__data.addToWorkNotes2-p-NConf} Standard: Falsch Aktionen, für die dieser Parameter gültig ist: * teilnehmen * MultiJoin * SelfJoin * start {#NClient-getNotifyActionTemplate__ul_kwg_ktx_vhb} |
| 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, für den mehrere Telefonkonferenzen zulässig sind.{#NClient-getNotifyActionTemplate__data.allowMulticonference2-p-NConf} Standard: Falsch Aktionen, für die dieser Parameter gültig ist: * start {#NClient-getNotifyActionTemplate__ul_ay4_mtx_vhb} |
| Daten.Konfid | SYS_ID der Telefonkonferenz. Tabelle: Notify-Telefonkonferenz \[Notify_Conference_call\]{#NClient-getNotifyActionTemplate__data.confId2-p-NConf} Aktionen, für die dieser Parameter erforderlich ist: * end * teilnehmen * MultiJoin * SelfJoin {#NClient-getNotifyActionTemplate__ul_afs_qsx_vhb} 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 \[Notify_participant\] abruft. |
| data.fromNumber | Service Provider-Nummer, an die für die Telefonkonferenz gerufen werden soll. Suchen Sie diesen Wert in der Spalte „Nummer" oder „Telefonnummer" der Tabelle „Notify-Telefonnummer" \[Notify_number\].{#NClient-getNotifyActionTemplate__data.fromNumber2-p-NConf} Aktionen, für die dieser Parameter erforderlich ist: * start {#NClient-getNotifyActionTemplate__ul_exs_stx_vhb} |
| 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 {#NClient-getNotifyActionTemplate__ul_q1m_wbv_nhb} Standard: Falsch Aktionen, für die dieser Parameter gültig ist: * start {#NClient-getNotifyActionTemplate__ul_d1d_stx_vhb} |
| data.items | Informationen für jeden Teilnehmer, die in die Telefonkonferenz aufgenommen werden sollen. 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 entweder übergeben wird idOder notifyParticipantId, Dieser Wert ersetzt die Telefonnummern im Anwender-/Teilnehmerdatensatz und wird verwendet, um den Anruf zu tätigen. Gültige Aktionen: Join, MultiJoin, Start * E-Mail: E-Mail-Adresse des Teilnehmers.Gültige Aktionen: Join, MultiJoin, Start {#NClient-getNotifyActionTemplate__ul_qzh_pqt_rhb} |
| Daten.Nachricht | Nachricht, die laut gelesen 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 {#NClient-getNotifyActionTemplate__ul_jnl_ntx_vhb} |
| data.serviceProvider | Erforderlich. Name des Konferenzservice Providers, z. B. Zoom oder Webex. Aktionen, für die dieser Parameter erforderlich ist: * alle {#NClient-getNotifyActionTemplate__ul_vwb_psx_vhb} |
| 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 „Benachrichtigungs-Konferenzanruf" \[Notify_Conference_call\] gespeichert und kann später nachverfolgt werden. {#NClient-getNotifyActionTemplate__data.sys_id-p2-NConf} Dieser Parameter wird in Verbindung mit verwendet data.Table, data.addToWorkNotes, Und allowMulticonferenceParameter. {#NClient-getNotifyActionTemplate__data.sys_id-p3-NConf} Aktionen, für die dieser Parameter gültig ist: * start {#NClient-getNotifyActionTemplate__ul_h3l_qsx_vhb} |
| 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.{#NClient-getNotifyActionTemplate__data.table-p2-NConf} Dieser Parameter wird in Verbindung mit verwendet data.sysId, data.addToWorkNotes, Und allowMulticonferenceParameter.{#NClient-getNotifyActionTemplate__data.table-p3-NConf} Aktionen, für die dieser Parameter gültig ist: * start {#NClient-getNotifyActionTemplate__ul_mj1_4sx_vhb} |
[Tabelle : 8. Rückgaben]

{#NClient-getNotifyActionTemplate__table_c2h_cwd_vhb}  
Das folgende Beispiel zeigt, wie getNotifyActionTemplate() aufgerufen wird, um die Datenvorlage abzurufen, 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) {#ariaid-title6}

Startet eine neue Telefonkonferenz.
{#NClient-start_O__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Daten | Objekt | Objekt, das die Telefonkonferenz beschreibt. |
| Data.addToArbeitsnotizen | Boolean | Optional.Kennzeichnung, die angibt, ob Informationen zu den Teilnehmern, die in der Telefonkonferenz enthalten waren, im Feld „Arbeitsnotizen" des zugehörigen Datensatzes hinzugefügt werden sollen. 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.{#NClient-start_O__data.addToWorkNotes2-p-NConf} Standard: Falsch |
| Data.allowMultikonferenz | 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, für den mehrere Telefonkonferenzen zulässig sind. Standard: Falsch |
| data.fromNumber | Zeichenfolge | Erforderlich. Service Provider-Nummer, an die für die Telefonkonferenz gerufen 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, die in die Telefonkonferenz aufgenommen werden sollen. "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 entweder übergeben wird idOder notifyParticipantIdParameter: Dieser Wert ersetzt die Telefonnummern im Anwender-/Teilnehmerdatensatz und wird verwendet, um den Anruf zu tätigen. |
| Daten.Nachricht | Zeichenfolge | Optional. Nachricht, die laut gelesen 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 „Benachrichtigungs-Konferenzanruf" \[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 : 9. Parameter]

{#NClient-start_O__table_jrr_133_nhb__entry__2}

| Typ | Beschreibung |
|-|-|
| Objekt | Ergebnisse der Konferenzaktion. `<action>.Status `: Status der Konferenzaktion. * Datentyp: Boolescher Wert * Mögliche Werte: * Wahr: Konferenzaktion erfolgreich * Falsch: Konferenzaktion fehlgeschlagen {#NClient-start_O__ul_w5y_hyt_b3b} {#NClient-start_O__ul_psg_gyt_b3b} `<action>.Erfolgsnachrichten `: Wenn <var class="keyword varname">Status </var>Ist „wahr", Erfolgsmeldung(en), andernfalls leer. * Datentyp: Array von Zeichenfolgen {#NClient-start_O__ul_qm2_myt_b3b} `<action>.Warnmeldungen `: Wenn <var class="keyword varname">Status </var>Ist „falsch", alle während der Verarbeitung ausgelösten Warnmeldungen. * Datentyp: Array von Zeichenfolgen {#NClient-start_O__ul_xbz_nyt_b3b} `<action>.Fehlermeldungen `: Wenn <var class="keyword varname">Status </var>Ist „falsch", alle Fehlermeldungen, die während der Verarbeitung ausgelöst werden. * Datentyp: Array von Zeichenfolgen {#NClient-start_O__ul_tht_4yt_b3b} |
[Tabelle : 10. Rückgaben]

{#NClient-start_O__table_jrr_133_nhb}  
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: '+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);
        });
    }


