OpenFrameAPI – Client

Die OpenFrameAPI Stellt Methoden bereit, die mit OpenFrame interagieren. OpenFrame ist ein häufiger Frame, mit dem Kommunikationspartner ihre Systeme in die ServiceNow-Plattform integrieren können.

Eine der Hauptanforderungen ist die Fähigkeit, Code aus verschiedenen Domänen zu verbinden und bereitzustellen, die sich nahtlos mit Partner-Subsystemen verbinden können. Diese domänenübergreifende Verbindung ist erforderlich, um Verbindungen und Rückrufe in Kommunikationssystemen ohne domänenübergreifende Probleme zu registrieren.

OpenFrame hat zwei wichtige Teile. Einer wohnt in ServiceNow Anwendung (als TopFrame bezeichnet) und diese API, die aus der Partneranwendung bezogen wird. Diese API verfügt über die erforderlichen Methoden, um mit TopFrame zu kommunizieren und die visuellen Funktionen von zu steuern OpenFrame .

Hinweis:

Um in Bezug auf die OpenFrame-Bibliothek aktuell zu bleiben, verwenden Sie den folgenden Ressourcen-URI: https://[servicenow-Instanz]/scripts/openframe/latest/openFrameAPI.min.js.

OpenFrameAPI – getAWAAgentPresence(Zeichenfolgeerfolg, Zeichenfolgenfehler)

Gibt den aktuellen Anwesenheitsstatus des angemeldeten Service Desk-Mitarbeiters zurück.

Tabelle : 1. Parameter

Name	Typ	Beschreibung
Erfolg	Zeichenfolge	Wenn die Methode erfolgreich ist, Name der aufzurufenden Rückruffunktion.
Fehler	Zeichenfolge	Wenn die Methode fehlschlägt, Name der aufzurufenden Rückruffunktion.

Tabelle : 2. Rückgaben

Typ	Beschreibung
Anwesenheit	Ergebnisse, die von der openFrame-Infrastruktur an die Funktion „erfolgreicher Rückruf“ übergeben wurden. Datentyp: Objekt "presence": { "available": Boolean, "channels": [Array], "name": "String", "sys_id": "String" }
Anwesenheit.verfügbar	Kennzeichnung, die angibt, ob der zugeordnete Agent verfügbar ist. Gültige Werte: Wahr: Service Desk-Mitarbeiter ist verfügbar. Falsch: Service Desk-Mitarbeiter ist nicht verfügbar. Datentyp: Boolesch
presence.channels	Liste der verfügbaren Kommunikationskanäle mit dem Service Desk-Mitarbeiter. Datentyp: Array von Objekten "channels": [ { "available": Boolean, "name": "String", "restrict_update": Boolean, "service_channel_type": "String", "sys_id": "String" } ]
presence.channels.available	Kennzeichnung, die angibt, ob der Kanal verfügbar ist. Gültige Werte: Wahr: Kanal ist verfügbar. Falsch: Kanal ist nicht verfügbar. Datentyp boolesch
presence.channels.name	Name des Kanals, z. B. Chat oder Telefon. Datentyp: Zeichenfolge
presence.channels.restrict_update	Kennzeichnung, die angibt, ob der Anwender Updates auf den Kanal beschränken kann. Gültige Werte: Wahr: Der Anwender kann Aktualisierungen auf den Kanal beschränken. Falsch: Der Anwender kann Aktualisierungen nicht auf den Kanal beschränken. Datentyp boolesch
presence.channels.service_channel_type	Typ des Servicekanals. Datentyp: Zeichenfolge
presence.channels.sys_id	SYS_ID des Kanaldatensatzes. Datentyp: Zeichenfolge Tabelle: Servicekanäle [Awa_Service_Channel]
presence.name	Name des Anwesenheitsstatus des Service Desk-Mitarbeiters. Datentyp: Zeichenfolge
Presence.sys_ID	SYS_ID des Anwesenheitsstatusdatensatzes. Datentyp: Zeichenfolge Tabelle: Anwesenheitsstatus [Awa_presence_State]

Das folgende Codebeispiel zeigt, wie diese Methode aufgerufen wird.

function failure(data)
{
  console.log("failure: " + JSON.stringify(data));
}
 
function success(data)
{
  console.log("success: " + JSON.stringify(data));
}
 
openFrameAPI.getAWAAgentPresence(success, failure)

Antwort auf erfolgreiche Rückruffunktion:

success: { 
  "presence": { 
    "name": "Available", 
    "sys_id": "0b10223c57a313005baaaa65ef94f970", 
    "available": true, 
    "channels": [ 
      { 
        "name": "Chat", 
        "available": true, 
        "sys_id": "27f675e3739713004a905ee515f6a7c3", 
        "restrict_update": false, 
        "service_channel_type": "chat" 
      } 
    ] 
  } 
}

openFrameAPI – hide()

Blendet den OpenFrame im TopFrame aus.

Tabelle : 3. Parameter

Name	Typ	Beschreibung
Keine

Tabelle : 4. Ergebnisse

Typ	Beschreibung
void

openFrameAPI.hide()

openFrameAPI – init(Object config, function successCallback, function failureCallback)

Initialisiert OpenFrame. Dies muss die erste Methode sein, die Sie aufrufen.

Diese Methode initialisiert die Kommunikation mit TopFrame und initialisiert alle visuellen Elemente, die in übergeben werden configParameter.

Tabelle : 5. Parameter

Name	Typ	Beschreibung
Konfiguration	Objekt	Name-Wert-Paare, die während des Initialisierungsprozesses verwendet werden sollen. Mögliche Schlüssel: height Untertitel Titel TitleIcon width Alle Schlüssel sind optional. Übergeben Sie ein leeres Objekt, wenn Sie diese Schlüssel-Wert-Paare nicht festlegen möchten.
successCallback	Funktion	Name der Rückruffunktion, die verwendet werden soll, wenn Init Methode erfolgreich. Die OpenFrame-Konfiguration Im System gespeicherte Daten werden als Parameter an die Rückruffunktion übergeben.
failureCallback	Funktion	Name der Rückruffunktion, die verwendet werden soll, wenn Init Methode schlägt fehl.

Tabelle : 6. Rückgaben

Typ	Beschreibung
void

var config = {
height: 300,
width: 200
}
function handleCommunicationEvent(context) {
console.log("Communication from Topframe", context);
}
function initSuccess(snConfig) {
console.log("openframe configuration", snConfig);
//register for communication event from TopFrame
openFrameAPI.subscribe(openFrameAPI.EVENTS.COMMUNICATION_EVENT,
handleCommunicationEvent);
}
function initFailure(error) {
console.log("OpenFrame init failed...", error);
}
openFrameAPI.init(config, initSuccess, initFailure);

openFrameAPI – isVisible(function callback)

Überprüft, ob der OpenFrame im TopFrame sichtbar ist.

Tabelle : 7. Parameter

Name	Typ	Beschreibung
callback	function	Die Callback-Funktion empfängt einen Parameter mit dem Wert „true“ oder „false“. „True“, wenn OpenFrame sichtbar ist, und „false“, wenn nicht sichtbar.

Tabelle : 8. Ergebnisse

Typ	Beschreibung
void

function callback(isVisible) {
console.log(isVisible)
}
openFrameAPI.isVisible(callback)

openFrameAPI - openCustomURL(String details)

Öffnet eine anwenderdefinierte URL in der UI16-Schnittstelle.

Tabelle : 9. Parameter

Name	Typ	Beschreibung
URL	Zeichenfolge	Text der anwenderdefinierten URL. Maximale Größe: 2083 Zeichen

Tabelle : 10. Rückgaben

Typ	Beschreibung
void

openFrameAPI.openCustomURL('10_cool_things.do');

openFrameAPI – openServiceNowForm(Object details)

Öffnet eine Formular-URL.

Wenn ein Agent einen eingehenden Anruf erhält, werden im OpenFrame-Fenster Informationen wie Account, Kontakt oder Verbraucher angezeigt. Durch Klicken auf einen Link im OpenFrame-Fenster wird der entsprechende Datensatz angezeigt.

• In der Plattform-Schnittstelle öffnet diese API eine Formular-URL im TopFrame.
• Für Mitarbeiterbereich unterstützt diese API die Verwaltung der Interaktionsregisterkarte. In Mitarbeiterbereich wird ein Interaktionsdatensatz auf einer übergeordneten Registerkarte geöffnet, und der angegebene Entitätsdatensatz wird auf einer untergeordneten Registerkarte unter der Interaktionsregisterkarte geöffnet.

Tabelle : 11. Parameter

Name	Typ	Beschreibung
details	Objekt	Schlüssel-Wert-Paare, die die zu öffnende Formular-URL identifizieren. "details": { "entity": "String"; "interaction_sys_id": "String"; "query": "String" }
details.entity	Zeichenfolge	Tabellen- oder Entitätsname.
details.interaction_sys_id	Zeichenfolge	Optional. SYS_ID des Interaktionsdatensatzes, der als übergeordnete Registerkarte in geöffnet werden soll Mitarbeiterbereich. Hinweis: In der Plattform-Schnittstelle wird interaction_sys_id ignoriert.
details.query	Zeichenfolge	Abfrage, um den zu öffnenden Datensatz zu identifizieren, z. B.: query:'sys_id=<record_sys_id>'.

Tabelle : 12. Rückgaben

Typ	Beschreibung
void

Das folgende Beispiel zeigt die grundlegende Verwendung in Plattform:

openFrameAPI.openServiceNowForm({entity:'customer_account', 
query:'sys_id=447832786f0331003b3c498f5d3ee452', 'interaction_sys_id':'3be092313b711300758ce9b534efc4dd'});

Das folgende Beispiel zeigt die Verwendung von queryParameter zum Erstellen eines neuen Datensatzes mit Daten, die im Formular bereitgestellt werden, mithilfe von „sysparm_query“ und einer codierten Abfrage zum Ausfüllen der Felder „vor- und Nachname“ im Arbeitsbereich:

openFrameAPI.openServiceNowForm({ entity: 'sys_user',
query: 'sys_id=-1&sysparm_query=first_name=Ivan^last_name=Greggor' });

OpenFrameAPI – openServiceNowFormwithChildTab()

Öffnet einen ServiceNow Formular mit einer untergeordneten Registerkarte, wenn sie in einem Arbeitsbereich aufgerufen wird, oder öffnet eine Entität, wenn sie in der UI16-Schnittstelle aufgerufen wird.

Tabelle : 13. Parameter

Name	Typ	Beschreibung
OpenServiceNowFormwithChildTab	Objekt	Definiert, ob die API einen öffnet ServiceNow Formular mit einer untergeordneten Registerkarte, wenn sie in einem Arbeitsbereich aufgerufen wird, oder öffnet eine Entität, wenn sie in der UI16-Schnittstelle aufgerufen wird. openFrameAPI.openServiceNowFormwithChildTab({ entity: "String", sys_id: String", parent_entity: "String", parent_entity_sys_id: "String" })
OpenServiceNowFormwithChildTab.Entität	Zeichenfolge	Name der Tabelle, die den zu öffnenden Datensatz enthält.
OpenServiceNowFormwithChildTab.sys_ID	Zeichenfolge	SYS_ID des zu öffnenden Datensatzes.
OpenServiceNowFormwithChildTab.parent_Entity	Zeichenfolge	Name der Tabelle, die als übergeordnete Registerkarte geöffnet werden soll.
OpenServiceNowFormwithChildTab.parent_Entity_sys_ID	Zeichenfolge	SYS_ID des zu öffnenden übergeordneten Datensatzes.

Tabelle : 14. Rückgaben

Typ	Beschreibung
Keine

Das folgende Beispiel öffnet die übergeordnete Entität als übergeordnete Registerkarte in einem konfigurierten Arbeitsbereich oder öffnet nur die Entität, wenn sie in UI16 aufgerufen wird.

openFrameAPI.openServiceNowFormwithChildTab({
  entity: "customer_account", 
  sys_id: "447832786f0331003b3c498f5d3ee452", 	
  parent_entity: "interaction", 
  parent_entity_sys_id: "3be092313b711300758ce9b534efc4dd"
});

openFrameAPI – openServiceNowList(Object details)

Öffnet eine Listen-URL in der UI16-Schnittstelle.

Tabelle : 15. Parameter

Name	Typ	Beschreibung
details	Objekt	Schlüssel-Wert-Paare, die den Inhalt beschreiben, der beim Öffnen der Listen-URL verwendet werden soll. Gültige Werte: Entität: Tabellenname Abfrage: Codierte Abfragezeichenfolge

Tabelle : 16. Rückgaben

Typ	Beschreibung
void

openFrameAPI.openServiceNowList({entity:'case', query:'active=true'});

openFrameAPI - setFrameMode(mode)

Legt den OpenFrame-Modus fest.

Der in dieser API übergebene Modus:

• Legt das entsprechende Symbol im Header fest: reduzieren oder erweitern.
• Löst das relevante Event für CTI aus:
  • openFrameAPI.EVENTS.COLLAPSE
  • openFrameAPI.EVENTS.EXPAND

Tabelle : 17. Parameter

Name	Typ	Beschreibung
Modus	Zeichenfolge	Legen Sie den OpenFrame-Modus fest. Aufgelistete Optionen: openFrameAPI.FRAME_MODE.COLLAPSE openFrameAPI.FRAME_MODE.EXPAND

Tabelle : 18. Ergebnisse

Typ	Beschreibung
void

openFrameAPI.setFrameMode(openFrameAPI.FRAME_MODE.COLLAPSE);

openFrameAPI - setHeight(height)

Legt die OpenFrame-Höhe fest.

Tabelle : 19. Parameter

Name	Typ	Beschreibung
Höhe	Nummer	Höhe in Pixel

Tabelle : 20. Ergebnisse

Typ	Beschreibung
void

openFrameAPI.setHeight(100);

OpenFrameAPI – setICContext(Zeichenfolgentyp, Objekt-<Context>)

Legt die Kontextdaten im Zusammenhang mit den Interaktionssteuerungen auf dem Client fest. Verwenden Sie diese Kontextdaten, um die Client-UI zu bestimmen, die in OpenFrame angezeigt werden soll.

Weitere Informationen zu interaktiven Steuerungen finden Sie unter Interaction Controls Component.

Weitere Informationen zu Interaktionsdatensätzen finden Sie unter CSM voice interaction record page.

Tabelle : 21. Parameter

Name	Typ	Beschreibung
Typ	Zeichenfolge	Typ der festzulegenden Kontextdaten. Gültige Werte: ActiveCall: Legt den Kontext für die Komponente „laufender aktiver Anruf“ fest. Wenn Sie diesen Kontexttyp übergeben, müssen Sie auch übergeben ActiveCall[] JSON als ContextParameter. IdleState: Legt die Leerlaufstatusfähigkeiten für den aktuellen Anwender fest. Wenn diese Option festgelegt ist, wird die UI für den Leerlaufstatus (Wähltastatus) in OpenFrame angezeigt. Wenn Sie diesen Kontexttyp übergeben, müssen Sie auch übergeben <idleState>{} JSON als ContextParameter. SearchTargetList: Legt den Telefonverzeichniskontext fest. Wenn dies festgelegt ist, wird aktiviert Anruf weiterleiten In der Komponente „aktiver Anruf“. Wenn Sie diesen Kontexttyp übergeben, müssen Sie auch übergeben SearchTargetList[] JSON als ContextParameter.
<Context>	Objekt	Festzulegende Kontextdaten. Jeder Kontextdatentyp hat einen anderen Satz möglicher Eingabedaten. Gültig ContextDatenobjekte: activeCall <idleState> searchTargetList
activeCall	Array von Objekten	Details zu einem aktiven Anruf. Jedes Objekt stellt einen laufenden aktiven Anruf dar. "activeCall": [ { "currentParticipant": {Object}, "customPayload: {Object}, "direction": "String", "externalId": "String", "nowRecordId": "String", "nowRecordTable": "String", "participants": [Array], "type": "String" } ]
ActiveCall.currentTeilnehmer	Objekt	Erforderlich. Details zu den Anruffähigkeiten und dem Anrufstatus des aktuellen Teilnehmers. "currentParticipant": { "actor": "String", "callStartTime": "String", "capabilities": {Object}, "connectedTime": "String", "custom-capability-state-1": Boolean, "flagged": Boolean, "held": Boolean, "id": "String", "muted": Boolean, "name": "String", "paused": Boolean, "recording": "String", "state": "String", "wrapUP": {Object} }
ActiveCall.currentTeilnehmer.​Akteur	Zeichenfolge	Typ des Teilnehmers im Anruf. Gültige Werte: Service Desk-Mitarbeiter Hinweis: Andere Teilnehmertypen, die in der Zukunft hinzugefügt werden sollen.
ActiveCall.currentTeilnehmer.​CallStartTime	Zeichenfolge	Datum und Uhrzeit des Beginns des Anrufs. Zeitstandard: UTC Format: RSS – „<Wochentag>, TT mmm jjjj hh:MM:ss GMT“. Beispiel: „Mi, 17 Dez 2024 05:23:41 GMT“
ActiveCall.currentTeilnehmer.​Fähigkeiten	Objekt	Details zu den Fähigkeiten, die der aktuelle Teilnehmer (Service Desk-Mitarbeiter) während eines Anrufs ausführen kann. Die zugehörigen Symbole werden in der Komponente „aktiver Anruf“ für die aktivierten Fähigkeiten angezeigt. "capabilities": { "dtmf": Boolean, "endCall": Boolean, "flag": Boolean, "hold": Boolean, "leaveAndTransfer": Boolean, "mergeCall": Boolean, "mute": Boolean, "resumeRecording": Boolean, "pauseRecording": Boolean, "startRecording": Boolean, "stopRecording": Boolean, "transfer": Boolean }
ActiveCall.currentTeilnehmer.​Fähigkeiten. ​dtmf	Boolean	Kennzeichnung, die angibt, ob der Service Desk-Mitarbeiter für den aktuellen Anruf über die Funktion „Dual Tone MultiFrequency“ (DTMF) verfügt. Gültige Werte: Wahr: Teilnehmer hat DTMF-Fähigkeit. Falsch: Teilnehmer hat keine DTMF-Fähigkeit. Standardwert: false
ActiveCall.currentTeilnehmer.​Fähigkeiten. ​EndCall	Boolean	Kennzeichnung, die angibt, ob der zugeordnete Teilnehmer den Anruf beenden kann. Gültige Werte: Wahr: Der Teilnehmer kann den Anruf beenden. Die Schaltfläche „Anruf beenden“ ist in der Anwenderoberfläche aktiviert. Falsch: Teilnehmer kann den Anruf nicht beenden. Die Schaltfläche „Anruf beenden“ ist in der Anwenderoberfläche deaktiviert. Standardwert: false
ActiveCall.currentTeilnehmer.​Fähigkeiten. ​Kennzeichnung	Boolean	Kennzeichnung, die angibt, ob der Teilnehmer den Anruf für Qualitätsprobleme kennzeichnen kann, z. B. Probleme mit der Sprachqualität. Gültige Werte: Wahr: Teilnehmer kann Problemanrufe kennzeichnen. Falsch: Teilnehmer kann keine Problemanrufe kennzeichnen. Standardwert: false
ActiveCall.currentTeilnehmer.​Fähigkeiten. ​Halten	Boolean	Kennzeichnung, die angibt, ob der Teilnehmer den Anruf in den Wartestatus setzen kann. Gültige Werte: Wahr: Der Teilnehmer kann den Anruf auf „Warten“ setzen. Die Schaltfläche Halten ist in der Anwenderoberfläche aktiviert. Falsch: Der Teilnehmer kann den Anruf nicht in den Warteschleife setzen. Die Schaltfläche Halten ist in der Anwenderoberfläche deaktiviert. Standardwert: false
ActiveCall.currentTeilnehmer.​Fähigkeiten. ​LeaseAndTransfer	Boolean	Kennzeichnung, die angibt, ob der Teilnehmer den Anruf an einen anderen Service Desk-Mitarbeiter weiterleiten und dann den Anruf abgeben kann. Aktivieren Sie diese Fähigkeit für Aktionen wie Konsultationsübertragungen, bei denen der konsultierte Anwender nicht der Besitzer des Anrufs ist. Gültige Werte: Wahr: Der Teilnehmer kann den Anruf weiterleiten und abgeben. Falsch: Teilnehmer kann den Anruf nicht weiterleiten und abgeben. Standardwert: false
ActiveCall.currentTeilnehmer.​Fähigkeiten. ​MergeCall	Boolean	Kennzeichnung, die angibt, ob der Teilnehmer den Anruf zusammenführen kann. Verwenden Sie diese Fähigkeit, wenn die Anrufabschnitte des Teilnehmers zusammengeführt werden können. Gültige Werte: Wahr: Der Teilnehmer kann den Anruf zusammenführen. Die Schaltfläche Zusammenführen ist in der Anwenderoberfläche aktiviert. Falsch: Teilnehmer kann den Anruf nicht zusammenführen. Die Schaltfläche „Zusammenführen“ ist in der Anwenderoberfläche deaktiviert. Standardwert: false
ActiveCall.currentTeilnehmer.​Fähigkeiten. ​Stummschalten	Boolean	Kennzeichnung, die angibt, ob der Teilnehmer den Anruf stummschalten kann. Gültige Werte: Wahr: Der Teilnehmer kann den Anruf stummschalten. Die Stummschaltfläche ist in der Anwenderoberfläche aktiviert. Falsch: Teilnehmer kann den Anruf nicht stummschalten. Die Stummschaltfläche ist in der Anwenderoberfläche deaktiviert. Standardwert: false
ActiveCall.currentTeilnehmer.​Fähigkeiten. ​Aufzeichnung fortsetzen	Boolean	Kennzeichnung, die angibt, ob der Teilnehmer die Aufzeichnung des Anrufs fortsetzen kann. Gültige Werte: Wahr: Der Teilnehmer kann die Aufzeichnung des Anrufs fortsetzen. Die Schaltfläche „Aufzeichnung anhalten“ ist in der Anwenderoberfläche aktiviert. Falsch: Teilnehmer kann die Aufzeichnung des Anrufs nicht fortsetzen. Die Schaltfläche „Aufzeichnung anhalten“ ist in der Anwenderoberfläche deaktiviert. Standardwert: false
ActiveCall.currentTeilnehmer.​Fähigkeiten. ​PauseRecording	Boolean	Kennzeichnung, die angibt, ob der Teilnehmer die Aufzeichnung des Anrufs anhalten kann. Gültige Werte: Wahr: Der Teilnehmer kann die Aufzeichnung des Anrufs anhalten. Die Schaltfläche „Aufzeichnung anhalten“ ist in der Anwenderoberfläche aktiviert. Falsch: Teilnehmer kann die Aufzeichnung des Anrufs nicht anhalten. Die Schaltfläche „Aufzeichnung anhalten“ ist in der Anwenderoberfläche deaktiviert. Standardwert: false
ActiveCall.currentTeilnehmer.​Fähigkeiten. ​StartRecording	Boolean	Kennzeichnung, die angibt, ob der Teilnehmer mit der Aufzeichnung des Anrufs beginnen kann. Gültige Werte: Wahr: Der Teilnehmer kann mit der Aufzeichnung des Anrufs beginnen. Die Schaltfläche „Aufzeichnung“ ist in der Anwenderoberfläche aktiviert. Falsch: Teilnehmer kann die Aufzeichnung des Anrufs nicht starten. Die Schaltfläche „Aufzeichnung“ ist in der Anwenderoberfläche deaktiviert. Standardwert: false
ActiveCall.currentTeilnehmer.​Fähigkeiten. ​Aufzeichnung stoppen	Boolean	Kennzeichnung, die angibt, ob der Teilnehmer die Aufzeichnung des Anrufs beenden kann. Gültige Werte: Wahr: Der Teilnehmer kann die Aufzeichnung des Anrufs beenden. Die Schaltfläche „Aufzeichnung stoppen“ ist in der Anwenderoberfläche aktiviert. Falsch: Teilnehmer kann die Aufzeichnung des Anrufs nicht stoppen. Die Schaltfläche „Aufzeichnung stoppen“ ist in der Anwenderoberfläche deaktiviert. Standardwert: false
ActiveCall.currentTeilnehmer.​Fähigkeiten. ​Übertragen	Boolean	Kennzeichnung, die angibt, ob der Teilnehmer den Anruf weiterleiten kann. Gültige Werte: Wahr: Der Teilnehmer kann den Anruf weiterleiten. Die Schaltfläche „Übertragen“ ist in der Anwenderoberfläche aktiviert. Falsch: Teilnehmer kann den Anruf nicht weiterleiten. Die Schaltfläche „Übertragen“ ist in der Anwenderoberfläche deaktiviert. Standardwert: false
ActiveCall.currentTeilnehmer.​ConnectedTime	Zeichenfolge	Datum und Uhrzeit der anfänglichen Verbindung des Anrufs. Zeitbasis: UTC Format: RSS – „<Wochentag>, TT mmm jjjj hh:MM:ss GMT“. Beispiel: „Mi, 17 Dez 2024 05:23:41 GMT“
ActiveCall.currentTeilnehmer.​Anwenderdefinierte Fähigkeit-Status-1	Boolean	Kennzeichnung, die angibt, ob der Anruf aktuelle Teilnehmer hat. Gültige Werte: Wahr: Aktuelle Teilnehmer des Anrufs. Falsch: Keine aktuellen Teilnehmer im Anruf. Standardwert: false
ActiveCall.currentTeilnehmer.​Gekennzeichnet	Boolean	Kennzeichnung, die angibt, ob der Anruf für ein Problem gekennzeichnet ist, z. B. ein Problem mit der Sprachqualität. Gültige Werte: Wahr: Anruf wurde für ein Problem gekennzeichnet. Falsch: Anruf wurde für ein Problem nicht gekennzeichnet. Standardwert: false
ActiveCall.currentTeilnehmer.​Gehalten	Boolean	Kennzeichnung, die den Status „Angehalten“ des Teilnehmers angibt. Gültige Werte: Wahr: Teilnehmer ist in der Warteschleife. Falsch: Teilnehmer ist nicht in der Warteschleife. Standardwert: false
ActiveCall.currentTeilnehmer.​id	Zeichenfolge	Erforderlich. SYS_ID des zugehörigen Teilnehmerdatensatzes, z. B. die sys_ID des Service Desk-Mitarbeiters. Tabelle: Benutzer [sys_user]
ActiveCall.currentTeilnehmer.​Stummgeschaltet	Boolean	Kennzeichnung, die den stummgeschalteten Status des Teilnehmers angibt. Gültige Werte: Wahr: Teilnehmer ist stummgeschaltet. Falsch: Teilnehmer ist nicht stummgeschaltet. Standardwert: false
ActiveCall.currentTeilnehmer.​Name	Zeichenfolge	Name des Teilnehmers.
ActiveCall.currentTeilnehmer.​Angehalten	Boolean	Kennzeichnung, die den Status „Angehalten“ des Teilnehmers angibt. Gültige Werte: Wahr: Teilnehmer ist angehalten. Falsch: Teilnehmer ist nicht angehalten. Standardwert: false
ActiveCall.currentTeilnehmer.​Aufzeichnung	Zeichenfolge	Aktueller Aufzeichnungsstatus des Anrufs. Gültige Werte: in_progress Keine
ActiveCall.currentTeilnehmer.​Nachbearbeitung	Objekt	Zukünftige Verwendung.
ActiveCall.customPayload	Objekt	Anwenderdefinierte Nutzlast, die als Teil von Open Frame-Ereignissen an OpenFrame übergeben werden soll. Dies ist ein Freiformobjekt und kann alle Daten enthalten, die zum Anpassen der aktiven Anrufkomponente erforderlich sind, z. B. das Hinzufügen von Schaltflächen oder Text.
ActiveCall.direction	Zeichenfolge	Richtung des Anrufs für den zugehörigen Teilnehmer. Gültige Werte: eingehend outbound
AktiveCall.externalId		Erforderlich. Eindeutiger Wert, der den aktuellen aktiven Anruf im zugehörigen externen System identifiziert.
ActiveCall. ​NowRecordId	Zeichenfolge	Erforderlich. SYS_ID des aktiven Anrufdatensatzes. Tabelle: Nur Interaktion [Interaktion] unterstützte Option für Basissystem.
ActiveCall. ​NowRecordTable	Zeichenfolge	Erforderlich. Tabelle, zu der der aktive Anruf gehört. Tabelle: Nur Interaktion [Interaktion] unterstützte Option für Basissystem.
ActiveCall. ​Teilnehmer	Array von Objekten	Erforderlich. Liste der zusätzlichen Teilnehmer des Anrufs. Ein Teilnehmer kann ein Service Desk-Mitarbeiter, ein Kunde, eine externe Person, die kein Service Desk-Mitarbeiter oder Kunde ist, oder eine Warteschlange sein. "participants": [ { "actor": "String", "ani": "String", "address": "String", "capabilities": {Object}, "callStartTime" "String", "connectedTime": "String", "customPayload": {Object}, "dnis": "String", "held": Boolean, "heldAtTime": "String", "id": "String", "muted": Boolean, "name": "String", "requestACW": Boolean, "requireWrapup": Boolean, "state": "String" } ]
ActiveCall. ​Teilnehmer. ​Akteur	Zeichenfolge	Typ des Akteurs für den zugeordneten Teilnehmer. Zum Beispiel: Service Desk-Mitarbeiter Kunde external Warteschlange
ActiveCall. ​Teilnehmer. ​ani		Automatische Nummernidentifizierung. Telefonnummer, die dem Empfänger des Telefonanrufs angezeigt werden soll.
ActiveCall. ​Teilnehmer. ​Adresse	Zeichenfolge	Telefonnummer des Teilnehmers.
ActiveCall. ​Teilnehmer. ​Fähigkeiten	Objekt	Details zum Typ der Fähigkeiten, die der Teilnehmer für den zugehörigen Anruf hat. "capabilities": { "endCall": Boolean, "hold": Boolean, "mute": Boolean }
ActiveCall. ​Teilnehmer. ​Fähigkeiten. ​EndCall	Boolean	Kennzeichnung, die angibt, ob der zugeordnete Teilnehmer den Anruf beenden kann. Gültige Werte: Wahr: Der Teilnehmer kann den Anruf beenden. Die Schaltfläche „Anruf beenden“ ist in der Anwenderoberfläche aktiviert. Falsch: Teilnehmer kann den Anruf nicht beenden. Die Schaltfläche „Anruf beenden“ ist in der Anwenderoberfläche deaktiviert. Standardwert: false
ActiveCall. ​Teilnehmer. ​Fähigkeiten. ​Halten	Boolean	Kennzeichnung, die angibt, ob der Teilnehmer den Anruf in den Wartestatus setzen kann. Gültige Werte: Wahr: Der Teilnehmer kann den Anruf auf „Warten“ setzen. Die Schaltfläche Halten ist in der Anwenderoberfläche aktiviert. Falsch: Der Teilnehmer kann den Anruf nicht in den Warteschleife setzen. Die Schaltfläche Halten ist in der Anwenderoberfläche deaktiviert. Standardwert: false
ActiveCall. ​Teilnehmer. ​Fähigkeiten. ​Stummschalten	Boolean	Kennzeichnung, die angibt, ob der Teilnehmer den Anruf stummschalten kann. Gültige Werte: Wahr: Der Teilnehmer kann den Anruf stummschalten. Die Stummschaltfläche ist in der Anwenderoberfläche aktiviert. Falsch: Teilnehmer kann den Anruf nicht stummschalten. Die Stummschaltfläche ist in der Anwenderoberfläche deaktiviert. Standardwert: false
ActiveCall. ​Teilnehmer. ​ConnectedTime	Zeichenfolge	Erforderlich. Datum und Uhrzeit, zu der der Teilnehmer anfänglich mit dem Anruf verbunden war. Zeitstandard: UTC Format: RSS – „<Wochentag>, TT mmm jjjj hh:MM:ss GMT“. Beispiel: „Mi, 17 Dez 2024 05:23:41 GMT“
ActiveCall. ​Teilnehmer. ​CustomPayload	Objekt	Anwenderdefinierte Nutzlast, die als Teil anwenderdefinierter Open Frame-Ereignisse an OpenFrame übergeben werden soll. Dies ist ein Freiformobjekt und kann alle Daten enthalten, die zum Anpassen der Komponente „aktiver Anruf“ erforderlich sind, z. B. das Hinzufügen von Schaltflächen oder Text.
ActiveCall. ​Teilnehmer. ​dnis	Zeichenfolge	Identifizierungsservice Für Gewählte Nummer. Telefonnummer, die der Teilnehmer gewählt hat.
ActiveCall. ​Teilnehmer. ​Gehalten	Boolean	Kennzeichnung, die den Status „Angehalten“ des Teilnehmers angibt. Gültige Werte: Wahr: Teilnehmer ist in der Warteschleife. Falsch: Teilnehmer ist nicht in der Warteschleife. Standardwert: false
ActiveCall. ​Teilnehmer. ​HeldAtTime	Zeichenfolge	Datum und Uhrzeit, zu der die Verbindung des Teilnehmers zum Anruf angehalten wurde. Zeitbasis: UTC Format: RSS – „<Wochentag>, TT mmm jjjj hh:MM:ss GMT“. Beispiel: „Mi, 17 Dez 2024 05:23:41 GMT“
ActiveCall. ​Teilnehmer. ​id	Zeichenfolge	Erforderlich. Eindeutige ID des Teilnehmers aus dem CCaaS-System (Contact Center as a Service).
ActiveCall. ​Teilnehmer. ​Stummgeschaltet	Boolean	Kennzeichnung, die den Stummschaltungsstatus des Teilnehmers angibt. Gültige Werte: Wahr: Teilnehmer ist stummgeschaltet. Falsch: Teilnehmer ist nicht stummgeschaltet. Standardwert: false
ActiveCall. ​Teilnehmer. ​Name	Zeichenfolge	Name des Teilnehmers.
ActiveCall. ​Teilnehmer. ​AnforderungsACW	Boolean	Nur für Anwendungsfall für Service Desk-Mitarbeiter: Nur gültig, wenn activeCall.currentParticipant.actorIst „Agent“. Kennzeichnung, die angibt, ob der Teilnehmer mit dem Kunden sprechen muss. Gültige Werte: Wahr: Nachverfolgung erforderlich. Falsch: Keine Nachverfolgung erforderlich. Standardwert: false
ActiveCall. ​Teilnehmer. ​Erforderliche Nachbearbeitung	Boolean	Nur für Anwendungsfall für Service Desk-Mitarbeiter: Nur gültig, wenn activeCall.currentParticipant.actorIst „Agent“. Kennzeichnung, die angibt, ob angezeigt werden soll Abschluss Komponente, sobald der Anruf abgeschlossen ist. Gültige Werte: Wahr: Zeigen Sie an Abschluss Komponente bei Abschluss des Anrufs. Falsch: Nicht anzeigen Abschluss Komponente bei Abschluss des Anrufs. Standardwert: false
ActiveCall. ​Teilnehmer. ​status	Zeichenfolge	Status der Anrufstrecke des Teilnehmers. Wird unter der Telefonnummer in angezeigt Aktiver Anruf Komponente. Dies kann ein beliebiger aussagekräftiger Text sein, z. B.: Warnungen Verbunden Klingelnd
ActiveCall.type	Zeichenfolge	Typ des Anrufs. Gültige Werte: Anruf Rückrufanforderung Voicemail
<idleState>	Objekt	Beschreibt den Leerlaufstatuskontext des Service Desk-Mitarbeiters. Diese Kontextdaten bestimmen die Informationen, die auf der Wähltastatur angezeigt werden, wenn ein Service Desk-Mitarbeiter auf einen Anruf wartet, und die Fähigkeiten, die er über diese Wähltastatur hat. <idleState> { "capability": {Object}, "currentInboundId": "String", "dialpadInfoMessage": {Object}, "enableState": {Object} }
<idleState>.Fähigkeit	Objekt	Beschreibung der Leerlaufstatus-Fähigkeiten des aktuellen Anwenders. "capability": { "globalContactSearch": Boolean, "logOut": Boolean, "outBoundCall": Boolean }
<idleState>.Fähigkeit. ​GlobalContactSerarch	Boolean	Kennzeichnung, die angibt, ob die globale Kontaktliste im Leerlauf angezeigt werden soll. Gültige Werte: Wahr: Zeigt die globale Kontaktliste an. Falsch: Globale Kontaktliste nicht anzeigen. Standardwert: false
<idleState>.Fähigkeit. ​Melden Sie sich ab	Boolean	Kennzeichnung, die angibt, ob sich der Anwender im Leerlauf abmelden kann. Gültige Werte: Wahr: Der Anwender kann sich abmelden, wenn der Anruf inaktiv ist. Die Schaltfläche Abmelden wird auf der Wähltastatur angezeigt. Falsch: Anwender kann sich nicht abmelden, wenn der Anruf inaktiv ist. Standardwert: false
<idleState>.Fähigkeit. ​OutBoundCall	Boolean	Kennzeichnung, die angibt, ob der Anwender im Leerlauf einen ausgehenden Anruf tätigen kann. Gültige Werte: Wahr: Der Anwender kann einen ausgehenden Anruf tätigen, wenn der Anruf inaktiv ist. Falsch: Der Anwender kann keinen ausgehenden Anruf tätigen, wenn der Anruf inaktiv ist. Standardwert: false
<idleState>. ​CurrentInlimitId	Zeichenfolge	Eingehender Bezeichner der Anbieteranwendung, die zum Erstellen der Interaktion mit dem ausgehenden Anruf verwendet wird. Tabelle: Befindet sich im ID-Feld der Tabelle „Identitäten des Anbieterkanals“ [sys_cs_Provider_Application]. Standard: Basissystemanbieter-Anwendung
<idleState>. ​DialpadInfoMessage	Objekt	Details zur Informationsnachricht, die auf der Wähltastatur des Anwenders angezeigt werden soll, z. B. die aktuell ausgewählte Warteschlange. "dialpadInfoMessage": { "label": "String", "value": "String" } Im folgenden Beispiel labelIst Ausgewählte Warteschlange: Und valueIst Kundenanfragen . Sie können auch einfach entweder verwenden labelOder valueParameter mit Ausgewählte Warteschlange: Kundenanfragen .
<idleState>. ​DialpadInfoMessage. ​Bezeichnung	Zeichenfolge	Freiform-Bezeichnung, die auf der Wähltastatur angezeigt werden soll.
<idleState>. ​DialpadInfoMessage. ​Wert	Zeichenfolge	Freiform-Nachrichtentext, der nach der Bezeichnung auf der Wähltastatur angezeigt werden soll.
<idleState>. ​AktivierenStatus	Objekt	Details zum Aktivierungsstatus der Schaltflächen auf der Wähltastatur. "enableState": { "logOut": Boolean, "outBoundCall": Boolean }
<idleState>. ​AktivierenStatus. ​Melden Sie sich ab	Boolean	Kennzeichnung, die angibt, ob die Schaltfläche „Abmelden“ in der Anwenderoberfläche im Leerlauf aktiviert werden soll. Gültige Werte: Wahr: Zeigt die Schaltfläche „Abmelden“ an, während sich der Leerlauf befindet. Falsch: Die Schaltfläche „Abmelden“ im Leerlauf nicht anzeigen. Standardwert: false
<idleState>. ​AktivierenStatus. ​OutBoundCall	Boolean	Kennzeichnung, die angibt, ob die Schaltfläche „ausgehender Anruf“ in der Anwenderoberfläche aktiviert werden soll, während sie sich im Leerlauf befindet. Gültige Werte: Wahr: Schaltfläche „ausgehender Anruf“ im Leerlauf anzeigen. Falsch: Die Schaltfläche „ausgehender Anruf“ im Leerlauf nicht anzeigen. Standardwert: false
searchTargetList	Array von Objekten	Details der übertragungsbezogenen Daten für einen ServiceNow Tabelle. "searchTargetList": [ { "externalId": "String", "nowRecordId": "String", "nowRecordTable": "String", "participantID": "String", "targets": [Array] } ]
SearchTargetList. ​ExternalID	Zeichenfolge	Eindeutiger Bezeichner des zugehörigen Aufrufs im CCaaS-System.
SearchTargetList. ​NowRecordId	Zeichenfolge	Erforderlich. SYS_ID des Datensatzes, zu dem die searchTargetList gehört. Hinweis: Derzeit werden nur Datensätze in der Tabelle „Interaktion“ [Interaction] unterstützt.
SearchTargetList. ​NowRecordTable	Zeichenfolge	Erforderlich. ServiceNow Tabelle, zu der die searchTargetList gehört. Tabelle: Nur gültiger Wert – „Interaktion“
SearchTargetList. ​Beteiligungs-ID	Zeichenfolge	Eindeutiger Bezeichner für den Teilnehmer aus dem CCaaS-System.
SearchTargetList. ​Ziele	Array von Objekten	Details zu den Service Desk-Mitarbeitern, externen Anwendern und/oder Warteschlangen, an die der Anruf übertragen werden kann. "targets": [ { "payload": {Object}, "transferSubtypes": [Array], "type": "String" } ]
SearchTargetList. ​Ziele. ​Nutzlast	Objekt	Details zu den Informationen, die im Steuerelement „Anruf weiterleiten“ angezeigt werden sollen. Im Folgenden finden Sie ein Beispiel für Anruf weiterleiten Steuerung, die eine Liste von Service Desk-Mitarbeitern enthält, an die der Anruf übertragen werden kann. Der Screenshot zeigt, welche Elemente der Anwenderoberfläche die einzelnen Parameter in haben list.payloadSteuerungen. "payload": { "list": [Array] } Dieses Beispiel zeigt eine Agent-Nutzlast ( „SearchTargetList.targets.type“: „Agent“ ). "payload": { "list": [ { "name": "Alice Anderson", "id": "agent1Id", "hasStats": "true", "presence": "available", "moreInfo": [ { "label": "Skill", "value": "CRM certified" } ] } ] } Das folgende Beispiel zeigt ein Beispiel für eine Warteschlangennutzlast ( „SearchTargetList.targets.type“: „Warteschlange“ ). "payload": { "list": [ { "name": "Product Support Queue", "id": "queue1Id", "hasStats": "true", "moreInfo": [ { "label": "Skill", "value": "10sec" }, { "label": "Queue Skill", "value": "German" } ] }, { "name": "Billing Queue", "id": "queue2Id", "hasStats": "true", "moreInfo": [ { "label": "Skill", "value": "10sec" } ] } ] }
SearchTargetList. ​Ziele. ​Nutzlast. ​Liste	Array von Objekten	Details zur Nutzlast für jeden Zieltyp. "list": [ { "hasStats": Boolean, "id": "String", "moreInfo": [Array], "name": "String", "presence": "String" } ]
SearchTargetList. ​Ziele. ​Nutzlast. ​Liste. ​HasStats	Boolean	Kennzeichnung, die angibt, ob das zugeordnete Ziel über zusätzliche Statistiken wie eine Wartezeit für eine Warteschlange verfügt. Gültige Werte: Wahr: Ziel hat zusätzliche Statistiken. Neben dem Namen oder der Warteschlange des Service Desk-Mitarbeiters wird ein Informationssymbol angezeigt. Falsch: Ziel hat keine zusätzlichen Statistiken. Standardwert: false
SearchTargetList. ​Ziele. ​Nutzlast. ​Liste. ​id	Zeichenfolge	Eindeutiger Bezeichner des Service Desk-Mitarbeiters oder der Warteschlange im CCaaS-System.
SearchTargetList. ​Ziele. ​Nutzlast. ​Liste. ​Moreinfo	Array von Objekten	Erforderlich, wenn searchTargetList.targets.payload.list.hasStatsIst auf festgelegt „Wahr“ . Liste der Kompetenzen, über die der Service Desk-Mitarbeiter oder die Warteschlange verfügt. Diese Informationen werden in einem Popup-Fenster angezeigt, wenn der Anwender das Informationssymbol am Ende des Entitätsnamens auswählt. "moreInfo": [ { "label": "String", "value": "String" } ]
SearchTargetList. ​Ziele. ​Nutzlast. ​Liste. ​Moreinfo. ​Bezeichnung	Zeichenfolge	Freiform-Bezeichnung für die Informationen, die im Popup-Fenster angezeigt werden sollen, z. B. Kompetenz Oder Sprache .
SearchTargetList. ​Ziele. ​Nutzlast. ​Liste. ​Moreinfo. ​Wert	Zeichenfolge	Text, der im Popup-Fenster nach der Bezeichnung angezeigt werden soll, z. B. CRM-zertifiziert Oder Deutsch .
SearchTargetList. ​Ziele. ​Nutzlast. ​Liste. ​Name	Zeichenfolge	Name des Service Desk-Mitarbeiters, des externen Anwenders oder der Warteschlange. Befindet sich im CCaaS-System.
SearchTargetList. ​Ziele. ​Nutzlast. ​Liste. ​Anwesenheit	Zeichenfolge	Anwesenheitsstatus des zugehörigen Service Desk-Mitarbeiters. Dieser Parameter ist nur für gültig searchTargetList.targets.typeVon „Service Desk-Mitarbeiter“ . Gültige Werte: Verfügbar abwesend Belegt offline
SearchTargetList. ​Ziele. ​TransferUntertypen	Array von Objekten	Details zum Typ der Übertragung, die für den angegebenen unterstützt wird searchTargetList.targets.type. Diese Informationen werden angezeigt, wenn der Anwender in der Anwenderoberfläche auf die Ellipse neben dem Namen des Ziels klickt. Wenn beispielsweise nur ein Konsultationstyp für den aktuellen Zieltyp unterstützt wird, z. B. Warteschlange, enthält dieses Array ein Objekt, das den Konsultationstyp der Übertragung angibt. "transferSubtypes": [ { "id": "String", "label": "String" } ]
SearchTargetList. ​Ziele. ​TransferUntertypen. ​id	Zeichenfolge	Bezeichner des Transferuntertyps. Gültige Werte: Blind: Service Desk-Mitarbeiter überträgt den Kundenanruf direkt an einen anderen Service Desk-Mitarbeiter oder eine andere Warteschlange, ohne zuerst mit dem Service Desk-Mitarbeiter zu sprechen. Konsultieren: Service Desk-Mitarbeiter kontaktiert den Service Desk-Mitarbeiter, mit dem er beraten möchte, und führt den Kunden dann mit dem beratenden Service Desk-Mitarbeiter in den Anruf ein. Dies muss dem Wert in entsprechen searchTargetList.targets.transferSubtypes.label.
SearchTargetList. ​Ziele. ​TransferUntertypen. ​Bezeichnung	Zeichenfolge	Bezeichnung des Transferuntertyps. Wenn Sie keine Bezeichnung übergeben, wird in der Anwenderoberfläche für den Transferuntertyp nichts angezeigt. Gültige Werte: Blind Konsultieren Dies muss dem Wert in entsprechen searchTargetList.targets.transferSubtypes.id.
SearchTargetList. ​Ziele. ​Typ	Zeichenfolge	Typ des Ziels. Gültige Werte: Service Desk-Mitarbeiter external Warteschlange

Tabelle : 22. Rückgaben

Typ	Beschreibung
Keine

Das folgende Codebeispiel zeigt, wie der Kontext des aktiven Status festgelegt wird.

openFrameAPI.setICContext("activeCall", {
  "activeCall": [
    { 
      "nowRecordTable": "interaction",
      "nowRecordId": "12345675678903456",
      "externalId": "1234567890",
      "type": "call",
      "direction": "inbound",
      "currentParticipant": {
        "id": "participant1",
        "name": "John 1",
        "actor": "agent",
        "state": "connected",
        "connectedTime": "Fri, 12 Jul 2024 05:23:41 GMT",
        "callStartTime": "Fri, 12 Jul 2024 04:20:22 GMT",
        "muted": false,
        "held": true,
        "paused": true,
        "flagged": true,
        "recording": "in_progress",
        "capabilities": {
          "hold": false,
          "mute": true,
          "endCall": true,
          "startRecording": true,
          "pauseRecording": true,
          "stopRecording": true,
          "resumeRecording": true,
          "transfer": true,
          "mergeCall": true,
          "leaveAndTransfer": true,
          "dtmf": true,
          "flag": true
        }
      },
      "participants": [
        {
          "id": "customer1",
          "name": "Gilly 1",
          "actor": "customer",
          "address": "[phone]",
          "ani": "[phone]", 
          "dnis": "[phone]",
          "state": "connected",
          "connectedTime": "Fri, 12 Jul 2024 00:23:41 GMT",
          "callStartTime": "Fri, 12 Jul 2024 20:55:04 GMT",
          "muted": false,
          "held": false,
          "heldAtTime": "Fri, 12 Jul 2024 20:55:04 GMT", 
          "capabilities": {
            "mute": true,
            "hold": true,
            "endCall": true
          }
        },
        {
          "id": "agent2",
          "name": "Ned",
          "actor": "agent",
          "address": "[phone]",
          "ani": "[phone]", 
          "dnis": "[phone]",
          "state": "Ringing...",
          "requireWrapup": true,
          "requestACW": true,
          "connectedTime": "Fri, 12 Jul 2024 20:24:41 GMT",
          "callStartTime": "Fri, 12 Jul 2024 20:56:34 GMT",
          "muted": true,
          "held": true,
          "heldAtTime": "Fri, 12 Jul 2024 20:55:41 GMT",
          "capabilities": {
            "mute": true,
            "endCall": true,
            "hold": true 
          }
        }
      ]
    },
    {
      "nowRecordTable": "interaction",
      "nowRecordId": "12345yhedfh534576u5",
      "externalId": "1234567890",
      "type": "call",
      "direction": "inbound",
      "currentParticipant": {
        "id": "participant1",
        "name": "John 1",
        "actor": "agent",
        "state": "connected",
        "muted": true,
        "held": false,
        "recording": "in_progress",
        "paused": true,
        "flagged": true,
        "capabilities": {
          "hold": false,
          "mute": true,
          "endCall": true,
          "record": true,
          "startRecording": true,
          "stopRecording": true,
          "transfer": true,
          },
          "mergeCall": false,
          "dtmf": true,
          "flag": true
        }
      },
      "participants": [
        {
          "id": "customer1",
          "name": "Gilly 2",
          "actor": "customer",
          "address": "[phone]",
          "state": "connected",
          "connectedTime": "Wed, 04 Dec 2024 00:23:41 GMT",
          "muted": true,
          "held": false,
          "heldAtTime": "Fri, 12 Jul 2024 20:24:41 GMT”,
          "capabilities": {
            "mute": true,
            "hold": true,
            "endCall": true
          }
        },
        {
          "id": "agent2",
          "name": "Ned 2",
          "actor": "agent",
          "address": "[phone]",
          "state": "Ringing...",
          "connectedTime": "Fri, 12 Jul 2024 20:24:41 GMT",
          "muted": true,
          "held": true,
          "heldaAtTime": "Fri, 12 Jul 2024 20:24:41 GMT”,
          "capabilities": {
            "mute": true,
            "endCall": true,
            "hold": true
          }
        }
      ]
     }
    ]
  }
);

Das folgende Beispiel zeigt, wie der Kontext des Leerlaufstatus festgelegt wird.

openFrameAPI.setICContext("idleState", {
  "capability": {
    "outBoundCall": true,
    "logOut": true 
  },
  "enableState": {
    "outBoundCall": true,
    "logOut": true
  },
  "dialpadInfoMessage": {
    "label": "Info Message Label",
    "value": "Info Message Value"
  },
  "currentInboundId": "1234"
});

Das folgende Beispiel zeigt, wie der Kontext der Suchzielliste festgelegt wird.

openFrameAPI.setICContext("searchTargetList",
  {
    "searchTargetList": [
      {
        "nowRecordTable": "interaction",
        "nowRecordId": "1234",
        "externalId": "5678",
        "participantID": "participant1",
        "targets": [
          {
            "type": "agent",
            "transferSubtypes": [
              {
                "id": "consult",
                "label": "Consult"
              },
              {
                "id": "blind",
                "label": "Blind"
              }
            ],
            "payload": {
              "list": [
                {
                  "name": "John Jason",
                  "id": "agent1Id",
                  "hasStats": "true",
                  "presence": "away",
                  "moreInfo": [
                    {
                      "label": "Skill",
                      "value": "10sec"
                    }
                  ]
                }
              ]
            }
          },
          {
            "type": "queue",
            "transferSubtypes": [
              {
                "id": "consult",
                "label": "Consult"
              },
              {
                "id": "blind",
                "label": "Blind"
              }
            ],
            "payload": {
              "list": [
                {
                  "name": "Product Support Queue",
                  "id": "queue1Id",
                  "hasStats": "true",
                  "moreInfo": [
                    {
                      "label": "Skill",
                      "value": "10sec"
                    },
                    {
                      "label": "Queue Skill",
                      "value": "German"
                    }
                  ]
                },
                {
                  "name": "Billing Queue",
                  "id": "queue2Id",
                  "hasStats": "true",
                  "moreInfo": [
                    {
                      "label": "Skill",
                      "value": "10sec"
                    }
                  ]
                }
              ]
            }
          }
        ],
        "customPayload": {}
      }
    ],
    "customPayload": {}
  });

openFrameAPI – setIcons(Array icons)

Definiert Symbole im OpenFrame-Header, die neben dem Schließen-Symbol platziert werden.

Tabelle : 23. Parameter

Name	Typ	Beschreibung
icons	Array von Objekten	Eine Liste von Symbolkonfigurationen, wobei jede Symbolkonfiguration ein Objekt mit Schlüsselwerten ist imageURL, imageTitle, Und alle anderen erforderlichen Kontexte. Maximale Größe: Symbole können maximal 16x16 Pixel betragen. Größere Bilder werden automatisch auf dieses Maximum angepasst.

Tabelle : 24. Rückgaben

Typ	Beschreibung
void

openFrameAPI.setIcons([{imageURL:'https://mydomian.com/image/mute.png',
imageTitle:'mute', id:101}, {imageURL:'https://mydomian.com/image/hold.png',
imageTitle:'hold', id:102}]);

openFrameAPI - setPresenceIndicator(presence)

Legt den Anwesenheitsindikator fest, um die Agent-Verfügbarkeit in einem Arbeitsbereich anzuzeigen.

Weitere Informationen zum Konfigurieren von OpenFrame finden Sie unter Erstellen Sie eine OpenFrame-Konfiguration

Tabelle : 25. Parameter

Name	Typ	Beschreibung
state	Zeichenfolge	Anwesenheitsstatus des Agent. Standardstatus: Verfügbar Abwesend Offline Sie können auch benutzerdefinierte Status angeben.
color	Zeichenfolge	Farbe des Anwesenheitsindikators im Arbeitsbereich. Unterstützte Farben: rot Orange grau grün

Tabelle : 26. Ergebnisse

Typ	Beschreibung
void

openframeAPI.setPresenceIndicator('Available', 'green');

openFrameAPI – setSize(Number width, Number height)

Legt die OpenFrame-Größe fest.

Tabelle : 27. Parameter

Name	Typ	Beschreibung
width	Zahl	Sollte größer als null sein.
height	Zahl	Sollte größer als null sein.

Tabelle : 28. Ergebnisse

Typ	Beschreibung
void

openFrameAPI.setSize(300, 370);

openFrameAPI – setSubtitle(String subTitle)

Legt den OpenFrame-Untertitel fest.

Tabelle : 29. Parameter

Name	Typ	Beschreibung
subTitle	Zeichenfolge	Eine Zeichenfolge mit maximal 256 Zeichen.

Tabelle : 30. Ergebnisse

Typ	Beschreibung
void

openFrameAPI.setSubtitle('[phone]');

openFrameAPI – setTitle(String title)

Legt den OpenFrame-Titel fest.

Tabelle : 31. Parameter

Name	Typ	Beschreibung
title	Zeichenfolge	Eine Zeichenfolge mit maximal 256 Zeichen.

Tabelle : 32. Ergebnisse

Typ	Beschreibung
void

openFrameAPI.setTitle('Incoming Call');

openFrameAPI – setTitleIcon(Object icon)

Legt das Titelsymbol von OpenFrame fest.

Tabelle : 33. Parameter

Name	Typ	Beschreibung
icon	Objekt	Objekt von Schlüssel-Wert-Paaren. Schlüssel enthalten imageURL, imageTitle, Und alle anderen erforderlichen Kontexte. Maximale Größe: Symbole können maximal 16x16 Pixel betragen. Größere Bilder werden automatisch auf dieses Maximum angepasst.

Tabelle : 34. Rückgaben

Typ	Beschreibung
void

openFrameAPI.setTitleIcon({imageURL:'/my/image/path.png', imageTitle:'mute', id:101});

openFrameAPI.setTitleIcon({imageURL:'https://mydomian.com/image/path.png',
imageTitle:'mute', id:101});

openFrameAPI - setWidth(width)

Legt die OpenFrame-Breite fest.

Tabelle : 35. Parameter

Name	Typ	Beschreibung
Breite	Nummer	Breite in Pixel

Tabelle : 36. Ergebnisse

Typ	Beschreibung
void

openFrameAPI.setWidth(100);

openFrameAPI – show()

Macht den OpenFrame im TopFrame sichtbar.

Tabelle : 37. Parameter

Name	Typ	Beschreibung
Keine

Tabelle : 38. Ergebnisse

Typ	Beschreibung
void

openFrameAPI.show()

openFrameAPI – subscribe(openFrameAPIEVENT event, function eventCallback)

Abonniert ein angegebenes Ereignis.

Tabelle : 39. Parameter

Name	Typ	Beschreibung
event	openFrameAPIEVENT	Das Ereignis, das abonniert werden soll: Openframe_Agent_off_Interaction: Gibt die Anwesenheit eines Service Desk-Mitarbeiters im Chat als „aus“ oder „verfügbar“ an. Openframe_Awa_Agent_presence: In Erweiterte Arbeitszuweisung( AWA), tritt dieses Ereignis auf, wenn sich der Anwesenheitsstatus des Service Desk-Mitarbeiters ändert. Entwickler von Computer Telephony Integration (CTI) können dieses Ereignis abonnieren, um Änderungen des Anwesenheitsstatus zu erhalten. Openframe_Awa_workitem_accepted: Tritt auf, wenn ein Arbeitselement von einem Service Desk-Mitarbeiter akzeptiert wird. Openframe_Awa_workitem_offered: Tritt auf, wenn einem Service Desk-Mitarbeiter ein Arbeitselement angeboten wird. Openframe_Awa_workitem_rejected: Tritt auf, wenn ein Arbeitselement von einem Service Desk-Mitarbeiter abgelehnt wird. openframe_before_destroy: Tritt ein, bevor der TopFrame entladen wird. Openframe_collapse: Tritt auf, wenn im OpenFrame-Header das Symbol „Reduzieren“ ausgewählt ist. openframe_communication: Anwendungsspezifisch und kann angepasst werden. openframe_communication_failure: Tritt ein, wenn die Kommunikation mit TopFrame fehlschlägt. Openframe_expand: Tritt auf, wenn im OpenFrame-Header das Erweiterungssymbol ausgewählt ist. Openframe_Heart_Beat: Tritt auf, wenn die Anwendersitzung erweitert oder abgemeldet wird. openframe_header_icon_clicked: Veraltet. Verwenden Sie stattdessen openframe_icon_clicked oder openframe_title_icon_clicked. openframe_hidden: Tritt ein, wenn der OpenFrame ausgeblendet ist. Openframe_icon_clicked: Tritt auf, wenn ein anderes Symbol als das Schließen-Symbol in der OpenFrame-Fußzeile ausgewählt ist. Der Callback empfängt das Icon-Objekt als einen Parameter. openframe_shown: Tritt ein, wenn der OpenFrame angezeigt wird. Openframe_title_icon_clicked: Tritt auf, wenn das Titelsymbol in OpenFrame ausgewählt ist. Der Callback empfängt das titleIcon-Objekt als Parameter. Openframe_wrap_up_submitted: Tritt auf, wenn die Nachbearbeitungszeiträume am enden Dialogfeld ohne Modi für Nachbearbeitung . Das Ereignis wird nur ausgelöst, wenn die Nachbearbeitung extern ist.
eventCallback	Funktion	Funktion, die aufgerufen werden soll, wenn das angegebene Ereignis auftritt.

Tabelle : 40. Rückgaben

Typ	Beschreibung
Ergebnisse	Die meisten Ereignisabonnements haben keine Rückgabewerte. Die Ereignisabonnements, die Werte zurückgeben, werden in den folgenden Tabelleneinträgen beschrieben.
openframe_awa_agent_presence	In AWA, openframe_awa_agent_presenceEreignis gibt zurück Anwesenheit Objekt: "presence":{ "available": Boolean, "channels":[ { "available": Boolean, "name": "String", "restrict_update": Boolean, "sys_id": "String" } ], "name": "String", "sys_id": "String" } presence: Informationen zum aktuellen Anwesenheitsstatus und -Kanal eines Service Desk-Mitarbeiters. presence.available: Kennzeichnung, die angibt, ob der Service Desk-Mitarbeiter verfügbar ist. presence.channels: Liste von Objekten, die die verfügbaren Kommunikationskanäle mit dem Service Desk-Mitarbeiter beschreiben. presence.channels.available: Kennzeichnung, die angibt, ob der Kanal verfügbar ist. presence.channels.name: Kanalname, z. B. Chat oder Telefon. presence.channels.restrict_update: Kennzeichnung, die angibt, ob der Anwender Updates einschränken kann. presence.channels.sys_id: Kanal-sys_ID presence.name: Name des Anwesenheitsstatus des Service Desk-Mitarbeiters. presence.sys_id: Anwesenheitsstatus-sys_id.
Openframe_Awa_workitem_accepted und openframe_Awa_workitem_offered	In AWA, openframe_awa_workitem_acceptedUnd openframe_awa_workitem_offeredEreignisse geben zurück Arbeitselement Objekt: "workItem": { "document": { "sys_id": "String", "table": "String" }, "isAutoAccepted": Boolean, "isQueueTransferred": Boolean, "previousWorkItem": "String", "serviceChannel": { "name": "String", "sys_id": "String" }, "size": Number, "sys_id": "String" } workItem: Informationen zum Arbeitselement, das dem Ereignis zugeordnet ist. workItem.document: Liste der Dokumente, die der Arbeitselementaufgabe zugeordnet sind. workItem.document.sys_id: SYS_ID des Dokuments, das der Arbeitselementaufgabe zugewiesen ist. workItem.document.table: Name der Dokumenttabelle, die der Aufgabe zugewiesen ist. workItem.isAutoAccepted: Kennzeichnung, die angibt, ob das Arbeitselement automatisch vom System akzeptiert wurde. Auf „wahr“ festlegen, wenn das Arbeitselement automatisch akzeptiert wurde. workItem.isQueueTransferred: Kennzeichnung, die angibt, ob das Arbeitselement in der Warteschlange übertragen wird. Legen Sie den Wert auf „wahr“ fest, wenn das Arbeitselement in der Warteschlange übertragen wird, oder auf „falsch“, wenn dies nicht der Fall ist Weitere Informationen zu Warteschlangenübertragungen finden Sie unter Transfer a chat to another queue. workItem.previousWorkItem: SYS_ID des vorherigen Arbeitselements für dieselbe Dokument-ID. Für nicht übertragene Arbeitselemente ist dieser Wert leer. workItem.serviceChannel: Liste der Servicekanäle, die der Arbeitselementaufgabe zugeordnet sind. workItem.serviceChannel.name: Name des Servicekanals, z. B. Chat oder Telefon. workItem.serviceChannel.sys_id: SYS_ID des Servicekanals. workItem.size: Kapazität des Service Desk-Mitarbeiters, die verwendet wird, wenn dieses Arbeitselement dem Service Desk-Mitarbeiter zugewiesen wird. workItem.sys_id: SYS_ID des Arbeitselements, das akzeptiert oder angeboten wurde.
openframe_awa_workitem_rejected	In AWA, openframe_awa_workitem_rejectedEreignis gibt zurück Arbeitselement Objekt: "workItem": { "document": { "sys_id": "String", "table": "String" }, "isQueueTransferred": Boolean, "previousWorkItem": "String", "rejection": { "reason": "String", "sys_id": "String" }, "serviceChannel": { "name": "String", "sys_id": "String" }, "size": Number, "sys_id": "String" } workItem: Informationen zum Arbeitselement, das dem Ereignis zugeordnet ist. workItem.document: Liste der Dokumente, die der Arbeitselementaufgabe zugeordnet sind. workItem.document.sys_id: SYS_ID des Dokuments, das der Arbeitselementaufgabe zugewiesen ist. workItem.document.table: Name der Dokumenttabelle, die der Aufgabe zugewiesen ist. workItem.isQueueTransferred: Kennzeichnung, die angibt, ob das Arbeitselement in der Warteschlange übertragen wird. Legen Sie den Wert auf „wahr“ fest, wenn das Arbeitselement in der Warteschlange übertragen wird, oder auf „falsch“, wenn dies nicht der Fall ist Weitere Informationen zu Warteschlangenübertragungen finden Sie unter Transfer a chat to another queue. workItem.previousWorkItem: SYS_ID des vorherigen Arbeitselements für dieselbe Dokument-ID. Für nicht übertragene Arbeitselemente ist dieser Wert leer. workItem.rejection: Liste der Gründe für die Ablehnung des Arbeitselements. workItem.rejection.reason: Name des Grunds für die Ablehnung der Arbeitselemente. workItem.rejection.sys_id: SYS_ID des Ablehnungsgrunds. Tabelle: Ablehnungsgründe [Awa_reject_reason] workItem.serviceChannel: Liste der Servicekanäle, die der Arbeitselementaufgabe zugeordnet sind. workItem.serviceChannel.name: Name des Servicekanals, z. B. Chat oder Telefon. workItem.serviceChannel.sys_id: SYS_ID des Servicekanals. workItem.size: Kapazität des Service Desk-Mitarbeiters, die verwendet wird, wenn dieses Arbeitselement dem Service Desk-Mitarbeiter zugewiesen wird. workItem.sys_id: SYS_ID des Arbeitselements, das akzeptiert oder angeboten wurde.
Openframe_Heart_Beat	Die openframe_heart_beatEreignis gibt das folgende Objekt zurück: { "lastUiActivity": "String", "sessionLoggedIn": Boolean } lastUiActivity: Optional. Zeitstempel der letzten UI-Aktivität, die die Anwendersitzung verlängert hat. sessionLoggedIn Kennzeichnung, die angibt, ob der Anwender angemeldet ist. Wahr: Anwender ist angemeldet. Falsch: Anwender ist nicht angemeldet.
Openframe_wrap_up_submitted	Die openframe_wrap_up_submittedEreignis gibt das folgende Objekt zurück: { "wrapUp": { "external": Boolean, "externalSegmentId": "String", "recordId": "String", "recordTable": "String", "wrapUpCode": "String", "wrapUpNotes": "String", "wrapUpSegmentId": "String" } } external: Kennzeichnung, die angibt, ob die Nachbearbeitung intern von behandelt wird ServiceNow Instanz oder außerhalb von verwaltet ServiceNow Instanz von einem anderen Anrufsystem. Wahr: Die Nachbearbeitung wird von einem externen Anrufsystem verarbeitet. Falsch: Nachbearbeitung wird von behandelt ServiceNow Instanz. externalSegmentId: Eindeutiger Bezeichner des externen Datenobjekts, das die externe Nachbearbeitung ausgelöst hat. recordId: SYS_ID des Interaktionsdatensatzes, der abgeschlossen wird. recordTable: Name der Tabelle, die den Datensatz enthält. Immer als „Interaktion“ festlegen. wrapUpCode: Code, der vom Anwender während der Nachbearbeitung ausgewählt wurde und angibt, wie die Interaktion gelöst wurde. wrapUpNotes: Freiformtext, der vom Anwender während der Nachbearbeitung eingegeben wurde und beschreibt, wie die Interaktion gelöst wurde. wrapUpSegmentId: SYS_ID des der Interaktion zugeordneten Abschlusssegmentdatensatzes. Befindet sich in der Tabelle „Nachbearbeitungssegment“ [Interaction_wrap_up_Segment]. Enthält die Abschlussdaten.

Das folgende Codebeispiel zeigt, wie diese Methode für einen aufgerufen wird Openframe_Awa_Agent_presence Ereignis.

function handleIconClick(context) {
console.log("Icon was clicked", context);
}
openFrameAPI.subscribe(openFrameAPI.events.openframe_awa_agent_presence, handleIconClick);

Ausgabe:

// Sample presence object output
// openframe_awa_agent_presence event only

{
  "result":{
    "presence":{
      "name":"Available",
      "sys_id":"27f675e3739713004a905ee515f6a7c3",
      "available":true,
      "channels":[
        {
          "name":"Chat",
          "available":true,
          "sys_id":"36f675e4239713124a905fe515f6a832",
          "restrict_update":false
        },
        {
          "name":"Phone",
          "available":true,
          "sys_id":"9378a530a1820610f809018efd9bc01e",
          "restrict_update":false
        }
      ]
    }
  }
}

Das folgende Codebeispiel zeigt, wie diese Methode für einen aufgerufen wird Openframe_Awa_workitem_accepted Ereignis.

function handleIconClick(context) {
console.log("Icon was clicked", context);
}
openFrameAPI.subscribe(openFrameAPI.events.openframe_awa_workitem_accepted, handleIconClick);

Ausgabe:

// Sample workItem object output
// openframe_awa_workitem_accepted event only
{
  "result": {
    "workItem": {
      "sys_id": "14c86c40a1650610f87701807d9bc0be",
      "size": 1,
      "serviceChannel": {
        "name": "Chat",
        "sys_id": "27f675e3739713004a905ee515f6a7c3"
      },
      "document": {
        "sys_id": "aa582040a1650610f87701807d9bc076",
        "table": "interaction"
      },
      "previousWorkItem": "7c78a440a1650610f87701807d9bc02b",
      "isQueueTransferred": true,
      "isAutoAccepted": true
    }
  }
}

Das folgende Codebeispiel zeigt, wie diese Methode für einen aufgerufen wird Openframe_Awa_workitem_rejected Ereignis.

function handleIconClick(context) {
console.log("Icon was clicked", context);
}
openFrameAPI.subscribe(openFrameAPI.events.openframe_awa_workitem_rejected, handleIconClick);

Ausgabe:

// Sample workItem object output
// openframe_awa_workitem_rejected event only
{
  "payload": {
    "workItem": {
      "sys_id": "2c3bdc4824250610f8775e73b116f8de",
      "size": "1",
      "serviceChannel": {
        "name": "Chat",
        "sysID": "27f675e3739713004a905ee515f6a7c3"
      },
      "document": {
        "sys_id": "cf0a180824250610f8775e73b116f80c",
        "table": "interaction"
      },
      "rejection": {
        "reason": "Busy",
        "sys_id": "4e93fa29b38023002e7b6e5f26a8dc20"
      },
      "previousWorkItem": "831b9c4824250610f8775e73b116f841",
      "isQueueTransferred": true
    }
  }
}

openFrameAPI – version()

Gibt die OpenFrame-API-Version zurück.

Tabelle : 41. Parameter

Name	Typ	Beschreibung
Keine

Tabelle : 42. Ergebnisse

Typ	Beschreibung
Zeichenfolge	Die OpenFrame-API-Version

var version = openFrameAPI.version();

console.log("API version " + version);