Crear mensaje en Intercom, con una API
Envía un mensaje nuevo de un miembro del equipo a un contacto, en el Messenger (in_app) o por email. Email exige subject y template. La conversación solo existe después de que el contacto responde, salvo que create_conversation_without_contact_reply sea true.
- Identificador
- intercom_create_message
La llamada
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": {}
}
}Tu sistema envía el id de la conexión de tu cliente y los argumentos de la tool. Los headers son los mismos de toda la API de Connect: el token de tu producto y el token de tu cliente.
Parámetros
Las descripciones de los parámetros siguen la documentación oficial de la app, en inglés.
| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| message_type | string | Sí | in_app shows the message in the Messenger; email sends it by email.Valores: in_app, email |
| subject | string | No | Subject of the email. Required with email. |
| body | string | Sí | Content of the message, as HTML or plain text. |
| template | string | No | Style of the email, plain or personal. Required with email. |
| from | object | Sí | The teammate who sends the message. |
| to | object | Sí | The contact who receives the message. |
| create_conversation_without_contact_reply | boolean | No | true opens the conversation in the inbox right away, without waiting for the contact to reply. The default is false. |
Conexiones posibles
Tu cliente conecta su cuenta de Intercom una sola vez, con uno de los modos de abajo. La misma conexión sirve para todas las tools del toolkit.
OAuth con la app de tu producto
Registras la app OAuth de tu producto una sola vez, con POST /api/merchants/credentials/intercom, y tu cliente autoriza la cuenta en una pantalla de consentimiento. Connect renueva el token cuando está por vencer.
La respuesta
Si la llamada tiene éxito, Connect conserva el status y el cuerpo de la respuesta de la app. Los errores HTTP devueltos por la app usan el objeto {error, api_error}; la autenticación o validación pueden fallar antes de la ejecución. El header X-Toolkit-Execution-Id identifica la ejecución registrada, disponible en GET /api/tools/executions/{uuid}.
Lista para agentes de IA
El input de esta tool es un JSON Schema, disponible en GET /api/tools/intercom_create_message. Se convierte en la definición de tool de tu agente sin conversión.
Otras tools de Intercom
- Listar contactosGETLista los contactos del workspace, usuarios y leads, 10 por página por defecto. La página siguiente viene de pages.next.starting_after en la respuesta; sin él, esta es la última página. Los contactos fusionados no aparecen.
- Buscar contactosPOSTBusca contactos por sus atributos, por ejemplo por email, role o un atributo personalizado. Los timestamps son segundos Unix en UTC. Devuelve total_count y data, 50 por página por defecto, y la página siguiente viene de pages.next.starting_after. Un contacto creado en los últimos minutos puede no aparecer todavía.
- Obtener contactoGETDevuelve un contacto con role, email, teléfono, nombre, owner_id, custom_attributes, tags, empresas y ubicación. Un contacto fusionado en otro devuelve 410.
- Crear contactoPOSTCrea un contacto, usuario o lead. Envía al menos uno entre email, external_id o role. Todo atributo personalizado enviado debe existir ya en el workspace, o Intercom rechaza el contacto.
- Actualizar contactoPUTActualiza un contacto: envía solo los campos a cambiar. Un usuario no puede pasar a lead. Todo atributo personalizado enviado debe existir ya en el workspace.
- Listar conversacionesGETLista las conversaciones del workspace, 20 por página por defecto. La página siguiente viene de pages.next.starting_after en la respuesta; sin él, esta es la última página. Obtener conversación devuelve todas las partes de una conversación.
- Buscar conversacionesPOSTBusca conversaciones por sus atributos, por ejemplo las abiertas asignadas a un miembro del equipo o a un equipo. Los timestamps son segundos Unix. Devuelve total_count y conversations, 20 por página por defecto, y la página siguiente viene de pages.next.starting_after.
- Obtener conversaciónGETDevuelve una conversación con sus partes (mensajes, notas y acciones), hasta las 500 más recientes, además de state, asignados, contactos y tags.
Toolkits de la misma categoría
Ver los 100 toolkitsMira Connect aplicado a tu producto.
Pruébalo durante 15 días sin tarjeta, o cuéntale tu caso a nuestro equipo.
