Pular para o conteúdo principal
POST
Get one record

Descrição

Retorna um único registro de memória de um usuário pela sua key, identificado por userReferenceId e botId.

Endpoint

Parâmetros do corpo

Você deve enviar socketId, ou userReferenceId junto com botId. Uma das duas formas é obrigatória.
string
Identificador de referência externo do usuário.
string
Identificador do canal associado à memória.
string
Identificador do socket do usuário (o flow_token dos WhatsApp Flows). Alternativa a userReferenceId + botId; não pode ser combinado com eles. Um socketId inexistente ou de outra empresa retorna 404.
string
obrigatório
Chave do registro a obter.

Autenticação

Todas as requisições devem incluir o cabeçalho x-api-key com uma API key que tenha o scope memory:read.

Exemplo de solicitação

cURL

Respostas

Exemplo de resposta

Autorizações

x-api-key
string
header
obrigatório

API key del proyecto de Jelou

Corpo

application/json
userReferenceId
string
obrigatório

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

botId
string
obrigatório

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

key
string
obrigatório

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.

Resposta

Record retrieved successfully.

status
string
Exemplo:

"success"

message
string
Exemplo:

"Record retrieved successfully"

data
any

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