--- sourceDocument: Xanadu-API-Referenz sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/de-DE/xanadu/api-reference Release : - xanadu ft:locale : - de-DE ft:publication_title : - Xanadu-API-Referenz ft:clusterId : - crapiref bundleId : - crapiref workflow : - Creator --- # NotifyOnTaskClient : Client # NotifyOnTaskClient : Client {#ariaid-title1} * Freigeben Version: Xanadu * * Aktualisiert 1. August 2024 * * ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 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 {#NotifyOnTaskClient__ul_e5f_pqy_4hb} {#NotifyOnTaskClient__ul_qvb_kqy_4hb} Das Notify-Plugin (com.snc.notify) erfordert ein separates Abonnement. Weitere Informationen zur Aktivierung des Notify-Plugins finden Sie unter [Notify aktivieren](https://www.servicenow.com/docs/access?context=t_ActivateNotify&version=xanadu&pubname=xanadu-servicenow-platform&ft:locale=en-US). ## NotifyOnTaskClient -- addParticipants(Objektdaten) {#ariaid-title2} Fügt die angegebenen Teilnehmer zu einer angegebenen Telefonkonferenz hinzu. {#NClient-addParticipants_O__dataObject-table-NConf__entry__3} | 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. {#NClient-addParticipants_O__ul_qzh_pqt_rhb} | | 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 : 1. Parameter] {#NClient-addParticipants_O__dataObject-table-NConf} {#NClient-addParticipants_O__table_rpj_1y5_nhb__entry__2} | Typ | Beschreibung | |-|-| | Objekt | Ergebnisse der Konferenzaktion. \Status „ wahr" ist, sonst leer. * Datentyp: Array von Zeichenfolgen {#NClient-addParticipants_O__ul_qm2_myt_b3b} \Status „ falsch" ist, alle Warnmeldungen, die während der Verarbeitung ausgelöst werden. * Datentyp: Array von Zeichenfolgen {#NClient-addParticipants_O__ul_xbz_nyt_b3b} \Status „ falsch" ist, alle Fehlermeldungen, die während der Verarbeitung ausgelöst werden. * Datentyp: Array von Zeichenfolgen {#NClient-addParticipants_O__ul_tht_4yt_b3b} | [Tabelle : 2. Ergebnisse] {#NClient-addParticipants_O__table_rpj_1y5_nhb} 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 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. {#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 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 {#NClient-doConferenceAction_S_O__ul_pq5_qfv_nhb} | | 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.{#NClient-doConferenceAction_S_O__data.addToWorkNotes2-p-NConf} Standardwert: false Aktionen, für die dieser Parameter gültig ist: * start * teilnehmen * multiJoin * SelfJoin {#NClient-doConferenceAction_S_O__ul_kwg_ktx_vhb} | | 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.{#NClient-doConferenceAction_S_O__data.allowMulticonference2-p-NConf} Standardwert: false Aktionen, für die dieser Parameter gültig ist: * start {#NClient-doConferenceAction_S_O__ul_ay4_mtx_vhb} | | data.confId | Zeichenfolge | Sys-ID der Telefonkonferenz. Die Sys-ID der Konferenz befindet sich in der 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 „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\].{#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} | | 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 {#NClient-doConferenceAction_S_O__ul_q1m_wbv_nhb} Standardwert: false Aktionen, für die dieser Parameter gültig ist: * start {#NClient-doConferenceAction_S_O__ul_d1d_stx_vhb} | | 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 {#NClient-doConferenceAction_S_O__ul_jnl_ntx_vhb} | | 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". {#NClient-doConferenceAction_S_O__ul_qzh_pqt_rhb} | | 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 {#NClient-doConferenceAction_S_O__ul_vwb_psx_vhb} | | 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. {#NClient-doConferenceAction_S_O__data.sys_id-p2-NConf} Dieser Parameter wird in Verbindung mit den Parametern data.Table, data.addToWorkNotesund allowMulticonference verwendet.{#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 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.{#NClient-doConferenceAction_S_O__data.table-p2-NConf} Dieser Parameter wird in Verbindung mit den Parametern data.sysId, data.addToWorkNotesund allowMulticonference verwendet.{#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. \Status „ wahr" ist, sonst leer. * Datentyp: Array von Zeichenfolgen {#NClient-doConferenceAction_S_O__ul_qm2_myt_b3b} \Status „ falsch" ist, alle Warnmeldungen, die während der Verarbeitung ausgelöst werden. * Datentyp: Array von Zeichenfolgen {#NClient-doConferenceAction_S_O__ul_xbz_nyt_b3b} \Status „ falsch" ist, alle Fehlermeldungen, die während der Verarbeitung ausgelöst werden. * Datentyp: Array von Zeichenfolgen {#NClient-doConferenceAction_S_O__ul_tht_4yt_b3b} | [Tabelle : 4. Ergebnisse] {#NClient-doConferenceAction_S_O__table_rqs_vdv_nhb} 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) {#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 | |-|-|-| | 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 : 5. Parameter] {#NClient-endConference_O__table_dqd_qcv_nhb__entry__2} | Typ | Beschreibung | |-|-| | Objekt | Ergebnisse der Konferenzaktion. \Status „ wahr" ist, sonst leer. * Datentyp: Array von Zeichenfolgen {#NClient-endConference_O__ul_qm2_myt_b3b} \Status „ falsch" ist, alle Warnmeldungen, die während der Verarbeitung ausgelöst werden. * Datentyp: Array von Zeichenfolgen {#NClient-endConference_O__ul_xbz_nyt_b3b} \Status „ falsch" ist, alle Fehlermeldungen, die während der Verarbeitung ausgelöst werden. * Datentyp: Array von Zeichenfolgen {#NClient-endConference_O__ul_tht_4yt_b3b} | [Tabelle : 6. Ergebnisse] {#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 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()](https://servicenow-prod.fluidtopics.net/jadeebEx6Uj8pRCzMZ7XsQ#NotifyOnTaskClient "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."). 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. {#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.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.{#NClient-getNotifyActionTemplate__data.addToWorkNotes2-p-NConf} Standardwert: false Aktionen, für die dieser Parameter gültig ist: * start * teilnehmen * multiJoin * SelfJoin {#NClient-getNotifyActionTemplate__ul_kwg_ktx_vhb} | | 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.{#NClient-getNotifyActionTemplate__data.allowMulticonference2-p-NConf} Standardwert: false Aktionen, für die dieser Parameter gültig ist: * start {#NClient-getNotifyActionTemplate__ul_ay4_mtx_vhb} | | data.confId | Sys-ID der Telefonkonferenz. Die Sys-ID der Konferenz befindet sich in der 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 „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\].{#NClient-getNotifyActionTemplate__data.fromNumber2-p-NConf} Aktionen, für die dieser Parameter erforderlich ist: * start {#NClient-getNotifyActionTemplate__ul_exs_stx_vhb} | | 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 {#NClient-getNotifyActionTemplate__ul_q1m_wbv_nhb} Standardwert: false Aktionen, für die dieser Parameter gültig ist: * start {#NClient-getNotifyActionTemplate__ul_d1d_stx_vhb} | | 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". {#NClient-getNotifyActionTemplate__ul_qzh_pqt_rhb} | | 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 {#NClient-getNotifyActionTemplate__ul_jnl_ntx_vhb} | | data.serviceProvider | Erforderlich. Name des Service Providers für Konferenzen, z. B. Zoom oder Webex. Aktionen, für die dieser Parameter erforderlich ist: * alle {#NClient-getNotifyActionTemplate__ul_vwb_psx_vhb} | | 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. {#NClient-getNotifyActionTemplate__data.sys_id-p2-NConf} Dieser Parameter wird in Verbindung mit den Parametern data.Table, data.addToWorkNotesund allowMulticonference verwendet.{#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 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.{#NClient-getNotifyActionTemplate__data.table-p2-NConf} Dieser Parameter wird in Verbindung mit den Parametern data.sysId, data.addToWorkNotesund allowMulticonference verwendet.{#NClient-getNotifyActionTemplate__data.table-p3-NConf} Aktionen, für die dieser Parameter gültig ist: * start {#NClient-getNotifyActionTemplate__ul_mj1_4sx_vhb} | [Tabelle : 8. Ergebnisse] {#NClient-getNotifyActionTemplate__table_c2h_cwd_vhb} 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) {#ariaid-title6} Startet eine neue Telefonkonferenz. {#NClient-start_O__entry__3} | 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.{#NClient-start_O__data.addToWorkNotes2-p-NConf} 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. {#NClient-start_O__ul_qzh_pqt_rhb} | | 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 : 9. Parameter] {#NClient-start_O__table_jrr_133_nhb__entry__2} | Typ | Beschreibung | |-|-| | Objekt | Ergebnisse der Konferenzaktion. \Status „ wahr" ist, sonst leer. * Datentyp: Array von Zeichenfolgen {#NClient-start_O__ul_qm2_myt_b3b} \Status „ falsch" ist, alle Warnmeldungen, die während der Verarbeitung ausgelöst werden. * Datentyp: Array von Zeichenfolgen {#NClient-start_O__ul_xbz_nyt_b3b} \Status „ falsch" ist, alle Fehlermeldungen, die während der Verarbeitung ausgelöst werden. * Datentyp: Array von Zeichenfolgen {#NClient-start_O__ul_tht_4yt_b3b} | [Tabelle : 10. Ergebnisse] {#NClient-start_O__table_jrr_133_nhb} 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); }); }