Benutzer-CDP abfragen

Mit dieser Schnittstelle können Entwickler:innen die Benutzer-CDP-Informationen (Customer Data Platform) von Agent:innen-/Workflow-Benutzer:innen abfragen – darunter Benutzer-ID, anonyme ID und Konversationstyp. Die Abfrage erfolgt entweder über eine entwicklerdefinierte Benutzer-ID oder eine anonyme ID.

Die Benutzer-CDP-Informationen werden jeweils unter jedem Agent:in/Workflow gespeichert. Das bedeutet, dass die Benutzerdaten derselben Person zwischen verschiedenen Agent:innen/Workflows isoliert sind.

Anfragemethode

GET

Endpunkt

https://api.${endpoint}/v1/user/get-user-cdp

Authentifizierung

Informationen zu den Authentifizierungsmethoden finden Sie in der API-Übersicht.

Anfrage

Anfragebeispiele

Abfrage nach user_id:

curl -X GET 'https://api.${endpoint}/v1/user/get-user-cdp?user_id=BC123' \ -H 'Authorization: Bearer ${token}'

                      
                      curl -X GET 'https://api.${endpoint}/v1/user/get-user-cdp?user_id=BC123' \
-H 'Authorization: Bearer ${token}'

Dieser Codeblock im schwebenden Fenster

Abfrage nach anonymous_id:

curl -X GET 'https://api.${endpoint}/v1/user/get-user-cdp?anonymous_id=22ses32dsafdabd1w2sad' \ -H 'Authorization: Bearer ${token}'

                      
                      curl -X GET 'https://api.${endpoint}/v1/user/get-user-cdp?anonymous_id=22ses32dsafdabd1w2sad' \
-H 'Authorization: Bearer ${token}'

Dieser Codeblock im schwebenden Fenster

Abfrage nach user_id und anonymous_id:

curl -X GET 'https://api.${endpoint}/v1/user/get-user-cdp?user_id=BC123&anonymous_id=22ses32dsafdabd1w2sad' \ -H 'Authorization: Bearer ${token}'

                      
                      curl -X GET 'https://api.${endpoint}/v1/user/get-user-cdp?user_id=BC123&anonymous_id=22ses32dsafdabd1w2sad' \
-H 'Authorization: Bearer ${token}'

Dieser Codeblock im schwebenden Fenster

Die aktuelle anonymous_id kann unter „Agent:in/Workflow-Konfiguration – Globale Variablen“ eingesehen werden.

Anfrage-Header

Feld	Typ	Beschreibung
Authorization	Bearer ${token}	Verwenden Sie „Authorization: Bearer ${token}“ zur Authentifizierung. Ihren Schlüssel `$ {token}` erhalten Sie auf der API-Key-Seite.

Query-Parameter

Parameter	Typ	Beschreibung	Erforderlich
user_id	string	Entwicklerdefinierte Benutzer-ID.	nein
anonymous_id	string	Von der GPTBots-Plattform generierte anonyme ID, meist basierend auf einer eindeutigen Kennung einer Drittanbieter-Plattform. Unter „Agent:in/Workflow-Konfiguration – Globale Variablen“ abrufbar.	nein

Mindestens einer der Parameter user_id oder anonymous_id muss angegeben werden, sonst wird ein Parameterfehler zurückgegeben.

Mit nur user_id können Sie alle verknüpften Informationen zu einer Person abfragen.

Mit nur anonymous_id erhalten Sie die Informationen zu einer anonymen ID.

Durch Angabe von user_id und anonymous_id ist eine präzise Abfrage möglich.

Antwort

Antwort-Body

{ "code": 0, "message": "OK", "data": { "user1": { "user_id": "user1", "anonymous_ids": [ { "anonymous_id": "aId3", "conversation_type": "WEB", "source_id": null } ] }, "67b58121035e5b152b0419ee": { "user_id": "67b58121035e5b152b0419ee", "anonymous_ids": [ { "anonymous_id": "aId3", "conversation_type": "C", "source_id": null } ] } } }

                      
                      {
    "code": 0,
    "message": "OK",
    "data": {
        "user1": {
            "user_id": "user1",
            "anonymous_ids": [
                {
                    "anonymous_id": "aId3",
                    "conversation_type": "WEB",
                    "source_id": null
                }
            ]
        },
        "67b58121035e5b152b0419ee": {
            "user_id": "67b58121035e5b152b0419ee",
            "anonymous_ids": [
                {
                    "anonymous_id": "aId3",
                    "conversation_type": "C",
                    "source_id": null
                }
            ]
        }
    }
}

Dieser Codeblock im schwebenden Fenster

Erfolgreiche Antwort

Die Antwort ist ein Objekt, bei dem der Schlüssel die jeweilige user_id ist. Der Wert enthält die vollständigen Benutzer-CDP-Informationen:

Feld	Typ	Beschreibung
{user_id}	object	Objekt, das unter der jeweiligen Benutzer-ID alle zugehörigen CDP-Informationen enthält.
{user_id}.user_id	string	Benutzer-ID.
{user_id}.anonymous_ids	array	Alle aktuell mit dieser Benutzer-ID verknüpften anonymen IDs und deren Konversationstypen.
{user_id}.anonymous_ids[].anonymous_id	string	Anonyme ID.
{user_id}.anonymous_ids[].conversation_type	string	Konversationstyp. Eine Zuordnungstabelle finden Sie im Abschnitt „Konversationstypen“ der Benutzer:innen-Übersicht.
{user_id}.anonymous_ids[].source_id	string	Quell-ID der Konversationsplattform. Beispiel: Bei Integration mit „TELEGRAM“ und mehreren TG-Bots hat jeder Bot eine eigene Quell-ID.

Fehlerantwort

Feld	Typ	Beschreibung
code	int	Fehlercode
message	string	Fehlermeldung

Statuscodes

Statuscode	Beschreibung
200	Erfolg
400	Parameterfehler (keine Abfrageparameter angegeben)
401	Nicht autorisiert
403	Zugriff verweigert
500	Serverfehler