---
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


---

# BenachrichtigungUtil -- Global

# BenachrichtigungUtil -- Global {#ariaid-title1}

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

Die BenachrichtigungUtil Die Skripteinbindung bietet Dienstprogrammmethoden, die bei der Interaktion mit Notify-Aufrufen und SMS-Nachrichten mithilfe serverseitiger Skripts verwendet werden.
Zur Verwendung dieser Skripteinbindung müssen Sie das Notify-Plugin (com.snc.notify) aktivieren.

Mit BenachrichtigungUtil Skripteinbindung Sie können:  
* Ruft alle Notify-Telefonnummern und zugehörigen Notify-Informationen aus einem angegebenen Quelldatensatz ab.
* Rufen Sie eine Liste eindeutiger Notify-Telefonnummern ab.
* Bestimmen Sie, ob aktive Telefonkonferenzen für den angegebenen Quelldatensatz vorhanden sind.
* Ruft die SMS-fähige Nummer ab, die dem angegebenen Notify-Anwender zugeordnet ist.
* Validieren Sie eine angegebene Notify-Telefonnummer.
{#NotifyUtilAPI__ul_qvb_kqy_4hb}

## NotifyUtil: NotifyUtil() {#ariaid-title2}

Instanziiert ein NotifyUtil-Klassenobjekt.
{#NU-NotifyUtil__table_e31_kmm_kmb__entry__3}

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

{#NU-NotifyUtil__table_e31_kmm_kmb}  
In diesem Beispiel wird ein NotifyUtil-Objekt instanziiert.

    var notifyUtil = new NotifyUtil(); 
    notifyUtil.getTelephonyProviers();

## NotifyUtil -- getListOfNotifyNumbersAndProviders(Zeichenfolge sourceTable, Zeichenfolge sourceSysId, Zeichenfolge notifyGroupSelectorSysId, boolescher FilterSMSCapableNums) {#ariaid-title3}

Gibt alle Notify-Telefonnummern und zugehörigen Notify-Informationen aus einem angegebenen Quelldatensatz zurück, z. B. einem Incident.
Sie können diese Informationen verwenden, um einen Anruf zu initiieren oder eine SMS-Nachricht für einen bestimmten Quelldatensatz zu senden. Die zurückgegebenen Informationen basieren auf der Konfiguration des Notify-Anbieterauswahl-Frameworks. Weitere Informationen finden Sie unter [Benachrichtigen](https://www.servicenow.com/docs/access?context=notify-landing-page&version=yokohama&pubname=yokohama-servicenow-platform&ft:locale=en-US)
{#NU-getListNotifyNumsProvids_S_S_S_B__table_pmg_pyt_kmb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| FilterSMSCapableNums | Boolean | Optional. Kennzeichnung, die angibt, ob nur SMS-fähige Nummern zurückgegeben werden sollen. Gültige Werte: * Wahr: Nur SMS-fähige Telefonnummern und Informationen zurückgeben. * Falsch: Gibt alle Notify-Telefonnummern und -Informationen zurück. Standard: Falsch |
| NotifyGroupSelectorSysId | Zeichenfolge | Optional. SYS_ID einer Notify-Gruppe, für die die Notify-Nummern und -Informationen zurückgegeben werden sollen. Standard: Alle Gruppen |
| sourceSysId | Zeichenfolge | SYS_ID des Quelldatensatzes, für den die Notify-Nummern und -Informationen zurückgegeben werden sollen. Dies kann beispielsweise die sys_ID eines Datensatzes in der Tabelle „Incident \[Incident\]" sein. |
| sourceTable | Zeichenfolge | Name der Tabelle, die den Quelldatensatz enthält, der die gewünschten Notify-Nummern und -Informationen enthält. |
[Tabelle : 2. Parameter]

{#NU-getListNotifyNumsProvids_S_S_S_B__table_pmg_pyt_kmb} {#NU-getListNotifyNumsProvids_S_S_S_B__table_qmg_pyt_kmb__entry__2}

| Typ | Beschreibung |
|-|-|
| ConfProviders | Liste der verfügbaren Konferenzanbieter. Datentyp: Array |
| Nummern | Liste von Objekten, die jeweils eine einzelne Notify-Nummer beschreiben. Datentyp: Array "numbers": [{ "defaultFlag": Boolean, "name": "String", "number": "String", "shortCode": Boolean, "sysId": "String }] |
| numbers.defaultFlag | Kennzeichnung, die angibt, ob die zugeordnete Notify-Nummer die Standardnummer ist. Mögliche Werte: * Wahr: Standardnummer * Falsch: Nicht die Standardnummer Datentyp: Boolescher Wert |
| numbers.name | Name oder Bezeichnung der Nummer. Datentyp: Zeichenfolge |
| Nummern.Nummer | Notify-Nummer. Datentyp: Zeichenfolge |
| Nummern.Shortcode | Kennzeichnung, die angibt, ob die zugehörige Notify-Nummer eine Kurzwahl ist. Mögliche Werte: * Wahr: Kurzwahl * Falsch: Keine Kurzwahl Datentyp: Boolescher Wert |
| Nummern.sysId | SYS_ID der Notify-Nummer. Datentyp: Zeichenfolge |
[Tabelle : 3. Rückgaben]

{#NU-getListNotifyNumsProvids_S_S_S_B__table_qmg_pyt_kmb}  
Dieses Beispiel zeigt, wie die Notify-Telefonnummern und die zugehörigen Notify-Informationen aus einem angegebenen Quelldatensatz abgerufen werden.

    function updateConferenceBridges(sourceTable, sourceId) {

      var notifyUtil = new global.NotifyUtil();
      var numbersAndProviders = notifyUtil.getListOfNotifyNumbersAndProviders(sourceTable, sourceId);
      var confBridges = [];
      if (numbersAndProviders.confProviders) {
        numbersAndProviders.confProviders.forEach(function(provider){
        confBridges.push(provider);
        });
      }
      if (numbersAndProviders.numbers) {
        numbersAndProviders.numbers.forEach(function(number){
          confBridges.push(number.name);
        });
      }
    } 

## NotifyUtil -- getSMSNumberForUser(Zeichenfolge userGrOrId) {#ariaid-title4}

Gibt die SMS-fähige Nummer zurück, die dem angegebenen Notify-Anwender zugeordnet ist.
{#NU-getSMSNumberForUser_S__table_dkn_1wt_kmb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| UserGROrId | Zeichenfolge oder [GlideRecord -- Global](https://servicenow-prod.fluidtopics.net/PhVphXpfpHtoByvicO1vjw#c_GlideRecordAPI "Die GlideRecord API wird für Datenbankvorgänge verwendet.") | SYS_ID des Anwenderdatensatzes, Tabelle: Anwendertabelle \[sys_user\] oder der sys_user GlideRecord des Anwenders, für den die SMS-fähige Telefonnummer zurückgegeben werden soll. |
[Tabelle : 4. Parameter]

{#NU-getSMSNumberForUser_S__table_dkn_1wt_kmb} {#NU-getSMSNumberForUser_S__table_ekn_1wt_kmb__entry__2}

| Typ | Beschreibung |
|-|-|
| Zeichenfolge | SMS-fähige Telefonnummer des Anwenders. Gibt Null zurück, wenn der angegebene Anwender nicht gefunden wird. |
[Tabelle : 5. Rückgaben]

{#NU-getSMSNumberForUser_S__table_ekn_1wt_kmb}  
Dieses Beispiel zeigt, wie Sie mithilfe des zugehörigen GlideRecord eine SMS-fähige Telefonnummer erhalten.

    var sourceRecord = new GlideRecord('incident');
    sourceRecord.query();
    if (sourceRecord.next()) {
      var fromNumber = getFromNumber();
      var nUtil = new NotifyUtil();
      var toNumber = nUtil.getSMSNumberForUser(sourceRecord.assigned_to.getRefRecord());
      var message = 'Incident ' + sourceRecord.getDisplayValue() + ' has been assigned to you.';
      if (fromNumber && nUtil.validateOutboundNotifyPhoneNumber(fromNumber) && toNumber && nUtil.validatePhoneNumber(toNumber)) {
        var notifySMS = new NotifySMS();
        notifySMS.sendToNumber(fromNumber, toNumber, message, sourceRecord);
      }
    }

    function getFromNumber() {
      var prop = gs.getProperty('custom_property_name', '');
      if (!prop){
        return getFallbackFromNumber();
      }
      return prop;
    } 

    function getFallbackFromNumber() {
      var notifyNumGr = new GlideRecord("notify_number");
      notifyNumGr.addActiveQuery();
      notifyNumGr.addQuery('has_sms_out', 'yes');
      notifyNumGr.query();
      if (notifyNumGr.next()) {
        return notifyNumGr.number + '';
      }
      return '';
    } 

## NotifyUtil -- getUniquePhoneNumbersForUsersAndGroups(Array-Nummern, Array-Anwender, Array-Gruppen, Zeichenfolgentyp, boolescher Wert getData) {#ariaid-title5}

Gibt eine Liste eindeutiger Notify-Telefonnummern zurück.
Wenn Sie keine Parameter im Anruf übergeben, werden alle Notify-Nummern in der Notify-Telefonnummer \[Notify_number\]-Tabelle auf Duplikate überprüft, wobei jede verfügbare Telefonnummer nur einmal in der zurückgegebenen Liste angezeigt wird. Sie können die Rückgabeergebnisse verfeinern, indem Sie eine Liste von Anwendern oder Gruppen angeben, die überprüft werden sollen, oder indem Sie eine Reihe von Nummern oder Nummerntypen (SMS oder Sprachfunktionen) angeben. Sie können auch anfordern, dass die Metadaten, die jeder Nummer zugeordnet sind, zusammen mit den eindeutigen Nummern zurückgegeben werden. Wenn Sie keinen Parameter verwenden möchten, übergeben Sie einfach `Null `Als Platzhalter. Beispiel: `NUtil.getUniquePhoneNumbersForUsersAndGroups(null, userids, null, 'sms', falsch) zurückgeben; `.
{#NU-getUniqPhNumUsersGrps_S_S_S_S_S__table_kxw_hs5_kmb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| getData | Boolean | Optional. Kennzeichnung, die angibt, ob Metadaten zusammen mit der Liste eindeutiger Telefonnummern zurückgegeben werden sollen. Gültige Werte: * Wahr: Metadaten zurückgeben. * Falsch: Keine Metadaten zurückgeben. {#NU-getUniqPhNumUsersGrps_S_S_S_S_S__ul_cjn_1jy_slb} Standard: Falsch |
| groups | Array | Optional. Liste der zu überprüfenden sys_ID-Gruppen. Standard: Alle Gruppen überprüfen. Tabelle: Gruppe \[sys_user_group\] |
| Nummern | Array | Optional. Liste bestimmter Notify-Telefonnummern, die überprüft werden sollen. Standard: Überprüfen Sie alle Telefonnummern. |
| Typ | Zeichenfolge | Optional. Typ der zu überprüfenden Telefonnummern. Gültige Werte (Groß-/Kleinschreibung beachten): * voice * sms {#NU-getUniqPhNumUsersGrps_S_S_S_S_S__ul_epz_3t1_lmb} Standard: Alle Telefonnummerntypen überprüfen |
| users | Array | Optional. Liste der sys_IDs bestimmter zu überprüfender Anwender. Standard: Alle Anwender überprüfen Tabelle: Anwender \[sys_user\] |
[Tabelle : 6. Parameter]

{#NU-getUniqPhNumUsersGrps_S_S_S_S_S__table_kxw_hs5_kmb} {#NU-getUniqPhNumUsersGrps_S_S_S_S_S__table_lxw_hs5_kmb__entry__2}

| Name | Beschreibung |
|-|-|
| Nummern | Eindeutige Notify-Telefonnummern. Datentyp: Array |
| Ergebnis | Nur zurückgegeben, wenn getDataIst auf „wahr" festgelegt. Metadaten, die jeder eindeutigen Nummer zugeordnet sind. Datentyp: Objekt "result": { "number": "String", "sysId": "String", "type": "String", "valid": Boolean } |
| Ergebnis.Nummer | Eindeutige Notify-Telefonnummer. Datentyp: Zeichenfolge |
| Ergebnis.sysId | SYS_ID des Datensatzes, der die Notify-Telefonnummer enthält. Datentyp: Zeichenfolge Tabelle: Notify-Telefonnummer \[Notify_number\] |
| Ergebnis.Typ | Enthält immer „u" für Anwender. Datentyp: Zeichenfolge |
| Ergebnis.gültig | Kennzeichnung, die angibt, ob die Notify-Telefonnummer im gültigen E.164-Format vorliegt. Mögliche Werte: * Wahr: Gültiges E.164-Format. * Falsch: Nicht im E.164-Format. {#NU-getUniqPhNumUsersGrps_S_S_S_S_S__ul_in5_lcy_vmb} Datentyp: Boolescher Wert |
[Tabelle : 7. Rückgaben]

{#NU-getUniqPhNumUsersGrps_S_S_S_S_S__table_lxw_hs5_kmb}  
Dieses Beispiel zeigt, wie Sie einen bestimmten Satz eindeutiger Notify-Telefonnummern anfordern, die SMS-Fähigkeiten haben.

    var fromNumber = getFromNumber();
    var toNumbers = getRecipientNumbers();
    var message = 'This is an example SMS';
    var sourceRecord = new GlideRecord('incident');
    sourceRecord.query();
    if (sourceRecord.next()) {
      var notifySMS = new NotifySMS();
      notifySMS.sendToNumber(fromNumber, toNumbers, message, sourceRecord);
    }

    function getRecipientNumbers() {
      var userGr = new GlideRecord('sys_user');
      userGr.addActiveQuery();
      userGr.addQuery('first_name', 'STARTSWITH', 'A');
      userGr.setLimit(5);
      userGr.query(); 
      var userIds = [];
      while (userGr.next()) {
        userIds.push(userGr.getUniqueValue());
      }
      if (userIds.length > 0) {
        var nUtil = new NotifyUtil();
        return nUtil.getUniquePhoneNumbersForUsersAndGroups(null, userIds, null, 'sms', false);
      } 
    }

    function getFromNumber() {
      var prop = gs.getProperty('custom_property_name', '');
      if (!prop){
        return getFallbackFromNumber();
      } 
      return prop; 
    }

    function getFallbackFromNumber() {
      var notifyNumGr = new GlideRecord("notify_number");
      notifyNumGr.addActiveQuery();
      notifyNumGr.addQuery('has_sms_out', 'yes');
      notifyNumGr.query();
      if (notifyNumGr.next()) {
        return notifyNumGr.number + '';
      }
      return '';
    }

## NotifyUtil -- hasActiveConferenceCalls(ZeichenfolgenquelleRecSysId) {#ariaid-title6}

Bestimmt, ob aktive Telefonkonferenzen für den angegebenen Quelldatensatz vorhanden sind.
{#NU-hasActiveConferenceCalls_S__table_wwv_ktm_kmb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| SourceRecSysId | Zeichenfolge | SYS_ID des Datensatzes, der auf aktive Telefonkonferenzen überprüft werden soll. Beispiel: Die sys_ID eines Datensatzes in der Incident-Tabelle. |
[Tabelle : 8. Parameter]

{#NU-hasActiveConferenceCalls_S__table_wwv_ktm_kmb} {#NU-hasActiveConferenceCalls_S__table_xwv_ktm_kmb__entry__2}

| Typ | Beschreibung |
|-|-|
| Boolean | Kennzeichnung, die angibt, ob dem angegebenen Datensatz aktive Telefonkonferenzen zugeordnet sind. Mögliche Werte: * Wahr: Aktive Telefonkonferenzen sind für den angegebenen Datensatz verfügbar. * Falsch: Keine aktiven Telefonkonferenzen. {#NU-hasActiveConferenceCalls_S__ul_ucd_zwm_kmb} |
[Tabelle : 9. Rückgaben]

{#NU-hasActiveConferenceCalls_S__table_xwv_ktm_kmb}  
In diesem Beispiel wird eine Informationsnachricht angezeigt, wenn einem Incident-Datensatz aktive Telefonkonferenzen zugeordnet sind.

    (function executeRule(current, previous /*null when async*/) {
      var nUtil = new NotifyUtil();
      if (nUtil.hasActiveConferenceCalls(current.getUniqueValue())) {
        gs.addInfoMessage("There are active conference calls related to this Incident.");
      } 
    })(current, previous);

## NotifyUtil -- validateOutbound NotifyPhoneNumber (Zeichenfolgennummer) {#ariaid-title7}

Validiert eine angegebene Notify-Telefonnummer.
Die Methode führt drei Validierungstypen durch:

1. Gibt an, ob die Notify-Nummer in der Tabelle Notify-Telefonnummer \[Notify_number\] vorhanden ist.
2. Gibt an, ob der Notify-Nummer eine Notify-Gruppe zugeordnet ist.
3. Gibt an, ob die Notify-Nummer aktiv ist.
{#NU-validateOutNotifyPhoneNum_S__ol_ej5_w4t_kmb} Wenn eine dieser Validierungen fehlschlägt, löst die Methode eine Ausnahme aus.
{#NU-validateOutNotifyPhoneNum_S__table_nkw_m4t_kmb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Nummer | Zeichenfolge | Notify-Nummer zur Validierung. |
[Tabelle : 10. Parameter]

{#NU-validateOutNotifyPhoneNum_S__table_nkw_m4t_kmb} {#NU-validateOutNotifyPhoneNum_S__table_okw_m4t_kmb__entry__2}

| Typ | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 11. Rückgaben]

{#NU-validateOutNotifyPhoneNum_S__table_okw_m4t_kmb}  
Dieses Beispiel veranschaulicht, wie eine Notify-Nummer validiert wird.

    var sourceRecord = new GlideRecord('incident');
    sourceRecord.query();
    if (sourceRecord.next()) {
      var fromNumber = getFromNumber();
      var nUtil = new NotifyUtil();
      var toNumber = nUtil.getSMSNumberForUser(sourceRecord.assigned_to.getRefRecord());
      var message = 'Incident ' + sourceRecord.getDisplayValue() + ' has been assigned to you.';
      if (fromNumber && nUtil.validateOutboundNotifyPhoneNumber(fromNumber) && toNumber && nUtil.validatePhoneNumber(toNumber)) {
        var notifySMS = new NotifySMS();
        notifySMS.sendToNumber(fromNumber, toNumber, message, sourceRecord);
      }
    }

    function getFromNumber() {
      var prop = gs.getProperty('custom_property_name', '');
      if (!prop){
        return getFallbackFromNumber();
      }
      return prop;
    } 

    function getFallbackFromNumber() {
      var notifyNumGr = new GlideRecord("notify_number");
      notifyNumGr.addActiveQuery();
      notifyNumGr.addQuery('has_sms_out', 'yes');
      notifyNumGr.query();
      if (notifyNumGr.next()) {
        return notifyNumGr.number + '';
      }
      return '';
    } 

## NotifyUtil -- validatePhoneNumber (Zeichenfolgennummer) {#ariaid-title8}

Überprüft, ob die angegebene Nummer eine gültige E.164-Telefonnummer ist.
{#NU-validatePhoneNumber_S__table_nyd_b5t_kmb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Nummer | Zeichenfolge | Zu validierende Telefonnummer. |
[Tabelle : 12. Parameter]

{#NU-validatePhoneNumber_S__table_nyd_b5t_kmb} {#NU-validatePhoneNumber_S__table_oyd_b5t_kmb__entry__2}

| Typ | Beschreibung |
|-|-|
| Boolean | Kennzeichnung, die angibt, ob die angegebene Nummer eine gültige Telefonnummer ist. Mögliche Werte: * Wahr: Gültige E.164-Telefonnummer. * Falsch: Ungültige Telefonnummer. |
[Tabelle : 13. Rückgaben]

{#NU-validatePhoneNumber_S__table_oyd_b5t_kmb}  
Dieses Beispiel veranschaulicht, wie eine Telefonnummer validiert wird.

    var sourceRecord = new GlideRecord('incident');
    sourceRecord.query();
    if (sourceRecord.next()) {
      var fromNumber = getFromNumber();
      var nUtil = new NotifyUtil();
      var toNumber = nUtil.getSMSNumberForUser(sourceRecord.assigned_to.getRefRecord());
      var message = 'Incident ' + sourceRecord.getDisplayValue() + ' has been assigned to you.';
      if (fromNumber && nUtil.validateOutboundNotifyPhoneNumber(fromNumber) && toNumber && nUtil.validatePhoneNumber(toNumber)) {
        var notifySMS = new NotifySMS();
        notifySMS.sendToNumber(fromNumber, toNumber, message, sourceRecord);
      }
    }

    function getFromNumber() {
      var prop = gs.getProperty('custom_property_name', '');
      if (!prop){
        return getFallbackFromNumber();
      }
      return prop;
    } 

    function getFallbackFromNumber() {
      var notifyNumGr = new GlideRecord("notify_number");
      notifyNumGr.addActiveQuery();
      notifyNumGr.addQuery('has_sms_out', 'yes');
      notifyNumGr.query();
      if (notifyNumGr.next()) {
        return notifyNumGr.number + '';
      }
      return '';
    } 


