Consultar CDP de usuario - GPTBots

Permite a los desarrolladores consultar la información del CDP (Customer Data Platform) de los usuarios de un agente/recorrido (workflow), incluida el ID de usuario, el ID anónimo y el tipo de conversación, mediante un ID de usuario o un ID anónimo.

La información del CDP del usuario se almacena por cada agente/recorrido (workflow), lo que significa que los datos del mismo usuario se aíslan entre diferentes agentes/recorridos (workflow).

Método de solicitud

GET

Endpoint

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

Autenticación

Para más información sobre los métodos de autenticación, consulte la visión general de la API.

Solicitud

Ejemplos de solicitud

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

Este bloque de código en una ventana flotante

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

Este bloque de código en una ventana flotante

Consulta por user_id y 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}'

Este bloque de código en una ventana flotante

El anonymous_id del usuario actual se puede obtener en «Configuración del agente/recorrido (workflow): variables globales».

Cabeceras de la solicitud

Campo	Tipo	Descripción
Authorization	Bearer ${token}	Se utiliza `Authorization: Bearer ${token}` para la autenticación. La clave se obtiene como `${token}` en la página «API Key».

Parámetros de consulta

Parámetro	Tipo	Descripción	Obligatorio
user_id	string	ID de usuario definida por el desarrollador.	false
anonymous_id	string	ID anónimo generado por la plataforma GPTBots, normalmente basado en el identificador único de una plataforma de terceros. Se puede obtener en «Configuración del agente/recorrido (workflow): variables globales».	false

Se debe proporcionar al menos uno de user_id o anonymous_id; de lo contrario, se devolverá un error de parámetros.

Se puede consultar toda la información vinculada de un usuario proporcionando únicamente user_id.

Se puede consultar la información de usuario asociada a un ID anónimo proporcionando únicamente anonymous_id.

Se puede realizar una consulta precisa proporcionando user_id y anonymous_id.

Respuesta

Cuerpo de la respuesta

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

Este bloque de código en una ventana flotante

Respuesta correcta

La respuesta es un objeto cuya clave es user_id y cuyo valor es la información de CDP de ese usuario:

Campo	Tipo	Descripción
{user_id}	object	Objeto cuya clave es el ID de usuario y que contiene la información completa de CDP del usuario.
{user_id}.user_id	string	ID de usuario.
{user_id}.anonymous_ids	array	Todos los ID anónimos actualmente vinculados a este ID de usuario y sus tipos de conversación.
{user_id}.anonymous_ids[].anonymous_id	string	ID anónimo.
{user_id}.anonymous_ids[].conversation_type	string	Tipo de conversación. Se puede encontrar una tabla de mapeo en la sección de tipos de conversación de la visión general del usuario.
{user_id}.anonymous_ids[].source_id	string	ID de origen (Source ID) de la plataforma de conversación. Por ejemplo, si se integra con `TELEGRAM` y se añaden 2 bots de TG, cada bot tendrá su propio Source ID.

Respuesta de error

Campo	Tipo	Descripción
code	int	Código de error
message	string	Mensaje de error

Códigos de estado

Código de estado	Descripción
200	Éxito
400	Error de parámetros (no se proporcionaron parámetros de consulta)
401	No autorizado
403	Permiso denegado
500	Error del servidor