Requête CDP utilisateur

Permet aux développeurs d'interroger les informations CDP (Customer Data Platform) d'un utilisateur d'Agent/Workflow, incluant l'ID utilisateur, l'ID anonyme et le type de conversation, en utilisant soit un ID utilisateur, soit un ID anonyme.

Les informations CDP utilisateur sont stockées sous chaque Agent/Workflow, ce qui signifie que les données pour un même utilisateur sont isolées entre différents Agents/Workflows.

Méthode de requête

GET

Endpoint

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

Authentification

Veuillez consulter la vue d'ensemble de l'API pour plus de détails sur les méthodes d'authentification.

Requête

Exemples de requête

Requête par 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}'

Ce bloc de code dans la fenêtre flottante

Requête par 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}'

Ce bloc de code dans la fenêtre flottante

Requête par user_id et 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}'

Ce bloc de code dans la fenêtre flottante

L'anonymous_id de l'utilisateur actuel peut être obtenu depuis "Configuration Agent/Workflow - Variables globales".

En-têtes de requête

Champ	Type	Description
Authorization	Bearer ${token}	Utilisez `Authorization: Bearer ${token}` pour l'authentification. Obtenez votre clé `${token}` depuis la page Clé API.

Paramètres de requête

Paramètre	Type	Description	Obligatoire
user_id	string	ID utilisateur défini par le développeur.	false
anonymous_id	string	Un ID anonyme généré par la plateforme GPTBots, généralement basé sur l'identifiant unique d'une plateforme tierce. Peut être obtenu depuis "Configuration Agent/Workflow - Variables globales".	false

Au moins l'un des paramètres user_id ou anonymous_id doit être fourni ; sinon, une erreur de paramètre sera retournée.

Vous pouvez interroger toutes les informations liées à un utilisateur en fournissant uniquement le user_id.

Vous pouvez interroger les informations utilisateur associées à un ID anonyme en fournissant uniquement l'anonymous_id.

Vous pouvez effectuer une requête précise en fournissant à la fois le user_id et l'anonymous_id.

Réponse

Corps de la réponse

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

Ce bloc de code dans la fenêtre flottante

Réponse réussie

La réponse est un objet dont la clé est le user_id et la valeur correspond aux informations CDP de cet utilisateur :

Champ	Type	Description
{user_id}	object	Un objet indexé par l'ID utilisateur, contenant toutes les informations CDP de l'utilisateur.
{user_id}.user_id	string	ID utilisateur.
{user_id}.anonymous_ids	array	Tous les IDs anonymes actuellement liés à cet ID utilisateur et leurs types de conversation.
{user_id}.anonymous_ids[].anonymous_id	string	ID anonyme.
{user_id}.anonymous_ids[].conversation_type	string	Type de conversation. Un tableau de correspondance est disponible dans la section Types de conversation de la vue d'ensemble utilisateur.
{user_id}.anonymous_ids[].source_id	string	ID source de la plateforme de conversation. Par exemple, en intégrant avec `TELEGRAM` et en ajoutant 2 Bots TG, chaque Bot aura son propre ID source.

Réponse d'erreur

Champ	Type	Description
code	int	Code d'erreur
message	string	Message d'erreur

Codes de statut

Code de statut	Description
200	Succès
400	Erreur de paramètre (aucun paramètre de requête fourni)
401	Non autorisé
403	Permission refusée
500	Erreur serveur