Pailot

Intercom

Контакты, компании, диалоги и тикеты Intercom в процессах Pailot

Intercom — платформа общения с клиентами: контакты, компании, диалоги, тикеты и исходящие сообщения.

С Intercom в Pailot вы можете:

  • Создавать, читать, обновлять, искать и удалять контакты
  • Создавать и смотреть компании
  • Читать, искать и отвечать в диалогах
  • Создавать тикеты и отправлять сообщения от имени администратора

Нужен ключ API (Application Programming Interface — программный интерфейс) Intercom.

Блок ставят на холст как отдельный шаг или прикрепляют к агенту. Ключ — в переменных окружения рабочего пространства.

Инструменты

intercom_create_contact

Создать контакт: нужны email, external_id или role. В ответе только поля, совпадающие с API.

Вход

ПараметрТипОбязательныйОписание
rolestringНетРоль контакта: user или lead. По умолчанию lead
emailstringНетEmail контакта
external_idstringНетВнешний уникальный ID контакта
phonestringНетТелефон контакта
namestringНетИмя контакта
avatarstringНетURL аватара контакта
signed_up_atnumberНетВремя регистрации — Unix timestamp
last_seen_atnumberНетВремя последнего визита — Unix timestamp
owner_idstringНетID администратора — владельца контакта
unsubscribed_from_emailsbooleanНетОтписан ли контакт от писем
custom_attributesstringНетПользовательские атрибуты — JSON-объект (например {"attribute_name": "value"})
company_idstringНетID компании для привязки при создании

Выход

ПараметрТипОписание
contactobjectСозданный контакт
↳ idstringУникальный ID контакта
↳ typestringТип списка
↳ rolestringРоль контакта (user или lead)
↳ emailstringEmail контакта
↳ phonestringТелефон контакта
↳ namestringИмя контакта
↳ avatarstringURL аватара контакта
↳ owner_idstringID администратора контакта
↳ external_idstringВнешний ID контакта
↳ created_atnumberUnix timestamp создания контакта
↳ updated_atnumberUnix timestamp последнего обновления контакта
↳ signed_up_atnumberUnix timestamp регистрации пользователя
↳ last_seen_atnumberUnix timestamp последнего визита
↳ workspace_idstringID рабочего пространства контакта
↳ custom_attributesobjectПользовательские атрибуты контакта
↳ tagsobjectТеги контакта
↳ typestringТип списка
↳ urlstringURL списка тегов
↳ dataarrayОбъекты тегов
↳ has_morebooleanЕсть ли ещё теги
↳ total_countnumberВсего тегов
↳ urlstringURL списка компаний
↳ dataarrayОбъекты социальных профилей
↳ has_morebooleanЕсть ли ещё компании
↳ total_countnumberВсего компаний
↳ notesobjectЗаметки контакта
↳ typestringТип списка
↳ urlstringURL списка заметок
↳ dataarrayОбъекты заметок
↳ has_morebooleanЕсть ли ещё заметки
↳ total_countnumberВсего заметок
↳ companiesobjectКомпании контакта
↳ typestringТип списка
↳ urlstringURL списка компаний
↳ dataarrayОбъекты компаний
↳ has_morebooleanЕсть ли ещё компании
↳ total_countnumberВсего компаний
↳ locationobjectМестоположение контакта
↳ typestringТип местоположения
↳ citystringГород
↳ regionstringРегион / штат
↳ countrystringСтрана
↳ country_codestringКод страны
↳ continent_codestringКод континента
↳ citystringГород
↳ regionstringРегион / штат
↳ countrystringСтрана
↳ country_codestringКод страны
↳ continent_codestringКод континента
↳ social_profilesobjectСоциальные профили контакта
↳ typestringТип списка
↳ dataarrayОбъекты социальных профилей
↳ unsubscribed_from_emailsbooleanОтписан ли контакт от писем
contactIdstringID созданного контакта

intercom_get_contact

Один контакт по ID. В ответе только поля, совпадающие с API.

Вход

ПараметрТипОбязательныйОписание
contactIdstringДаID контакта

Выход

ПараметрТипОписание
contactobjectОбъект контакта
↳ idstringУникальный ID контакта
↳ typestringТип объекта (contact)
↳ rolestringРоль контакта (user или lead)
↳ emailstringEmail контакта
↳ phonestringТелефон контакта
↳ namestringИмя контакта
↳ avatarstringURL аватара контакта
↳ owner_idstringID администратора контакта
↳ external_idstringВнешний ID контакта
↳ created_atnumberUnix timestamp создания контакта
↳ updated_atnumberUnix timestamp последнего обновления контакта
↳ workspace_idstringID рабочего пространства контакта
↳ custom_attributesobjectПользовательские атрибуты контакта
↳ tagsobjectТеги контакта
↳ notesobjectЗаметки контакта
↳ companiesobjectКомпании контакта
↳ locationobjectМестоположение контакта
↳ social_profilesobjectСоциальные профили контакта
↳ unsubscribed_from_emailsbooleanОтписан ли контакт от писем

intercom_update_contact

Обновить контакт. В ответе только поля, совпадающие с API.

Вход

ПараметрТипОбязательныйОписание
contactIdstringДаID контакта
rolestringНетРоль контакта: user или lead
external_idstringНетВнешний уникальный ID контакта
emailstringНетEmail контакта
phonestringНетТелефон контакта
namestringНетИмя контакта
avatarstringНетURL аватара контакта
signed_up_atnumberНетВремя регистрации — Unix timestamp
last_seen_atnumberНетВремя последнего визита — Unix timestamp
owner_idstringНетID администратора — владельца контакта
unsubscribed_from_emailsbooleanНетОтписан ли контакт от писем
custom_attributesstringНетПользовательские атрибуты — JSON-объект (например {"attribute_name": "value"})
company_idstringНетID компании для привязки

Выход

ПараметрТипОписание
contactobjectОбновлённый контакт
↳ idstringУникальный ID контакта
↳ typestringТип объекта (contact)
↳ rolestringРоль контакта (user или lead)
↳ emailstringEmail контакта
↳ phonestringТелефон контакта
↳ namestringИмя контакта
↳ avatarstringURL аватара контакта
↳ owner_idstringID администратора контакта
↳ external_idstringВнешний ID контакта
↳ created_atnumberUnix timestamp создания контакта
↳ updated_atnumberUnix timestamp последнего обновления контакта
↳ workspace_idstringID рабочего пространства контакта
↳ custom_attributesobjectПользовательские атрибуты контакта
↳ tagsobjectТеги контакта
↳ notesobjectЗаметки контакта
↳ companiesobjectКомпании контакта
↳ locationobjectМестоположение контакта
↳ social_profilesobjectСоциальные профили контакта
↳ unsubscribed_from_emailsbooleanОтписан ли контакт от писем
contactIdstringID обновлённого контакта

intercom_list_contacts

Список всех контактов Intercom с постраничным выводом

Вход

ПараметрТипОбязательныйОписание
per_pagenumberНетРезультатов на страницу (макс. 150)
starting_afterstringНетКурсор постраничного вывода - ID, после которого начать

Выход

ПараметрТипОписание
contactsarrayОбъекты контактов
↳ idstringУникальный ID контакта
↳ typestringТип объекта (contact)
↳ rolestringРоль контакта (user или lead)
↳ emailstringEmail контакта
↳ phonestringТелефон контакта
↳ namestringИмя контакта
↳ external_idstringВнешний ID контакта
↳ created_atnumberUnix timestamp создания контакта
↳ updated_atnumberUnix timestamp последнего обновления контакта
↳ workspace_idstringID рабочего пространства контакта
↳ custom_attributesobjectПользовательские атрибуты контакта
↳ tagsobjectТеги контакта
↳ companiesobjectКомпании контакта
pagesobjectДанные постраничного вывода
↳ typestringТип объекта страниц
↳ pagenumberНомер текущей страницы
↳ per_pagenumberРезультатов на страницу
↳ total_pagesnumberВсего страниц
total_countnumberВсего контактов

intercom_search_contacts

Найти контакты Intercom по запросу

Вход

ПараметрТипОбязательныйОписание
querystringДаПоисковый запрос (например {"field":"email","operator":"=","value":"user@example.com"})
per_pagenumberНетРезультатов на страницу (макс. 150)
starting_afterstringНетКурсор постраничного вывода
sort_fieldstringНетПоле сортировки (например "name", "created_at", "last_seen_at")
sort_orderstringНетПорядок сортировки: "ascending" или descending

Выход

ПараметрТипОписание
contactsarrayМассив matching contact objects
↳ idstringУникальный ID контакта
↳ typestringТип объекта (contact)
↳ rolestringРоль контакта (user или lead)
↳ emailstringEmail контакта
↳ phonestringТелефон контакта
↳ namestringИмя контакта
↳ avatarstringURL аватара контакта
↳ owner_idstringID администратора контакта
↳ external_idstringВнешний ID контакта
↳ created_atnumberUnix timestamp создания контакта
↳ updated_atnumberUnix timestamp последнего обновления контакта
↳ signed_up_atnumberUnix timestamp регистрации пользователя
↳ last_seen_atnumberUnix timestamp последнего визита
↳ workspace_idstringID рабочего пространства контакта
↳ custom_attributesobjectПользовательские атрибуты контакта
↳ tagsobjectТеги контакта
↳ notesobjectЗаметки контакта
↳ companiesobjectКомпании контакта
↳ locationobjectМестоположение контакта
↳ social_profilesobjectСоциальные профили контакта
↳ unsubscribed_from_emailsbooleanОтписан ли контакт от писем
pagesobjectДанные постраничного вывода
↳ typestringТип объекта страниц
↳ pagenumberНомер текущей страницы
↳ per_pagenumberРезультатов на страницу
↳ total_pagesnumberВсего страниц
total_countnumberВсего matching contacts

intercom_delete_contact

Удалить контакт Intercom по ID. В ответе только поля, совпадающие с API.

Вход

ПараметрТипОбязательныйОписание
contactIdstringДаID контакта для удаления

Выход

ПараметрТипОписание
idstringID удалённого контакта
deletedbooleanУдалён ли контакт

intercom_create_company

Создать или обновить компанию в Intercom

Вход

ПараметрТипОбязательныйОписание
company_idstringДаYour уникальный идентификатор компании
namestringНетНазвание компании
websitestringНетСайт компании
planstringНетНазвание тарифа компании
sizenumberНетЧисло сотрудников
industrystringНетОтрасль компании
monthly_spendnumberНетВыручка компании. Дробная часть отбрасывается (155.98 → 155)
custom_attributesstringНетПользовательские атрибуты — JSON-объект
remote_created_atnumberНетВремя, когда вы создали компанию — Unix timestamp

Выход

ПараметрТипОписание
companyobjectСозданная или обновлённая компания
↳ idstringУникальный идентификатор компании
↳ typestringТип списка сегментов
↳ app_idstringID приложения Intercom
↳ company_idstringYour уникальный идентификатор компании
↳ namestringНазвание компании
↳ websitestringURL сайта компании
↳ planobjectДанные тарифа компании
↳ sizenumberЧисло employees
↳ industrystringОтрасль компании
↳ monthly_spendnumberМесячная выручка компании
↳ session_countnumberЧисло sessions
↳ user_countnumberЧисло пользователей в компании
↳ created_atnumberUnix timestamp создания компании
↳ updated_atnumberUnix timestamp последнего обновления компании
↳ remote_created_atnumberUnix timestamp, когда вы создали компанию
↳ custom_attributesobjectПользовательские атрибуты company
↳ tagsarrayОбъекты тегов
↳ segmentsarrayМассив segment objects
companyIdstringID созданной или обновлённой компании

intercom_get_company

Компания Intercom по ID

Вход

ПараметрТипОбязательныйОписание
companyIdstringДаID компании

Выход

ПараметрТипОписание
companyobjectОбъект компании
↳ idstringУникальный идентификатор компании
↳ typestringТип объекта (company)
↳ app_idstringID приложения Intercom
↳ company_idstringYour уникальный идентификатор компании
↳ namestringНазвание компании
↳ websitestringURL сайта компании
↳ planobjectДанные тарифа компании
↳ sizenumberЧисло employees
↳ industrystringОтрасль компании
↳ monthly_spendnumberМесячная выручка компании
↳ session_countnumberЧисло sessions
↳ user_countnumberЧисло пользователей в компании
↳ created_atnumberUnix timestamp создания компании
↳ updated_atnumberUnix timestamp последнего обновления компании
↳ custom_attributesobjectПользовательские атрибуты company
↳ tagsobjectТеги company
↳ segmentsobjectСегменты компании

intercom_list_companies

Список компаний Intercom с постраничным выводом. Лимит — 10 000 компаний. Если больше — используйте Scroll API.

Вход

ПараметрТипОбязательныйОписание
per_pagenumberНетРезультатов на страницу
pagenumberНетНомер страницы
starting_afterstringНетКурсор постраничного вывода (предпочтительнее нумерации страниц)

Выход

ПараметрТипОписание
companiesarrayОбъекты компаний
↳ idstringУникальный идентификатор компании
↳ typestringТип объекта (company)
↳ app_idstringID приложения Intercom
↳ company_idstringYour уникальный идентификатор компании
↳ namestringНазвание компании
↳ websitestringURL сайта компании
↳ planobjectДанные тарифа компании
↳ monthly_spendnumberМесячная выручка компании
↳ session_countnumberЧисло sessions
↳ user_countnumberЧисло пользователей в компании
↳ created_atnumberUnix timestamp создания компании
↳ updated_atnumberUnix timestamp последнего обновления компании
↳ custom_attributesobjectПользовательские атрибуты company
↳ tagsobjectТеги company
↳ segmentsobjectСегменты компании
pagesobjectДанные постраничного вывода
↳ typestringТип объекта страниц
↳ pagenumberНомер текущей страницы
↳ per_pagenumberРезультатов на страницу
↳ total_pagesnumberВсего страниц
total_countnumberВсего компаний
successbooleanУспешность операции

intercom_get_conversation

Диалог Intercom по ID

Вход

ПараметрТипОбязательныйОписание
conversationIdstringДаID диалога
display_asstringНетplaintext — получить сообщения обычным текстом
include_translationsbooleanНетtrue — части диалога переводятся на определённый язык диалога

Выход

ПараметрТипОписание
conversationobjectОбъект диалога
↳ idstringУникальный идентификатор диалога
↳ typestringТип объекта (conversation)
↳ titlestringЗаголовок диалога
↳ created_atnumberUnix timestamp создания диалога
↳ updated_atnumberUnix timestamp последнего обновления диалога
↳ waiting_sincenumberUnix timestamp ожидания ответа
↳ snoozed_untilnumberUnix timestamp конца отложения
↳ openbooleanОткрыт ли диалог
↳ statestringСостояние диалога
↳ readbooleanПрочитан ли диалог
↳ prioritystringПриоритет диалога
↳ admin_assignee_idnumberID назначенного администратора
↳ team_assignee_idstringID назначенной команды
↳ tagsobjectТеги диалога
↳ sourceobjectИсточник диалога
↳ contactsobjectКонтакты в диалоге
↳ teammatesobjectУчастники диалога
↳ conversation_partsobjectЧасти диалога
↳ statisticsobjectСтатистика диалога
successbooleanУспешность операции

intercom_list_conversations

Список диалогов Intercom с постраничным выводом

Вход

ПараметрТипОбязательныйОписание
per_pagenumberНетРезультатов на страницу (макс. 150)
starting_afterstringНетКурсор постраничного вывода
sortstringНетПоле сортировки (например "waiting_since", "updated_at", "created_at")
orderstringНетПорядок сортировки: asc (по возрастанию) или desc (по убыванию)

Выход

ПараметрТипОписание
conversationsarrayМассив объектов диалогов
↳ idstringУникальный идентификатор диалога
↳ typestringТип объекта (conversation)
↳ titlestringЗаголовок диалога
↳ created_atnumberUnix timestamp создания диалога
↳ updated_atnumberUnix timestamp последнего обновления диалога
↳ waiting_sincenumberUnix timestamp ожидания ответа
↳ openbooleanОткрыт ли диалог
↳ statestringСостояние диалога
↳ readbooleanПрочитан ли диалог
↳ prioritystringПриоритет диалога
↳ admin_assignee_idnumberID назначенного администратора
↳ team_assignee_idstringID назначенной команды
↳ tagsobjectТеги диалога
↳ sourceobjectИсточник диалога
↳ contactsobjectКонтакты в диалоге
pagesobjectДанные постраничного вывода
↳ typestringТип объекта страниц
↳ pagenumberНомер текущей страницы
↳ per_pagenumberРезультатов на страницу
↳ total_pagesnumberВсего страниц
total_countnumberВсего диалогов
successbooleanУспешность операции

intercom_reply_conversation

Ответить в диалог от имени администратора Intercom

Вход

ПараметрТипОбязательныйОписание
conversationIdstringДаID диалога для ответа
message_typestringДаТип сообщения: comment или note
bodystringДаТекст ответа
admin_idstringНетID администратора, который пишет ответ. Если не задано — администратор по умолчанию (Operator/Fin)
attachment_urlsstringНетURL изображений через запятую (не больше 10)
created_atnumberНетUnix timestamp создания ответа. Если не задано — текущее время.

Выход

ПараметрТипОписание
conversationobjectОбновлённый диалог
↳ idstringУникальный идентификатор диалога
↳ typestringТип объекта (conversation)
↳ titlestringЗаголовок диалога
↳ created_atnumberUnix timestamp создания диалога
↳ updated_atnumberUnix timestamp последнего обновления диалога
↳ waiting_sincenumberUnix timestamp ожидания ответа
↳ openbooleanОткрыт ли диалог
↳ statestringСостояние диалога
↳ readbooleanПрочитан ли диалог
↳ prioritystringПриоритет диалога
↳ admin_assignee_idnumberID назначенного администратора
↳ team_assignee_idstringID назначенной команды
↳ tagsobjectТеги диалога
↳ sourceobjectИсточник диалога
↳ contactsobjectКонтакты в диалоге
↳ conversation_partsobjectЧасти диалога
conversationIdstringID диалог
successbooleanУспешность операции

intercom_search_conversations

Найти диалоги Intercom по запросу. В ответе только поля, совпадающие с API.

Вход

ПараметрТипОбязательныйОписание
querystringДаПоисковый запрос как JSON-объект
per_pagenumberНетРезультатов на страницу (макс. 150)
starting_afterstringНетКурсор постраничного вывода
sort_fieldstringНетПоле сортировки (например "created_at", "updated_at")
sort_orderstringНетПорядок сортировки: "ascending" или descending

Выход

ПараметрТипОписание
conversationsarrayМассив подходящих диалогов
↳ idstringУникальный идентификатор диалога
↳ typestringТип объекта (conversation)
↳ titlestringЗаголовок диалога
↳ created_atnumberUnix timestamp создания диалога
↳ updated_atnumberUnix timestamp последнего обновления диалога
↳ waiting_sincenumberUnix timestamp ожидания ответа
↳ openbooleanОткрыт ли диалог
↳ statestringСостояние диалога
↳ readbooleanПрочитан ли диалог
↳ prioritystringПриоритет диалога
↳ admin_assignee_idnumberID назначенного администратора
↳ team_assignee_idstringID назначенной команды
↳ tagsobjectТеги диалога
↳ sourceobjectИсточник диалога
↳ contactsobjectКонтакты в диалоге
pagesobjectДанные постраничного вывода
↳ typestringТип объекта страниц
↳ pagenumberНомер текущей страницы
↳ per_pagenumberРезультатов на страницу
↳ total_pagesnumberВсего страниц
total_countnumberВсего matching conversations
successbooleanУспешность операции

intercom_create_ticket

Создать тикет в Intercom. В ответе только поля, совпадающие с API.

Вход

ПараметрТипОбязательныйОписание
ticket_type_idstringДаID типа тикета
contactsstringДаJSON-массив идентификаторов контактов (например [{"id": "contact_id"}])
ticket_attributesstringДаJSON-объект атрибутов тикета, включая default_title и default_description
company_idstringНетID компании для привязки тикета
created_atnumberНетUnix timestamp создания тикета. Если не задано — текущее время.
conversation_to_link_idstringНетID существующего диалога для привязки к тикету
disable_notificationsbooleanНетtrue — не слать уведомления при создании тикета

Выход

ПараметрТипОписание
ticketobjectСозданный тикет
↳ idstringУникальный идентификатор тикета
↳ typestringТип объекта (ticket)
↳ ticket_idstringID тикета
↳ ticket_typeobjectТип тикета
↳ ticket_attributesobjectАтрибуты тикета
↳ ticket_statestringСостояние тикета
↳ ticket_state_internal_labelstringВнутренняя метка состояния тикета
↳ ticket_state_external_labelstringВнешняя метка состояния тикета
↳ created_atnumberUnix timestamp создания тикета
↳ updated_atnumberUnix timestamp последнего обновления тикета
↳ contactsobjectКонтакты тикета
↳ admin_assignee_idstringID назначенного администратора
↳ team_assignee_idstringID назначенной команды
↳ is_sharedbooleanОбщий ли тикет
↳ openbooleanОткрыт ли тикет
ticketIdstringID тикет
successbooleanУспешность операции

intercom_get_ticket

Тикет Intercom по ID. В ответе только поля, совпадающие с API.

Вход

ПараметрТипОбязательныйОписание
ticketIdstringДаID тикета

Выход

ПараметрТипОписание
ticketobjectОбъект тикета
↳ idstringУникальный идентификатор тикета
↳ typestringТип объекта (ticket)
↳ ticket_idstringID тикета
↳ ticket_typeobjectТип тикета
↳ ticket_attributesobjectАтрибуты тикета
↳ ticket_statestringСостояние тикета
↳ ticket_state_internal_labelstringВнутренняя метка состояния тикета
↳ ticket_state_external_labelstringВнешняя метка состояния тикета
↳ created_atnumberUnix timestamp создания тикета
↳ updated_atnumberUnix timestamp последнего обновления тикета
↳ contactsobjectКонтакты тикета
↳ admin_assignee_idstringID назначенного администратора
↳ team_assignee_idstringID назначенной команды
↳ is_sharedbooleanОбщий ли тикет
↳ openbooleanОткрыт ли тикет
ticketIdstringID тикет
successbooleanУспешность операции

intercom_create_message

Создать и отправить сообщение от имени администратора Intercom. В ответе только поля, совпадающие с API.

Вход

ПараметрТипОбязательныйОписание
message_typestringДаТип сообщения: inapp — в приложении, email — письмо
templatestringДаСтиль шаблона: plain — обычный текст, personal — персональный
subjectstringНетТема письма (для типа email)
bodystringДаТело сообщения
from_typestringДаТип отправителя: admin
from_idstringДаID администратора-отправителя
to_typestringДаТип получателя: contact
to_idstringДаID контакта-получателя
created_atnumberНетUnix timestamp создания сообщения. Если не задано — текущее время.

Выход

ПараметрТипОписание
messageobjectСозданное сообщение
↳ idstringУникальный идентификатор сообщения
↳ typestringТип объекта (message)
↳ created_atnumberUnix timestamp создания сообщения
↳ bodystringТело сообщения
↳ message_typestringТип сообщения (in_app или email)
↳ conversation_idstringID диалог
↳ ownerobjectВладелец сообщения
messageIdstringID сообщение
successbooleanУспешность операции
На этой странице

На этой странице

Получить доступ
Копилот собирает процесс. Менеджер запускает сам. Можно поставить в контур компании.
Получить доступ