Authentifizierung während der Sitzung über die API

Auf dieser Seite wird erläutert, wie Sie API-Endpunkte für Anrufe und Chats für die Authentifizierung während einer Sitzung in Ihren SDK-Kanälen verwenden.

Nutzer können eine Supportsitzung, z. B. einen Supportchat, ohne Authentifizierung starten. Wenn eine Endnutzerauthentifizierung erforderlich wird, können Sie einen Authentifizierungsablauf initiieren. Nach erfolgreicher Authentifizierung können Sie die Kennung end_user aktualisieren, um die Sitzung mit dem verifizierten Endnutzer zu verknüpfen.

URI und Authentifizierung

Der Basis-URI für diesen neuen Endpunkt variiert je nach comm_type.

Für den call-Kommunikationstyp:

POST https://<subdomain>.<domain>/apps/api/v1/calls/:call_id/end_user

Für den chat-Kommunikationstyp:

POST https://<subdomain>.<domain>/apps/api/v1/chats/:chat_id/end_user

API-Vorgänge

In den folgenden Abschnitten finden Sie Details zu den API-Vorgängen.

Parameter

Der Text der API-Anfrage sollte die folgenden Felder enthalten:

ID Feldname Typ Erforderlich/Optional? Beschreibung Beispielwerte
0 identifier String Ja Eindeutige externe Kennung angegeben.
1 name String Nein Der allgemeine Name oder die Kennung, die mit der Interaktion verknüpft ist. Hilft bei der Kundensuche. John Doe
2 email String Nein Die allgemeine E-Mail-Adresse, die mit der Interaktion verknüpft ist. Hilft bei der Kundensuche. john@doe.com
3 phone String Nein Die allgemeine Telefonnummer, die mit der Interaktion verknüpft ist. Hilft bei der Kundensuche. 123-456-7890

API-Beispiele

In den nächsten Abschnitten finden Sie Beispiele für API-Anfragen und -Antworten.

Beispiel für eine Erfolgsantwort

202 Accepted

{
 "message": "accepted"
}

Beispiele für Fehlerantworten

In den nächsten Abschnitten finden Sie Beispiele für Fehlerantworten.

Fehlerantworten

400 – Ungültige Anfrage: In der Anfrage fehlt das erforderliche ID-Feld.

{
  "message": "param is missing or the value is empty: identifier"
}

401 Nicht autorisiert – Authentifizierung fehlgeschlagen.

{
  "message": "Not Found"
}

404 Nicht gefunden – Für die angegebene ID ist kein Anruf oder Chat vorhanden.

Sitzung nicht aktiv

400 {"message": "Call is already ended"}
400 {"message": "Chat is already ended"}

Nicht unterstützte CRM-Anfrage

400 Bad Request – Die CRM-Konfiguration der Instanz unterstützt diesen Aktualisierungspfad nicht.

{
  "message": "Unsupported CRM request"
}

Doppelte Anfrage

400 {"message": "Duplicate request: Please wait for the interval to expire"}

Beispiel für eine API-Anfrage

Im nächsten Abschnitt finden Sie Beispiel-API-Anfragen für die Kommunikationstypen „Anruf“ und „Chat“.

Anruf-Kommunikationstyp

POST https://<subdomain>.<domain>/apps/api/v1/calls/:call_id/end_user
Content-Type: application/json
-u apiuser:APIUSER_TOKEN

{
    "identifier": "unique_external_id",
    "name": "John Doe",
    "email": "johndoe@example.com",
    "phone": "123-456-7890"
}

Chat-Kommunikationstyp

POST https://<subdomain>.<domain>/apps/api/v1/chats/:chat_id/end_user
Content-Type: application/json
-u apiuser:APIUSER_TOKEN

{
    "identifier": "unique_external_id",
    "name": "Jane Smith",
    "email": "janesmith@example.com",
    "phone": "098-765-4321"
}

Apps API-Dokumentation

Weitere API-Endpunkte für Apps finden Sie unter Apps API Publication.