Criar mensagem no Intercom, por uma API
Envia uma nova mensagem de um membro da equipe a um contato, no Messenger (in_app) ou por email. Email exige subject e template. A conversa só existe depois que o contato responde, a menos que create_conversation_without_contact_reply seja true.
- Identificador
- intercom_create_message
A chamada
POST https://connect.reportei.com/api/tools/intercom_create_message/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"message_type": "in_app",
"body": "<body>",
"from": {},
"to": {}
}
}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 |
|---|---|---|---|
| message_type | string | Sim | in_app shows the message in the Messenger; email sends it by email.Valores: in_app, email |
| subject | string | Não | Subject of the email. Required with email. |
| body | string | Sim | Content of the message, as HTML or plain text. |
| template | string | Não | Style of the email, plain or personal. Required with email. |
| from | object | Sim | The teammate who sends the message. |
| to | object | Sim | The contact who receives the message. |
| create_conversation_without_contact_reply | boolean | Não | true opens the conversation in the inbox right away, without waiting for the contact to reply. The default is false. |
Conexões possíveis
O seu cliente conecta a conta do Intercom uma vez, por um dos modos abaixo. A mesma conexão serve para todas as tools do toolkit.
OAuth com o app do seu produto
Você cadastra o app OAuth do seu produto uma vez, em POST /api/merchants/credentials/intercom, e o cliente autoriza a conta numa tela de consentimento. O Connect renova o token quando ele está para vencer.
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/intercom_create_message. Ele vira a definição de tool do seu agente sem conversão.
Outras tools do Intercom
- Listar contatosGETLista os contatos do workspace, usuários e leads, 10 por página por padrão. A próxima página vem de pages.next.starting_after na resposta; sem ele, esta é a última página. Contatos mesclados não aparecem.
- Buscar contatosPOSTBusca contatos pelos seus atributos, por exemplo por email, role ou um atributo customizado. Timestamps são segundos Unix em UTC. Retorna total_count e data, 50 por página por padrão, e a próxima página vem de pages.next.starting_after. Um contato criado nos últimos minutos pode ainda não aparecer.
- Obter contatoGETRetorna um contato com role, email, telefone, nome, owner_id, custom_attributes, tags, empresas e localização. Um contato mesclado em outro retorna 410.
- Criar contatoPOSTCria um contato, usuário ou lead. Envie ao menos um entre email, external_id ou role. Todo atributo customizado enviado já deve existir no workspace, ou o Intercom recusa o contato.
- Atualizar contatoPUTAtualiza um contato: envie só os campos a alterar. Um usuário não pode virar lead. Todo atributo customizado enviado já deve existir no workspace.
- Listar conversasGETLista as conversas do workspace, 20 por página por padrão. A próxima página vem de pages.next.starting_after na resposta; sem ele, esta é a última página. Obter conversa retorna todas as partes de uma conversa.
- Buscar conversasPOSTBusca conversas pelos seus atributos, por exemplo as abertas atribuídas a um membro da equipe ou a um time. Timestamps são segundos Unix. Retorna total_count e conversations, 20 por página por padrão, e a próxima página vem de pages.next.starting_after.
- Obter conversaGETRetorna uma conversa com suas partes (mensagens, notas e ações), até as 500 mais recentes, além de state, responsáveis, contatos e tags.
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.
