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âmetroTipoObrigatórioDescrição
message_typestringSimin_app shows the message in the Messenger; email sends it by email.Valores: in_app, email
subjectstringNãoSubject of the email. Required with email.
bodystringSimContent of the message, as HTML or plain text.
templatestringNãoStyle of the email, plain or personal. Required with email.
fromobjectSimThe teammate who sends the message.
toobjectSimThe contact who receives the message.
create_conversation_without_contact_replybooleanNãotrue 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

Ver as 13 tools

Toolkits da mesma categoria

Ver os 100 toolkits

Veja o Connect aplicado ao seu produto.

Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.