Работа с чатами

Работа с чатами через API Radist.Online: получение ключа, источники WhatsApp, Telegram, MAX, подписка на вебхуки, создание чата и отправка сообщений клиенту.

1. Получаем API ключ

Для этого переходим в личном кабинете в раздел Интеграции. Создаём интеграцию с типом API, указываем, к каким разделам интеграция имеет доступ (нужны как минимум “Сообщения” и “Вебхуки”) и сохраняем ключ.

2. Проверяем, какие источники чатов есть в компании

Это можно сделать, отправив запрос MessagingGetChatsSources (GET /companies/{company_id}/messaging/chats/sources/)

На данный момент доступны типы источников: whatsapp, waba, telegram, telegram_bot, max_personal, max_bot, vk_group, vk_direct, avito.

Пример ответа:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62

[
  {
    "connection_id": 123,
    "name": "Номер 1",
    "type": "whatsapp",
    "create_chat": {
      "with_phone": true,
      "with_username": false,
      "with_chat_id": false
    },
    "subscription": {
      "id": 1,
      "paid_until": "2025-03-17T13:35:35.728Z",
      "subscription_plan": "STANDARD"
    }
  },
  {
    "connection_id": 456,
    "name": "Продажи",
    "type": "waba",
    "create_chat": {
      "with_phone": true,
      "with_username": false,
      "with_chat_id": false
    },
    "subscription": {
      "id": 2,
      "paid_until": "2025-03-17T13:35:35.728Z",
      "subscription_plan": "STANDARD"
    }
  },
  {
    "connection_id": 789,
    "name": "test telegram",
    "type": "telegram",
    "create_chat": {
      "with_phone": true,
      "with_username": true,
      "with_chat_id": true
    },
    "subscription": {
      "id": 3,
      "paid_until": "2025-03-17T13:35:35.728Z",
      "subscription_plan": "ADVANCED"
    }
  },
  {
    "connection_id": 1001,
    "name": "tg bot",
    "type": "telegram_bot",
    "create_chat": {
      "with_phone": false,
      "with_username": false,
      "with_chat_id": false
    },
    "subscription": {
      "id": 11,
      "paid_until": "3000-03-17T13:35:35.728Z",
      "subscription_plan": "FREE"
    }
  }
]

В ответе указывается id подключения, его название, тип, а также флаги create_chat, показывающие, каким идентификатором эти источники могут создавать чаты. Например, подключения waba, whatsapp могут создавать чаты только с использованием номера телефона. Подключения telegram — по телефону, имени пользователя или идентификатору чата в мессенджере, max_personal — по телефону или идентификатору чата, vk_direct — по телефону или имени пользователя. telegram_bot, max_bot, vk_group, avito не могут создавать чаты: с ними диалог начинает клиент.

3. Подписываемся на вебхуки

Для того, чтобы получать уведомления, когда приходят новые сообщения или отправленные сообщения доставлены/прочитаны, необходимо подписаться на вебхуки. Как это сделать описано здесь.

4. Создаём чат

Если вы хотите написать клиенту, переписки с которым ещё не было, необходимо сначала создать с ним чат. Как это сделать описано здесь.

5. Отправляем сообщения

Как это сделать описано здесь.

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

С чего начать работу с API, если нужен обмен сообщениями?

С пяти шагов, которые разобраны на этой странице: получить API-ключ, посмотреть доступные источники чатов, подписаться на вебхуки, создать чат и отправить сообщение. Этого набора хватает, чтобы собрать рабочую интеграцию.

Зачем подписываться на вебхуки?

Чтобы получать входящие сообщения и события, а не опрашивать API в цикле. Опрос упирается в лимит 5 запросов в секунду и быстро приводит к ответам 429.

Какие права нужны ключу, чтобы отправлять сообщения?

messaging для чатов и сообщений и webhooks для подписки на события.