---
sourceDocument: Yokohama-API-Referenz
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/de-DE/yokohama/api-reference

 Release :

    - yokohama

ft:locale :

    - de-DE

ft:publication_title :

    - Yokohama-API-Referenz

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# OpenFrameAPI -- Client

# OpenFrameAPI -- Client {#ariaid-title1}

* Freigeben Version: Yokohama
* 
* Aktualisiert 30. Januar 2025
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 30 Minuten Lesedauer

Die OpenFrameAPI Stellt Methoden bereit, die mit OpenFrame interagieren. OpenFrame ist ein omnipräsenter Frame, mit dem Kommunikationspartner ihre Systeme in integrieren können ServiceNowPlattform.

Eine der Kernanforderungen ist die Fähigkeit, Code aus verschiedenen Domänen zu verbinden und zu bedienen, die nahtlos mit Partnersubsystemen verbunden werden können. Diese domänenübergreifende Verbindung ist erforderlich, um Verbindungen und Rückrufe ohne domänenübergreifende Probleme in Kommunikationssystemen registriert zu halten.  
OpenFrame hat zwei bedeutende Teile. Einer wohnt in ServiceNowAnwendung (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](https://www.servicenow.com/docs/access?context=c_OpenFrameOverview&version=yokohama&pubname=yokohama-customer-service-management&ft:locale=en-US).  
Hinweis:  
Um in Bezug auf die OpenFrame-Bibliothek aktuell zu bleiben, verwenden Sie die folgende Ressourcen-URI: https://\[servicenow instance\]/scripts/openframe/latest/openFrameAPI.min.js .

## OpenFrameAPI -- getAWAAgentPresence (Zeichenfolgenerfolg, Zeichenfolgenfehler) {#ariaid-title2}

Gibt den aktuellen Anwesenheitsstatus des angemeldeten Service Desk-Mitarbeiters zurück.
{#openFrameAPI-getAWAPresense_S_S__table_z1t_mgn_sbc__entry__3}

| 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 : 1. Parameter]

{#openFrameAPI-getAWAPresense_S_S__table_z1t_mgn_sbc} {#openFrameAPI-getAWAPresense_S_S__table_abt_mgn_sbc__entry__2}

| 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: Agent ist verfügbar. * Falsch: Agent ist nicht verfügbar. Datentyp: Boolescher Wert |
| 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 Updates auf den Kanal beschränken. * Falsch: Anwender kann Updates 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 Anwesenheitsstatus-Datensatzes. Datentyp: Zeichenfolge Tabelle: Anwesenheitsstatus \[Awa_presence_State\] |
[Tabelle : 2. Rückgaben]

{#openFrameAPI-getAWAPresense_S_S__table_abt_mgn_sbc}  
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() {#ariaid-title3}

Blendet OpenFrame im TopFrame aus.
{#r_openFrameAPI-hide__table_yzb_mxx_kt__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Keine |   |   |
[Tabelle : 3. Parameter]

{#r_openFrameAPI-hide__table_yzb_mxx_kt} {#r_openFrameAPI-hide__table_zzb_mxx_kt__entry__2}

| Typ | Beschreibung |
|-|-|
| Ungültig |   |
[Tabelle : 4. Rückgaben]

{#r_openFrameAPI-hide__table_zzb_mxx_kt}  

    openFrameAPI.hide()

## OpenFrameAPI -- init(Objektkonfiguration, FunktionsfolgeRückruf, Funktionsfehler-Rückruf) {#ariaid-title4}

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.
{#r_openFrameAPI-init_Object_Object_Object__table_vz3_jyw_kt__entry__3}

| 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. |
| Erfolgreicher Rückruf | Funktion | Name der Rückruffunktion, die verwendet werden soll, wenn Init Methode erfolgreich. Die [OpenFrame-Konfiguration](https://www.servicenow.com/docs/access?context=t_CreateAnOpenFrameConfiguration&version=yokohama&pubname=yokohama-customer-service-management&ft:locale=en-US)Im System gespeicherte Daten werden als Parameter an die Rückruffunktion übergeben. |
| Fehler beim Rückruf | Funktion | Name der Rückruffunktion, die verwendet werden soll, wenn Init Methode schlägt fehl. |
[Tabelle : 5. Parameter]

{#r_openFrameAPI-init_Object_Object_Object__table_vz3_jyw_kt} {#r_openFrameAPI-init_Object_Object_Object__table_wz3_jyw_kt__entry__2}

| Typ | Beschreibung |
|-|-|
| Ungültig |   |
[Tabelle : 6. Rückgaben]

{#r_openFrameAPI-init_Object_Object_Object__table_wz3_jyw_kt}  

    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(Funktionsrückruf) {#ariaid-title5}

Überprüft, ob OpenFrame im TopFrame sichtbar ist.
{#r_openFrameAPI-isVisible_Object_Object__table_zdj_ygy_kt__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Rückruf | Funktion | Die Rückruffunktion empfängt einen Parameter mit dem Wert „wahr" oder „falsch". „Wahr", wenn OpenFrame sichtbar ist, und „falsch", wenn nicht sichtbar. |
[Tabelle : 7. Parameter]

{#r_openFrameAPI-isVisible_Object_Object__table_zdj_ygy_kt} {#r_openFrameAPI-isVisible_Object_Object__table_a2j_ygy_kt__entry__2}

| Typ | Beschreibung |
|-|-|
| Ungültig |   |
[Tabelle : 8. Rückgaben]

{#r_openFrameAPI-isVisible_Object_Object__table_a2j_ygy_kt}  

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

## OpenFrameAPI -- openCustomURL(Zeichenfolgendetails) {#ariaid-title6}

Öffnet eine anwenderdefinierte URL in der UI16-Schnittstelle.
{#r_openFrameAPI-openCustomURL__table_ob3_ryd_lt__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| URL | Zeichenfolge | Text der anwenderdefinierten URL. Maximale Größe: 2083 Zeichen |
[Tabelle : 9. Parameter]

{#r_openFrameAPI-openCustomURL__table_ob3_ryd_lt} {#r_openFrameAPI-openCustomURL__table_pb3_ryd_lt__entry__2}

| Typ | Beschreibung |
|-|-|
| Ungültig |   |
[Tabelle : 10. Rückgaben]

{#r_openFrameAPI-openCustomURL__table_pb3_ryd_lt}  

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

## OpenFrameAPI -- openServiceNowForm(Objektdetails) {#ariaid-title7}

Öffnet eine Formular-URL.
Wenn ein Service Desk-Mitarbeiter 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 Plattformschnittstelle öffnet diese API eine Formular-URL in TopFrame.
* Für Mitarbeiterbereich, Diese API unterstützt die Verwaltung von Interaktionsregisterkarten. In Mitarbeiterbereich, Wird ein Interaktionsdatensatz in einer übergeordneten Registerkarte geöffnet, und der angegebene Entitätsdatensatz wird in einer untergeordneten Registerkarte unter der Registerkarte „Interaktion" geöffnet.
{#r_openFrameAPI-openServiceNowForm_Object__ul_mwy_4nc_lhb} {#r_openFrameAPI-openServiceNowForm_Object__table_ulq_vwd_lt__entry__3}

| 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.Entität | 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 Plattformschnittstelle von interaction_sys_idWird ignoriert. |
| Details.Abfrage | Zeichenfolge | Abfrage zum Identifizieren des zu öffnenden Datensatzes, z. B.: `Abfrage:'sys_ID=<record_sys_id>' `. |
[Tabelle : 11. Parameter]

{#r_openFrameAPI-openServiceNowForm_Object__table_ulq_vwd_lt} {#r_openFrameAPI-openServiceNowForm_Object__table_vlq_vwd_lt__entry__2}

| Typ | Beschreibung |
|-|-|
| Ungültig |   |
[Tabelle : 12. Rückgaben]

{#r_openFrameAPI-openServiceNowForm_Object__table_vlq_vwd_lt}  
Das folgende Beispiel zeigt die grundlegende Nutzung in der Plattform:

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

Das folgende Beispiel zeigt, wie verwendet wird 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() {#ariaid-title8}

Öffnet einen ServiceNowFormular mit einer untergeordneten Registerkarte, wenn in einem Arbeitsbereich aufgerufen, oder öffnet eine Entität, wenn sie in der UI16-Schnittstelle aufgerufen wird.
{#openFrameAPI-openSNFormwithChildTab__table_j13_hwv_hyb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| OpenServiceNowFormwithuntergeordnete Registerkarte | Objekt | Definiert, ob die API einen öffnet ServiceNowFormular mit einer untergeordneten Registerkarte, wenn in einem Arbeitsbereich aufgerufen, 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 : 13. Parameter]

{#openFrameAPI-openSNFormwithChildTab__table_j13_hwv_hyb} {#openFrameAPI-openSNFormwithChildTab__table_k13_hwv_hyb__entry__2}

| Typ | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 14. Rückgaben]

{#openFrameAPI-openSNFormwithChildTab__table_k13_hwv_hyb}  
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 (Objektdetails) {#ariaid-title9}

Öffnet eine Listen-URL in der UI16-Schnittstelle.
{#r_openFrameAPI-openServiceNowList_Object__table_fpq_5xd_lt__entry__3}

| 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](https://www.servicenow.com/docs/access?context=c_EncodedQueryStrings&version=yokohama&pubname=yokohama-platform-user-interface&ft:locale=en-US) {#r_openFrameAPI-openServiceNowList_Object__ul_ndm_fxd_lt} |
[Tabelle : 15. Parameter]

{#r_openFrameAPI-openServiceNowList_Object__table_fpq_5xd_lt} {#r_openFrameAPI-openServiceNowList_Object__table_gpq_5xd_lt__entry__2}

| Typ | Beschreibung |
|-|-|
| Ungültig |   |
[Tabelle : 16. Rückgaben]

{#r_openFrameAPI-openServiceNowList_Object__table_gpq_5xd_lt}  

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

## OpenFrameAPI -- setFrameMode(Mode) {#ariaid-title10}

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 Ereignis für CTI aus:
  * OpenFrameAPI.EREIGNISSE.REDUZIEREN
  * OpenFrameAPI.EREIGNISSE.ERWEITERN
  {#r_openFrameAPI-setFrameMode__ul_sjp_rgw_5fb}
{#r_openFrameAPI-setFrameMode__ul_vnq_4gw_5fb}
{#r_openFrameAPI-setFrameMode__table_yzb_mxx_kt__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Modus | Zeichenfolge | Legen Sie den OpenFrame-Modus fest. Aufgezählte Optionen: 1. OPENFRAMEAPI.FRAME_MODE.REDUZIEREN 2. OPENFRAMEAPI.FRAME_MODE.EXPAND {#r_openFrameAPI-setFrameMode__ol_yjp_3gw_5fb} |
[Tabelle : 17. Parameter]

{#r_openFrameAPI-setFrameMode__table_yzb_mxx_kt} {#r_openFrameAPI-setFrameMode__table_zzb_mxx_kt__entry__2}

| Typ | Beschreibung |
|-|-|
| Ungültig |   |
[Tabelle : 18. Rückgaben]

{#r_openFrameAPI-setFrameMode__table_zzb_mxx_kt}  

    openFrameAPI.setFrameMode(openFrameAPI.FRAME_MODE.COLLAPSE);

## OpenFrameAPI -- setHeight(height) {#ariaid-title11}

Legt die OpenFrame-Höhe fest.
{#r_openFrameAPI-setHeight__table_yzb_mxx_kt__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Höhe | Nummer | Höhe in Pixel |
[Tabelle : 19. Parameter]

{#r_openFrameAPI-setHeight__table_yzb_mxx_kt} {#r_openFrameAPI-setHeight__table_zzb_mxx_kt__entry__2}

| Typ | Beschreibung |
|-|-|
| Ungültig |   |
[Tabelle : 20. Rückgaben]

{#r_openFrameAPI-setHeight__table_zzb_mxx_kt}  

    openFrameAPI.setHeight(100);

## OpenFrameAPI -- setICContext(Zeichenfolgentyp, Objekt-\<Context\>) {#ariaid-title12}

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](https://www.servicenow.com/docs/access?context=interaction-controls-component&version=yokohama&pubname=yokohama-customer-service-management&ft:locale=en-US).

Weitere Informationen zu Interaktionsdatensätzen finden Sie unter [CSM voice interaction record page](https://www.servicenow.com/docs/access?context=csm-native-voice-record-page&version=yokohama&pubname=yokohama-customer-service-management&ft:locale=en-US).
{#openFrameAPI-setICContext_S_O__table_xlq_rhg_zdc__entry__3}

| 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 Inaktivitätsstatus-Fähigkeiten für den aktuellen Anwender fest. Wenn diese Option festgelegt ist, wird die UI des Leerlaufstatus (Wähltastatus) in OpenFrame angezeigt. Wenn Sie diesen Kontexttyp übergeben, müssen Sie auch übergeben `<idleState>{} `JSON als ContextParameter. ![Tastaturkomponente]() * SearchTargetList: Legt den Kontext des Telefonverzeichnisses fest. Wenn diese Option festgelegt ist, wird sie aktiviert Anruf weiterleiten In der Komponente „aktiver Anruf". Wenn Sie diesen Kontexttyp übergeben, müssen Sie auch übergeben `SearchTargetList[] `JSON als ContextParameter. <br /> |
| \<Context\> | Objekt | Festzulegende Kontextdaten. Jeder Kontextdatentyp hat einen anderen Satz möglicher Eingabedaten. Gültig ContextDatenobjekte: * `activeCall` * `<idleState>` * `searchTargetList` |
| activeCall | Objekt-Array | 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.currentParticipant.​Anrufstartzeit | 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. <br /> "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 über die Funktion „Dual Tone MultiFrequency" (DTMF) für den aktuellen Anruf verfügt. Gültige Werte: * Wahr: Teilnehmer hat DTMF-Fähigkeit. * Falsch: Teilnehmer hat keine DTMF-Fähigkeit. Standard: Falsch |
| 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. Standard: Falsch |
| 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 Problemaufrufe kennzeichnen. * Falsch: Teilnehmer kann Problemaufrufe nicht kennzeichnen. Standard: Falsch |
| ActiveCall.currentTeilnehmer.​Fähigkeiten. ​Warten | 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 Wartezustand setzen. Die Schaltfläche „Halten" ist in der Anwenderoberfläche deaktiviert. Standard: Falsch |
| 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 übertragen und abgeben. Standard: Falsch |
| 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: 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. Standard: Falsch |
| 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. Standard: Falsch |
| 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. Standard: Falsch |
| 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. Standard: Falsch |
| 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. Standard: Falsch |
| 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 anhalten" ist in der Anwenderoberfläche aktiviert. * Falsch: Teilnehmer kann die Aufzeichnung des Anrufs nicht beenden. Die Schaltfläche „Aufzeichnung anhalten" ist in der Anwenderoberfläche deaktiviert. Standard: Falsch |
| 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. Standard: Falsch |
| ActiveCall.currentParticipant.​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.currentParticipant.​Custom-Capability-State-1 | Boolean | Zukünftige Verwendung. |
| 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. Standard: Falsch |
| ActiveCall.currentTeilnehmer.​Gehalten | Boolean | Kennzeichnung, die den Status „Angehalten" des Teilnehmers angibt. Gültige Werte: * Wahr: Teilnehmer ist angehalten. * Falsch: Teilnehmer ist nicht angehalten. Standard: Falsch |
| ActiveCall.currentTeilnehmer.​id | Zeichenfolge | Erforderlich. SYS_ID des zugeordneten Teilnehmerdatensatzes, z. B. die sys_ID des Agenten. Tabelle: Anwender \[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. {#openFrameAPI-setICContext_S_O__ul_bhv_vd4_zdc} Standard: Falsch |
| 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. Standard: Falsch |
| 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 an OpenFrame übergeben werden soll. Dies ist ein Freiform-Objekt 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 zugeordneten Teilnehmer. Gültige Werte: * Eingehend * outbound |
| ActiveCall.externalId |   | Erforderlich. Eindeutiger Wert, der den aktuell 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 | Objekt-Array | 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. Standard: Falsch |
| ActiveCall. ​Teilnehmer. ​Fähigkeiten. ​Warten | 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 Wartezustand setzen. Die Schaltfläche „Halten" ist in der Anwenderoberfläche deaktiviert. Standard: Falsch |
| 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. Standard: Falsch |
| 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. ​Anwenderdefinierte Nutzlast | Objekt | Anwenderdefinierte Nutzlast, die an OpenFrame übergeben werden soll. Dies ist ein Freiform-Objekt 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. ​Angehalten | Boolean | Kennzeichnung, die den Status „Angehalten" des Teilnehmers angibt. Gültige Werte: * Wahr: Teilnehmer ist angehalten. * Falsch: Teilnehmer ist nicht angehalten. Standard: Falsch |
| 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. Standard: Falsch |
| ActiveCall. ​Teilnehmer. ​Name | Zeichenfolge | Name des Teilnehmers. |
| ActiveCall. ​Teilnehmer. ​AnforderungsACW | Boolean | Nur gültig, wenn activeCall.currentParticipant.actorIst „Agent". Kennzeichnen Sie diesen Indikator ATS, die der Teilnehmer mit dem Kunden besprechen muss. Gültige Werte: * Wahr: Nachverfolgung erforderlich. * Falsch: Keine Nachverfolgung erforderlich. {#openFrameAPI-setICContext_S_O__ul_d5s_xtb_j2c} Standard: Falsch |
| ActiveCall. ​Teilnehmer. ​Erforderliche Nachbearbeitung | Boolean | Nur gültig, wenn activeCall.currentParticipant.actorIst „Agent". Kennzeichnung, die angibt, ob angezeigt werden soll Abschluss Komponente, sobald der Anruf abgeschlossen ist. <br /> Gültige Werte: * Wahr: Zeigt die Nachbearbeitungskomponente bei Abschluss des Anrufs an. * Falsch: Die Nachbearbeitungskomponente bei Anrufabschluss nicht anzeigen. {#openFrameAPI-setICContext_S_O__ul_enm_4tb_j2c} Standard: Falsch |
| ActiveCall. ​Teilnehmer. ​status | Zeichenfolge | Status des Anrufabschnitts des Teilnehmers. Wird unter der Telefonnummer in angezeigt Aktiver Anruf Komponente. Dies kann ein beliebiger aussagekräftiger Text sein, z. B.: * Warnungen Werden Ausgegeben * Verbunden * Klingelnd |
| ActiveCall.type | Zeichenfolge | Typ des Anrufs. Gültige Werte: * Rufen Sie an * Rückrufanforderung * Voicemail |
| \<idleState\> | Objekt | Beschreibt den Inaktivitätsstatuskontext des Agenten. 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 Inaktivitätsstatus-Fähigkeiten des aktuellen Anwenders. "capability": { "globalContactSearch": Boolean, "logOut": Boolean, "outBoundCall": Boolean } |
| \<idleState\>.Fähigkeit. ​GlobalContactSerarch | Boolean | Kennzeichnung, die angibt, ob die globale Kontaktliste angezeigt werden soll, während sie sich im Inaktivitätsstatus befindet. Gültige Werte: * Wahr: Zeigt die globale Kontaktliste an. * Falsch: Globale Kontaktliste nicht anzeigen. {#openFrameAPI-setICContext_S_O__ul_mdc_m2c_j2c} Standard: Falsch |
| \<idleState\>.Fähigkeit. ​Abmelden | Boolean | Kennzeichnung, die angibt, ob sich der Anwender im Leerlaufstatus 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. Standard: Falsch |
| \<idleState\>.Fähigkeit. ​OutBoundCall | Boolean | Kennzeichnung, die angibt, ob der Anwender einen ausgehenden Anruf tätigen kann, während er sich im Leerlauf befindet. 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. Standard: Falsch |
| \<idleState\>. ​CurrentInlimitId | Zeichenfolge | Eingehender Bezeichner der Anbieteranwendung, die zum Erstellen der Interaktion für ausgehende Anrufe verwendet wird. Tabelle: Befindet sich im ID-Feld der Tabelle „Identitäten des Anbieterkanals \[sys_cs_provider_application\]". Standard: Basissystemanbieteranwendung |
| \<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 . <br /> |
| \<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. ​Abmelden | Boolean | Kennzeichnung, die angibt, ob die Schaltfläche „Abmelden" in der Anwenderoberfläche aktiviert werden soll, während sie sich im Inaktivitätsstatus befindet. Gültige Werte: * Wahr: Zeigt die Schaltfläche „Abmelden" an, während sich der Inaktivitätsstatus befindet. * Falsch: Die Schaltfläche „Abmelden" nicht anzeigen, während sich der Inaktivitätsstatus befindet. Standard: Falsch |
| \<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 Inaktivitätsstatus befindet. Gültige Werte: * Wahr: Schaltfläche für ausgehenden Anruf anzeigen, während sich der Leerlauf befindet. * Falsch: Die Schaltfläche „ausgehender Anruf" im Leerlaufstatus nicht anzeigen. Standard: Falsch |
| searchTargetList | Objekt-Array | Details der übertragungsbezogenen Daten für einen ServiceNowTabelle. "searchTargetList": [ { "externalId": "String", "nowRecordId": "String", "nowRecordTable": "String", "participantID": "String", "targets": [Array] } ] |
| SearchTargetList. ​Externe ID | 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" \[Interaktion\] unterstützt. |
| SearchTargetList. ​NowRecordTable | Zeichenfolge | Erforderlich. ServiceNowTabelle, zu der die searchTargetList gehört. Tabelle: Nur gültiger Wert -- `„Interaktion" ` |
| SearchTargetList. ​Partizipierende ID | Zeichenfolge | Eindeutiger Bezeichner für den Teilnehmer aus dem CCaaS-System. |
| SearchTargetList. ​Ziele | Objekt-Array | 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 übertragen" angezeigt werden sollen. Das folgende ist 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. <br /> "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 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 | Objekt-Array | 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. Standard: Falsch |
| SearchTargetList. ​Ziele. ​Nutzlast. ​Liste. ​id | Zeichenfolge | Eindeutiger Bezeichner des Agenten oder der Warteschlange im CCaaS-System. |
| SearchTargetList. ​Ziele. ​Nutzlast. ​Liste. ​Moreinfo | Objekt-Array | 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 Agenten, externen Anwenders oder der Warteschlange. Befindet sich im CCaaS-System. |
| SearchTargetList. ​Ziele. ​Nutzlast. ​Liste. ​Anwesenheit | Zeichenfolge | Anwesenheitsstatus des zugeordneten Service Desk-Mitarbeiters. Dieser Parameter ist nur für gültig searchTargetList.targets.typeVon `„Service Desk-Mitarbeiter" `. Gültige Werte: * Verfügbar * entfernt * Belegt * offline |
| SearchTargetList. ​Ziele. ​Transferuntertypen | Objekt-Array | 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. <br /> Wenn beispielsweise nur ein Beratungstyp für den aktuellen Zieltyp unterstützt wird, z. B. Warteschlange, enthält dieses Array ein Objekt, das den Beratungstyp der Übertragung angibt. "transferSubtypes": [ { "id": "String", "label": "String" } ] |
| SearchTargetList. ​Ziele. ​Transferuntertypen. ​id | Zeichenfolge | Bezeichner des Transferuntertyps. Gültige Werte: * Blind: Service Desk-Mitarbeiter leitet den Kundenanruf direkt an einen anderen Service Desk-Mitarbeiter oder eine andere Warteschlange weiter, 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 Übertragungsuntertyp 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 : 21. Parameter]

{#openFrameAPI-setICContext_S_O__table_xlq_rhg_zdc} {#openFrameAPI-setICContext_S_O__table_ylq_rhg_zdc__entry__2}

| Typ | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 22. Rückgaben]

{#openFrameAPI-setICContext_S_O__table_ylq_rhg_zdc}  
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": "+18582359874",
              "ani": "+16193287356", 
              "dnis": "+18004346258",
              "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": "+3134787324",
              "ani": "+13134787324", 
              "dnis": "+14773286943",
              "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": "+123456789",
              "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": "+123456789",
              "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 Inaktivitätsstatus 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-Symbole) {#ariaid-title13}

Definiert Symbole im OpenFrame-Header, die neben dem Symbol „Schließen" platziert werden.
{#r_openFrameAPI-setIcons_Array__table_dg3_lny_kt__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Symbole | 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 : 23. Parameter]

{#r_openFrameAPI-setIcons_Array__table_dg3_lny_kt} {#r_openFrameAPI-setIcons_Array__table_eg3_lny_kt__entry__2}

| Typ | Beschreibung |
|-|-|
| Ungültig |   |
[Tabelle : 24. Rückgaben]

{#r_openFrameAPI-setIcons_Array__table_eg3_lny_kt}  

    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 (Präsenz) {#ariaid-title14}

Legt den Anwesenheitsindikator fest, um die Verfügbarkeit von Service Desk-Mitarbeitern in einem Arbeitsbereich anzuzeigen.
Weitere Informationen zum Konfigurieren von OpenFrame finden Sie unter [Erstellen Sie eine OpenFrame-Konfiguration](https://www.servicenow.com/docs/access?context=t_CreateAnOpenFrameConfiguration&version=yokohama&pubname=yokohama-customer-service-management&ft:locale=en-US)
{#openFrameAPI-setPresenceIndicator__table_o4l_p1c_jhb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Staat | Zeichenfolge | Anwesenheitsstatus des Service Desk-Mitarbeiters. standardstatus: * Verfügbar * Abwesend * Offline {#openFrameAPI-setPresenceIndicator__ul_bws_ldg_d3b} Sie können auch anwenderdefinierte status angeben. |
| Farbe | Zeichenfolge | Anwesenheitsindikatorfarbe im Arbeitsbereich. Unterstützte Farben: * rot * Orange * grau * grün {#openFrameAPI-setPresenceIndicator__ul_xwr_xbg_d3b} |
[Tabelle : 25. Parameter]

{#openFrameAPI-setPresenceIndicator__table_o4l_p1c_jhb} {#openFrameAPI-setPresenceIndicator__table_p4l_p1c_jhb__entry__2}

| Typ | Beschreibung |
|-|-|
| Ungültig |   |
[Tabelle : 26. Rückgaben]

{#openFrameAPI-setPresenceIndicator__table_p4l_p1c_jhb}  

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

## OpenFrameAPI -- SETSIZE(Zahlenbreite, Zahlenhöhe) {#ariaid-title15}

Legt die OpenFrame-Größe fest.
{#r_openFrameAPI-setSize_Number_Number__table_vvk_5jy_kt__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| width | Nummer | Muss größer als Null sein. |
| height | Nummer | Muss größer als Null sein. |
[Tabelle : 27. Parameter]

{#r_openFrameAPI-setSize_Number_Number__table_vvk_5jy_kt} {#r_openFrameAPI-setSize_Number_Number__table_wvk_5jy_kt__entry__2}

| Typ | Beschreibung |
|-|-|
| Ungültig |   |
[Tabelle : 28. Rückgaben]

{#r_openFrameAPI-setSize_Number_Number__table_wvk_5jy_kt}  

    openFrameAPI.setSize(300, 370);

## OpenFrameAPI -- setSubtitle(Zeichenfolgenuntertitel) {#ariaid-title16}

Legt den OpenFrame-Untertitel fest.
{#r_openFrameAPI-setSubtitle_String__table_ztd_hjy_kt__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Untertitel | Zeichenfolge | Eine Zeichenfolge mit maximal 256 Zeichen. |
[Tabelle : 29. Parameter]

{#r_openFrameAPI-setSubtitle_String__table_ztd_hjy_kt} {#r_openFrameAPI-setSubtitle_String__table_a5d_hjy_kt__entry__2}

| Typ | Beschreibung |
|-|-|
| Ungültig |   |
[Tabelle : 30. Rückgaben]

{#r_openFrameAPI-setSubtitle_String__table_a5d_hjy_kt}  

    openFrameAPI.setSubtitle('+18888888888');

## OpenFrameAPI -- setTitle(Zeichenfolgentitel) {#ariaid-title17}

Legt den OpenFrame-Titel fest.
{#r_openFrameAPI-setTitle_String__table_jbl_w3y_kt__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Titel | Zeichenfolge | Eine Zeichenfolge mit maximal 256 Zeichen. |
[Tabelle : 31. Parameter]

{#r_openFrameAPI-setTitle_String__table_jbl_w3y_kt} {#r_openFrameAPI-setTitle_String__table_kbl_w3y_kt__entry__2}

| Typ | Beschreibung |
|-|-|
| Ungültig |   |
[Tabelle : 32. Rückgaben]

{#r_openFrameAPI-setTitle_String__table_kbl_w3y_kt}  

    openFrameAPI.setTitle('Incoming Call');

## OpenFrameAPI -- setTitleIcon(Objektsymbol) {#ariaid-title18}

Legt das Titelsymbol des OpenFrame fest.
{#r_openFrameAPI-setTitleIcon_Object__table_w42_kky_kt__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| icon | Objekt | Objekt von Schlüssel-Wert-Paaren. Schlüssel enthalten imageURL, imageTitle, Und jeder andere erforderliche Kontext. Maximale Größe: Symbole können maximal 16x16 Pixel betragen. Größere Bilder werden automatisch auf dieses Maximum angepasst. |
[Tabelle : 33. Parameter]

{#r_openFrameAPI-setTitleIcon_Object__table_w42_kky_kt} {#r_openFrameAPI-setTitleIcon_Object__table_x42_kky_kt__entry__2}

| Typ | Beschreibung |
|-|-|
| Ungültig |   |
[Tabelle : 34. Rückgaben]

{#r_openFrameAPI-setTitleIcon_Object__table_x42_kky_kt}  

    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) {#ariaid-title19}

Legt die OpenFrame-Breite fest.
{#r_openFrameAPI-setWidth__table_yzb_mxx_kt__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Breite | Nummer | Breite in Pixel |
[Tabelle : 35. Parameter]

{#r_openFrameAPI-setWidth__table_yzb_mxx_kt} {#r_openFrameAPI-setWidth__table_zzb_mxx_kt__entry__2}

| Typ | Beschreibung |
|-|-|
| Ungültig |   |
[Tabelle : 36. Rückgaben]

{#r_openFrameAPI-setWidth__table_zzb_mxx_kt}  

    openFrameAPI.setWidth(100);

## OpenFrameAPI -- Show() {#ariaid-title20}

Macht OpenFrame im TopFrame sichtbar.
{#r_openFrameAPI-show__table_ah2_vwx_kt__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Keine |   |   |
[Tabelle : 37. Parameter]

{#r_openFrameAPI-show__table_ah2_vwx_kt} {#r_openFrameAPI-show__table_bh2_vwx_kt__entry__2}

| Typ | Beschreibung |
|-|-|
| Ungültig |   |
[Tabelle : 38. Rückgaben]

{#r_openFrameAPI-show__table_bh2_vwx_kt}  

    openFrameAPI.show()

## OpenFrameAPI -- Subscribe(openFrameAPIEVENT-Ereignis, function eventCallback) {#ariaid-title21}

Abonniert ein angegebenes Ereignis.
{#r_openFrameAPI-subscribe_Event_Object__table_znv_gvd_lt__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Ereignis | 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), dieses Ereignis tritt auf, wenn sich der Anwesenheitsstatus des Service Desk-Mitarbeiters ändert. Entwickler der 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 auf, 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 auf, wenn die Kommunikation mit TopFrame fehlschlägt. * Openframe_expand: Tritt auf, wenn das Erweiterungssymbol im OpenFrame-Header 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 auf, wenn OpenFrame ausgeblendet ist. * Openframe_icon_clicked: Tritt auf, wenn ein anderes Symbol als das Symbol „Schließen" in der OpenFrame-Fußzeile ausgewählt ist. Der Rückruf empfängt das Symbolobjekt als Parameter. * Openframe_shown: Tritt auf, wenn OpenFrame angezeigt wird. * openframe_title_icon_clicked: tritt auf, wenn das Titelsymbol in OpenFrame ausgewählt ist. Der Rückruf 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](https://www.servicenow.com/docs/access?context=interaction-wrapup-modeless-dialog&version=yokohama&pubname=yokohama-customer-service-management&ft:locale=en-US). Das Ereignis wird nur ausgelöst, wenn die Nachbearbeitung extern ist. |
| EventRückruf | Funktion | Funktion, die aufgerufen werden soll, wenn das angegebene Ereignis eintritt. |
[Tabelle : 39. Parameter]

{#r_openFrameAPI-subscribe_Event_Object__table_znv_gvd_lt} {#r_openFrameAPI-subscribe_Event_Object__table_a4v_gvd_lt__entry__2}

| 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 Agent 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 {#r_openFrameAPI-subscribe_Event_Object__ul_xf1_pcp_zbc} * presence.name: Name des Anwesenheitsstatus des Service Desk-Mitarbeiters. * presence.sys_id: Anwesenheitsstatus sys_ID {#r_openFrameAPI-subscribe_Event_Object__ul_wf1_pcp_zbc} |
| 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. {#r_openFrameAPI-subscribe_Event_Object__ul_svh_jww_zbc} * 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 wurde. 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](https://www.servicenow.com/docs/access?context=transfer-chat-queue&version=yokohama&pubname=yokohama-platform-user-interface&ft:locale=en-US). * workItem.previousWorkItem: SYS_ID des vorherigen Arbeitselements für dieselbe Dokument-ID. Für die nicht übertragenen 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. {#r_openFrameAPI-subscribe_Event_Object__ul_tvh_jww_zbc} * 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. {#r_openFrameAPI-subscribe_Event_Object__ul_rvh_jww_zbc} |
| 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. {#r_openFrameAPI-subscribe_Event_Object__ul_f3z_jww_zbc} * workItem.isQueueTransferred: Kennzeichnung, die angibt, ob das Arbeitselement in der Warteschlange übertragen wurde. 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](https://www.servicenow.com/docs/access?context=transfer-chat-queue&version=yokohama&pubname=yokohama-platform-user-interface&ft:locale=en-US). * workItem.previousWorkItem: SYS_ID des vorherigen Arbeitselements für dieselbe Dokument-ID. Für die nicht übertragenen 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\] {#r_openFrameAPI-subscribe_Event_Object__ul_g3z_jww_zbc} * 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. {#r_openFrameAPI-subscribe_Event_Object__ul_h3z_jww_zbc} * 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. {#r_openFrameAPI-subscribe_Event_Object__ul_e3z_jww_zbc} |
| 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 ServiceNowInstanz oder verwaltet außerhalb von ServiceNowInstanz von einem anderen Anrufsystem. * Wahr: Die Nachbearbeitung wird von einem externen Anrufsystem verarbeitet. * Falsch: Nachbearbeitung wird von behandelt ServiceNowInstanz. {#r_openFrameAPI-subscribe_Event_Object__ul_mkx_nhl_wdc} * 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 aufgelöst wurde. * wrapUpSegmentId: SYS_ID des Segmentdatensatzes der Interaktionsabschlusserklärung, der der Interaktion zugeordnet ist. Befindet sich in der Tabelle „Nachbearbeitungssegment" \[interaction_wrap_up_segment\]. Enthält die Nachbearbeitungsdaten. |
[Tabelle : 40. Rückgaben]

{#r_openFrameAPI-subscribe_Event_Object__table_a4v_gvd_lt}  
Das folgende Codebeispiel zeigt, wie diese Methode für 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 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 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() {#ariaid-title22}

Gibt die OpenFrame-API-Version zurück.
{#r_openFrameAPI-version__table_ob3_ryd_lt__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Keine |   |   |
[Tabelle : 41. Parameter]

{#r_openFrameAPI-version__table_ob3_ryd_lt} {#r_openFrameAPI-version__table_pb3_ryd_lt__entry__2}

| Typ | Beschreibung |
|-|-|
| Zeichenfolge | Die OpenFrame-API-Version |
[Tabelle : 42. Rückgaben]

{#r_openFrameAPI-version__table_pb3_ryd_lt}  

    var version = openFrameAPI.version();

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


