NotifyJsTelefonyDriver – Global

  • Freigeben Version: Xanadu
  • Aktualisiert 1. August 2024
  • 8 Minuten Lesedauer
  • Die NotifyJsTelefonyDriver- API stellt Methoden bereit, mit denen Sie Informationen zu den Fähigkeiten des zugehörigen Telefonietreibers abrufen können.

    Es handelt sich um einen geskripteten Erweiterungspunkt, der nur verwendet werden kann, wenn sein Objekt von einer anderen Methode zurückgegeben wird, z. B. NotifyUtil - getTeletelefonyDriverFromNotifyNumber(). Sie können diese API nicht direkt aufrufen. Die aufrufende Methode ordnet der Schnittstelle einen bestimmten Treiber zu und abstrahiert die Details zur Bestimmung des Treibers. Alle verfügbaren Treiber implementieren dieselbe Schnittstelle, die von der NotifyJsTelephoneDriver- API definiert wird.

    Im folgenden Codebeispiel gibt die Methode getTelephoneDriverFromNotifyNumber() eine Implementierung dieser API zurück, wobei die Treiberschnittstelle durch die übergebene Telefonnummer bestimmt wird, z. B. TwilioNotifyJsTelephoneyDriver.
    getDriverDetails('<notify_number>'); 
    
    function getDriverDetails(notifyNumber) {
      var nUtil = new NotifyUtil();
      if (!notifyNumber || !nUtil.validateOutboundNotifyNumber(notifyNumber))
        return;
      var driver = nUtil.getTelephonyDriverFromNotifyNumber(notifyNumber);
        if (driver) {
          return {
            driverName: driver.getName(),
            supportsCall: driver.supportsCall(),
            supportsSMS: driver.supportsSms()
          } 
        }
    } 

    Um zu sehen, welche Treiber dem Erweiterungspunkt NotifyJsTelephoneDriver zugeordnet sind, navigieren Sie zuSystemerweiterungspunkte > global.NotifyJsTelephoneDriver. Alle zugeordneten Treiberimplementierungen werden auf der Registerkarte Implementationen angezeigt.

    Weitere Informationen zu geskripteten Erweiterungspunkten finden Sie unter Erweiterungspunkte zum Erweitern von Anwendungsfunktionalitäten verwenden.

    Zur Verwendung dieser API müssen Sie das Notify-Plugin (com.snc.notify) aktivieren. Um bestimmte Treiberimplementierungen, wie z. B. Twilligo, zu aktivieren, müssen Sie das entsprechende Plugin aktivieren.

    NotifyJsTelephoneyDriver – Anruf (Objekt NotifyPhoneNumber, Zeichenfolge PhoneNumber)

    Ruft eine angegebene Telefonnummer an.

    Tabelle : 1. Parameter
    Name Typ Beschreibung
    notifyPhoneNumber NotifyPhoneNumber : Global NotifyPhoneNumber-Datensatz, der die Notify-Telefonnummer enthält, von der aus der Anruf erfolgen soll. Befindet sich in der Tabelle „Notify-Telefonnummer“ [notify_number].
    toPhoneNumber Zeichenfolge Anzurufende Telefonnummer.

    Format: E.164

    Tabelle : 2. Ergebnisse
    Typ Beschreibung
    Keine

    getDriverDetails('<notify_number>'); 
    
    function getDriverDetails(notifyNumber) {
      var nUtil = new NotifyUtil();
      if (!notifyNumber || !nUtil.validateOutboundNotifyNumber(notifyNumber))
        return;
      var driver = nUtil.getTelephonyDriverFromNotifyNumber(notifyNumber);
        if (driver) {
    
        }
    } 

    NotifyJsTelefonyDriver – getCapabilities()

    Gibt eine Liste der Fähigkeiten des Telefonietreibers zurück.

    Tabelle : 3. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 4. Ergebnisse
    Typ Beschreibung
    Keine

    In diesem Beispiel werden die Funktionen des zugehörigen Telefonietreibers zurückgegeben.

    getDriverDetails('<notify_number>'); 
    
    function getDriverDetails(notifyNumber) {
      var nUtil = new NotifyUtil();
      if (!notifyNumber || !nUtil.validateOutboundNotifyNumber(notifyNumber))
        return;
      var driver = nUtil.getTelephonyDriverFromNotifyNumber(notifyNumber);
        if (driver) {
          return {
           capabilities: driver.getCapabilities()
          } 
        }
    } 

    NotifyJsTelefonyDriver – getMaxSizeForBulkSms(Zeichenfolge phoneNumber)

    Gibt die maximale Anzahl von Telefonnummern zurück, an die der Telefonietreiber, der der übergebenen Notify-Telefonnummer zugeordnet ist, jeweils eine SMS-Nachricht senden kann.

    Tabelle : 5. Parameter
    Name Typ Beschreibung
    phoneNumber Zeichenfolge Notify-Telefonnummer, um die maximale Anzahl von Telefonnummern zu überprüfen, die der zugeordnete Fahrer in einer Massen-SMS-Nachricht an senden kann.
    Tabelle : 6. Ergebnisse
    Typ Beschreibung
    Nummer Maximale Anzahl von Telefonnummern, an die eine SMS-Nachricht in einer einzigen Massen-SMS-Zustellung gesendet werden kann.

    In diesem Beispiel wird die maximale Anzahl von Telefonnummern zurückgegeben, die in einer einzelnen Massen-SMS-Nachricht für den zugehörigen Telefonietreiber an gesendet werden können.

    getDriverDetails('<notify_number>'); 
    
    function getDriverDetails(notifyNumber) {
      var nUtil = new NotifyUtil();
      if (!notifyNumber || !nUtil.validateOutboundNotifyNumber(notifyNumber))
        return;
      var driver = nUtil.getTelephonyDriverFromNotifyNumber(notifyNumber);
        if (driver) {
           return {
           maxSmsNumbers: driver.getMaxSizeForBulkSMS(notifyNumber)
          }       
        }
    } 

    NotifyJsTelephoneyDriver – getPhoneNumber(Zeichenfolge phoneNumber)

    Gibt den Notify-Telefonnummerndatensatz für die angegebene Telefonnummer zurück.

    Gibt null zurück, wenn die angegebene Telefonnummer nicht in der Tabelle „Notify-Telefonnummer“ [notify_number] gefunden wird.

    Tabelle : 7. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 8. Ergebnisse
    Typ Beschreibung
    NotifyPhoneNumberAPI Notify-Telefonnummerndatensatz, der der angegebenen Telefonnummer zugeordnet ist.

    In diesem Beispiel wird der Telefonietreiber abgerufen und der zugehörige Notify-Telefonnummerndatensatz für eine angegebene Telefonnummer zurückgegeben.

    getDriverDetails('<notify_number>'); 
    
    function getDriverDetails(notifyNumber) {
      var nUtil = new NotifyUtil();
      if (!notifyNumber || !nUtil.validateOutboundNotifyNumber(notifyNumber))
        return;
      var driver = nUtil.getTelephonyDriverFromNotifyNumber(notifyNumber);
        if (driver) {
          return {
           phoneNumberRecord: driver.getPhoneNumber(notifyNumber)
          } 
        }
    } 

    NotifyJsTelefonyDriver – getPhoneNumbers()

    Gibt eine Liste aller Notify-Telefonnummern zurück, die dem aktuellen Telefonietreiber zugeordnet sind.

    Tabelle : 9. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 10. Ergebnisse
    Typ Beschreibung
    Zeichenfolge Kommagetrennte Liste aller Notify-Telefonnummern, die dem aktuellen Fahrer zugeordnet sind.

    In diesem Beispiel wird der Telefonietreiber abgerufen und die Liste der Notify-Telefonnummern zurückgegeben, die dem aktuellen Telefonietreiber zugeordnet sind.

    getDriverDetails('<notify_number>'); 
    
    function getDriverDetails(notifyNumber) {
      var nUtil = new NotifyUtil();
      if (!notifyNumber || !nUtil.validateOutboundNotifyNumber(notifyNumber))
        return;
      var driver = nUtil.getTelephonyDriverFromNotifyNumber(notifyNumber);
        if (driver) {
          return {
           phoneNumbers: driver.getPhoneNumbers()
          } 
        }
    } 

    NotifyJsTelefonyDriver – isActive()

    Überprüft, ob der aktuelle Telefonietreiber aktiv ist.

    Tabelle : 11. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 12. Ergebnisse
    Typ Beschreibung
    Boolean

    Kennzeichnung, die angibt, ob der aktuelle Telefonietreiber aktiv ist.

    Gültige Werte:
    • „wahr“: Der Treiber ist aktiv.
    • „falsch“: Treiber ist inaktiv.

    In diesem Beispiel wird der Telefonietreiber abgerufen und zurückgegeben, ob der aktuelle Telefonietreiber aktiv ist.

    getDriverDetails('<notify_number>'); 
    
    function getDriverDetails(notifyNumber) {
      var nUtil = new NotifyUtil();
      if (!notifyNumber || !nUtil.validateOutboundNotifyNumber(notifyNumber))
        return;
      var driver = nUtil.getTelephonyDriverFromNotifyNumber(notifyNumber);
        if (driver) {
          return {
            active: driver.isActive()
          } 
        }
    } 

    NotifyJsTelefonyDriver – Kick(GlideRecordmemberRecord)

    Entfernt den angegebenen Anrufer aus der aktuellen Notify-Konferenzschaltung.

    Tabelle : 13. Parameter
    Name Typ Beschreibung
    teilnehmerdatensatz GlideRecord : Global GlideRecord-Objekt, das den Notify-Teilnehmer-Datensatz [notify_participant] des Anrufers enthält, der aus der Konferenzschaltung entfernt werden soll.
    Tabelle : 14. Ergebnisse
    Typ Beschreibung
    Zeichenfolge Wird nur bei Fehler zurückgegeben. Fehlermeldung, die beschreibt, warum der Anrufer nicht aus dem Anruf entfernt wurde.

    In diesem Beispiel wird der zugeordnete Anrufer in der aktuellen Telefonkonferenz stummgeschaltet.

    getDriverDetails('<notify_number>'); 
    
    function getDriverDetails(notifyNumber) {
      var nUtil = new NotifyUtil();
      if (!notifyNumber || !nUtil.validateOutboundNotifyNumber(notifyNumber))
        return;
      var driver = nUtil.getTelephonyDriverFromNotifyNumber(notifyNumber);
        if (driver) {
          var notifyParticipantGr = new GlideRecord('notify_participant');
          notifyParticipantGr.get('active participant sys id');
        
          if (notifyParticipantGr.isValid) {
            driver.kick(notifyParticipantGr)
        }
    } 

    NotifyJsTelephoneDriver – mute(GlideRecordmemberRecord)

    Schaltet den angegebenen Anrufer in der aktuellen Notify-Telefonkonferenz stumm.

    Tabelle : 15. Parameter
    Name Typ Beschreibung
    teilnehmerdatensatz GlideRecord : Global GlideRecord-Objekt, das den Notify-Teilnehmer-Datensatz [notify_participant] des Anrufers enthält, der in der Telefonkonferenz stummgeschaltet werden soll.
    Tabelle : 16. Ergebnisse
    Typ Beschreibung
    Zeichenfolge Wird nur bei Fehler zurückgegeben. Fehlermeldung, die beschreibt, warum der Anrufer nicht stummgeschaltet wurde.

    In diesem Beispiel wird der zugeordnete Anrufer in der aktuellen Telefonkonferenz stummgeschaltet.

    getDriverDetails('<notify_number>'); 
    
    function getDriverDetails(notifyNumber) {
      var nUtil = new NotifyUtil();
      if (!notifyNumber || !nUtil.validateOutboundNotifyNumber(notifyNumber))
        return;
      var driver = nUtil.getTelephonyDriverFromNotifyNumber(notifyNumber);
        if (driver) {
          var notifyParticipantGr = new GlideRecord('notify_participant');
          notifyParticipantGr.get('active participant sys id');
        
          if (notifyParticipantGr.isValid) {
            driver.mute(notifyParticipantGr)
        }
    } 

    NotifyJsTelephoneDriver – sendAutonomousBulkSms(Object notifyPhoneNumber, Array toPhoneNumber, Zeichenfolgennachricht, GlideRecord-Quelle)

    Sendet die angegebene SMS-Nachricht (Short Message Service) an die angegebene Liste von Telefonnummern.

    Darüber hinaus können Sie optional den Incident-Datensatz zuordnen, der die Generierung der SMS-Nachricht mit der SMS-Nachricht verursacht hat.

    Tabelle : 17. Parameter
    Name Typ Beschreibung
    Nachricht Zeichenfolge Zu sendende Nachricht.
    notifyPhoneNumber NotifyPhoneNumber : Global Datensatz, der die Telefonnummer enthält, von der die Massen-SMS-Nachricht gesendet wird.
    Quelle GlideRecord : Global Optional. Incident-GlideRecord, der im Feld Quelle des zugehörigen SMS-Nachrichtendatensatzes in der Notify-Nachricht-Tabelle [notify message] gespeichert werden soll. Dadurch wird der Incident-Datensatz, der das Generieren der SMS-Nachricht verursacht hat, mit der SMS-Nachricht verknüpft.

    Standard: Keine. Wenn dieser Parameter nicht übergeben wird, werden diese Informationen nicht nachverfolgt.

    toPhoneNumbers Array Liste der Telefonnummern der Geräte, die die SMS-Nachricht empfangen sollen.
    Tabelle : 18. Ergebnisse
    Typ Beschreibung
    Keine

    In diesem Beispiel wird gezeigt, wie eine autonome Massen-SMS gesendet wird.

    getDriverDetails('<notify_number>'); 
    
    function getDriverDetails(notifyNumber) {
      var nUtil = new NotifyUtil();
      if (!notifyNumber || !nUtil.validateOutboundNotifyNumber(notifyNumber))
        return;
      var driver = nUtil.getTelephonyDriverFromNotifyNumber(notifyNumber);
        if (driver) {
    
        }
    } 

    NotifyJsTelefonyDriver – sendSMS(NotifyPhoneNumber notifyPhoneNumber, Zeichenfolge toTelefonnummer, Zeichenfolge messageBody)

    Sendet eine angegebene SMS-Nachricht (Short Message Service) an eine angegebene Telefonnummer.

    Tabelle : 19. Parameter
    Name Typ Beschreibung
    notifyPhoneNumber NotifyPhoneNumber : Global Notify-Telefonnummerndatensatz, der die Telefonnummer enthält, von der die SMS-Nachricht gesendet wird. Befindet sich in der Tabelle „Notify-Telefonnummer“ [notify_number].
    toPhoneNumber Zeichenfolge Telefonnummer, an die die SMS-Nachricht gesendet werden soll.

    Format: E.164-konform

    message Zeichenfolge Text, der in der SMS-Nachricht gesendet werden soll.
    Tabelle : 20. Ergebnisse
    Typ Beschreibung
    Keine

    In diesem Beispiel wird eine SMS-Nachricht an eine angegebene Telefonnummer gesendet.

    getDriverDetails('<notify_number>'); 
    
    function getDriverDetails(notifyNumber) {
      var nUtil = new NotifyUtil();
      if (!notifyNumber || !nUtil.validateOutboundNotifyNumber(notifyNumber))
        return;
      var driver = nUtil.getTelephonyDriverFromNotifyNumber(notifyNumber);
        if (driver) {
            
        }
    } 

    NotifyJsTelefonyDriver – unterstützt AutonomousBulkSms(Zeichenfolge phoneNumber)

    Überprüft, ob die angegebene Notify-Telefonnummer in der Lage ist, autonome Massennachrichten des Short Message Service (SMS) zu bearbeiten.

    Tabelle : 21. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 22. Ergebnisse
    Typ Beschreibung
    Boolean

    Kennzeichnung, die angibt, ob die angegebene Notify-Telefonnummer autonome Massen-SMS unterstützt.

    Gültige Werte:
    • true: Unterstützt autonome Massen-SMS.
    • „falsch“: Unterstützt keine autonomen Massen-SMS.

    In diesem Beispiel wird der Telefonietreiber abgerufen und zurückgegeben, ob der Treiber autonome Massen-SMS unterstützt.

    getDriverDetails('<notify_number>'); 
    
    function getDriverDetails(notifyNumber) {
      var nUtil = new NotifyUtil();
      if (!notifyNumber || !nUtil.validateOutboundNotifyNumber(notifyNumber))
        return;
      var driver = nUtil.getTelephonyDriverFromNotifyNumber(notifyNumber);
        if (driver) {
          return {
            supportsBulkSMS: driver.supportsAutonomousBulkSms(notifyNumber)
          } 
        }
    } 

    NotifyJsTelefonyDriver – unterstützt Anruf ()

    Überprüft, ob der aktuelle Telefonietreiber Telefonanrufe verarbeiten kann.

    Tabelle : 23. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 24. Ergebnisse
    Typ Beschreibung
    Boolean

    Kennzeichnung, die angibt, ob der aktuelle Telefonietreiber Telefonanrufe unterstützt.

    Gültige Werte:
    • „wahr“: Der Treiber unterstützt Telefonanrufe.
    • „falsch“: Der Treiber unterstützt keine Telefonanrufe.

    In diesem Beispiel wird der Telefonietreiber abgerufen und zurückgegeben, ob der Treiber Telefonanrufe unterstützt.

    getDriverDetails('<notify_number>'); 
    
    function getDriverDetails(notifyNumber) {
      var nUtil = new NotifyUtil();
      if (!notifyNumber || !nUtil.validateOutboundNotifyNumber(notifyNumber))
        return;
      var driver = nUtil.getTelephonyDriverFromNotifyNumber(notifyNumber);
        if (driver) {
          return {
            supportsCall: driver.supportsCall()
          } 
        }
    } 

    NotifyJsTelefonyDriver – unterstütztCallOverWebRtc()

    Überprüft, ob die angegebene Notify-Nummer Anrufe an einen Browser mithilfe von WebRTC (Real-Time Communications) tätigen kann.

    Tabelle : 25. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 26. Ergebnisse
    Typ Beschreibung
    Boolean

    Kennzeichnung, die angibt, ob die angegebene Notify-Telefonnummer Browseranrufe mit WebRTC unterstützt.

    Gültige Werte:
    • true: Unterstützt WebRTC.
    • „falsch“: WebRTC wird nicht unterstützt.

    In diesem Beispiel wird der Telefonietreiber abgerufen und zurückgegeben, ob der Treiber Browseraufrufe mit WebRTC unterstützt.

    getDriverDetails('<notify_number>'); 
    
    function getDriverDetails(notifyNumber) {
      var nUtil = new NotifyUtil();
      if (!notifyNumber || !nUtil.validateOutboundNotifyNumber(notifyNumber))
        return;
      var driver = nUtil.getTelephonyDriverFromNotifyNumber(notifyNumber);
        if (driver) {
          return {
            supportsWebRTC: driver.supportsCallOverWebRtc(notifyNumber)
          } 
        }
    } 

    NotifyJsTelefonyDriver – unterstützt SMS()

    Überprüft, ob der aktuelle Telefonietreiber SMS-Nachrichten (Short Message Service) verarbeiten kann.

    Tabelle : 27. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 28. Ergebnisse
    Typ Beschreibung
    Boolean

    Kennzeichnung, die angibt, ob der aktuelle Telefonietreiber SMS unterstützt.

    Gültige Werte:
    • „wahr“: Treiber unterstützt SMS.
    • „falsch“: Der Treiber unterstützt keine SMS.

    In diesem Beispiel wird der Telefonietreiber abgerufen und zurückgegeben, ob der Treiber SMS unterstützt.

    getDriverDetails('<notify_number>'); 
    
    function getDriverDetails(notifyNumber) {
      var nUtil = new NotifyUtil();
      if (!notifyNumber || !nUtil.validateOutboundNotifyNumber(notifyNumber))
        return;
      var driver = nUtil.getTelephonyDriverFromNotifyNumber(notifyNumber);
        if (driver) {
          return {
            supportsSMS: driver.supportsSMS()
          } 
        }
    } 

    NotifyJsTelephoneDriver – Stummschaltung aufheben (GlideRecord-Teilnehmerdatensatz)

    Hebt die Stummschaltung des angegebenen Anrufers in der aktuellen Notify-Telefonkonferenz auf.

    Tabelle : 29. Parameter
    Name Typ Beschreibung
    teilnehmerdatensatz GlideRecord : Global GlideRecord-Objekt, das den Notify-Teilnehmer-Datensatz [notify_participant] des Anrufers enthält, der in der Telefonkonferenz stummgeschaltet werden soll.
    Tabelle : 30. Ergebnisse
    Typ Beschreibung
    Zeichenfolge Wird nur bei Fehler zurückgegeben. Fehlermeldung, die beschreibt, warum der Anrufer nicht stummgeschaltet wurde.

    In diesem Beispiel wird der zugeordnete Anrufer in der aktuellen Telefonkonferenz stummgeschaltet.

    getDriverDetails('<notify_number>'); 
    
    function getDriverDetails(notifyNumber) {
      var nUtil = new NotifyUtil();
      if (!notifyNumber || !nUtil.validateOutboundNotifyNumber(notifyNumber))
        return;
      var driver = nUtil.getTelephonyDriverFromNotifyNumber(notifyNumber);
        if (driver) {
          var notifyParticipantGr = new GlideRecord('notify_participant');
          notifyParticipantGr.get('active participant sys id');
        
          if (notifyParticipantGr.isValid) {
            driver.unmute(notifyParticipantGr)
        }
    }