Skip to main content
POST
Enviar mensagem

Autorizações

Authorization
string
header
obrigatório

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Parâmetros de caminho

agentId
string
obrigatório

Identificador do assistente

Corpo

application/json
id
string

A conversa para enviar a mensagem, ou undefined para iniciar uma nova conversa

tools
object[]

Ferramentas utilizadas pelo assistente

preview
boolean
padrão:false
utm
object

Informações de rastreamento UTM

format
enum<string>
padrão:markdown

Formata a resposta gerada pelo assistente para diferentes canais

Opções disponíveis:
markdown,
plain,
whatsapp,
slack
leadId
string

Identificador do lead

platformUserIdentifier
string

Identificador do usuário plataforma de origem

message
object | null

Mensagem única para adicionar neste turno da conversa e gerar uma resposta

messages
object[] | null

Mensagens para adicionar neste turno da conversa e gerar uma resposta

Resposta

Successful response

Resposta de uma conversa de chat com mensagens, status e lead

id
string
obrigatório

Identificador da conversa

messages
object[]
obrigatório

Mensagens geradas durante este turno da conversa

status
enum<string>
obrigatório

Status

Opções disponíveis:
active,
finished
lead
object

Dados do lead