Перейти к основному содержимому

ChannelSafeRead

Канал — это подключённый аккаунт для обмена сообщениями (номер/аккаунт у провайдера, такого как Wazzup24, GreenAPI, Wappi, ChatPush и т. п.), через который платформа отправляет и принимает сообщения. ChannelSafeRead — форма, возвращаемая API; она не содержит учётных данных провайдера.

idIdrequired

Уникальный числовой идентификатор записи.

created_atdate-timerequired

Время создания (UTC, ISO 8601).

nameNamerequired

Человекочитаемое название канала.

numberNumberrequired

Номер телефона или идентификатор аккаунта канала.

config objectrequired

Конфигурация уровня канала (JSON).

alias object

Необязательное значение канала для CRM, используемое для точного сопоставления импортируемых контактов типа chat_id с этим каналом.

anyOf
string
accept_comment_hooksAccept Comment Hooks
Default value: true
fetch_only_unreadFetch Only Unread
Default value: true
last_seen_msg_id object
anyOf
string
radist_webhook_connection_ids object

Служебный реестр подключений Radist.online, для которых уже зарегистрирован входящий вебхук этого канала (id подключения → id вебхука Radist). Заполняется автоматически при резолве чата; не редактируйте его и сохраняйте полученное значение при обновлении config.

property name*string
spam_block objectrequired

Последнее состояние проверки канала через Telegram SpamBot, если канал поддерживает такую проверку.

statusStatus

Текущий статус проверки спамблока.

Possible values: [unknown, ongoing_check, not_limited, limited, parse_failed, send_failed]

Default value: unknown
limited_until object

Время снятия ограничения аккаунта по ответу SpamBot, если его удалось распознать.

anyOf
date-time
check_started_at object

Когда была запущена последняя проверка.

anyOf
date-time
last_response_at object

Время последнего ответа SpamBot по этому каналу.

anyOf
date-time
last_response_text object

Сырой текст последнего ответа SpamBot для диагностики оператором.

anyOf
string
last_error object

Последняя ошибка отправки или разбора ответа, если проверка завершилась неуспешно.

anyOf
string
request_message_id object

Внешний Wappi id сообщения последнего запроса /start, если доступен.

anyOf
string
request_task_id object

Внешний Wappi task id последнего запроса /start, если доступен.

anyOf
string
source object

Источник последней проверки — ручное действие пользователя или плановая автоматизация.

anyOf
string

Possible values: [manual, scheduled]

requested_by_user_id object

ID пользователя, вручную запустившего последнюю проверку, если есть.

anyOf
integer
channel_typeChannel Typerequired

Мессенджер (например, whatsapp, telegram, waba, instagram, email, sms).

Possible values: [telegram, whatsapp, waba, max, viber, instagram, fasttrack, usedesk, salebot, avito, vk, yandex_messenger, email, sms, pinbox, linkedin, amocrm_salesbot, bitrix24_openlines, sip, webrtc, bothelp]

vendorVendorrequired

Провайдер/шлюз, обеспечивающий работу канала (например, wazzup24, greenapi, wappi, chatpush, self_wz).

Possible values: [wazzup24, self_wz, chatpush, greenapi, wappi, chatapp, yandex_messenger, salebot, bothelp, radist, fasttrack, usedesk, amocrm_salesbot, bitrix24_openlines, twilio, mail.ru, gmail, pinbox, unipile, voice]

is_session_activeIs Session Activerequired

Подключена/авторизована ли внешняя сессия провайдера.

is_activeIs Activerequired

Включён ли канал для использования платформой.

is_archivedIs Archivedrequired

Заархивирован ли канал.

crm_integration_id objectrequired
anyOf
integer
deactivated_until objectrequired

Если задано, канал приостановлен до этого момента (UTC).

anyOf
date-time
outreach_daily_limitOutreach Daily Limitrequired

Максимум сообщений холодной рассылки через этот канал в сутки.

skip_outreach_until objectrequired

Если задано, холодная рассылка через этот канал приостановлена до этого момента (UTC).

anyOf
date-time
add_outreach_interval_secondsAdd Outreach Interval Secondsrequired

Минимальный интервал между отправками холодной рассылки в этом канале.

sub_outreach_daily_limitSub Outreach Daily Limitrequired

Максимум сообщений sub-outreach (в существующие чаты) в сутки — обычно выше, чем для холодной рассылки.

skip_sub_outreach_until objectrequired

Если задано, sub-outreach через этот канал приостановлен до этого момента (UTC).

anyOf
date-time
add_sub_outreach_interval_secondsAdd Sub Outreach Interval Secondsrequired

Минимальный интервал между отправками sub-outreach в этом канале.

is_testIs Test

Является ли канал тестовым.

Default value: false
webhook_uuid object

Непрозрачный идентификатор для построения URL входящего вебхука канала.

anyOf
string
webhook_url objectrequired

URL входящего вебхука, который провайдер должен вызывать для этого канала (формируется из vendor + webhook_uuid).

anyOf
string
ChannelSafeRead
{
  "id": 0,
  "created_at": "2024-07-29T15:51:28.071Z",
  "name": "string",
  "number": "string",
  "config": {
    "alias": "string",
    "accept_comment_hooks": true,
    "fetch_only_unread": true,
    "last_seen_msg_id": "string",
    "radist_webhook_connection_ids": {}
  },
  "spam_block": {
    "status": "unknown",
    "limited_until": "2024-07-29T15:51:28.071Z",
    "check_started_at": "2024-07-29T15:51:28.071Z",
    "last_response_at": "2024-07-29T15:51:28.071Z",
    "last_response_text": "string",
    "last_error": "string",
    "request_message_id": "string",
    "request_task_id": "string",
    "source": "manual",
    "requested_by_user_id": 0
  },
  "channel_type": "telegram",
  "vendor": "wazzup24",
  "is_session_active": true,
  "is_active": true,
  "is_archived": true,
  "crm_integration_id": 0,
  "deactivated_until": "2024-07-29T15:51:28.071Z",
  "outreach_daily_limit": 0,
  "skip_outreach_until": "2024-07-29T15:51:28.071Z",
  "add_outreach_interval_seconds": 0,
  "sub_outreach_daily_limit": 0,
  "skip_sub_outreach_until": "2024-07-29T15:51:28.071Z",
  "add_sub_outreach_interval_seconds": 0,
  "is_test": false,
  "webhook_uuid": "string",
  "webhook_url": "string"
}