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.
Nur Benutzer:innen, für die eine user_id festgelegt wurde, können hinsichtlich ihrer CDP-Informationen abgefragt werden. Benutzer:innen ohne festgelegte user_id können nicht abgefragt werden.

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

                    

• Abfrage nach anonymous_id:

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

                    

• 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}'

                    

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

Anfrage-Header

Query-Parameter

1. Mindestens einer der Parameter user_id oder anonymous_id muss angegeben werden, sonst wird ein Parameterfehler zurückgegeben.
2. Mit nur user_id können Sie alle verknüpften Informationen zu einer Person abfragen.
3. Mit nur anonymous_id erhalten Sie die Informationen zu einer anonymen ID.
4. 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",
            "user_email": "user1@example.com",
            "user_phone": "+6080000000",
            "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
                }
            ]
        }
    }
}

                    

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:

Fehlerantwort

Statuscodes