---
sourceDocument: Xanadu-API-Referenz
sourceDocumentLink: https://www.servicenow.com/docs/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


---

# OnCallContactPreferenceUtil : Global

# OnCallContactPreferenceUtil : Global {#ariaid-title1}

* Freigeben Version: Xanadu
* 
* Aktualisiert 1. August 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 4 Minuten Lesedauer

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

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

Diese Skripteinbindung unterstützt die [OnCallRotation-Skripteinbindung](https://www.servicenow.com/docs/H6LGE8I4xuIshvVNqAYTyw#c_OnCallRotationAPI "Die OnCallRotation -Skripteinbindung bietet Methoden zum Verwalten von Rufbereitschaftszeitplänen.").

## 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(Object escalatee, Number 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 Benutzerkontakteinstellungen.
{#P-getContactsAtByEscalatee_O_N_F_S__table_o1s_x5j_3gb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Eskalationsempfänger | Objekt | Obligatorisch. Von der [getEscalationPlan()-](https://www.servicenow.com/docs/H6LGE8I4xuIshvVNqAYTyw#r_OCR-getEscalationPlan_S_GDT "Ruft für die Schicht einer Gruppe zum angegebenen Datum und zur angegebenen Uhrzeit eine Liste mit Objekten, zu denen die Eskalation erfolgen soll, Eskalationspläne, die entweder aus einem Benutzer [sys_user] oder einem Benachrichtigungsgerät [cmn_notif_device] bestehen, ab. Diese API ist für eine einzelne Schicht, sich überschneidende Schichten und benutzerdefinierte Eskalation anwendbar.") Methode zurückgegebenes Eskalationsempfängerobjekt. |
| Kontaktversuch | Nummer | Optional. 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. Format jjjj-MM-tt HH:mm:ss 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 Eskalierten (entweder ein Benutzer-, Gruppen- oder Gerätedatensatz, abhängig von den Benachrichtigungsregeln) zu einem bestimmten Zeitpunkt und an einer bestimmten Position. * Typ: Zeichenfolge Typ des Kontakts, z. B. Benutzer. * 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\]. * escalation_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, obligatorischer Kommunikationskanal. Unterstützte Werte sind SMS, Sprachanruf oder E-Mail. * override_user_contact_preference: Boolesch. „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 of preferred format, e.g., email or number\>: 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 of preferred format, e.g., email or number\>: 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. Ergebnisse]

{#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(String userSysId, Number contactAttempt, GlideDateTime gdt, String communicationTypes) {#ariaid-title4}

Ruft die Liste der Kontakteinstellungen zu dem Zeitpunkt ab, zu dem sich der Anwender für Kommunikation entschieden hat. Wenn keine Uhrzeit angegeben ist, wird die aktuelle Uhrzeit verwendet. Diese Methode ist für einzelne und sich überschneidende Schichten anwendbar.
{#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\]. |
| Kontaktversuch | Nummer | Optional. 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. Format jjjj-MM-tt HH:mm:ss in der UTC-Zeitzone. Standard ist jetzt. |
| communicationTypes | Zeichenfolge | Optional. Kommagetrennte Zeichenfolge, die einen oder mehrere der folgenden Werte enthält: * E-Mail * sms * voice {#P-getUserPreferences_S_N_GDT_S__ul_pbz_gp5_1jb} Standard enthält alle verfügbaren Kommunikationstypen. |
[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 für Rufbereitschaftsbenutzer. * Typ: Zeichenfolge Bevorzugtes Kontaktformat des Anwenders, z. B. SMS, E-Mail oder Nummer. * \<name of preferred format, e.g., email or number\>: Zeichenfolge. Inhalt des bevorzugten Kontakttyps, z. B. E-Mail-Adresse oder Telefonnummer. {#P-getUserPreferences_S_N_GDT_S__ul_pzn_52r_gjb} |
[Tabelle : 5. Ergebnisse]

{#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(String rotaId, GlideDateTime gdt) {#ariaid-title5}

Ruft eine Liste von Ausweichkontakten 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. Format jjjj-MM-tt HH:mm:ss in der UTC-Zeitzone. Standard 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 Catch-All-Kontakte mit Einstellungen. * Typ: Zeichenfolge Typ des Kontakts, z. B. Benutzer. * 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\]. * escalation_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, obligatorischer Kommunikationskanal. Unterstützte Werte sind SMS, Sprachanruf oder E-Mail. * override_user_contact_preference: Boolesch. „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 of preferred format, e.g., email or number\>: 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 of preferred format, e.g., email or number\>: 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. Ergebnisse]

{#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"
        }]
    }]