Start Conversation
Conversa
Iniciar conversa
Inicia uma nova conversa com um usuário final
POST
Start Conversation
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
Parâmetros de rota
string
obrigatório
Identificador único do projeto Jelou a partir do qual a conversa é iniciada.
Parâmetros do corpo
string
obrigatório
Identificador do bot do Jelou que gerenciará a conversa.
string
obrigatório
Identificador do usuário final com quem a conversa será iniciada.
string
Mensagem inicial que será enviada ao iniciar a conversa. Se omitida, a conversa inicia sem mensagem prévia.
object
Dados adicionais associados à conversa. Podem incluir identificadores externos, números de ticket ou outro contexto relevante para o seu sistema.Exemplo:
{ "ticketId": "T-12345" }object
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.
Exemplo de requisição
O exemplo a seguir inicia uma conversa com atribuição à filaSUPORTE e inclui metadata de ticket:
cURL
Respostas
Exemplo de resposta
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
Campos do payload
Autorizações
API key del proyecto de Jelou
Parâmetros de caminho
Unique identifier of the Jelou project
Corpo
application/json
Resposta
Conversation started successfully