Saltar al contenido principal
POST
Get one record

Descripción

Devuelve un único registro de memoria de un usuario por su key, identificado por userReferenceId y botId.

Endpoint

Parámetros del cuerpo

Debes enviar socketId, o bien userReferenceId junto con botId. Una de las dos formas es obligatoria.
string
Identificador de referencia externo del usuario.
string
Identificador del canal asociado a la memoria.
string
Identificador del socket del usuario (el flow_token de los WhatsApp Flows). Alternativa a userReferenceId + botId; no se puede combinar con ellos. Un socketId inexistente o de otra compañía responde 404.
string
requerido
Clave del registro a obtener.

Autenticación

Todas las peticiones deben incluir el encabezado x-api-key con una API key que tenga el scope memory:read.

Ejemplo de solicitud

cURL

Respuestas

Ejemplo de respuesta

Autorizaciones

x-api-key
string
header
requerido

API key del proyecto de Jelou

Cuerpo

application/json
userReferenceId
string
requerido

External reference identifier of the user. Use together with botId. Cannot be combined with socketId.

botId
string
requerido

Identifier of the bot associated with the memory. Use together with userReferenceId. Cannot be combined with socketId.

key
string
requerido

Key of the record to retrieve.

socketId
string

Socket identifier of the user (the flow_token of WhatsApp Flows). Alternative to userReferenceId + botId. An unknown socketId, or one of another company, answers 404.

Respuesta

Record retrieved successfully.

status
string
Ejemplo:

"success"

message
string
Ejemplo:

"Record retrieved successfully"

data
any

The stored value for the requested key. Any JSON type.