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


---

# OnCallContactPreferenceUtil -- Global

# OnCallContactPreferenceUtil -- Global {#ariaid-title1}

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

Die OnCallContactPreferenceUtil Die Skripteinbindung stellt Methoden für die Verarbeitung von Kontakteinstellungen bereit.

Informationen zur Konfiguration der Kontakteinstellungen finden Sie unter [Konfigurieren Sie Kontakteinstellungen](https://www.servicenow.com/docs/access?context=config-my-contact-prefs-oncall&version=yokohama&pubname=yokohama-it-service-management&ft:locale=en-US).

Diese Skripteinbindung unterstützt [Rotation bei Anruf](https://servicenow-prod.fluidtopics.net/iLOBaPHd9esBMaxGYybcEA#c_OnCallRotationAPI "Die Rotation bei Anruf Die Skripteinbindung bietet Methoden zum Verwalten von Rufbereitschaftszeitplänen.")Skripteinbindung.

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

Erstellt eine Instanz der Klasse „OnCallContactPreferenceUtil".
{#P-OnCallContactPreferenceUtil__table_pzm_w3f_2w__entry__3}

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

{#P-OnCallContactPreferenceUtil__table_pzm_w3f_2w}

## OnCallContactPreferenceUtil -- getContactsAtByEscalatee(Objekt-Eskalationsempfänger, Nummer contactAttempt, GlideDateTime gdt, Zeichenfolge rotaSysIds) {#ariaid-title3}

Ruft eine Liste von Kontakten mit dem Eskalationsempfänger-Objekt ab. Jeder zurückgegebene Kontakt enthält eine Liste der Kontakteinstellungen des Anwenders.
{#P-getContactsAtByEscalatee_O_N_F_S__table_o1s_x5j_3gb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Eskalationsempfänger | Objekt | Obligatorisch. Eskalationsempfängerobjekt, das von zurückgegeben wird [GetEscalationPlan()](https://servicenow-prod.fluidtopics.net/iLOBaPHd9esBMaxGYybcEA#r_OCR-getEscalationPlan_S_GDT "Ruft eine Liste von Objekten ab, an die eskaliert werden soll, Eskalationspläne, die entweder aus einem Anwender [sys_user] oder einem Benachrichtigungsgerät [cmn_notif_device] für die Schicht einer Gruppe zum angegebenen Datum und zur angegebenen Uhrzeit bestehen. Diese API gilt für eine einzelne Schicht, überlappende Schichten und anwenderdefinierte Eskalation.")Methode. |
| ContactAttempt | Nummer | Optional. Der Versuch, Kontakt aufzunehmen \[ Standardwert = 1 \]. * <kbd class="ph userinput">1 </kbd>: Erster Versuch * <kbd class="ph userinput">2 </kbd>: Erste Erinnerung * <kbd class="ph userinput">3 oder mehr </kbd>: Nachfolgende Erinnerungen {#P-getContactsAtByEscalatee_O_N_F_S__ul_gp2_q4w_gjb} |
| gdt | GlideDateTime | Optional. jjjj-MM-TT HH:mm:ss-Format in der UTC-Zeitzone. Der Standardwert ist now.admin |
| RotaSysIds | Zeichenfolge | Optional. Kommagetrennte Zeichenfolge von SYS-IDs von Schichten aus der Tabelle \[cmn_Rota\]. Der Standardwert gibt SYS-IDs der Schichten zum aktuellen Zeitpunkt zurück. |
[Tabelle : 2. Parameter]

{#P-getContactsAtByEscalatee_O_N_F_S__table_o1s_x5j_3gb} {#P-getContactsAtByEscalatee_O_N_F_S__table_nmd_wvj_3gb__entry__2}

| Typ | Beschreibung |
|-|-|
| Array-Objekt | Array von Eskalationsempfängern (je nach Benachrichtigungsregeln entweder ein Anwender, eine Gruppe oder ein Gerätedatensatz) zu einem bestimmten Zeitpunkt und an einer bestimmten Position. * Typ: Zeichenfolge. Typ des Kontakts, z. B. Anwender. * sys_ID: Zeichenfolge. SYS-ID des Anwenders aus der Tabelle \[sys_user\]. * rota_ID: Zeichenfolge. SYS-ID der Schicht aus der Tabelle \[cmn_Rota\]. * Roster_ID: Zeichenfolge. SYS-ID des Dienstplans aus der Tabelle \[cmn_Rota_Roster\]. * Eskalation_STEP_ID: Zeichenfolge. Wenn ein Eskalationspfad definiert wurde, SYS-ID des Eskalationsschritts aus der Tabelle \[cmn_rota_esc_step_def\]. * Forced_communication_Channel: Zeichenfolge. Wenn in den Einstellungen angegeben, Obligatorisch Kommunikationskanal. Unterstützte Werte sind SMS, Sprache oder E-Mail. * Boolescher override_user_contact_preference:. „Wahr", wenn Kontaktüberschreibungen vorhanden sind, andernfalls „falsch". * Preference_Source: Zeichenfolge. Quelle der Einstellung, z. B. Kontakt oder Gruppe. * Contact_attempt: Nummer. Kontaktversuche: 1 = erster Versuch, 2 = erste Erinnerung usw. * User_preferences: Array-Objekt. * Typ: Zeichenfolge. Bevorzugtes Kontaktformat des Anwenders, z. B. sms, E-Mail oder Nummer. * \<Name des bevorzugten Formats, z. B. E-Mail oder Nummer\>: Zeichenfolge. Inhalt des bevorzugten Kontakttyps, z. B. E-Mail-Adresse oder Telefonnummer. {#P-getContactsAtByEscalatee_O_N_F_S__ul_pzn_52r_gjb} * Contact_preferences, Array-Objekt. * Typ: Zeichenfolge. Bevorzugtes Kontaktformat des Anwenders, z. B. E-Mail oder Nummer. * \<Name des bevorzugten Formats, z. B. E-Mail oder Nummer\>: Zeichenfolge. Inhalt des bevorzugten Kontakttyps, z. B. E-Mail-Adresse oder Telefonnummer. {#P-getContactsAtByEscalatee_O_N_F_S__ul_vnw_y2r_gjb} {#P-getContactsAtByEscalatee_O_N_F_S__ul_whv_4bp_3jb} |
[Tabelle : 3. Rückgaben]

{#P-getContactsAtByEscalatee_O_N_F_S__table_nmd_wvj_3gb}  

    var serviceDeskSysId = '<Sys_ID>';
    var ocRotation = new OnCallRotation();
    var escalationPlan = ocRotation.getEscalationPlan(serviceDeskSysId);
    var escalatee = escalationPlan[0];

    var onContactPrefUtil = new OnCallContactPreferenceUtil();
    var contactAttempt = 1;
    var gdt = new GlideDateTime();
    var contacts = onContactPrefUtil.getContactsAtByEscalatee(escalatee, contactAttempt, gdt);
    gs.log(JSON.stringify(contacts));

Ausgabe:

    [{
        "type": "user",
        "sys_id": "<Sys_ID>",
        "rota_id": "<Rotation_ID>",
        "roster_id": "",
        "escalation_step_id": "<Escalation_Step_ID>",
        "forced_communication_channel": "",
        "override_user_contact_preference": true,
        "preference_source": "contact",
        "contact_attempt": 1,
        "user_preferences": [{
            "type": "sms",
            "number": "8587200477"
        }],
        "contact_preferences": [{
            "type": "voice",
            "number": "5555555555"
        }]
    }]

## OnCallContactPreferenceUtil -- getUserPreferences(Zeichenfolge userSysId, Nummer contactAttempt, GlideDateTime gdt, Zeichenfolge communicationTypes) {#ariaid-title4}

Ruft die Liste der Kontakteinstellungen zu dem Zeitpunkt ab, zu dem sich der Anwender für die Kommunikation entschieden hat. Wenn keine Zeit angegeben ist, wird die aktuelle Zeit verwendet. Diese Methode gilt für einzelne und sich überschneidende Schichten.
{#P-getUserPreferences_S_N_GDT_S__table_ixr_4jk_3gb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| userSysId | Zeichenfolge | SYS-ID des Anwenders aus der Tabelle \[sys_user\]. |
| ContactAttempt | Nummer | Optional. Der Versuch, Kontakt aufzunehmen \[ Standardwert = 1 \]. * <kbd class="ph userinput">1 </kbd>: Erster Versuch * <kbd class="ph userinput">2 </kbd>: Erste Erinnerung * <kbd class="ph userinput">3 oder mehr </kbd>: Nachfolgende Erinnerungen {#P-getUserPreferences_S_N_GDT_S__ul_gp2_q4w_gjb} |
| gdt | GlideDateTime | Optional. jjjj-MM-TT HH:mm:ss-Format in der UTC-Zeitzone. Der Standardwert ist jetzt. |
| Kommunikationstypen | Zeichenfolge | Optional. Kommagetrennte Zeichenfolge, die mindestens einen der folgenden Werte enthält: * E-Mail * sms * voice {#P-getUserPreferences_S_N_GDT_S__ul_pbz_gp5_1jb} Standardmäßig sind alle verfügbaren Kommunikationstypen enthalten. |
[Tabelle : 4. Parameter]

{#P-getUserPreferences_S_N_GDT_S__table_ixr_4jk_3gb} {#P-getUserPreferences_S_N_GDT_S__table_ubq_ykk_3gb__entry__2}

| Typ | Beschreibung |
|-|-|
| Array-Objekt | Kontakteinstellung des Rufbereitschaftsanwenders. * Typ: Zeichenfolge. Bevorzugtes Kontaktformat des Anwenders, z. B. sms, E-Mail oder Nummer. * \<Name des bevorzugten Formats, z. B. E-Mail oder Nummer\>: Zeichenfolge. Inhalt des bevorzugten Kontakttyps, z. B. E-Mail-Adresse oder Telefonnummer. {#P-getUserPreferences_S_N_GDT_S__ul_pzn_52r_gjb} |
[Tabelle : 5. Rückgaben]

{#P-getUserPreferences_S_N_GDT_S__table_ubq_ykk_3gb}  

    var onContactPrefUtil = new OnCallContactPreferenceUtil();
    var contactAttempt = 1;
    var gdt = new GlideDateTime();
    var itilUserSysId = '<itilUserSysId>;
    var userPreferences = onContactPrefUtil.getUserPreferences(itilUserSysId, contactAttempt, gdt);
    gs.log(JSON.stringify(userPreferences));

Ausgabe:

    [{
        "type": "sms",
        "number": "5555555555"
    }, {
        "type": "voice",
        "number": "5555555555"
    }]

## OnCallContactPreferenceUtil -- getCatchAllContacts (Zeichenfolge rotaId, GlideDateTime gdt) {#ariaid-title5}

Ruft eine Liste von Kontakten und Einstellungen für alle Kontakte und Einstellungen ab.
{#P-getCatchAllContacts_S_GDT_S__table_xgb_ypj_3gb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| rotaId | Zeichenfolge | SYS-ID der Schicht aus der Tabelle \[cmn_Rota\]. |
| gdt | GlideDateTime | Optional. jjjj-MM-TT HH:mm:ss-Format in der UTC-Zeitzone. Der Standardwert ist jetzt. |
[Tabelle : 6. Parameter]

{#P-getCatchAllContacts_S_GDT_S__table_xgb_ypj_3gb} {#P-getCatchAllContacts_S_GDT_S__table_ygb_ypj_3gb__entry__2}

| Typ | Beschreibung |
|-|-|
| Array-Objekt | Liste der ausweichenden Kontakte mit Einstellungen. * Typ: Zeichenfolge. Typ des Kontakts, z. B. Anwender. * sys_ID: Zeichenfolge. SYS-ID des Anwenders aus der Tabelle \[sys_user\]. * rota_ID: Zeichenfolge. SYS-ID der Schicht aus der Tabelle \[cmn_Rota\]. * Roster_ID: Zeichenfolge. SYS-ID des Dienstplans aus der Tabelle \[cmn_Rota_Roster\]. * Eskalation_STEP_ID: Zeichenfolge. Wenn ein Eskalationspfad definiert wurde, SYS-ID des Eskalationsschritts aus der Tabelle \[cmn_rota_esc_step_def\]. * Forced_communication_Channel: Zeichenfolge. Wenn in den Einstellungen angegeben, Obligatorisch Kommunikationskanal. Unterstützte Werte sind SMS, Sprache oder E-Mail. * Boolescher override_user_contact_preference:. „Wahr", wenn Kontaktüberschreibungen vorhanden sind, andernfalls „falsch". * Preference_Source: Zeichenfolge. Quelle der Einstellung, z. B. Kontakt oder Gruppe. * Contact_attempt: Nummer. Kontaktversuche: 1 = erster Versuch, 2 = erste Erinnerung usw. * User_preferences: Array-Objekt. * Typ: Zeichenfolge. Bevorzugtes Kontaktformat des Anwenders, z. B. sms, E-Mail oder Nummer. * \<Name des bevorzugten Formats, z. B. E-Mail oder Nummer\>: Zeichenfolge. Inhalt des bevorzugten Kontakttyps, z. B. E-Mail-Adresse oder Telefonnummer. {#P-getCatchAllContacts_S_GDT_S__ul_pzn_52r_gjb} * Contact_preferences, Array-Objekt. * Typ: Zeichenfolge. Bevorzugtes Kontaktformat des Anwenders, z. B. E-Mail oder Nummer. * \<Name des bevorzugten Formats, z. B. E-Mail oder Nummer\>: Zeichenfolge. Inhalt des bevorzugten Kontakttyps, z. B. E-Mail-Adresse oder Telefonnummer. {#P-getCatchAllContacts_S_GDT_S__ul_vnw_y2r_gjb} {#P-getCatchAllContacts_S_GDT_S__ul_ftv_sbp_3jb} |
[Tabelle : 7. Rückgaben]

{#P-getCatchAllContacts_S_GDT_S__table_ygb_ypj_3gb}  
Beispiel:


    var onContactPrefUtil = new OnCallContactPreferenceUtil();
    var contactAttempt = 1;
    var gdt = new GlideDateTime();
    var rotaSysId = '<Rotation_Sys_ID>';
    var catchAllContacts = onContactPrefUtil.getCatchAllContacts(rotaSysId, gdt);
    gs.log(JSON.stringify(catchAllContacts));

Ausgabe:

    [{
        "type": "user",
        "sys_id": "<Sys_ID>",
        "rota_id": "<Rotation_ID>",
        "roster_id": "",
        "escalation_step_id": "<Escalation_Step_ID>",
        "forced_communication_channel": "",
        "override_user_contact_preference": true,
        "preference_source": "contact",
        "contact_attempt": 1,
        "user_preferences": [{
            "type": "sms",
            "number": "8587200477"
        }],
        "contact_preferences": [{
            "type": "voice",
            "number": "5555555555"
        }]
    }]


