Cria ID de Conversação
Endpoint para criar um ID de conversação para uso com o Tolky Reasoning.
Cria ID de Conversação para Reasoning
Este endpoint permite criar um ID de conversação para uso com o Tolky Reasoning, opcionalmente associando a um lead existente ou criando um novo lead.
🔍 Visão Geral
O endpoint createConversationId cria uma nova conversação no sistema Tolky, que pode ser utilizada para interações subsequentes com o Tolky Reasoning. A conversação pode ser associada a um lead existente (usando externalId) ou criar um novo lead automaticamente.
🔗 Endpoint
POST /api/externalAPIs/public/createConversationId
⚙️ Parâmetros da Requisição
📋 Estrutura do JSON
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
externalId | string | Não | ID externo de um lead para associar à conversação |
userName | string | Não | Nome do usuário/lead |
email | string | Não | Email do usuário/lead |
cpf | string | Não | CPF do usuário/lead |
📦 Estrutura da Resposta
A resposta da API segue o formato padrão das APIs Tolky, com códigos de status e mensagens relevantes.
{
"code": 200,
"data": {
"leadId": "uuid-do-lead",
"conversationId": "uuid-da-conversacao",
"sessionId": "uuid-da-sessao"
},
"message": "OK"
}
💡 Exemplos de Uso
Tab Title
Tab Title
curl --location '{base-url}/api/externalAPIs/public/createConversationId' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {User-Access-Token}' \
--data-raw '{
"userName": "João Silva",
"email": "joao.silva@exemplo.com",
"phone": "31999999999"
"externalId": "cliente-123"
}'
⚠️ Tratamento de Erros
⏱️ Timeout
Todas as requisições têm um timeout de 30 segundos. Se a requisição exceder este limite, será retornado um erro 408 (Request Timeout).
✨ Boas Práticas
🔄 Endpoints Relacionados
Tolky Reasoning
Para processamento de perguntas e respostas contextualizadas utilizando a inteligência do Tolky.
Endpoint: POST /api/externalAPIs/public/tolkyReasoning