DOCS

POST/messenger/chat/message/send

Enviar mensagem (bot)

Envia uma mensagem em nome do bot (fromBot: true), persiste em messenger/chat/message e faz dispatch externo (WhatsApp/Facebook/Instagram) conforme o canal da room.

Método e URL

POST https://api.agilize.app/messenger/chat/message/send

Autenticação

Envie a chave de API no cabeçalho da requisição.

Accept: application/json
x-api-key: SUA_CHAVE_API

Parâmetros

NomeOrigemObrigatórioTipoDescrição
x-api-keyheaderSimstringChave da API de integração gerada em seu painel gerencial.
content-typeheaderSimstringapplication/json

Corpo da requisição

  • Obrigatório: Sim
  • Content-Type: application/json

Campos do corpo

CampoTipoObrigatórioValores / ExemploDescrição
roomstringSimID da sala (room) onde a mensagem será enviada
messageobjectSim
fileMessengerChatMessageSendFile | nullNãoArquivo único (alternativa a files)
filesMessengerChatMessageSendFileNãoLista de arquivos (no momento a plataforma envia apenas o primeiro para canais externos)

Estruturas internas

message

{
  "text": [
    "string",
    "null"
  ],
  "buttons": "object"
}

file

{
  "mimetype": "string",
  "name": "string",
  "fileUrl": "string (uri)"
}

files

[
  {
    "mimetype": "string",
    "name": "string",
    "fileUrl": "string (uri)"
  }
]

Exemplo básico:

{
  "room": "valor",
  "message": {
    "text": "valor",
    "buttons": {}
  }
}

Respostas

StatusDescriçãoConteúdo
200Mensagem processada e persistidaapplication/json
400Payload inválido
401API key ausente ou inválida
403Sala não pertence ao projeto do usuário
404Sala não encontrada
409Configuração do canal não encontrada
502Falha ao enviar para o provider externoapplication/json

Exemplos básicos

Escolha uma linguagem para abrir o exemplo de requisição.

Testar requisição

Preencha os parâmetros, informe a chave no cabeçalho x-api-key e envie a requisição diretamente pelo navegador.

Carregando teste interativo do endpoint...