Agent Mapping-API

Die Agent Mapping- API bietet einen Endpunkt für die Zuordnung von externen Mitarbeiter-IDs aus CCaaS-Systemen (Contact Center as a Service) zu internen Mitarbeiter-IDs in Now Platform.

Diese API erfordert das Plugin „External Agent Management Utility Pack“ (sn_external_agent). Zum Aufrufen dieser API benötigen Sie die Rolle „interaction_agent“.

Weitere Informationen zur Integration in CCaaS-Systeme finden Sie unter Integrating with contact centers.

Agent-Zuordnung – PUT /sn_ct_ctr_it_core/agent_mapping/agent/{agentId}/inboundId/{inboundId}

Ordnet eine externe Mitarbeiter-ID aus einem CCaaS-System (Contact Center as a Service) einer internen Mitarbeiter-ID im Now Platformzu.

Rufen Sie diesen Endpunkt auf, wenn sich ein Service Desk-Mitarbeiter beim CCaaS-System an- oder abmeldet, um seinen aktiven Status zu aktualisieren. Dieser Endpunkt erstellt oder aktualisiert Datensätze in der Tabelle „External Agent Mapping“ [external_agent_mapping] mit den folgenden Daten:

• Externe CCaaS-Agent-ID
• Identität des Anbieterkanals, die der eingehenden ID zugeordnet ist
• Aktiver Status des Service Desk-Mitarbeiters im CCaaS-System
• Verweis auf den Benutzerdatensatz [sys_user] für den Agent

URL-Format

Standard-URL: /api/sn_ct_ctr_it_core/agent_mapping/agent/{agentId}/inboundId/{inboundId}

Unterstützte Anforderungsparameter

Tabelle : 1. Pfadparameter

Name	Beschreibung
agentId	Sys_id des internen Agent. Datentyp: Zeichenfolge Tabelle: Benutzer [sys_user]
eingehendeId	Eingehende ID aus dem Identitätsdatensatz des Provider-Kanals für das CCaaS-System. Datentyp: Zeichenfolge Tabelle: Identität des Provider-Kanals [sys_cs_provider_application] Feld: Eingehende ID

Tabelle : 2. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 3. Parameter des Anforderungstexts (JSON)

Name	Beschreibung
aktiv	Kennzeichnung, die angibt, ob der Service Desk-Mitarbeiter derzeit beim CCaaS-System angemeldet ist. Gültige Werte: wahr: Der Service Desk-Mitarbeiter ist angemeldet. „falsch“: Der Service Desk-Mitarbeiter wird abgemeldet. Standardwert: wahr Datentyp: Boolesch
external_agent_id	Erforderlich. Externe Agent-ID aus dem CCaaS-System. 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.

Tabelle : 4. Anforderungskopfzeilen

Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützt nur application/json.
Content-Type	Datenformat des Anforderungstexts. Unterstützt nur application/json.

Tabelle : 5. Antwortkopfzeilen

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 HTTP-Antwortcodes der REST-API.

Tabelle : 6. Statuscodes

Statuscode	Beschreibung
200	Okay. Vorhandener Agent-Zuordnungsdatensatz aktualisiert.
201	Erstellt Neuer Agent-Zuordnungsdatensatz erstellt.
400	Ungültige Anforderung. Die in der Anforderung angegebene Agent-ID oder eingehende ID ist ungültig.

Parameter des Antwort-Haupttexts (JSON)

Name	Beschreibung
Ergebnis	Ergebnisobjekt, das Informationen zur Anforderung enthält. Datentyp: Objekt
result.mappingIds	Sys_ids aller erstellten oder aktualisierten Datensätze in der Tabelle „Zuordnung externer Service Desk-Mitarbeiter“ [external_agent_mapping]. Datentyp: Array von Zeichenfolgen
result.message	Nachricht, in der das Ergebnis der Anforderung erläutert wird. Datentyp: Zeichenfolge
result.status	Status der Anforderung. Mögliche Werte: Erfolg Fehler Datentyp: Zeichenfolge

cURL-Anforderung

In diesem Beispiel wird ein interner Agent mit der sys_id da419c1fc312310015519f2974d3ae15 der entsprechenden ID 12345 aus dem externen CCaaS-System zugeordnet.

curl "https://instance.service-now.com/api/sn_ct_ctr_it_core/agent_mapping/agent/da419c1fc312310015519f2974d3ae15/inboundId/ServiceNowVoice" \ 
--request PUT \ 
--header "Accept:application/json" \ 
--header "Content-Type:application/json" \ 
--data "{\"external_agent_id\":\"12345\"}" \ 
--user 'username':'password'

Antworttext:

{
  "result": { 
    "message": "Agent Id mapping record inserted", 
    "status": "success", 
    "mappingIds": [ 
      "128b74fcc3931a50325a4ad9d00131c3" 
    ] 
  } 
}

cURL-Anforderung

In diesem Beispiel wird der Parameter active auf false festgelegt, um anzugeben, dass der Service Desk-Mitarbeiter vom CCaaS-System abgemeldet ist.

curl "https://instance.service-now.com/api/sn_ct_ctr_it_core/agent_mapping/agent/da419c1fc312310015519f2974d3ae15/inboundId/ServiceNowVoice" \ 
--request PUT \ 
--header "Accept:application/json" \ 
--header "Content-Type:application/json" \ 
--data "{"external_agent_id":"12345", "active":"false"}" \ 
--user 'username':'password'

Antworttext:

{ 
  "result": { 
    "message": "Agent Id mapping record updated", 
    "status": "success", 
    "mappingIds": [ 
      "cea77cebebef9e10a341fc7acad0cdc2" 
    ] 
  } 
}