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 der Sitzung in Ihren SDK-Kanälen verwenden.

Nutzer können eine Supportsitzung starten, z. B. einen Supportchat, ohne sich zu authentifizieren. Wenn eine Endnutzerauthentifizierung erforderlich ist, 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

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

Für den call-comm_type:

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

Für den chat-comm_type:

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

API-Vorgänge

Parameter

Der Text der API-Anfrage muss 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

Beispiel für eine API-Antwort

Beispiel für eine erfolgreiche Antwort:

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 einen anderen Kommunikationstyp 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 eine API-Anfrage

Kommunikationstyp „Anruf“

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"
}

Kommunikationstyp „Chat“

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 Apps API-Endpunkte finden Sie unter Apps API Publication.