Referência de API
Enviar Mensagens
Conversações
Recursos
Datum
Painel de Atendimento Externo
Start Conversation
curl --request POST \
--url https://gateway.jelou.ai/jelouapi/v1/external-support/{projectId}/conversations/start \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"botId": "<string>",
"userId": "<string>",
"initialMessage": "<string>",
"metadata": {},
"assignment": {
"type": "<string>",
"target": "<string>"
}
}
'{
"message": "<string>",
"statusMessage": "<string>",
"status": 123,
"error": {
"code": "<string>",
"key": "<string>",
"description": "<string>",
"developerMessages": {},
"clientMessages": {}
},
"validationError": {}
}Conversa
Iniciar conversa
Inicia uma nova conversa com um usuário final
POST
/
v1
/
external-support
/
{projectId}
/
conversations
/
start
Start Conversation
curl --request POST \
--url https://gateway.jelou.ai/jelouapi/v1/external-support/{projectId}/conversations/start \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"botId": "<string>",
"userId": "<string>",
"initialMessage": "<string>",
"metadata": {},
"assignment": {
"type": "<string>",
"target": "<string>"
}
}
'{
"message": "<string>",
"statusMessage": "<string>",
"status": 123,
"error": {
"code": "<string>",
"key": "<string>",
"description": "<string>",
"developerMessages": {},
"clientMessages": {}
},
"validationError": {}
}Documentation Index
Fetch the complete documentation index at: https://docs.jelou.ai/llms.txt
Use this file to discover all available pages before exploring further.
Descrição
Inicia uma nova conversa com um usuário final no painel de atendimento externo. Permite especificar o bot que atenderá a conversa, o usuário destinatário, uma mensagem inicial e dados de atribuição a filas ou agentes. Ao ser executado, o Jelou emite o eventoconversation.start para o webhook configurado na integração.
Endpoint
POST https://gateway.jelou.ai/jelouapi/v1/external-support/{projectId}/conversations/start
Parâmetros de rota
Identificador único do projeto Jelou a partir do qual a conversa é iniciada.
Parâmetros do corpo
Identificador do bot do Jelou que gerenciará a conversa.
Identificador do usuário final com quem a conversa será iniciada.
Mensagem inicial que será enviada ao iniciar a conversa. Se omitida, a conversa inicia sem mensagem prévia.
Dados adicionais associados à conversa. Podem incluir identificadores externos, números de ticket ou outro contexto relevante para o seu sistema.Exemplo:
{ "ticketId": "T-12345" }Configuração de atribuição da conversa a uma fila ou agente específico.
type— Tipo de atribuição:queue(fila),operator(operador) outeam(equipe).target— Nome da fila ou identificador do agente destino.
Autenticação
Todas as requisições devem incluir o cabeçalhox-api-key com a API key do projeto Jelou.
x-api-key: API_KEY
Exemplo de requisição
O exemplo a seguir inicia uma conversa com atribuição à filaSUPORTE e inclui metadata de ticket:
cURL
curl --request POST \
--url https://gateway.jelou.ai/jelouapi/v1/external-support/PROJECT_ID/conversations/start \
--header 'x-api-key: API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"botId": "BOT_ID",
"userId": "USER_ID",
"initialMessage": "Olá, preciso de ajuda",
"metadata": { "ticketId": "T-12345" },
"assignment": { "type": "queue", "target": "SUPORTE" }
}'
Respostas
| Código | Status | Descrição |
|---|---|---|
| 200 | OK | Conversa iniciada com sucesso. |
| 401 | Unauthorized | Credenciais de autenticação inválidas ou ausentes. |
| 404 | Not Found | Bot ou usuário não encontrado. |
| 422 | Bad Request | Campos obrigatórios ausentes ou formato inválido. |
| 500 | Internal Server Error | Erro interno do servidor. |
Exemplo de resposta
{
"message": [
"Conversation started successfully"
],
"statusMessage": "success",
"status": 1,
"data": {
"conversationId": "CONVERSATION_ID",
"botId": "BOT_ID",
"userId": "USER_ID",
"status": "active"
}
}
Evento webhook conversation.start
Ao executar este recurso, o Jelou emitirá o evento conversation.start ao webhook configurado na integração. O payload varia conforme os campos enviados na requisição.
- Payload básico
- Com atribuição e metadata
{
"event": "conversation.start",
"timestamp": 1776133797422,
"field": "conversation",
"object": "conversation_event",
"event_type": "start",
"project_id": "PROJECT_ID",
"room_id": "ROOM_ID",
"contact": {
"id": "USER_ID",
"name": "USER_NAME"
},
"conversation": {
"id": "CONVERSATION_ID"
},
"bot": {
"id": "BOT_ID",
"name": "BOT_NAME"
},
"value": {}
}
{
"event": "conversation.start",
"timestamp": 1776134145523,
"field": "conversation",
"object": "conversation_event",
"event_type": "start",
"project_id": "PROJECT_ID",
"room_id": "ROOM_ID",
"contact": {
"id": "USER_ID",
"name": "USER_NAME"
},
"conversation": {
"id": "CONVERSATION_ID",
"assignment": {
"type": "queue",
"target": "SUPORTE"
}
},
"bot": {
"id": "BOT_ID",
"name": "BOT_NAME"
},
"value": {
"initial_message": "Olá, bom dia",
"metadata": {
"ticketId": "T-12345"
}
}
}
Campos do payload
| Campo | Tipo | Descrição |
|---|---|---|
event | string | Nome do evento: conversation.start |
timestamp | number | Marca de tempo Unix em milissegundos do momento do evento. |
project_id | string | Identificador do projeto Jelou. |
room_id | string | Identificador da sala de conversa. |
contact.id | string | Identificador do usuário final. |
contact.name | string | Nome do usuário final. |
conversation.id | string | Identificador único da conversa iniciada. |
conversation.assignment.type | string | Tipo de atribuição: queue ou direct. |
conversation.assignment.target | string | Nome da fila ou ID do agente destino. |
bot.id | string | Identificador do bot atribuído. |
bot.name | string | Nome do bot atribuído. |
value.initial_message | string | Mensagem inicial enviada ao iniciar a conversa (opcional). |
value.metadata | object | Metadata adicional da conversa (opcional). |
Autorizações
Basic authentication using Base64 encoded clientId:clientSecret
Parâmetros de caminho
Unique identifier of the Jelou project
Corpo
application/json
Resposta
Conversation started successfully
Esta página foi útil?
⌘I