Intercom
Контакты, компании, диалоги и тикеты Intercom в процессах Pailot
Intercom — платформа общения с клиентами: контакты, компании, диалоги, тикеты и исходящие сообщения.
С Intercom в Pailot вы можете:
- Создавать, читать, обновлять, искать и удалять контакты
- Создавать и смотреть компании
- Читать, искать и отвечать в диалогах
- Создавать тикеты и отправлять сообщения от имени администратора
Нужен ключ API (Application Programming Interface — программный интерфейс) Intercom.
Блок ставят на холст как отдельный шаг или прикрепляют к агенту. Ключ — в переменных окружения рабочего пространства.
Создать контакт: нужны email, external_id или role. В ответе только поля, совпадающие с API.
| Параметр | Тип | Обязательный | Описание |
|---|
role | string | Нет | Роль контакта: user или lead. По умолчанию lead |
email | string | Нет | Email контакта |
external_id | string | Нет | Внешний уникальный ID контакта |
phone | string | Нет | Телефон контакта |
name | string | Нет | Имя контакта |
avatar | string | Нет | URL аватара контакта |
signed_up_at | number | Нет | Время регистрации — Unix timestamp |
last_seen_at | number | Нет | Время последнего визита — Unix timestamp |
owner_id | string | Нет | ID администратора — владельца контакта |
unsubscribed_from_emails | boolean | Нет | Отписан ли контакт от писем |
custom_attributes | string | Нет | Пользовательские атрибуты — JSON-объект (например {"attribute_name": "value"}) |
company_id | string | Нет | ID компании для привязки при создании |
| Параметр | Тип | Описание |
|---|
contact | object | Созданный контакт |
↳ id | string | Уникальный ID контакта |
↳ type | string | Тип списка |
↳ role | string | Роль контакта (user или lead) |
↳ email | string | Email контакта |
↳ phone | string | Телефон контакта |
↳ name | string | Имя контакта |
↳ avatar | string | URL аватара контакта |
↳ owner_id | string | ID администратора контакта |
↳ external_id | string | Внешний ID контакта |
↳ created_at | number | Unix timestamp создания контакта |
↳ updated_at | number | Unix timestamp последнего обновления контакта |
↳ signed_up_at | number | Unix timestamp регистрации пользователя |
↳ last_seen_at | number | Unix timestamp последнего визита |
↳ workspace_id | string | ID рабочего пространства контакта |
↳ custom_attributes | object | Пользовательские атрибуты контакта |
↳ tags | object | Теги контакта |
↳ type | string | Тип списка |
↳ url | string | URL списка тегов |
↳ data | array | Объекты тегов |
↳ has_more | boolean | Есть ли ещё теги |
↳ total_count | number | Всего тегов |
↳ url | string | URL списка компаний |
↳ data | array | Объекты социальных профилей |
↳ has_more | boolean | Есть ли ещё компании |
↳ total_count | number | Всего компаний |
↳ notes | object | Заметки контакта |
↳ type | string | Тип списка |
↳ url | string | URL списка заметок |
↳ data | array | Объекты заметок |
↳ has_more | boolean | Есть ли ещё заметки |
↳ total_count | number | Всего заметок |
↳ companies | object | Компании контакта |
↳ type | string | Тип списка |
↳ url | string | URL списка компаний |
↳ data | array | Объекты компаний |
↳ has_more | boolean | Есть ли ещё компании |
↳ total_count | number | Всего компаний |
↳ location | object | Местоположение контакта |
↳ type | string | Тип местоположения |
↳ city | string | Город |
↳ region | string | Регион / штат |
↳ country | string | Страна |
↳ country_code | string | Код страны |
↳ continent_code | string | Код континента |
↳ city | string | Город |
↳ region | string | Регион / штат |
↳ country | string | Страна |
↳ country_code | string | Код страны |
↳ continent_code | string | Код континента |
↳ social_profiles | object | Социальные профили контакта |
↳ type | string | Тип списка |
↳ data | array | Объекты социальных профилей |
↳ unsubscribed_from_emails | boolean | Отписан ли контакт от писем |
contactId | string | ID созданного контакта |
Один контакт по ID. В ответе только поля, совпадающие с API.
| Параметр | Тип | Обязательный | Описание |
|---|
contactId | string | Да | ID контакта |
| Параметр | Тип | Описание |
|---|
contact | object | Объект контакта |
↳ id | string | Уникальный ID контакта |
↳ type | string | Тип объекта (contact) |
↳ role | string | Роль контакта (user или lead) |
↳ email | string | Email контакта |
↳ phone | string | Телефон контакта |
↳ name | string | Имя контакта |
↳ avatar | string | URL аватара контакта |
↳ owner_id | string | ID администратора контакта |
↳ external_id | string | Внешний ID контакта |
↳ created_at | number | Unix timestamp создания контакта |
↳ updated_at | number | Unix timestamp последнего обновления контакта |
↳ workspace_id | string | ID рабочего пространства контакта |
↳ custom_attributes | object | Пользовательские атрибуты контакта |
↳ tags | object | Теги контакта |
↳ notes | object | Заметки контакта |
↳ companies | object | Компании контакта |
↳ location | object | Местоположение контакта |
↳ social_profiles | object | Социальные профили контакта |
↳ unsubscribed_from_emails | boolean | Отписан ли контакт от писем |
Обновить контакт. В ответе только поля, совпадающие с API.
| Параметр | Тип | Обязательный | Описание |
|---|
contactId | string | Да | ID контакта |
role | string | Нет | Роль контакта: user или lead |
external_id | string | Нет | Внешний уникальный ID контакта |
email | string | Нет | Email контакта |
phone | string | Нет | Телефон контакта |
name | string | Нет | Имя контакта |
avatar | string | Нет | URL аватара контакта |
signed_up_at | number | Нет | Время регистрации — Unix timestamp |
last_seen_at | number | Нет | Время последнего визита — Unix timestamp |
owner_id | string | Нет | ID администратора — владельца контакта |
unsubscribed_from_emails | boolean | Нет | Отписан ли контакт от писем |
custom_attributes | string | Нет | Пользовательские атрибуты — JSON-объект (например {"attribute_name": "value"}) |
company_id | string | Нет | ID компании для привязки |
| Параметр | Тип | Описание |
|---|
contact | object | Обновлённый контакт |
↳ id | string | Уникальный ID контакта |
↳ type | string | Тип объекта (contact) |
↳ role | string | Роль контакта (user или lead) |
↳ email | string | Email контакта |
↳ phone | string | Телефон контакта |
↳ name | string | Имя контакта |
↳ avatar | string | URL аватара контакта |
↳ owner_id | string | ID администратора контакта |
↳ external_id | string | Внешний ID контакта |
↳ created_at | number | Unix timestamp создания контакта |
↳ updated_at | number | Unix timestamp последнего обновления контакта |
↳ workspace_id | string | ID рабочего пространства контакта |
↳ custom_attributes | object | Пользовательские атрибуты контакта |
↳ tags | object | Теги контакта |
↳ notes | object | Заметки контакта |
↳ companies | object | Компании контакта |
↳ location | object | Местоположение контакта |
↳ social_profiles | object | Социальные профили контакта |
↳ unsubscribed_from_emails | boolean | Отписан ли контакт от писем |
contactId | string | ID обновлённого контакта |
Список всех контактов Intercom с постраничным выводом
| Параметр | Тип | Обязательный | Описание |
|---|
per_page | number | Нет | Результатов на страницу (макс. 150) |
starting_after | string | Нет | Курсор постраничного вывода - ID, после которого начать |
| Параметр | Тип | Описание |
|---|
contacts | array | Объекты контактов |
↳ id | string | Уникальный ID контакта |
↳ type | string | Тип объекта (contact) |
↳ role | string | Роль контакта (user или lead) |
↳ email | string | Email контакта |
↳ phone | string | Телефон контакта |
↳ name | string | Имя контакта |
↳ external_id | string | Внешний ID контакта |
↳ created_at | number | Unix timestamp создания контакта |
↳ updated_at | number | Unix timestamp последнего обновления контакта |
↳ workspace_id | string | ID рабочего пространства контакта |
↳ custom_attributes | object | Пользовательские атрибуты контакта |
↳ tags | object | Теги контакта |
↳ companies | object | Компании контакта |
pages | object | Данные постраничного вывода |
↳ type | string | Тип объекта страниц |
↳ page | number | Номер текущей страницы |
↳ per_page | number | Результатов на страницу |
↳ total_pages | number | Всего страниц |
total_count | number | Всего контактов |
Найти контакты Intercom по запросу
| Параметр | Тип | Обязательный | Описание |
|---|
query | string | Да | Поисковый запрос (например {"field":"email","operator":"=","value":"user@example.com"}) |
per_page | number | Нет | Результатов на страницу (макс. 150) |
starting_after | string | Нет | Курсор постраничного вывода |
sort_field | string | Нет | Поле сортировки (например "name", "created_at", "last_seen_at") |
sort_order | string | Нет | Порядок сортировки: "ascending" или descending |
| Параметр | Тип | Описание |
|---|
contacts | array | Массив matching contact objects |
↳ id | string | Уникальный ID контакта |
↳ type | string | Тип объекта (contact) |
↳ role | string | Роль контакта (user или lead) |
↳ email | string | Email контакта |
↳ phone | string | Телефон контакта |
↳ name | string | Имя контакта |
↳ avatar | string | URL аватара контакта |
↳ owner_id | string | ID администратора контакта |
↳ external_id | string | Внешний ID контакта |
↳ created_at | number | Unix timestamp создания контакта |
↳ updated_at | number | Unix timestamp последнего обновления контакта |
↳ signed_up_at | number | Unix timestamp регистрации пользователя |
↳ last_seen_at | number | Unix timestamp последнего визита |
↳ workspace_id | string | ID рабочего пространства контакта |
↳ custom_attributes | object | Пользовательские атрибуты контакта |
↳ tags | object | Теги контакта |
↳ notes | object | Заметки контакта |
↳ companies | object | Компании контакта |
↳ location | object | Местоположение контакта |
↳ social_profiles | object | Социальные профили контакта |
↳ unsubscribed_from_emails | boolean | Отписан ли контакт от писем |
pages | object | Данные постраничного вывода |
↳ type | string | Тип объекта страниц |
↳ page | number | Номер текущей страницы |
↳ per_page | number | Результатов на страницу |
↳ total_pages | number | Всего страниц |
total_count | number | Всего matching contacts |
Удалить контакт Intercom по ID. В ответе только поля, совпадающие с API.
| Параметр | Тип | Обязательный | Описание |
|---|
contactId | string | Да | ID контакта для удаления |
| Параметр | Тип | Описание |
|---|
id | string | ID удалённого контакта |
deleted | boolean | Удалён ли контакт |
Создать или обновить компанию в Intercom
| Параметр | Тип | Обязательный | Описание |
|---|
company_id | string | Да | Your уникальный идентификатор компании |
name | string | Нет | Название компании |
website | string | Нет | Сайт компании |
plan | string | Нет | Название тарифа компании |
size | number | Нет | Число сотрудников |
industry | string | Нет | Отрасль компании |
monthly_spend | number | Нет | Выручка компании. Дробная часть отбрасывается (155.98 → 155) |
custom_attributes | string | Нет | Пользовательские атрибуты — JSON-объект |
remote_created_at | number | Нет | Время, когда вы создали компанию — Unix timestamp |
| Параметр | Тип | Описание |
|---|
company | object | Созданная или обновлённая компания |
↳ id | string | Уникальный идентификатор компании |
↳ type | string | Тип списка сегментов |
↳ app_id | string | ID приложения Intercom |
↳ company_id | string | Your уникальный идентификатор компании |
↳ name | string | Название компании |
↳ website | string | URL сайта компании |
↳ plan | object | Данные тарифа компании |
↳ size | number | Число employees |
↳ industry | string | Отрасль компании |
↳ monthly_spend | number | Месячная выручка компании |
↳ session_count | number | Число sessions |
↳ user_count | number | Число пользователей в компании |
↳ created_at | number | Unix timestamp создания компании |
↳ updated_at | number | Unix timestamp последнего обновления компании |
↳ remote_created_at | number | Unix timestamp, когда вы создали компанию |
↳ custom_attributes | object | Пользовательские атрибуты company |
↳ tags | array | Объекты тегов |
↳ segments | array | Массив segment objects |
companyId | string | ID созданной или обновлённой компании |
Компания Intercom по ID
| Параметр | Тип | Обязательный | Описание |
|---|
companyId | string | Да | ID компании |
| Параметр | Тип | Описание |
|---|
company | object | Объект компании |
↳ id | string | Уникальный идентификатор компании |
↳ type | string | Тип объекта (company) |
↳ app_id | string | ID приложения Intercom |
↳ company_id | string | Your уникальный идентификатор компании |
↳ name | string | Название компании |
↳ website | string | URL сайта компании |
↳ plan | object | Данные тарифа компании |
↳ size | number | Число employees |
↳ industry | string | Отрасль компании |
↳ monthly_spend | number | Месячная выручка компании |
↳ session_count | number | Число sessions |
↳ user_count | number | Число пользователей в компании |
↳ created_at | number | Unix timestamp создания компании |
↳ updated_at | number | Unix timestamp последнего обновления компании |
↳ custom_attributes | object | Пользовательские атрибуты company |
↳ tags | object | Теги company |
↳ segments | object | Сегменты компании |
Список компаний Intercom с постраничным выводом. Лимит — 10 000 компаний. Если больше — используйте Scroll API.
| Параметр | Тип | Обязательный | Описание |
|---|
per_page | number | Нет | Результатов на страницу |
page | number | Нет | Номер страницы |
starting_after | string | Нет | Курсор постраничного вывода (предпочтительнее нумерации страниц) |
| Параметр | Тип | Описание |
|---|
companies | array | Объекты компаний |
↳ id | string | Уникальный идентификатор компании |
↳ type | string | Тип объекта (company) |
↳ app_id | string | ID приложения Intercom |
↳ company_id | string | Your уникальный идентификатор компании |
↳ name | string | Название компании |
↳ website | string | URL сайта компании |
↳ plan | object | Данные тарифа компании |
↳ monthly_spend | number | Месячная выручка компании |
↳ session_count | number | Число sessions |
↳ user_count | number | Число пользователей в компании |
↳ created_at | number | Unix timestamp создания компании |
↳ updated_at | number | Unix timestamp последнего обновления компании |
↳ custom_attributes | object | Пользовательские атрибуты company |
↳ tags | object | Теги company |
↳ segments | object | Сегменты компании |
pages | object | Данные постраничного вывода |
↳ type | string | Тип объекта страниц |
↳ page | number | Номер текущей страницы |
↳ per_page | number | Результатов на страницу |
↳ total_pages | number | Всего страниц |
total_count | number | Всего компаний |
success | boolean | Успешность операции |
Диалог Intercom по ID
| Параметр | Тип | Обязательный | Описание |
|---|
conversationId | string | Да | ID диалога |
display_as | string | Нет | plaintext — получить сообщения обычным текстом |
include_translations | boolean | Нет | true — части диалога переводятся на определённый язык диалога |
| Параметр | Тип | Описание |
|---|
conversation | object | Объект диалога |
↳ id | string | Уникальный идентификатор диалога |
↳ type | string | Тип объекта (conversation) |
↳ title | string | Заголовок диалога |
↳ created_at | number | Unix timestamp создания диалога |
↳ updated_at | number | Unix timestamp последнего обновления диалога |
↳ waiting_since | number | Unix timestamp ожидания ответа |
↳ snoozed_until | number | Unix timestamp конца отложения |
↳ open | boolean | Открыт ли диалог |
↳ state | string | Состояние диалога |
↳ read | boolean | Прочитан ли диалог |
↳ priority | string | Приоритет диалога |
↳ admin_assignee_id | number | ID назначенного администратора |
↳ team_assignee_id | string | ID назначенной команды |
↳ tags | object | Теги диалога |
↳ source | object | Источник диалога |
↳ contacts | object | Контакты в диалоге |
↳ teammates | object | Участники диалога |
↳ conversation_parts | object | Части диалога |
↳ statistics | object | Статистика диалога |
success | boolean | Успешность операции |
Список диалогов Intercom с постраничным выводом
| Параметр | Тип | Обязательный | Описание |
|---|
per_page | number | Нет | Результатов на страницу (макс. 150) |
starting_after | string | Нет | Курсор постраничного вывода |
sort | string | Нет | Поле сортировки (например "waiting_since", "updated_at", "created_at") |
order | string | Нет | Порядок сортировки: asc (по возрастанию) или desc (по убыванию) |
| Параметр | Тип | Описание |
|---|
conversations | array | Массив объектов диалогов |
↳ id | string | Уникальный идентификатор диалога |
↳ type | string | Тип объекта (conversation) |
↳ title | string | Заголовок диалога |
↳ created_at | number | Unix timestamp создания диалога |
↳ updated_at | number | Unix timestamp последнего обновления диалога |
↳ waiting_since | number | Unix timestamp ожидания ответа |
↳ open | boolean | Открыт ли диалог |
↳ state | string | Состояние диалога |
↳ read | boolean | Прочитан ли диалог |
↳ priority | string | Приоритет диалога |
↳ admin_assignee_id | number | ID назначенного администратора |
↳ team_assignee_id | string | ID назначенной команды |
↳ tags | object | Теги диалога |
↳ source | object | Источник диалога |
↳ contacts | object | Контакты в диалоге |
pages | object | Данные постраничного вывода |
↳ type | string | Тип объекта страниц |
↳ page | number | Номер текущей страницы |
↳ per_page | number | Результатов на страницу |
↳ total_pages | number | Всего страниц |
total_count | number | Всего диалогов |
success | boolean | Успешность операции |
Ответить в диалог от имени администратора Intercom
| Параметр | Тип | Обязательный | Описание |
|---|
conversationId | string | Да | ID диалога для ответа |
message_type | string | Да | Тип сообщения: comment или note |
body | string | Да | Текст ответа |
admin_id | string | Нет | ID администратора, который пишет ответ. Если не задано — администратор по умолчанию (Operator/Fin) |
attachment_urls | string | Нет | URL изображений через запятую (не больше 10) |
created_at | number | Нет | Unix timestamp создания ответа. Если не задано — текущее время. |
| Параметр | Тип | Описание |
|---|
conversation | object | Обновлённый диалог |
↳ id | string | Уникальный идентификатор диалога |
↳ type | string | Тип объекта (conversation) |
↳ title | string | Заголовок диалога |
↳ created_at | number | Unix timestamp создания диалога |
↳ updated_at | number | Unix timestamp последнего обновления диалога |
↳ waiting_since | number | Unix timestamp ожидания ответа |
↳ open | boolean | Открыт ли диалог |
↳ state | string | Состояние диалога |
↳ read | boolean | Прочитан ли диалог |
↳ priority | string | Приоритет диалога |
↳ admin_assignee_id | number | ID назначенного администратора |
↳ team_assignee_id | string | ID назначенной команды |
↳ tags | object | Теги диалога |
↳ source | object | Источник диалога |
↳ contacts | object | Контакты в диалоге |
↳ conversation_parts | object | Части диалога |
conversationId | string | ID диалог |
success | boolean | Успешность операции |
Найти диалоги Intercom по запросу. В ответе только поля, совпадающие с API.
| Параметр | Тип | Обязательный | Описание |
|---|
query | string | Да | Поисковый запрос как JSON-объект |
per_page | number | Нет | Результатов на страницу (макс. 150) |
starting_after | string | Нет | Курсор постраничного вывода |
sort_field | string | Нет | Поле сортировки (например "created_at", "updated_at") |
sort_order | string | Нет | Порядок сортировки: "ascending" или descending |
| Параметр | Тип | Описание |
|---|
conversations | array | Массив подходящих диалогов |
↳ id | string | Уникальный идентификатор диалога |
↳ type | string | Тип объекта (conversation) |
↳ title | string | Заголовок диалога |
↳ created_at | number | Unix timestamp создания диалога |
↳ updated_at | number | Unix timestamp последнего обновления диалога |
↳ waiting_since | number | Unix timestamp ожидания ответа |
↳ open | boolean | Открыт ли диалог |
↳ state | string | Состояние диалога |
↳ read | boolean | Прочитан ли диалог |
↳ priority | string | Приоритет диалога |
↳ admin_assignee_id | number | ID назначенного администратора |
↳ team_assignee_id | string | ID назначенной команды |
↳ tags | object | Теги диалога |
↳ source | object | Источник диалога |
↳ contacts | object | Контакты в диалоге |
pages | object | Данные постраничного вывода |
↳ type | string | Тип объекта страниц |
↳ page | number | Номер текущей страницы |
↳ per_page | number | Результатов на страницу |
↳ total_pages | number | Всего страниц |
total_count | number | Всего matching conversations |
success | boolean | Успешность операции |
Создать тикет в Intercom. В ответе только поля, совпадающие с API.
| Параметр | Тип | Обязательный | Описание |
|---|
ticket_type_id | string | Да | ID типа тикета |
contacts | string | Да | JSON-массив идентификаторов контактов (например [{"id": "contact_id"}]) |
ticket_attributes | string | Да | JSON-объект атрибутов тикета, включая default_title и default_description |
company_id | string | Нет | ID компании для привязки тикета |
created_at | number | Нет | Unix timestamp создания тикета. Если не задано — текущее время. |
conversation_to_link_id | string | Нет | ID существующего диалога для привязки к тикету |
disable_notifications | boolean | Нет | true — не слать уведомления при создании тикета |
| Параметр | Тип | Описание |
|---|
ticket | object | Созданный тикет |
↳ id | string | Уникальный идентификатор тикета |
↳ type | string | Тип объекта (ticket) |
↳ ticket_id | string | ID тикета |
↳ ticket_type | object | Тип тикета |
↳ ticket_attributes | object | Атрибуты тикета |
↳ ticket_state | string | Состояние тикета |
↳ ticket_state_internal_label | string | Внутренняя метка состояния тикета |
↳ ticket_state_external_label | string | Внешняя метка состояния тикета |
↳ created_at | number | Unix timestamp создания тикета |
↳ updated_at | number | Unix timestamp последнего обновления тикета |
↳ contacts | object | Контакты тикета |
↳ admin_assignee_id | string | ID назначенного администратора |
↳ team_assignee_id | string | ID назначенной команды |
↳ is_shared | boolean | Общий ли тикет |
↳ open | boolean | Открыт ли тикет |
ticketId | string | ID тикет |
success | boolean | Успешность операции |
Тикет Intercom по ID. В ответе только поля, совпадающие с API.
| Параметр | Тип | Обязательный | Описание |
|---|
ticketId | string | Да | ID тикета |
| Параметр | Тип | Описание |
|---|
ticket | object | Объект тикета |
↳ id | string | Уникальный идентификатор тикета |
↳ type | string | Тип объекта (ticket) |
↳ ticket_id | string | ID тикета |
↳ ticket_type | object | Тип тикета |
↳ ticket_attributes | object | Атрибуты тикета |
↳ ticket_state | string | Состояние тикета |
↳ ticket_state_internal_label | string | Внутренняя метка состояния тикета |
↳ ticket_state_external_label | string | Внешняя метка состояния тикета |
↳ created_at | number | Unix timestamp создания тикета |
↳ updated_at | number | Unix timestamp последнего обновления тикета |
↳ contacts | object | Контакты тикета |
↳ admin_assignee_id | string | ID назначенного администратора |
↳ team_assignee_id | string | ID назначенной команды |
↳ is_shared | boolean | Общий ли тикет |
↳ open | boolean | Открыт ли тикет |
ticketId | string | ID тикет |
success | boolean | Успешность операции |
Создать и отправить сообщение от имени администратора Intercom. В ответе только поля, совпадающие с API.
| Параметр | Тип | Обязательный | Описание |
|---|
message_type | string | Да | Тип сообщения: inapp — в приложении, email — письмо |
template | string | Да | Стиль шаблона: plain — обычный текст, personal — персональный |
subject | string | Нет | Тема письма (для типа email) |
body | string | Да | Тело сообщения |
from_type | string | Да | Тип отправителя: admin |
from_id | string | Да | ID администратора-отправителя |
to_type | string | Да | Тип получателя: contact |
to_id | string | Да | ID контакта-получателя |
created_at | number | Нет | Unix timestamp создания сообщения. Если не задано — текущее время. |
| Параметр | Тип | Описание |
|---|
message | object | Созданное сообщение |
↳ id | string | Уникальный идентификатор сообщения |
↳ type | string | Тип объекта (message) |
↳ created_at | number | Unix timestamp создания сообщения |
↳ body | string | Тело сообщения |
↳ message_type | string | Тип сообщения (in_app или email) |
↳ conversation_id | string | ID диалог |
↳ owner | object | Владелец сообщения |
messageId | string | ID сообщение |
success | boolean | Успешность операции |