Intercom

Gestiona contactos, empresas, conversaciones, tickets y mensajes en Intercom

Configuración

Crear contacto

Operación
Crear contacto
Token de acceso*
••••••••
Rol
Select...
Correo electrónico
Correo del contacto
ID externo
Identificador externo del contacto
Teléfono
Número de teléfono del contacto
Nombre
Nombre del contacto
URL del avatar
URL de la imagen del avatar
Fecha de registro
Timestamp Unix
Última vez visto
Timestamp Unix
ID del propietario
ID de administrador
Baja de correos
Select...
Atributos personalizados
Objeto JSON con atributos personalizados
ID de empresa
ID de empresa para asociar al contacto
Crear contacto (intercom_create_contact)

Crear un contacto nuevo en Intercom con email, external_id o role

Entrada
ParámetroTipoObligatorioDescripción
rolestringNoEl rol del contacto. Acepta 'user' o 'lead'. El valor predeterminado es 'lead' si no se especifica.
emailstringNoLa dirección de correo electrónico del contacto
external_idstringNoUn identificador único del contacto proporcionado por el cliente
phonestringNoEl número de teléfono del contacto
namestringNoEl nombre del contacto
avatarstringNoUna URL de imagen de avatar del contacto
signed_up_atnumberNoLa hora de registro del usuario como marca de tiempo Unix
last_seen_atnumberNoLa última vez que se vio al usuario como marca de tiempo Unix
owner_idstringNoEl id de un administrador al que se ha asignado la propiedad de la cuenta del contacto
unsubscribed_from_emailsbooleanNoSi el contacto está dado de baja de los correos electrónicos
custom_attributesstringNoAtributos personalizados como objeto JSON (p. ej., {"attribute_name": "value"})
company_idstringNoID de empresa para asociar el contacto durante la creación
Salida
ParámetroTipoDescripción
contactobjectObjeto del contacto creado
metadataobjectMetadatos de la operación
successbooleanEstado de éxito de la operación

Obtener contacto

Operación
Obtener contacto
Token de acceso*
••••••••
ID de contacto*
ID de contacto
Obtener contacto (intercom_get_contact)

Obtener un único contacto por ID desde Intercom

Entrada
ParámetroTipoObligatorioDescripción
contactIdstringSíID del contacto que se va a obtener
Salida
ParámetroTipoDescripción
contactobjectObjeto de contacto
metadataobjectMetadatos de la operación
successbooleanEstado de éxito de la operación

Actualizar contacto

Operación
Actualizar contacto
Token de acceso*
••••••••
Rol
Select...
ID de contacto*
ID de contacto
Correo electrónico
Correo del contacto
ID externo
Identificador externo del contacto
Teléfono
Número de teléfono del contacto
Nombre
Nombre del contacto
URL del avatar
URL de la imagen del avatar
Fecha de registro
Marca de tiempo Unix
Visto por última vez
Marca de tiempo Unix
ID del propietario
ID de administrador
Dado de baja de correos
Select...
Atributos personalizados
Objeto JSON con atributos personalizados
ID de empresa
ID de empresa para asociar al contacto
Actualizar contacto (intercom_update_contact)

Actualizar un contacto existente en Intercom

Entrada
ParámetroTipoObligatorioDescripción
contactIdstringSíID del contacto a actualizar
rolestringNoRol del contacto. Acepta 'user' o 'lead'.
external_idstringNoIdentificador único del contacto proporcionado por el cliente
emailstringNoDirección de correo electrónico del contacto
phonestringNoNúmero de teléfono del contacto
namestringNoNombre del contacto
avatarstringNoURL de la imagen de avatar del contacto
signed_up_atnumberNoHora de registro del usuario como marca de tiempo Unix
last_seen_atnumberNoHora de la última vez que se vio al usuario como marca de tiempo Unix
owner_idstringNoID de un administrador al que se asignó la propiedad de la cuenta del contacto
unsubscribed_from_emailsbooleanNoIndica si el contacto está dado de baja de los correos electrónicos
custom_attributesstringNoAtributos personalizados como objeto JSON (p. ej., {"attribute_name": "value"})
company_idstringNoID de la empresa con la que asociar el contacto
Salida
ParámetroTipoDescripción
contactobjectObjeto de contacto actualizado
metadataobjectMetadatos de la operación
successbooleanEstado de éxito de la operación

Listar contactos

Operación
Listar contactos
Token de acceso*
••••••••
Por página
Resultados por página (máx.: 150)
A partir de
Cursor de paginación
Listar contactos (intercom_list_contacts)

Lista todos los contactos de Intercom con soporte de paginación

Entrada
ParámetroTipoObligatorioDescripción
per_pagenumberNoNúmero de resultados por página (máx.: 150)
starting_afterstringNoCursor de paginación: ID a partir del cual empezar
Salida
ParameterTypeDescription
contactsarrayArray de objetos de contacto
pagesobjectInformación de paginación
metadataobjectMetadatos de la operación
successbooleanEstado de éxito de la operación

Buscar contactos

Operación
Buscar contactos
Token de acceso*
••••••••
Consulta de búsqueda*
Consulta de búsqueda JSON o texto
Campo de ordenación
Campo por el que ordenar (p. ej., name, created_at)
Orden
Select...
Por página
Resultados por página (máx.: 150)
A partir de
Cursor de paginación
Buscar contactos (intercom_search_contacts)

Buscar contactos en Intercom mediante una consulta

Entrada
ParámetroTipoObligatorioDescripción
querystringSíConsulta de búsqueda (p. ej., {"field":"email","operator":"=","value":"user@example.com"})
per_pagenumberNoNúmero de resultados por página (máx.: 150)
starting_afterstringNoCursor para la paginación
sort_fieldstringNoCampo por el que ordenar (p. ej., "name", "created_at", "last_seen_at")
sort_orderstringNoOrden: "ascending" o "descending"
Salida
ParámetroTipoDescripción
contactsarrayArray de objetos de contacto coincidentes
pagesobjectInformación de paginación
metadataobjectMetadatos de la operación
successbooleanEstado de éxito de la operación

Eliminar contacto

Operación
Eliminar contacto
Token de acceso*
••••••••
ID de contacto*
ID de contacto
Eliminar contacto (intercom_delete_contact)

Elimina un contacto de Intercom por ID

Entrada
ParámetroTipoObligatorioDescripción
contactIdstringSíID del contacto a eliminar
Salida
ParámetroTipoDescripción
idstringID del contacto eliminado
deletedbooleanIndica si se eliminó el contacto
metadataobjectMetadatos de la operación
successbooleanEstado de éxito de la operación

Crear empresa

Operación
Crear empresa
Token de acceso*
••••••••
ID de empresa (externo)*
Tu identificador único de la empresa
Nombre de la empresa
Nombre de la empresa
Sitio web
Sitio web de la empresa
Plan
Plan de suscripción
Tamaño
Número de empleados
Industria
Industria de la empresa
Gasto mensual
Importe de ingresos
Fecha de creación remota
Marca de tiempo Unix de creación de la empresa
Crear empresa (intercom_create_company)

Crear o actualizar una empresa en Intercom

Entrada
ParámetroTipoObligatorioDescripción
company_idstringSíTu identificador único de la empresa
namestringNoEl nombre de la empresa
websitestringNoEl sitio web de la empresa
planstringNoEl nombre del plan de la empresa
sizenumberNoEl número de empleados de la empresa
industrystringNoEl sector en el que opera la empresa
monthly_spendnumberNoLos ingresos que la empresa genera para tu negocio. Nota: Este campo trunca los valores de punto flotante a enteros (p. ej., 155.98 se convierte en 155)
custom_attributesstringNoAtributos personalizados como objeto JSON
remote_created_atnumberNoEl momento en que creaste la empresa, como marca de tiempo Unix
Salida
ParámetroTipoDescripción
companyobjectObjeto de empresa creada o actualizada
metadataobjectMetadatos de la operación
successbooleanEstado de éxito de la operación

Obtener empresa

Operación
Obtener empresa
Token de acceso*
••••••••
ID de empresa*
ID de empresa de Intercom
Obtener empresa (intercom_get_company)

Recuperar una empresa por ID desde Intercom

Entrada
ParámetroTipoObligatorioDescripción
companyIdstringSíID de la empresa que se va a recuperar
Salida
ParámetroTipoDescripción
companyobjectObjeto de empresa
metadataobjectMetadatos de la operación
successbooleanEstado de éxito de la operación

Listar empresas

Operación
Listar empresas
Token de acceso*
••••••••
Por página
Resultados por página (máx.: 150)
A partir de
Cursor de paginación
Página
Número de página
Listar empresas (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 se pueden devolver mediante paginación. Para conjuntos de datos de más de 10,000 empresas, usa la Scroll API.

Entrada
ParámetroTipoObligatorioDescripción
per_pagenumberNoNúmero de resultados por página
pagenumberNoNúmero de página
starting_afterstringNoCursor para paginación (preferido sobre la paginación por páginas)
Salida
ParámetroTipoDescripción
companiesarrayArray de objetos de empresa
pagesobjectInformación de paginación
metadataobjectMetadatos de la operación
successbooleanEstado de éxito de la operación

Obtener conversación

Operación
Obtener conversación
Token de acceso*
••••••••
ID de conversación*
ID de conversación
Mostrar como
Select...
Incluir traducciones
Select...
Obtener conversación (intercom_get_conversation)

Recupera una conversación individual por ID de Intercom

Entrada
ParámetroTipoObligatorioDescripción
conversationIdstringSíID de la conversación que se va a recuperar
display_asstringNoEstablece "plaintext" para recuperar los mensajes en texto plano
include_translationsbooleanNoSi es true, las partes de la conversación se traducirán al idioma detectado de la conversación
Salida
ParámetroTipoDescripción
conversationobjectObjeto de conversación
metadataobjectMetadatos de la operación
successbooleanEstado de éxito de la operación

Listar conversaciones

Operación
Listar conversaciones
Token de acceso*
••••••••
Ordenar por
Campo por el que ordenar (p. ej., waiting_since, updated_at)
Orden
Select...
Por página
Resultados por página (máx.: 150)
A partir de
Cursor de paginación
Listar conversaciones (intercom_list_conversations)

Lista todas las conversaciones de Intercom con soporte de paginación

Entrada
ParámetroTipoObligatorioDescripción
per_pagenumberNoNúmero de resultados por página (máx.: 150)
starting_afterstringNoCursor de paginación
sortstringNoCampo por el que ordenar (p. ej., "waiting_since", "updated_at", "created_at")
orderstringNoOrden: "asc" (ascendente) o "desc" (descendente)
Salida
ParámetroTipoDescripción
conversationsarrayArray de objetos de conversación
pagesobjectInformación de paginación
metadataobjectMetadatos de la operación
successbooleanEstado de éxito de la operación

Responder a la conversación

Operación
Responder a la conversación
Token de acceso*
••••••••
ID de conversación*
ID de conversación
Tipo de mensaje*
Select...
Cuerpo del mensaje*
Texto del mensaje
ID de administrador*
ID del administrador que envía el mensaje
URL de archivos adjuntos
URL de imágenes separadas por comas (máx. 10)
Fecha de creación
Marca de tiempo Unix de creación de la respuesta
Responder a la conversación (intercom_reply_conversation)

Responder a una conversación como administrador en Intercom

Entrada
ParámetroTipoObligatorioDescripción
conversationIdstringSíID de la conversación a la que responder
message_typestringSíTipo de mensaje: "comment" o "note"
bodystringSíEl cuerpo de texto de la respuesta
admin_idstringNoEl ID del administrador que escribe la respuesta. Si no se proporciona, se usará un administrador predeterminado (Operator/Fin).
attachment_urlsstringNoLista de URL de imágenes separadas por comas (máx. 10)
created_atnumberNoMarca de tiempo Unix de creación de la respuesta. Si no se proporciona, se usa la hora actual.
Salida
ParámetroTipoDescripción
conversationobjectObjeto de conversación actualizado
metadataobjectMetadatos de la operación
successbooleanEstado de éxito de la operación

Buscar conversaciones

Operación
Buscar conversaciones
Token de acceso*
••••••••
Consulta de búsqueda*
Consulta de búsqueda JSON o texto
Campo de ordenación
Campo por el que ordenar (p. ej., name, created_at)
Orden
Select...
Por página
Resultados por página (máx.: 150)
A partir de
Cursor de paginación
Buscar conversaciones (intercom_search_conversations)

Buscar conversaciones en Intercom mediante una consulta

Entrada
ParámetroTipoObligatorioDescripción
querystringSíConsulta de búsqueda como objeto JSON
per_pagenumberNoNúmero de resultados por página (máx.: 150)
starting_afterstringNoCursor para paginación
sort_fieldstringNoCampo por el que ordenar (p. ej., "created_at", "updated_at")
sort_orderstringNoOrden: "ascending" o "descending"
Salida
ParámetroTipoDescripción
conversationsarrayArray de objetos de conversación coincidentes
pagesobjectInformación de paginación
metadataobjectMetadatos de la operación
successbooleanEstado de éxito de la operación

Crear ticket

Operación
Crear ticket
Token de acceso*
••••••••
ID de tipo de ticket*
ID del tipo de ticket
Contactos*
Array JSON de identificadores de contacto
Atributos del ticket*
Objeto JSON con atributos del ticket
ID de empresa
ID de empresa para asociar al ticket
Fecha de creación
Timestamp Unix de creación del ticket
Conversación a vincular
ID de la conversación para vincular al ticket
Desactivar notificaciones
Select...
Crear ticket (intercom_create_ticket)

Crear un ticket nuevo en Intercom

Entrada
ParámetroTipoObligatorioDescripción
ticket_type_idstringSíEl ID del tipo de ticket
contactsstringSíArray JSON de identificadores de contacto (p. ej., [{"id": "contact_id"}])
ticket_attributesstringSíObjeto JSON con atributos del ticket, incluidos default_title y default_description
company_idstringNoID de empresa para asociar el ticket
created_atnumberNoMarca de tiempo Unix de creación del ticket. Si no se proporciona, se usa la hora actual.
conversation_to_link_idstringNoID de una conversación existente para vincular a este ticket
disable_notificationsbooleanNoSi es true, suprime las notificaciones al crear el ticket
Salida
ParámetroTipoDescripción
ticketobjectObjeto del ticket creado
metadataobjectMetadatos de la operación
successbooleanEstado de éxito de la operación

Obtener ticket

Operación
Obtener ticket
Token de acceso*
••••••••
ID del ticket*
ID del ticket
Obtener ticket (intercom_get_ticket)

Recupera un único ticket por ID desde Intercom

Entrada
ParámetroTipoObligatorioDescripción
ticketIdstringSíID del ticket a recuperar
Salida
ParámetroTipoDescripción
ticketobjectObjeto ticket
metadataobjectMetadatos de la operación
successbooleanEstado de éxito de la operación

Crear mensaje

Operación
Crear mensaje
Token de acceso*
••••••••
Cuerpo del mensaje*
Texto del mensaje
Tipo de mensaje*
Select...
Plantilla*
Select...
Asunto
Asunto del correo (para tipo email)
Tipo de origen*
Select...
ID de origen*
ID de administrador
Tipo de destino*
Select...
ID de destino*
ID de contacto
Creado el
Marca de tiempo Unix de creación del mensaje
Crear mensaje (intercom_create_message)

Crear y enviar un nuevo mensaje iniciado por un administrador en Intercom

Entrada
ParámetroTipoObligatorioDescripción
message_typestringSíTipo de mensaje: "inapp" para mensajes en la aplicación o "email" para mensajes de correo electrónico
templatestringSíEstilo de plantilla del mensaje: "plain" para texto plano o "personal" para estilo personalizado
subjectstringNoEl asunto del mensaje (para el tipo email)
bodystringSíEl cuerpo del mensaje
from_typestringSíTipo de remitente: "admin"
from_idstringSíEl ID del administrador que envía el mensaje
to_typestringSíTipo de destinatario: "contact"
to_idstringSíEl ID del contacto que recibe el mensaje
created_atnumberNoMarca de tiempo Unix de creación del mensaje. Si no se proporciona, se usa la hora actual.
Salida
ParámetroTipoDescripción
messageobjectObjeto del mensaje creado
metadataobjectMetadatos de la operación
successbooleanEstado de éxito de la operación

Instrucciones de uso

Integra Intercom en el workflow. Permite 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.

Notas

  • Categoría: tools
  • Tipo: intercom