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

ChannelCreate

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

nameNamerequired

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

numberNumberrequired

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

credentials objectrequired

Учётные данные провайдера для аутентификации канала (проверяются для каждого vendor отдельно).

wazzup24 object
anyOf
api_keyApi Keyrequired
channel_idChannel Idrequired

Идентификатор канала, к которому относится запись.

chatpush object
anyOf
api_keyApi Keyrequired
channel_idChannel Idrequired

Идентификатор канала, к которому относится запись.

self_wz object
anyOf
all_creds object
anyOf
creds objectrequired
property name*any
keys objectrequired
property name*any
qrQrrequired
greenapi object
anyOf
api_keyApi Keyrequired
channel_idChannel Idrequired

Идентификатор канала, к которому относится запись.

wappi object
anyOf
channel_idChannel Idrequired

Идентификатор профиля Wappi, используемый для исходящих API-вызовов и сопоставления входящих вебхуков.

api_key object

Необязательный токен Wappi для конкретного канала. Если поле пустое, используется глобальный токен Wappi из конфигурации сервера.

anyOf
string
is_max_botIs Max Bot

Включите это поле для bot-профилей MAX в Wappi, чтобы MAX-запросы шли через bot API, а не через API личного MAX-аккаунта.

Default value: false
yandex_messenger object
anyOf
api_keyApi Keyrequired
channel_id object

Идентификатор канала, к которому относится запись.

anyOf
string
salebot object
anyOf
channel_idChannel Idrequired

Идентификатор канала, к которому относится запись.

api_keyApi Keyrequired
group_idsstring[]required
bothelp object
anyOf
channel_id object

Идентификатор канала, к которому относится запись.

anyOf
string
client_idClient Idrequired
client_secretClient Secretrequired
access_token object
anyOf
string
access_token_expires_at object
anyOf
date-time
radist object

Учётные данные канала Radist.online (vendor "radist"). Обязательны при создании такого канала.

anyOf
api_keyApi Keyrequired

API-токен Radist.online (передаётся в заголовке X-Api-Key).

company_idCompany Idrequired

Идентификатор компании в Radist.online — целое число, присутствует в каждом URL Radist API.

chatapp object
anyOf
channel_id object

Идентификатор канала, к которому относится запись.

anyOf
string
license_idLicense Idrequired
messenger_typeMessenger Typerequired
app_idApp Idrequired
emailEmailrequired
passwordPasswordrequired
access_token object
anyOf
string
access_token_expires_at object
anyOf
date-time
refresh_token object
anyOf
string
refresh_token_expires_at object
anyOf
date-time
fasttrack object
anyOf
channel_idChannel Idrequired

Идентификатор канала, к которому относится запись.

usedesk object
anyOf
channel_idChannel Idrequired

Идентификатор канала, к которому относится запись.

email object
anyOf
passwordPasswordrequired
usernameUsernamerequired
twilio object
anyOf
api_keyApi Keyrequired
channel_idChannel Idrequired

Идентификатор канала, к которому относится запись.

phone_number_sid object
anyOf
string
account_sidAccount Sidrequired
pinbox object
anyOf
api_tokenApi Tokenrequired
channel_idChannel Idrequired

Идентификатор канала, к которому относится запись.

unipile object
anyOf
channel_idChannel Idrequired

Идентификатор канала, к которому относится запись.

api_keyApi Keyrequired
dsnDsnrequired
amocrm_salesbot object
anyOf
channel_idChannel Idrequired

Идентификатор канала, к которому относится запись.

bitrix24_openlines object

Данные маршрутизации для управляемого backend-ом канала Открытых линий Bitrix24. Обычно клиентам не нужно создавать такой канал вручную.

anyOf
channel_idChannel Idrequired

Идентификатор CRM-интеграции Bitrix24, которой принадлежит этот синтетический канал.

config object

Конфигурация уровня канала (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
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 Active

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

Default value: true
is_activeIs Active

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

Default value: true
is_archivedIs Archived

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

Default value: false
crm_integration_id object
anyOf
integer
deactivated_until object

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

anyOf
date-time
outreach_daily_limitOutreach Daily Limit

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

Default value: 7
skip_outreach_until object

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

anyOf
date-time
sub_outreach_daily_limitSub Outreach Daily Limit

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

Default value: 1000
skip_sub_outreach_until object

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

anyOf
date-time
add_outreach_interval_secondsAdd Outreach Interval Seconds

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

Default value: 300
add_sub_outreach_interval_secondsAdd Sub Outreach Interval Seconds

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

Default value: 20
is_testIs Test

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

Default value: false
webhook_uuid object

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

anyOf
string
company_idCompany Idrequired

Компания-владелец канала. По этому значению backend создаёт связь company-channel.

ChannelCreate
{
  "name": "string",
  "number": "string",
  "credentials": {
    "wazzup24": {
      "api_key": "string",
      "channel_id": "string"
    },
    "chatpush": {
      "api_key": "string",
      "channel_id": "string"
    },
    "self_wz": {
      "all_creds": {
        "creds": {},
        "keys": {}
      },
      "qr": "string"
    },
    "greenapi": {
      "api_key": "string",
      "channel_id": "string"
    },
    "wappi": {
      "channel_id": "string",
      "api_key": "string",
      "is_max_bot": false
    },
    "yandex_messenger": {
      "api_key": "string",
      "channel_id": "string"
    },
    "salebot": {
      "channel_id": "string",
      "api_key": "string",
      "group_ids": [
        "string"
      ]
    },
    "bothelp": {
      "channel_id": "string",
      "client_id": "string",
      "client_secret": "string",
      "access_token": "string",
      "access_token_expires_at": "2024-07-29T15:51:28.071Z"
    },
    "radist": {
      "api_key": "string",
      "company_id": 0
    },
    "chatapp": {
      "channel_id": "string",
      "license_id": 0,
      "messenger_type": "string",
      "app_id": "string",
      "email": "string",
      "password": "string",
      "access_token": "string",
      "access_token_expires_at": "2024-07-29T15:51:28.071Z",
      "refresh_token": "string",
      "refresh_token_expires_at": "2024-07-29T15:51:28.071Z"
    },
    "fasttrack": {
      "channel_id": "string"
    },
    "usedesk": {
      "channel_id": "string"
    },
    "email": {
      "password": "string",
      "username": "string"
    },
    "twilio": {
      "api_key": "string",
      "channel_id": "string",
      "phone_number_sid": "string",
      "account_sid": "string"
    },
    "pinbox": {
      "api_token": "string",
      "channel_id": "string"
    },
    "unipile": {
      "channel_id": "string",
      "api_key": "string",
      "dsn": "string"
    },
    "amocrm_salesbot": {
      "channel_id": "string"
    },
    "bitrix24_openlines": {
      "channel_id": "string"
    }
  },
  "config": {
    "alias": "string",
    "accept_comment_hooks": true,
    "fetch_only_unread": true,
    "last_seen_msg_id": "string",
    "radist_webhook_connection_ids": {}
  },
  "channel_type": "telegram",
  "vendor": "wazzup24",
  "is_session_active": true,
  "is_active": true,
  "is_archived": false,
  "crm_integration_id": 0,
  "deactivated_until": "2024-07-29T15:51:28.071Z",
  "outreach_daily_limit": 7,
  "skip_outreach_until": "2024-07-29T15:51:28.071Z",
  "sub_outreach_daily_limit": 1000,
  "skip_sub_outreach_until": "2024-07-29T15:51:28.071Z",
  "add_outreach_interval_seconds": 300,
  "add_sub_outreach_interval_seconds": 20,
  "is_test": false,
  "webhook_uuid": "string",
  "company_id": 0
}