mirror of
https://github.com/simstudioai/sim.git
synced 2026-09-24 15:45:35 +08:00
Co-authored-by: waleedlatif1 <waleedlatif1@users.noreply.github.com>
361 lines
15 KiB
Plaintext
361 lines
15 KiB
Plaintext
---
|
|
title: Intercom
|
|
description: Gestiona contactos, empresas, conversaciones, tickets y mensajes en Intercom
|
|
---
|
|
|
|
import { BlockInfoCard } from "@/components/ui/block-info-card"
|
|
|
|
<BlockInfoCard
|
|
type="intercom"
|
|
color="#E0E0E0"
|
|
/>
|
|
|
|
{/* MANUAL-CONTENT-START:intro */}
|
|
[Intercom](https://www.intercom.com/) es una plataforma líder de comunicación con clientes que te permite gestionar y automatizar tus interacciones con contactos, empresas, conversaciones, tickets y mensajes, todo en un solo lugar. La integración de Intercom en Sim permite a tus agentes gestionar programáticamente las relaciones con los clientes, las solicitudes de soporte y las conversaciones directamente desde tus flujos de trabajo automatizados.
|
|
|
|
Con las herramientas de Intercom, puedes:
|
|
|
|
- **Gestión de contactos:** Crear, obtener, actualizar, listar, buscar y eliminar contactos—automatiza tus procesos de CRM y mantén actualizados los registros de tus clientes.
|
|
- **Gestión de empresas:** Crear nuevas empresas, recuperar detalles de empresas y listar todas las empresas relacionadas con tus usuarios o clientes comerciales.
|
|
- **Manejo de conversaciones:** Obtener, listar, responder y buscar conversaciones—permitiendo a los agentes seguir hilos de soporte en curso, proporcionar respuestas y automatizar acciones de seguimiento.
|
|
- **Gestión de tickets:** Crear y recuperar tickets programáticamente, ayudándote a automatizar el servicio al cliente, el seguimiento de problemas de soporte y las escalaciones de flujo de trabajo.
|
|
- **Enviar mensajes:** Activar mensajes a usuarios o leads para incorporación, soporte o marketing, todo desde dentro de tu automatización de flujo de trabajo.
|
|
|
|
Al integrar las herramientas de Intercom en Sim, potencias tus flujos de trabajo para comunicarte directamente con tus usuarios, automatizar procesos de atención al cliente, gestionar leads y agilizar las comunicaciones a escala. Ya sea que necesites crear nuevos contactos, mantener sincronizados los datos de los clientes, gestionar tickets de soporte o enviar mensajes de engagement personalizados, las herramientas de Intercom proporcionan una forma integral de gestionar las interacciones con los clientes como parte de tus automatizaciones inteligentes.
|
|
{/* MANUAL-CONTENT-END */}
|
|
|
|
## Instrucciones de uso
|
|
|
|
Integra Intercom en el flujo de trabajo. Puede crear, obtener, actualizar, listar, buscar y eliminar contactos; crear, obtener y listar empresas; obtener, listar, responder y buscar conversaciones; crear y obtener tickets; y crear mensajes.
|
|
|
|
## Herramientas
|
|
|
|
### `intercom_create_contact`
|
|
|
|
Crear un nuevo contacto en Intercom con email, external_id o rol
|
|
|
|
#### Entrada
|
|
|
|
| Parámetro | Tipo | Obligatorio | Descripción |
|
|
| --------- | ---- | -------- | ----------- |
|
|
| `role` | string | No | El rol del contacto. Acepta 'user' o 'lead'. Por defecto es 'lead' si no se especifica. |
|
|
| `email` | string | No | La dirección de correo electrónico del contacto |
|
|
| `external_id` | string | No | Un identificador único para el contacto proporcionado por el cliente |
|
|
| `phone` | string | No | El número de teléfono del contacto |
|
|
| `name` | string | No | El nombre del contacto |
|
|
| `avatar` | string | No | Una URL de imagen de avatar para el contacto |
|
|
| `signed_up_at` | number | No | La hora en que el usuario se registró como marca de tiempo Unix |
|
|
| `last_seen_at` | number | No | La hora en que el usuario fue visto por última vez como marca de tiempo Unix |
|
|
| `owner_id` | string | No | El id de un administrador al que se le ha asignado la propiedad de la cuenta del contacto |
|
|
| `unsubscribed_from_emails` | boolean | No | Si el contacto está dado de baja de los correos electrónicos |
|
|
| `custom_attributes` | string | No | Atributos personalizados como objeto JSON \(ej., \{"attribute_name": "value"\}\) |
|
|
| `company_id` | string | No | ID de empresa para asociar el contacto durante la creación |
|
|
|
|
#### Salida
|
|
|
|
| Parámetro | Tipo | Descripción |
|
|
| --------- | ---- | ----------- |
|
|
| `contact` | object | Objeto de contacto creado |
|
|
|
|
### `intercom_get_contact`
|
|
|
|
Obtener un solo contacto por ID desde Intercom
|
|
|
|
#### Entrada
|
|
|
|
| Parámetro | Tipo | Obligatorio | Descripción |
|
|
| --------- | ---- | -------- | ----------- |
|
|
| `contactId` | string | Sí | ID del contacto a recuperar |
|
|
|
|
#### Salida
|
|
|
|
| Parámetro | Tipo | Descripción |
|
|
| --------- | ---- | ----------- |
|
|
| `contact` | object | Objeto de contacto |
|
|
|
|
### `intercom_update_contact`
|
|
|
|
Actualizar un contacto existente en Intercom
|
|
|
|
#### Entrada
|
|
|
|
| Parámetro | Tipo | Obligatorio | Descripción |
|
|
| --------- | ---- | -------- | ----------- |
|
|
| `contactId` | string | Sí | ID del contacto a actualizar |
|
|
| `role` | string | No | El rol del contacto. Acepta 'user' o 'lead'. |
|
|
| `external_id` | string | No | Un identificador único para el contacto proporcionado por el cliente |
|
|
| `email` | string | No | La dirección de correo electrónico del contacto |
|
|
| `phone` | string | No | El número de teléfono del contacto |
|
|
| `name` | string | No | El nombre del contacto |
|
|
| `avatar` | string | No | Una URL de imagen de avatar para el contacto |
|
|
| `signed_up_at` | number | No | La hora en que el usuario se registró como marca de tiempo Unix |
|
|
| `last_seen_at` | number | No | La hora en que el usuario fue visto por última vez como marca de tiempo Unix |
|
|
| `owner_id` | string | No | El id de un administrador al que se le ha asignado la propiedad de la cuenta del contacto |
|
|
| `unsubscribed_from_emails` | boolean | No | Si el contacto está dado de baja de los correos electrónicos |
|
|
| `custom_attributes` | string | No | Atributos personalizados como objeto JSON \(ej., \{"attribute_name": "value"\}\) |
|
|
| `company_id` | string | No | ID de empresa para asociar el contacto |
|
|
|
|
#### Salida
|
|
|
|
| Parámetro | Tipo | Descripción |
|
|
| --------- | ---- | ----------- |
|
|
| `contact` | object | Objeto de contacto actualizado |
|
|
|
|
### `intercom_list_contacts`
|
|
|
|
Listar todos los contactos de Intercom con soporte de paginación
|
|
|
|
#### Entrada
|
|
|
|
| Parámetro | Tipo | Obligatorio | Descripción |
|
|
| --------- | ---- | -------- | ----------- |
|
|
| `per_page` | number | No | Número de resultados por página \(máx: 150\) |
|
|
| `starting_after` | string | No | Cursor para paginación - ID para comenzar después |
|
|
|
|
#### Salida
|
|
|
|
| Parámetro | Tipo | Descripción |
|
|
| --------- | ---- | ----------- |
|
|
| `contacts` | array | Array de objetos de contacto |
|
|
|
|
### `intercom_search_contacts`
|
|
|
|
Buscar contactos en Intercom usando una consulta
|
|
|
|
#### Entrada
|
|
|
|
| Parámetro | Tipo | Obligatorio | Descripción |
|
|
| --------- | ---- | -------- | ----------- |
|
|
| `query` | string | Sí | Consulta de búsqueda \(ej., \{"field":"email","operator":"=","value":"user@example.com"\}\) |
|
|
| `per_page` | number | No | Número de resultados por página \(máx: 150\) |
|
|
| `starting_after` | string | No | Cursor para paginación |
|
|
| `sort_field` | string | No | Campo por el cual ordenar \(ej., "name", "created_at", "last_seen_at"\) |
|
|
| `sort_order` | string | No | Orden de clasificación: "ascending" o "descending" |
|
|
|
|
#### Salida
|
|
|
|
| Parámetro | Tipo | Descripción |
|
|
| --------- | ---- | ----------- |
|
|
| `contacts` | array | Array de objetos de contacto coincidentes |
|
|
|
|
### `intercom_delete_contact`
|
|
|
|
Eliminar un contacto de Intercom por ID
|
|
|
|
#### Entrada
|
|
|
|
| Parámetro | Tipo | Obligatorio | Descripción |
|
|
| --------- | ---- | -------- | ----------- |
|
|
| `contactId` | string | Sí | ID del contacto a eliminar |
|
|
|
|
#### Salida
|
|
|
|
| Parámetro | Tipo | Descripción |
|
|
| --------- | ---- | ----------- |
|
|
| `id` | string | ID del contacto eliminado |
|
|
| `deleted` | boolean | Si el contacto fue eliminado |
|
|
| `metadata` | object | Metadatos de la operación |
|
|
|
|
### `intercom_create_company`
|
|
|
|
Crear o actualizar una empresa en Intercom
|
|
|
|
#### Entrada
|
|
|
|
| Parámetro | Tipo | Obligatorio | Descripción |
|
|
| --------- | ---- | -------- | ----------- |
|
|
| `company_id` | string | Sí | Tu identificador único para la empresa |
|
|
| `name` | string | No | El nombre de la empresa |
|
|
| `website` | string | No | El sitio web de la empresa |
|
|
| `plan` | string | No | El nombre del plan de la empresa |
|
|
| `size` | number | No | El número de empleados en la empresa |
|
|
| `industry` | string | No | La industria en la que opera la empresa |
|
|
| `monthly_spend` | number | No | Cuántos ingresos genera la empresa para tu negocio. Nota: Este campo trunca decimales a números enteros \(ej., 155.98 se convierte en 155\) |
|
|
| `custom_attributes` | string | No | Atributos personalizados como objeto JSON |
|
|
| `remote_created_at` | number | No | La fecha en que creaste la empresa como marca de tiempo Unix |
|
|
|
|
#### Salida
|
|
|
|
| Parámetro | Tipo | Descripción |
|
|
| --------- | ---- | ----------- |
|
|
| `company` | object | Objeto de empresa creado o actualizado |
|
|
|
|
### `intercom_get_company`
|
|
|
|
Recuperar una única empresa por ID desde Intercom
|
|
|
|
#### Entrada
|
|
|
|
| Parámetro | Tipo | Obligatorio | Descripción |
|
|
| --------- | ---- | -------- | ----------- |
|
|
| `companyId` | string | Sí | ID de la empresa a recuperar |
|
|
|
|
#### Salida
|
|
|
|
| Parámetro | Tipo | Descripción |
|
|
| --------- | ---- | ----------- |
|
|
| `company` | object | Objeto de empresa |
|
|
|
|
### `intercom_list_companies`
|
|
|
|
Lista todas las empresas de Intercom con soporte de paginación. Nota: Este endpoint tiene un límite de 10,000 empresas que pueden ser devueltas usando paginación. Para conjuntos de datos mayores a 10,000 empresas, usa la API Scroll en su lugar.
|
|
|
|
#### Entrada
|
|
|
|
| Parámetro | Tipo | Obligatorio | Descripción |
|
|
| --------- | ---- | -------- | ----------- |
|
|
| `per_page` | number | No | Número de resultados por página |
|
|
| `page` | number | No | Número de página |
|
|
| `starting_after` | string | No | Cursor para paginación \(preferido sobre paginación basada en páginas\) |
|
|
|
|
#### Salida
|
|
|
|
| Parámetro | Tipo | Descripción |
|
|
| --------- | ---- | ----------- |
|
|
| `companies` | array | Array de objetos de empresa |
|
|
|
|
### `intercom_get_conversation`
|
|
|
|
Recuperar una sola conversación por ID desde Intercom
|
|
|
|
#### Entrada
|
|
|
|
| Parámetro | Tipo | Obligatorio | Descripción |
|
|
| --------- | ---- | -------- | ----------- |
|
|
| `conversationId` | string | Sí | ID de la conversación a recuperar |
|
|
| `display_as` | string | No | Establecer en "plaintext" para recuperar mensajes en texto plano |
|
|
| `include_translations` | boolean | No | Cuando es true, las partes de la conversación se traducirán al idioma detectado de la conversación |
|
|
|
|
#### Salida
|
|
|
|
| Parámetro | Tipo | Descripción |
|
|
| --------- | ---- | ----------- |
|
|
| `conversation` | object | Objeto de conversación |
|
|
|
|
### `intercom_list_conversations`
|
|
|
|
Listar todas las conversaciones de Intercom con soporte de paginación
|
|
|
|
#### Entrada
|
|
|
|
| Parámetro | Tipo | Obligatorio | Descripción |
|
|
| --------- | ---- | -------- | ----------- |
|
|
| `per_page` | number | No | Número de resultados por página \(máx: 150\) |
|
|
| `starting_after` | string | No | Cursor para paginación |
|
|
| `sort` | string | No | Campo por el que ordenar \(p. ej., "waiting_since", "updated_at", "created_at"\) |
|
|
| `order` | string | No | Orden de clasificación: "asc" \(ascendente\) o "desc" \(descendente\) |
|
|
|
|
#### Salida
|
|
|
|
| Parámetro | Tipo | Descripción |
|
|
| --------- | ---- | ----------- |
|
|
| `conversations` | array | Array de objetos de conversación |
|
|
|
|
### `intercom_reply_conversation`
|
|
|
|
Responder a una conversación como administrador en Intercom
|
|
|
|
#### Entrada
|
|
|
|
| Parámetro | Tipo | Obligatorio | Descripción |
|
|
| --------- | ---- | -------- | ----------- |
|
|
| `conversationId` | string | Sí | ID de la conversación a la que responder |
|
|
| `message_type` | string | Sí | Tipo de mensaje: "comment" o "note" |
|
|
| `body` | string | Sí | El cuerpo de texto de la respuesta |
|
|
| `admin_id` | string | No | El ID del administrador que escribe la respuesta. Si no se proporciona, se usará un administrador predeterminado \(Operator/Fin\). |
|
|
| `attachment_urls` | string | No | Lista de URLs de imágenes separadas por comas \(máx 10\) |
|
|
| `created_at` | number | No | Marca de tiempo Unix de cuándo se creó la respuesta. Si no se proporciona, se usa la hora actual. |
|
|
|
|
#### Salida
|
|
|
|
| Parámetro | Tipo | Descripción |
|
|
| --------- | ---- | ----------- |
|
|
| `conversation` | object | Objeto de conversación actualizado |
|
|
|
|
### `intercom_search_conversations`
|
|
|
|
Buscar conversaciones en Intercom usando una consulta
|
|
|
|
#### Entrada
|
|
|
|
| Parámetro | Tipo | Obligatorio | Descripción |
|
|
| --------- | ---- | -------- | ----------- |
|
|
| `query` | string | Sí | Consulta de búsqueda como objeto JSON |
|
|
| `per_page` | number | No | Número de resultados por página \(máx: 150\) |
|
|
| `starting_after` | string | No | Cursor para paginación |
|
|
| `sort_field` | string | No | Campo por el que ordenar \(p. ej., "created_at", "updated_at"\) |
|
|
| `sort_order` | string | No | Orden de clasificación: "ascending" o "descending" |
|
|
|
|
#### Salida
|
|
|
|
| Parámetro | Tipo | Descripción |
|
|
| --------- | ---- | ----------- |
|
|
| `conversations` | array | Array de objetos de conversación coincidentes |
|
|
|
|
### `intercom_create_ticket`
|
|
|
|
Crear un nuevo ticket en Intercom
|
|
|
|
#### Entrada
|
|
|
|
| Parámetro | Tipo | Obligatorio | Descripción |
|
|
| --------- | ---- | -------- | ----------- |
|
|
| `ticket_type_id` | string | Sí | El ID del tipo de ticket |
|
|
| `contacts` | string | Sí | Array JSON de identificadores de contacto \(p. ej., \[\{"id": "contact_id"\}\]\) |
|
|
| `ticket_attributes` | string | Sí | Objeto JSON con atributos del ticket incluyendo _default_title_ y _default_description_ |
|
|
| `company_id` | string | No | ID de la empresa para asociar el ticket |
|
|
| `created_at` | number | No | Marca de tiempo Unix de cuándo se creó el ticket. Si no se proporciona, se utiliza la hora actual. |
|
|
| `conversation_to_link_id` | string | No | ID de una conversación existente para vincular a este ticket |
|
|
| `disable_notifications` | boolean | No | Cuando es true, suprime las notificaciones cuando se crea el ticket |
|
|
|
|
#### Salida
|
|
|
|
| Parámetro | Tipo | Descripción |
|
|
| --------- | ---- | ----------- |
|
|
| `ticket` | object | Objeto de ticket creado |
|
|
|
|
### `intercom_get_ticket`
|
|
|
|
Recuperar un solo ticket por ID desde Intercom
|
|
|
|
#### Entrada
|
|
|
|
| Parámetro | Tipo | Obligatorio | Descripción |
|
|
| --------- | ---- | -------- | ----------- |
|
|
| `ticketId` | string | Sí | ID del ticket a recuperar |
|
|
|
|
#### Salida
|
|
|
|
| Parámetro | Tipo | Descripción |
|
|
| --------- | ---- | ----------- |
|
|
| `ticket` | object | Objeto de ticket |
|
|
|
|
### `intercom_create_message`
|
|
|
|
Crear y enviar un nuevo mensaje iniciado por el administrador en Intercom
|
|
|
|
#### Entrada
|
|
|
|
| Parámetro | Tipo | Obligatorio | Descripción |
|
|
| --------- | ---- | -------- | ----------- |
|
|
| `message_type` | string | Sí | Tipo de mensaje: "inapp" para mensajes dentro de la aplicación o "email" para mensajes de correo electrónico |
|
|
| `template` | string | Sí | Estilo de plantilla del mensaje: "plain" para texto sin formato o "personal" para estilo personalizado |
|
|
| `subject` | string | No | El asunto del mensaje \(para tipo email\) |
|
|
| `body` | string | Sí | El cuerpo del mensaje |
|
|
| `from_type` | string | Sí | Tipo de remitente: "admin" |
|
|
| `from_id` | string | Sí | El ID del administrador que envía el mensaje |
|
|
| `to_type` | string | Sí | Tipo de destinatario: "contact" |
|
|
| `to_id` | string | Sí | El ID del contacto que recibe el mensaje |
|
|
| `created_at` | number | No | Marca de tiempo Unix de cuándo se creó el mensaje. Si no se proporciona, se utiliza la hora actual. |
|
|
|
|
#### Salida
|
|
|
|
| Parámetro | Tipo | Descripción |
|
|
| --------- | ---- | ----------- |
|
|
| `message` | object | Objeto de mensaje creado |
|
|
|
|
## Notas
|
|
|
|
- Categoría: `tools`
|
|
- Tipo: `intercom`
|