NotifyJsTelephonyDriver – Global

Washington DC API-Referenz

Release

washingtondc

ft:locale

de-DE

ft:publication_title

Washington DC API-Referenz

ft:clusterId

crapiref

bundleId

crapiref

workflow

Creator

NotifyJsTelephonyDriver – Global

Freigeben Version: Washingtondc

Aktualisiert 1. Februar 2024

8 Minuten Lesedauer

Die NotifyJsTelephonyDriver- API stellt Methoden bereit, mit denen Sie Informationen zu den Fähigkeiten des zugehörigen Telefonietreibers erhalten 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 – getTelephonyDriverFromNotifyNumber(). Sie können diese API nicht direkt aufrufen. Die aufrufende Methode ordnet der Schnittstelle einen bestimmten Treiber zu und abstrahiert die Details der Bestimmung des Treibers. Jeder der verfügbaren Treiber implementiert dieselbe Schnittstelle, die durch die NotifyJsTelephonyDriver- API definiert wird.

Im folgenden Codebeispiel gibt die Methode getTelephonyDriverFromNotifyNumber() eine Implementierung dieser API zurück, wobei die Treiberschnittstelle durch die übergebene Telefonnummer bestimmt wird, z. B. TwilioNotifyJsTelephonyDriver.

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 NotifyJsTelephonyDriver zugeordnet sind, navigieren Sie zuSystemerweiterungspunkte > global.NotifyJsTelephonyDriver. Alle zugeordneten Treiberimplementierungen werden auf der Registerkarte „ Implementierungen “ angezeigt.

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

Um diese API zu verwenden, müssen Sie das Notify-Plugin (com.snc.notify) aktivieren. Um bestimmte Treiberimplementierungen wie Twilo zu aktivieren, müssen Sie das entsprechende Plugin aktivieren.

NotifyJsTelephonyDriver – call(Object notifyPhoneNumber, String 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) {

    }
}

NotifyJsTelephonyDriver – 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 Fähigkeiten 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()
      } 
    }
}

NotifyJsTelephonyDriver – getMaxSizeForBulkSms(String phoneNumber)

Gibt die maximale Anzahl von Telefonnummern zurück, an die der Telefonietreiber, der der übergebenen Notify-Telefonnummer zugeordnet ist, gleichzeitig eine SMS-Nachricht an 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 an senden kann.

Tabelle : 6. Ergebnisse
Typ	Beschreibung
Nummer	Maximale Anzahl von Telefonnummern, an die eine SMS-Nachricht in einer einzelnen Massen-SMS gesendet werden kann.

In diesem Beispiel wird die maximale Anzahl von Telefonnummern zurückgegeben, die in einer einzelnen Massen-SMS 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)
      }       
    }
}

NotifyJsTelephonyDriver – getPhoneNumber(String 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)
      } 
    }
}

NotifyJsTelephonyDriver – 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()
      } 
    }
}

NotifyJsTelephonyDriver – 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: true: Treiber ist aktiv. false: 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()
      } 
    }
}

NotifyJsTelephonyDriver – kick(GlideRecord participantRecord)

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 Konferenzschaltung 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)
    }
}

NotifyJsTelephonyDriver – mute(GlideRecord participantRecord)

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 Konferenzschaltung 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)
    }
}

NotifyJsTelephonyDriver – sendAutonomousBulkSms(Object notifyPhoneNumber, Array toPhoneNumber, String message, GlideRecord source)

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

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

Tabelle : 17. Parameter
Name	Typ	Beschreibung
Nachricht	Zeichenfolge	Zu sendende Nachricht.
notifyPhoneNumber	NotifyPhoneNumber – Global	Datensatz, der die Telefonnummer enthält, die die Massen-SMS sendet.
Quelle	GlideRecord – Global	Optional. Incident-GlideRecord, der im Feld „Quelle“ des zugehörigen SMS-Nachrichtendatensatzes in der Notify-Nachricht-Tabelle [Notify-Nachricht] gespeichert werden soll. Dadurch wird der Incident-Datensatz, der die Generierung der SMS-Nachricht verursacht hat, mit dieser 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

Dieses Beispiel zeigt, 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) {

    }
}

NotifyJsTelephonyDriver – sendSMS(NotifyPhoneNumber notifyPhoneNumber, String toPhoneNumber, String 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
Nachricht	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) {
        
    }
}

NotifyJsTelephonyDriver – supportsAutonomousBulkSms(String phoneNumber)

Überprüft, ob die angegebene Notify-Telefonnummer autonome SMS-Nachrichten (Short Message Service) verarbeiten kann.

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. false: 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)
      } 
    }
}

NotifyJsTelephonyDriver – supportsCall()

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

Tabelle : 23. Parameter
Name	Typ	Beschreibung
Keine

Tabelle : 24. Ergebnisse
Typ	Beschreibung
Boolean	Kennzeichnung, die angibt, ob der aktuelle Telefontreiber Telefonanrufe unterstützt. Gültige Werte: true: Treiber unterstützt Telefonanrufe. false: 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()
      } 
    }
}

NotifyJsTelephonyDriver – supportsCallOverWebRtc()

Überprüft, ob die angegebene Notify-Telefonnummer Anrufe an einen Browser mit WebRTC (Real-Time Communications) ermöglichen 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. false: WebRTC wird nicht unterstützt.

In diesem Beispiel wird der Telefonietreiber abgerufen und zurückgegeben, ob der Treiber Browseranrufe 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)
      } 
    }
}

NotifyJsTelephonyDriver – supportsSMS()

Überprüft, ob der aktuelle Telefontreiber 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: true: Treiber unterstützt SMS. false: 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()
      } 
    }
}

NotifyJsTelephonyDriver – unmute(GlideRecord participantRecord)

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 Konferenzschaltung 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)
    }
}