AWA-Angebots-Arbeits-API
Die AWA-Angebotsarbeit Die API bietet einen Endpunkt zum Zuweisen oder Übertragen von Arbeitselementen an Service Desk-Mitarbeiter.
Diese API ist für die Verwendung mit CCAAS-Integrationen (Contact Center as a Service) vorgesehen, bei denen die Weiterleitungs- und Zuweisungsentscheidung im externen CCAAS-System erfolgt. Diese API ermöglicht einen Posteingangskarte Soll einem Service Desk-Mitarbeiter in angezeigt werden ServiceNow Mitarbeiterbereich Als Benachrichtigung zum Akzeptieren des Arbeitselements.
Diese API erfordert Erweiterte Arbeitszuweisung Plugin (com.Glide.awa). Um diese API aufzurufen, benötigen Sie entweder die Rolle Awa_Manager oder Awa_Integration_user.
Weitere Informationen zu finden AWA, Siehe Erweiterte Arbeitszuweisung .
AWA-Angebotsarbeit – POSTEN SIE /now/Awa/documents/{document_table}/{document_sys_ID}/Offer
Weist Arbeitselemente zu oder überträgt sie an Service Desk-Mitarbeiter.
Ein Arbeitselement ist ein einzelnes Arbeitselement, das von einem bearbeitet wird AWA Service Desk-Mitarbeiter von Start bis Ende. Ein Arbeitselement wird basierend auf einem Dokument erstellt, z. B. einer Interaktion oder Aufgabe.
Alle Service Desk-Mitarbeiter, die Arbeitselemente mit dieser API empfangen oder übertragen, müssen die Rollen Awa_Agent und Awa_external_user haben.
URL-Format
Versionierte URL: /api/now/{api_Version}/Awa/documents/{document_table}/{document_sys_ID}/offer
Standard-URL: /api/now/Awa/documents/{document_table}/{document_sys_ID}/offer
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| Document_table | Name der Tabelle, die dem Dokument zugeordnet ist, z. B. Tabelle „Interaktion“ [Interaktion] oder Tabelle „Aufgabe“ [Aufgabe]. Datentyp: Zeichenfolge |
| Document_sys_ID | SYS_ID des Dokuments, das an den Agent oder die Warteschlange weitergeleitet werden soll. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Zuweisung | Erforderlich für neue Zuweisungen. Objekt mit Informationen zur Zuweisung. Datentyp: Objekt |
| Zuweisung.After_timeout_presence | SYS_ID des Anwesenheitsstatus, zu dem der Service Desk-Mitarbeiter wechselt, wenn der timeoutParameter läuft ab. Wenn timeoutParameter wurde nicht übergeben, dieser Parameter wird ignoriert. Weitere Informationen zu anwesenheitsstatus finden Sie unter Configure agent presence states. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge (Anwesenheitsstatus des Service Desk-Mitarbeiters ändert sich nicht). Tabelle: AWA-Anwesenheitsstatus [Awa_presence_State] |
| Zuweisung.Agent_sys_ID | Erforderlich für neue Zuweisungen. SYS_ID des verfügbaren Service Desk-Mitarbeiters für den Empfang des Arbeitselements. Der Service Desk-Mitarbeiter muss über die Rollen Awa_Agent und Awa_external_user verfügen. Informationen dazu, wie Sie bestimmen, ob ein Service Desk-Mitarbeiter verfügbar ist, finden Sie unter Bedienelemente für den Posteingang des Service Desk-Mitarbei . Datentyp: Zeichenfolge Tabelle: Benutzer [sys_user] |
| Zuweisung.allowed_to_Decly | Kennzeichnung, die angibt, ob Service Desk-Mitarbeiter Arbeitselemente ablehnen dürfen. Wenn dieser Parameter ist Wahr , Auf der Posteingangskarte werden beide angezeigt Akzeptieren Und Ablehnen Schaltflächen auf der Posteingangskarte.Gültige Werte:
Datentyp: Boolesch Standardwert: wahr |
| Zuweisung.Display_Option | Anzeigeoption für die Karte und Registerkarte, wenn ein Arbeitselement automatisch zugewiesen wird. Dieser Parameter ist nur gültig, wenn enable_auto_assignIst Wahr . Gültige Werte:
Datentyp: Zeichenfolge Standard: Card_only |
| Zuweisung.enable_Auto_assign | Kennzeichnung, die angibt, ob das Arbeitselement automatisch akzeptiert werden soll oder es dem Service Desk-Mitarbeiter ermöglichen soll, das Arbeitselement manuell zu akzeptieren oder abzulehnen. Gültige Werte:
Datentyp: Boolesch Standardwert: false |
| Zuweisung.Offered_on | Angebotszeit des Arbeitselements. Die Angebotszeit wird verwendet, um die verbleibende Zeit zu berechnen, die dem Service Desk-Mitarbeiter verbleibt, um das Arbeitselement im Posteingang zu akzeptieren. Es hilft, die Diskrepanz zwischen dem Zeitpunkt, zu dem die API-Anforderung verarbeitet wird, und dem Zeitpunkt, zu dem das Weiterleitungssystem einer Drittpartei die API-Anforderung aufruft, zu berücksichtigen. Mit diesem Parameter können externe Systeme, die diesen Endpunkt aufrufen, die Angebotszeit des Arbeitselements so konfigurieren, dass es mit der internen Nachverfolgung des Arbeitselements des externen Systems synchronisiert bleibt. Wenn das Arbeitselement beispielsweise am 11:30:30 angeboten wurde, die Zeitüberschreitung 30 Sekunden beträgt und die aktuelle Zeit 11:30:45 ist, zeigt der Countdown-Timer 00:15 an (wie in 15 Sekunden verbleibend). Dieser Wert wird im Feld angebotene_on des Arbeitselements gespeichert. Dieser Parameter wird ignoriert, wenn der timeoutParameter wurde nicht übergeben. Datentyp: Zeichenfolge Format: UTC-Zeitstempel (jjjj-MM-tt'T'HH:mm:ss.SSS) |
| Zuweisung.Zeitüberschreitung | Zeit, die das Arbeitselement im Posteingang des Service Desk-Mitarbeiters verbleibt und darauf wartet, dass der Service Desk-Mitarbeiter die Arbeitszuweisung akzeptiert. Datentyp: Zahl Einheit: Sekunden Standard: Leere Zeichenfolge (keine Zeitbegrenzung). |
| External_Segment_ID | Externer Bezeichner aus dem CCAAS-System des Anrufsegments, das dem Service Desk-Mitarbeiter angeboten wird. Datentyp: Zeichenfolge |
| Warteschlangen-ID | Erforderlich für neue Zuweisungen. SYS_ID des Warteschlangendatensatzes oder des Warteschlangenbezeichners in einem externen System. Wenn Sie eine Queue_ID aus einem externen System verwenden, muss sie dem Feld Provider-Warteschlangen-ID (external_ID) im Datensatz „Awa_Queue“ zugeordnet werden. Datentyp: Zeichenfolge Tabelle: Warteschlange [Awa_Queue] |
| Übertragung | Erforderlich für Transferzuweisungen. Objekt mit Informationen zur Übertragung. Wenn für diesen Parameter ein Wert angegeben wird, wird die Zuweisung als Übertragungszuweisung betrachtet. Datentyp: Objekt |
| Transfer.Source_Queue_ID | Erforderlich für Transferzuweisungen. Quellwarteschlange, aus der die Übertragung initiiert wird. SYS_ID des Warteschlangendatensatzes oder des Warteschlangenbezeichners in einem externen System. Wenn Sie eine Queue_ID aus einem externen System verwenden, muss sie dem Feld Provider-Warteschlangen-ID (external_ID) im Datensatz „Awa_Queue“ zugeordnet werden. Dieser Parameter wird verwendet, um ein Arbeitselement vor dem Initiieren der Übertragung zu erstellen, wenn kein aktives Arbeitselement gefunden wird. Ermöglicht die Durchführung von Übertragungen, wenn die ursprüngliche Interaktion ohne Weiterleitung erstellt wurde, z. B. für ausgehende Anrufe. Datentyp: Zeichenfolge Tabelle: Warteschlange [Awa_Queue] |
| Transfer.target_ID | Erforderlich für Transferzuweisungen. SYS_ID des Service Desk-Mitarbeiters oder Warteschlangendatensatzes, an den die Zuweisung übertragen werden soll.
Datentyp: Zeichenfolge |
| Transfer.target_type | Erforderlich für Transferzuweisungen. Typ des Datensatzes, an den die Zuweisung übertragen werden soll. Gültige Werte:
Datentyp: Zeichenfolge |
| Transfer.Transfer_type | Erforderlich für Transferzuweisungen. Typ der Übertragung. Gültige Werte:
Datentyp: Zeichenfolge |
Header
Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Inhaltstyp | Datenformat des Anforderungstexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 401 | Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 404 | Nicht gefunden. Das angeforderte Element wurde nicht gefunden. |
| 409 | Konflikt. Die Anforderung konnte aufgrund eines Fehlers mit dem Arbeitselement oder der sys_ID des angegebenen Mitarbeiters nicht verarbeitet werden |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler. |
Antworttext-Parameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Nachricht | Antwortnachricht mit Informationen zum Erfolg oder Fehler der Zuweisung. Mögliche Werte:
|
| Erfolg | Kennzeichnung, die angibt, ob die Zuweisung erfolgreich ist. Mögliche Werte:
Datentyp: Boolesch |
| Work_item | Details zum erstellten oder aktualisierten Arbeitselement. Datentyp: Objekt |
| Work_item.Display_Name | Anzeigename des Dokumentdatensatzes. Datentyp: Zeichenfolge |
| Work_item.document_ID | SYS_ID des Dokumentdatensatzes. Datentyp: Zeichenfolge |
| Work_item.document_table | Name der Tabelle, die dem Dokument zugeordnet ist. Datentyp: Zeichenfolge |
| Work_item.Queue | SYS_ID des Warteschlangendatensatzes oder des Warteschlangenbezeichners in einem externen System. Datentyp: Zeichenfolge Tabelle: Warteschlange [Awa_Queue] |
| Work_item.sys_ID | SYS_ID des Arbeitselements. Datentyp: Zeichenfolge Tabelle: Arbeitselement [Awa_work_item] |
cURL-Anforderung
Dieses Beispiel zeigt, wie einem Service Desk-Mitarbeiter ein Arbeitselement zugewiesen wird.
curl "https://instance.servicenow.com/api/now/awa/documents/interaction/59616aba87bd5210be070d48dabb35e6/offer" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data '{
"external_segment_id": "segment_59616aba87bd5210be070d48dabb35e6",
"queue_id": "92f8942787851210be070d48dabb35fb",
"assignment": {
"agent_sys_id": "0d584509c323120095ccd02422d3ae5b",
"allowed_to_decline": "true",
"enable_auto_assign": "false",
"timeout": 30,
"offered_on":"2024-04-03T23:09:31.000"
}
}'
--user 'username':'password'Die Antwort zeigt an, dass das Arbeitselement dem Service Desk-Mitarbeiter erfolgreich zugewiesen wurde. Sie können das Ergebnis im Feld Zugewiesen an des Arbeitselementdatensatzes [Awa_work_item] überprüfen.
{
"result": {
"work_item": {
"display_name": "Interaction: IMS0000221",
"sys_id": "bfa3a27e87bd5210be070d48dabb3588",
"document_id": "59616aba87bd5210be070d48dabb35e6",
"document_table": "interaction",
"queue": "92f8942787851210be070d48dabb35fb"
},
"success": true,
"message": "Manual assignment successfully requested."
}
}