Интеграции (API v2)

Интеграции в API Radist.Online: создание и настройка соединений мессенджеров с amoCRM и Битрикс24, примеры изменения параметров whatsapp_amocrm и waba_bitrix.

Общее

Swagger: https://api.radist.online/v2/docs#/Integrations

Необходимые права доступа (scopes) для работы с API: integrations

Интеграция/integration - сущность, содержащая параметры для соединения одного внешнего сервиса с другим (tinkoff+amoCRM, whatsapp+bitrix24, …)

Замечания

• Создание доступно только для интеграций с типом API и Яндекс.Метрика. Другие интеграции создаются при установке в CRM-системе.
• Удаление доступно только для интеграций с типом API и Яндекс.Метрика. Для удаления других интеграций обратитесь в поддержку.

Примеры

Изменение настроек интеграции amoCRM+чаты на примере whatsapp_amocrm:

Метод для изменения настроек: IntegrationsUpdateIntegration

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15

{
  "name": "radist test", -- название можно изменить
  "status": "enabled", -- disabled, чтобы отключить интеграцию
  "type": "whatsapp_amocrm", -- тип должен совпадать с тем, что уже есть
  "whatsapp_amocrm": [  -- список с настройками подключений
    {
      "id": 15934, -- id подключения (в данном случае whatsapp)
      "pipeline_id": 5653852,  -- id воронки, в которой будут создаваться сделки
      "status_id": 49782925,  -- id статуса, в котором будут создаваться сделки
      "responsible_user_id": 11234567  -- id пользователя amoCRM, ответственного за созданные сделку и контакт
    }
  ],
  "write_first_conn": 15934,  -- номер по умолчанию (боты будут начинать чат с него)
  "check_phones_enabled": false  -- включить/выключить индикатор наличия WhatsApp'а в  интерфейсе CRM
}

Чтобы убрать подключение из интеграции, достаточно не передавать его в списке подключений. Чтобы убрать все подключения из интеграции, нужно передать пустой список.

Если не передавать pipeline_id/status_id, то сделки будут создваться в неразобранном. Список воронок можно получить тут: AmoCRMGetAmoPipelinesFromIntegration. Архивные воронки попадают в него, только если передать with_archive=true: к архивной воронке amoCRM подключение не привяжет.

Параметр responsible_user_id — пользователь amoCRM, которого назначат ответственным за сделку и контакт, созданные по входящему сообщению. От воронки не зависит: его можно указать и для подключения без pipeline_id/status_id. Если не передавать его, ответственный назначаться не будет. Список пользователей аккаунта можно получить тут: AmoCRMGetAmoUsersFromIntegration. Если указанного пользователя нет в аккаунте, метод вернёт ошибку 13007 (INTEGRATION_AMOCRM_RESPONSIBLE_USER_NOT_FOUND).

Параметр поддерживают интеграции мессенджеров с amoCRM: waba_amocrm, whatsapp_amocrm, retie_whatsappchatapi_amocrm, telegram_amocrm, telegram_bot_amocrm, odnoklassniki_amocrm, max_personal_amocrm, vk_amocrm, avito_amocrm.

Если amoCRM отклонил изменение, метод возвращает 400 с одной из ошибок:

• 10006 (CONNECTION_AMOCRM_ACCESS_DENIED) — нет доступа к аккаунту amoCRM;
• 10013 (CONNECTION_AMOCRM_NOT_PAID) — аккаунт amoCRM не оплачен;
• 10014 (CONNECTION_AMOCRM_PIPELINE_NOT_EXISTS) — воронки нет в amoCRM;
• 10021 (CONNECTION_AMOCRM_PIPELINE_ARCHIVED) — воронка в amoCRM перенесена в архив.

Изменение настроек интеграции Битрикс24+чаты на примере waba_bitrix

Метод для изменения настроек: IntegrationsUpdateIntegration

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

{
  "name": "integration name",
  "status": "enabled",
  "type": "waba_bitrix",
  "waba_bitrix": [
    {
      "id": 16549,  -- id подключения (в данном случае waba)
      "open_line_id": 1  -- id открытой линии
    }
  ]
}

Список открытых линий можно получить тут: BitrixGetBitrixListOfOpenLinesFromIntegration

Одно подключение можно привязать только к одной открытой линии: если указать его в списке дважды, метод вернёт 422 с ошибкой 1 (REQUEST_VALIDATION_ERROR).

Частые вопросы

Что можно сделать с интеграциями через API?

Посмотреть список интеграций компании и менять их настройки. Нужен scope integrations.

Как изменить настройки интеграции с amoCRM или Битрикс24?

Через метод изменения настроек интеграции — примеры для обеих CRM разобраны выше на этой странице, на связках whatsapp_amocrm и waba_bitrix.

Можно ли через API подключить новую интеграцию с CRM?

Раздел отвечает за список и настройки уже существующих интеграций. Само подключение CRM оформляется в личном кабинете, а API дальше управляет её параметрами.