Criar mensagem no Chatwoot, por uma API
Envia uma mensagem em uma conversa. Uma mensagem de saída chega ao contato pelo canal da caixa de entrada, como WhatsApp, email ou widget do site; private true cria uma nota interna que só os agentes veem. No WhatsApp, template_params envia um template aprovado.
- Identificador
- chatwoot_create_message
A chamada
POST https://connect.reportei.com/api/tools/chatwoot_create_message/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"account_id": 1,
"conversation_id": 1,
"content": "<content>"
}
}Seu sistema envia o id da conexão do cliente e os argumentos da tool. Os headers são os mesmos de toda a API do Connect: o token do seu produto e o token do cliente.
Parâmetros
As descrições dos parâmetros seguem a documentação oficial do app, em inglês.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| account_id | integer | Sim | Id of the Chatwoot account: the id of one of the accounts from Get profile, also shown in the dashboard URL after /accounts/, as in app.chatwoot.com/app/accounts/123. |
| conversation_id | integer | Sim | Id of the conversation, from List conversations. |
| content | string | Sim | Text of the message. With a template, the rendered text of the template. |
| message_type | string | Não | outgoing is a message to the contact; incoming records a message as sent by the contact.Valores: outgoing, incoming |
| private | boolean | Não | true makes the message an internal note, not sent to the contact. |
| template_params | object | Não | WhatsApp template approved in WhatsApp Business Manager. |
Conexões possíveis
O seu cliente conecta a conta do Chatwoot uma vez, por um dos modos abaixo. A mesma conexão serve para todas as tools do toolkit.
Chave de API
O cliente cola a chave do app numa tela do Connect, ou o seu sistema envia a chave por POST /api/customer-toolkits, sem tela.
A resposta
Em caso de sucesso, o Connect preserva o status e o corpo da resposta do app. Erros HTTP retornados pelo app usam o envelope {error, api_error}; falhas de autenticação ou validação podem ocorrer antes da execução. O header X-Toolkit-Execution-Id identifica a execução registrada, consultável em GET /api/tools/executions/{uuid}.
Pronta para agentes de IA
O input desta tool é um JSON Schema, disponível em GET /api/tools/chatwoot_create_message. Ele vira a definição de tool do seu agente sem conversão.
Outras tools do Chatwoot
- Listar conversasGETLista as conversas de uma conta, por padrão as abertas, com status, etiquetas, inbox_id, can_reply, o contato em meta.sender, o responsável e a última mensagem. data.meta traz as contagens por tipo de responsável. As páginas começam em 1; um payload vazio significa que não há mais páginas.
- Criar conversaPOSTInicia uma conversa com um contato em uma caixa de entrada, opcionalmente com uma primeira mensagem. source_id identifica o contato nessa caixa: vem de contact_inboxes em Search contacts, de Create contact ou de Create contact inbox. Em caixas de WhatsApp, a primeira mensagem vai como template aprovado em message.template_params.
- Atualizar status da conversaPOSTDefine o status de uma conversa: open, resolved, pending ou snoozed. Sem snoozed_until, uma conversa em snoozed espera a próxima resposta do contato, e qualquer resposta do contato a reabre.
- Atribuir conversaPOSTAtribui uma conversa a um agente ou a um time. Quando assignee_id é enviado, team_id é ignorado.
- Atualizar etiquetas da conversaPOSTDefine as etiquetas de uma conversa. A lista enviada substitui as etiquetas atuais, então deve incluir as que devem ficar.
- Listar mensagensGETRetorna as últimas mensagens de uma conversa em ordem crescente, com meta contendo etiquetas, contato e responsável. sender_type diz quem enviou cada mensagem, e private marca notas internas. Para mensagens mais antigas, passe before com o id da mais antiga recebida.
- Buscar contatosGETBusca os contatos que têm identificador, email ou telefone, por nome, identificador, email ou número de telefone, 15 por página. Cada contato traz contact_inboxes, que liga cada caixa ao source_id de que Create conversation precisa. meta.count é o total; uma página com menos de 15 contatos é a última.
- Criar contatoPOSTCria um contato em uma caixa de entrada da conta. A resposta traz o contato e o contact_inbox com o source_id de que Create conversation precisa.
Toolkits da mesma categoria
Ver os 100 toolkitsVeja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
