BenachrichtigungUmfangsdefiniert – Umfang

  • Freigeben Version: Yokohama
  • Aktualisiert 30. Januar 2025
  • 9 Minuten Lesedauer
  • Die BenachrichtigungUmfangsdefiniert Mit der API können Sie mit Notify-Aufrufen und SMS-Nachrichten mithilfe von Skripts interagieren.

    Führen Sie aus BenachrichtigungUmfangsdefiniert Klasse und die zugehörigen Methoden aus sn_Notify Namespace.

    NotifyScoped – Anruf(Zeichenfolge notifyPhoneNumber, Zeichenfolge zu PhoneNumber, GlideRecord-KonferenzCall, GlideRecord-KonferenzCallRecord, Zeichenfolge userSysId, Zeichenfolge groupSysId, GlideRecord sourceRecord)

    Ruft die angegebene E.164-konforme Telefonnummer an.

    Tabelle : 1. Parameter
    Name Typ Beschreibung
    NotifyPhoneNumber Zeichenfolge Benachrichtigen Sie die Telefonnummer, von der aus der Anruf getätigt werden soll. Wenn Sie einen Anruf initiieren, wird der Workflow für ausgehende Anrufe für die Nummerngruppe ausgeführt, die dieser Nummer zugeordnet ist. Stellen Sie sicher, dass dieser Workflow einen enthält Nehmen Sie an einer Telefonkonferenz Teil Aktivität zum Verbinden des Anwenders mit der Telefonkonferenz.
    Zu PhoneNumber Zeichenfolge Telefonnummer, die angerufen werden soll. Angerufene Nummern werden der Telefonkonferenz hinzugefügt.
    Konferenzanruf GlideRecord Optional. Wenn dieser Parameter übergeben wird, werden die Anrufer in identifiziert toPhoneNumberParameter werden automatisch der von diesem Datensatz identifizierten Telefonkonferenz hinzugefügt.

    GlideRecord für die Notify-Anruftabelle [Notify_Call], die den Telefonkonferenzdatensatz identifiziert. Dieser Datensatz wird automatisch dem Scratchpad für ausgehende Anrufe als Variable „Workflow.Scratchpad.Conference_call“ hinzugefügt.

    userSysId Zeichenfolge Optional. Eindeutiger Bezeichner (sys_ID) des Anwenders, der dem Anruf zugeordnet ist.
    groupSysId Zeichenfolge Optional. Eindeutiger Bezeichner (sys_ID) der Gruppe, die dem Aufruf zugeordnet ist.
    QuelleDatensatz GlideRecord Optional. Quelldatensatz, der diesen Anruf ausgelöst hat.
    Tabelle : 2. Rückgaben
    Typ Beschreibung
    Ungültig

    Dieses Beispiel veranschaulicht, wie Sie einen Anruf an eine andere Telefonnummer initiieren.

    var from = '+14048007337';
    var to = '+31646810495';
    
    // set up call
    new sn_notify.NotifyScoped().call(from, to);

    Dieses Beispiel veranschaulicht, wie Sie einen Anruf für eine Liste von Telefonnummern initiieren und diese Nummern automatisch in eine neue Telefonkonferenz einbinden.

    var notify = new sn_notify.NotifyScoped();
    var from = '+14041234567';
    var participants = ['+31612345678', '+31623456789', '+31687654321'];
    
    // set up a conference call
    var conferenceCall = notify.conferenceCall();
    
    // set up the outbound calls for all conference call participants
    for (var i in participants) {
        var to = participants[i];
        notify.call(from, to, conferenceCall);
    }

    NotifyScoped – conferenceCall (GlideRecord sourceRecord)

    Erstellt einen neuen GlideRecord für Telefonkonferenzen.

    Tabelle : 3. Parameter
    Name Typ Beschreibung
    QuelleDatensatz GlideRecord Optional. Datensatz, der die Anforderung zum Erstellen der Telefonkonferenz initiiert hat. Wird verwendet, um die Quell- und Tabellenfelder im Datensatz „Notify_Conference_call“ auszufüllen.
    Tabelle : 4. Rückgaben
    Typ Beschreibung
    GlideRecord Neuer Notify-Konferenzanruf [Notify_Conference_call]-Datensatz.
    var notify = new sn_notify.NotifyScoped();
    var from = '+14041234567';
    var participants = ['+31612345678', '+31623456789', '+31687654321'];
    
    // set up a conference call
    var conferenceCall = notify.conferenceCall();
    
    // set up the outbound calls for all conference call participants
    for (var i in participants) {
        var to = participants[i];
        notify.call(from, to, conferenceCall);
    }

    NotifyScoped – dequeue eCall (GlideRecord callRecord)

    Setzt einen Anruf fort, nachdem er in eine Warteschlange gestellt wurde (in Warteschlange).

    Verwenden Sie diese Methode, um Anrufe fortzusetzen, die mit in eine Warteschlange gestellt wurden Warteschlangenaufruf() Methode.

    Tabelle : 5. Parameter
    Name Typ Beschreibung
    Calldatensatz GlideRecord GlideRecord-Objekt in der Notify-Anruftabelle [Notify_Call] mit dem gehaltenen Anruf, den Sie fortsetzen möchten.
    Tabelle : 6. Rückgaben
    Typ Beschreibung
    Ungültig

    Das folgende Beispiel zeigt, wie Sie einen Anruf erneut aktivieren, der angehalten wurde.

    var notifyCallGr = new GlideRecord('notify_call');
    notifyCallGr.get('active participant sys id');
     
    if (notifyCallGr.isValid) {
        sn_notify.NotifyScoped.dequeueCall(notifyCallGr);
    }

    NotifyScoped – ForwardCall (GlideRecord-Anruf, Zeichenfolgenziel, zeichenfolgendtmf)

    Leitet den angegebenen Anruf an einen anderen Anrufempfänger weiter.

    Tabelle : 7. Parameter
    Name Typ Beschreibung
    Rufen Sie an GlideRecord oder Zeichenfolge Benachrichtigen Sie den Anrufdatensatz oder die Anruf-ID des Telefonanbieter des weiterzuleitenden Anrufs.
    destination GlideRecord oder Zeichenfolge Benachrichtigen Sie den Telefonnummerndatensatz oder eine E.164-konforme Telefonnummer des Anrufers, an den der Anruf weitergeleitet werden soll.
    dtmf Zeichenfolge Doppelton: Multifrequenz-Code (DTMF), der bei Anrufverbindung gesendet werden soll.
    Tabelle : 8. Rückgaben
    Typ Beschreibung
    Ungültig

    Das folgende Beispiel zeigt, wie ein Anruf an eine andere Telefonnummer weitergeleitet wird.

    var callID = 'CA92374b5aa561dab476a7001db6026edc'; // Twilio Call ID
    var phoneNumber = '+91406xxxxxxx';
    var dtmfTones = null;
     
    var notifyCallGr = new GlideRecord('notify_call');
    notifyCallGr.get('active participant sys id');
     
    if (notifyCallGr.isValid) {
        sn_notify.NotifyScoped.forwardCall(notifyCallGr(or) callID, phoneNumber, dtmfTones)
    }

    NotifyScoped – getAvailableClients(Zeichenfolge notifyNumber)

    Gibt eine Liste von Client-Sitzungen zurück, die für den Empfang von Anrufen verfügbar sind.

    Tabelle : 9. Parameter
    Name Typ Beschreibung
    Benachrichtigungsnummer Zeichenfolge Gültige Notify-Telefonnummer.
    Tabelle : 10. Rückgaben
    Typ Beschreibung
    Array GlideRecord aus der Tabelle Notify_Client_Session für die angegebene Telefonnummer.

    Gibt „0“ zurück, wenn keine Client-Sitzungen verfügbar sind.

    Das folgende Beispiel zeigt, wie verwendet wird GetAvailableClients() Methode zum Indizieren in die Tabelle Notify_Client_Session und anschließendes Iterieren für alle verfügbaren Notify-Clients.

    var clientSessionGr = sn_notify.NotifyScoped.getAvailableClients('+185xxxxxxxx'); 
    // Here clientSessionGr is of type GlideRecord on 'notify_client_session' table.
     
    var isLoggedInUserAvailable = false;
    while (clientSessionGr.next()) {
      if (clientSessionGr.user == gs.getUserID())
        isLoggedInUserAvailable = clientSessionGr.available;
    }
    gs.info('isLoggedInUserAvailable - ' + isLoggedInUserAvailable);

    NotifyScoped – getPhoneNumbers()

    Gibt alle Telefonnummern und Kurzwahlen zurück, die zur Benachrichtigung verfügbar sind.

    Tabelle : 11. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 12. Rückgaben
    Typ Beschreibung
    Array Liste von NotifyPhoneNumber-Objekten, wobei jedes Objekt eine Telefonnummer darstellt, die benachrichtigt werden kann.

    Dieses Beispiel veranschaulicht, wie die Notify-Telefonnummern abgerufen und dann über die Liste iteriert werden.

    // Instantiate notify
    var notify = new sn_notify.NotifyScoped();
    
    // Retrieve all available phone numbers
    var phoneNumbers = notify.getPhoneNumbers();
    
    // Iterate over phone numbers
    for (var i = 0; i < phoneNumbers.length; i++) {
      var number = phoneNumbers[i];
    
      // Perform any actions using each phone number
    
    }

    NotifyScoped – getShortCodes()

    Gibt alle Kurzwahlen zurück, die zur Benachrichtigung verfügbar sind.

    Tabelle : 13. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 14. Rückgaben
    Typ Beschreibung
    Ungültig

    Dieses Beispiel veranschaulicht, wie die Notify-Kurzwahlen abgerufen und dann über die Liste iteriert werden.

    // Instantiate notify
    var notify = new sn_notify.NotifyScoped();
    
    // Retrieve all available shortcodes
    var shortCodes = notify.getShortCodes();
    
    // Iterate over phone numbers
    for (var i = 0; i < shortCodes.length; i++) {
      var shortCode = shortCodes[i];
      gs.log(shortCode.getNumber());
    
    //perform any actions using each shortcode
    
    }

    NotifyScoped – getTokens (GlideRecord, Datensatz)

    Gibt Client-Token für alle aktiven Telefonietreiber zur Verwendung in WebRTC- oder mobilen Clients zurück.

    Diese Methode verwendet den aktuell angemeldeten Anwenderdatensatz als Client.

    Tabelle : 15. Parameter
    Name Typ Beschreibung
    record GlideRecord GlideRecord, der zur Identifizierung des Notify-Clients verwendet werden soll, z. B. ein Gruppendatensatz oder ein Anwenderdatensatz.
    Tabelle : 16. Rückgaben
    Typ Beschreibung
    Zeichenfolge Web-RTC-Token für die unterstützten Treiber als JSON-Zeichenfolge mit dem folgenden Format: {DriverName1: „token1“, driverName2: „token2“}, z. B. „TwilioDirect“:„eyJhxxxx.eyJleHAiOixxxx.7fejxxx_mbLxxx“

    Dieses Beispiel zeigt, wie die Client-Token für den derzeit angemeldeten Anwender abgerufen werden.

    // get Notify client Tokens per active Notify driver for the currently logged in user
    var json = new sn_notify.NotifyScoped().getTokens();
     
    // Parse the JSON that was return into a tokens object
    var tokens = JSON.parse(json);
    
    // Log line
    gs.log('Notify client tokens for the currently logged in user');
    
     // iterate over the driver tokens
    for (var driver in tokens) {
     	gs.log(driver + ' Driver token: ' + tokens[driver]);
    }

    Dieses Beispiel zeigt, wie die Client-Token für jede Notify-Gruppe abgerufen werden.

    // instantiate Notify
    var notify = new sn_notify.NotifyScoped.Notify();
     
    // get all Notify Groups
    var notifyGroup = new GlideRecord("notify_group");
    notifyGroup.query();
     
    // iterate over all notify groups
    while (notifyGroup.next()) {
      // generate Notify Client tokens per active Notify Driver for this group
      var json = notify.getTokens(notifyGroup);
      var tokens = JSON.parse(json);
     
      for (var driver in tokens) {
        gs.log(gs.getMessage("Notify Client token for {0} driver and Notify Group '{1}': {2}", [driver, notifyGroup.getValue('name'), tokens[driver]]));
      }
    }

    Dieses Beispiel veranschaulicht, wie die Client-Token für die aktiven Telefonietreiber abgerufen werden.

    var notify = new sn_notify.NotifyScoped();
    var now_GR = new GlideRecord('sys_user');
    if (now_GR.get(gs.getUserID())) {
      gs.info(notify.getTokens(now_GR));
    }

    Ausgabe:

    {"TwilioDirect":"eyJhxxxx.eyJleHAiOiIxxxx.7fejxxx_mbLxxx"}

    NotifyScoped – getTokenTTL(Zeichenfolgenbesitzer)

    Gibt die maximale Zeit zurück, die eine Clientsitzung für einen angegebenen Telefonietreiber aktiv bleibt, bevor eine automatische Zeitüberschreitung auftritt.

    Tabelle : 17. Parameter
    Name Typ Beschreibung
    Eigentümer Zeichenfolge Name des Telefonie-Treibers, für den die Sitzungslänge abgerufen werden soll.

    Gültige Werte:

    • Twilio: Für den alten Treiber
    • TwilioDirect: Für den neuen Treiber
    Tabelle : 18. Rückgaben
    Typ Beschreibung
    Ganzzahl Maximale Länge der Sitzung (in Sekunden).

    Standard: 1800 Sekunden

    Das folgende Beispiel zeigt, wie diese Methode und die zugehörige Antwort ordnungsgemäß aufgerufen werden. Es wird auch angezeigt, was zurückgegeben wird, wenn ein ungültiger Treiber übergeben wird.

    var owner = "TwilioDirect";  // Valid driver
    var ttl = SNC.Notify.getTokenTTL(owner);
    gs.info("Token TTL for " + owner + " --> " + ttl);
     
    owner = "Abcxyz";  // Invalid driver
    ttl = SNC.Notify.getTokenTTL(owner);
    // For an invalid driver, we throw NoSuchNotifyDriverException saying that Abcxyzdriver is not available
    // and return the default value of TTL
    gs.info("Token TTL for " + owner + " --> " + ttl); 

    NotifyScoped – hasCapability (Zeichenfolge notifyPhoneNumber, Zeichenfolgenfähigkeit)

    Bestimmt, ob die angegebene Telefonnummer über die angegebene Fähigkeit verfügt.

    Der der Telefonnummer zugeordnete Telefonie-Treiber enthält eine Liste aller Fähigkeiten des Telefons.

    Hinweis:
    Im Basissystem hat der Notify-JS-Treiber nur „Show_speakers“ als Fähigkeit. Dies kann geändert werden.
    Tabelle : 19. Parameter
    Name Typ Beschreibung
    NotifyPhoneNumber Zeichenfolge Telefonnummer, für die nach der angegebenen Fähigkeit gesucht werden soll.
    Fähigkeit Zeichenfolge Fähigkeit zur Erkennung. Der Zeichenfolgentext muss genau mit dem im Telefon übereinstimmen.
    Tabelle : 20. Rückgaben
    Typ Beschreibung
    Boolean Kennzeichnung, die angibt, ob das angegebene Telefon über die angegebene Fähigkeit verfügt.
    • Wahr: Telefon hat die Fähigkeit
    • Falsch: Telefon verfügt nicht über die Fähigkeit

    Dieses Beispiel zeigt, wie überprüft wird, ob ein Telefon über eine bestimmte Fähigkeit verfügt.

    // Each driver has a defined set of capabilities.
    
    var capability = 'show_speakers';
    gs.info(sn_notify.NotifyScoped.hasCapability('+185xxxxxxxx', capability)); // true
     
    capability = 'send_sms';
    gs.info(sn_notify.NotifyScoped.hasCapability('+185xxxxxxxx', capability)); // false

    NotifyScoped – Kick (GlideRecord-Teilnehmer)

    Entfernt den angegebenen Anrufer aus der aktuellen Notify-Telefonkonferenz.

    Tabelle : 21. Parameter
    Name Typ Beschreibung
    Teilnehmer GlideRecord GlideRecord-Objekt, das den Notify-Teilnehmer [Notify_participant]-Datensatz des Anrufers enthält, der aus der Telefonkonferenz entfernt werden soll.
    Tabelle : 22. Rückgaben
    Typ Beschreibung
    Ungültig

    Dieses Beispiel zeigt, wie ein Teilnehmer aus einem Anruf entfernt wird.

    var participant = new GlideRecord('notify_participant');
    participant.get('<sys_id>');
    if (participant.isValid()) {
        new sn_notify.NotifyScoped().kick(participant);
    }

    NotifyScoped – modifyCall(GlideRecord callRecord, NotifyAction notifyAction)

    Führt eine oder mehrere Aktivitäten für einen aktiven Notify-Telefonanruf aus.

    Verwenden Sie diese Methode, um das Verhalten eines Anrufs zu ändern. Beispiel: Übertragen eines Anrufs, Wiedergabe von Audiodateien oder Erzwingen eines Hängens.
    Hinweis:
    Die bereichsbezogene Implementierung dieser Methode unterstützt nur anwenderdefinierte Notify-Aktivitäten. Im Gegensatz zur globalen Implementierung bietet sie keine Benachrichtigungsaktion API. Details zum Erstellen einer anwenderdefinierten Notify-Aktivität finden Sie unter Notify-Workflow-Aktivitäten .
    Tabelle : 23. Parameter
    Name Typ Beschreibung
    Calldatensatz GlideRecord Notify-Anruf [Notify_Call]-Datensatz des Anrufs, für den die Aktionen angewendet werden sollen.
    NotifyAction Benachrichtigungsaktion NotifyAction-Objekt, das eine oder mehrere Aktivitäten beschreibt, die für den Anruf ausgeführt werden sollen.
    Tabelle : 24. Rückgaben
    Typ Beschreibung
    Ungültig

    NotifyScoped – stummschalten (GlideRecord partiantRecord)

    Schaltet den angegebenen Konferenzteilnehmer stumm.

    Tabelle : 25. Parameter
    Name Typ Beschreibung
    Partizipierender Datensatz GlideRecord GlideRecord aus der Tabelle Notify_participant, damit der Teilnehmer stummgeschaltet werden kann.
    Tabelle : 26. Rückgaben
    Typ Beschreibung
    Ungültig

    Das folgende Beispiel zeigt, wie ein Anrufer stummgeschaltet wird.

    var notifyParticipantGr = new GlideRecord('notify_participant');
    notifyParticipantGr.get('active participant sys id');
     
    if (notifyParticipantGr.isValid) {
        sn_notify.NotifyScoped.mute(notifyParticipantGr);
    }

    NotifyScoped – Warteschlangenruf (GlideRecord callRecord)

    Legt den angegebenen Anruf in eine Warteschlange (angehalten).

    Setzen Sie einen Anruf in der Warteschlange mit fort DewareCall() Methode.

    Tabelle : 27. Parameter
    Name Typ Beschreibung
    Calldatensatz GlideRecord GlideRecord-Objekt des Notify-Anrufdatensatzes (Notify_call-Tabelle), der angehalten werden soll.
    Tabelle : 28. Rückgaben
    Typ Beschreibung
    Ungültig
    var call = new GlideRecord('notify_call');
    call.get('<call record sys_id>');
    if (call.isValid()) {
        new sn_notify.NotifyScoped().queueCall(call);
    }

    NotifyScoped – sendBulkSMS(NotifyPhoneNumber notifyPhoneNumber, Zeichenfolge zu PhoneNumbers, Zeichenfolge messageBody, GlideRecord-Quelle)

    Sendet eine angegebene SMS-Nachricht an die angegebene Liste der Notify-Clients (Telefonnummern).

    Tabelle : 29. Parameter
    Name Typ Beschreibung
    NotifyPhoneNumber Benachrichtigungs-Telefonnummer Telefonnummer, von der die SMS-Nachricht gesendet wird.
    Zu PhoneNumbers Zeichenfolge Kommagetrennte Listentelefonnummern, an die die SMS-Nachricht gesendet werden soll.

    Format: E.164-konform

    MessageBody Zeichenfolge Zu sendender SMS-Text.
    Quelle GlideRecord Quelldatensatz, der diese SMS-Nachricht ausgelöst hat, z. B. ein Incident.
    Tabelle : 30. Rückgaben
    Typ Beschreibung
    Zeichenfolge Null

    Dieses Beispiel zeigt, wie eine SMS-Nachricht an mehrere Telefonnummern (Massen-SMS) gesendet wird.

    var incidentGr = new GlideRecord('incident');
    incidentGr.get('active incident sys_id');
    if (incidentGr.isValid()) {
        sn_notify.NotifyScoped.sendBulkSMS('+15413970605', ['+919885XXXXXX', '+919775XXXXXX'], 'Test automation message', incidentGr);
    }

    NotifyScoped – sendSMS(NotifyPhoneNumber notifyPhoneNumber, Zeichenfolge zu PhoneNumber, Zeichenfolge messageBody, GlideRecord-Quelle)

    Sendet eine SMS-Textnachricht an eine E.164-konforme Telefonnummer.

    Diese Methode erstellt einen neuen Datensatz in der Notify-Nachricht [Notify_message]-Tabelle und ordnet ihn dem Quelldatensatz zu.

    Tabelle : 31. Parameter
    Name Typ Beschreibung
    NotifyPhoneNumber Benachrichtigungs-Telefonnummer Benachrichtigen Sie die Telefonnummer oder Kurzwahl, an die diese SMS-Nachricht gesendet werden soll.
    Zu PhoneNumber Zeichenfolge E.164-konforme Telefonnummer, an die die SMS-Nachricht gesendet werden soll.
    MessageBody Zeichenfolge SMS-Textnachricht.
    Quelle GlideRecord Quelldatensatz, der diese SMS-Nachricht ausgelöst hat, z. B. ein Incident.
    Tabelle : 32. Rückgaben
    Typ Beschreibung
    Zeichenfolge Eindeutige Nachrichten-SID; im Notify-Nachricht [Notify_message]-Datensatz als Message_ID gespeichert

    Das folgende Beispiel zeigt, wie eine SMS-Nachricht gesendet wird.

    var incidentGr = new GlideRecord('incident');
    incidentGr.get('active incident sys_id');
    if (incidentGr.isValid()) {
        sn_notify.NotifyScoped.sendSMS('+15413970605', '+919885XXXXXX', 'Test automation message', incidentGr);
    }

    NotifyScoped – Stummschaltung aufheben(GlideRecord partiantRecord)

    Hebt die Stummschaltung des angegebenen Konferenzteilnehmers auf.

    Tabelle : 33. Parameter
    Name Typ Beschreibung
    Partizipierender Datensatz GlideRecord GlideRecord aus der Tabelle Notify_participant, damit der Teilnehmer die Stummschaltung aufheben kann.
    Tabelle : 34. Rückgaben
    Typ Beschreibung
    Ungültig

    Dieses Beispiel zeigt, wie die Stummschaltung eines angegebenen Anrufteilnehmers aufgehoben wird.

    var notifyParticipantGr = new GlideRecord('notify_participant');
    notifyParticipantGr.get('active participant sys id');
     
    if (notifyParticipantGr.isValid) {
        sn_notify.NotifyScoped.unmute(notifyParticipantGr);
    }