Authentifizierung während der Sitzung über die API

Auf dieser Seite wird beschrieben, wie Sie Anruf- und Chat-API-Endpunkte für die Authentifizierung während der Sitzung in Ihren SDK-Channels verwenden.

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

URI und Authentifizierung

Der Basis-URI für diesen neuen Endpunkt hängt vom comm_type ab.

Für den call-comm_type:

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

Für den chat-comm_type:

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

API-Vorgänge

Parameter

Der Body 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 generische Name oder die Kennung, die mit der Interaktion verknüpft ist. Hilft beim Nachschlagen von Kunden. John Doe
2 email String Nein Die allgemeine E‑Mail-Adresse, die mit der Interaktion verknüpft ist. Hilft beim Nachschlagen von Kunden. john@doe.com
3 phone String Nein Die allgemeine Telefonnummer, die mit der Interaktion verknüpft ist. Hilft beim Nachschlagen von Kunden. 123-456-7890

API-Beispiele

Beispiel für eine API-Antwort

Beispiel für eine Erfolgsantwort:

202 Accepted

{
 "message": "accepted"
}

Beispiele für Fehlerantworten

Fehlende Parameter
400 {"message": "param is missing or the value is empty: comm_type"}
400 {"message": "param is missing or the value is empty: identifier"}
Verweis auf eine andere Kommunikationsart als Anruf oder Chat
404 {"message": "Not Found"}
Sitzung nicht aktiv
400 {"message": "Call is already ended"}
400 {"message": "Chat is already ended"}
Nicht unterstützte CRM-Anfrage
400 {"message": "Unsupported CRM request"}
Doppelte Anfrage
400 {"message": "Duplicate request: Please wait for the interval to expire"}

Beispiel für API-Anfrage

Call Comm Type

POST https://<subdomain>.<domain>/apps/api/v1/calls/:call_id/end_user
Content-Type: application/json
Authorization: Bearer <your_access_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
Authorization: Bearer <your_access_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.