Skip to main content

ChannelCreate

A channel is a connected messaging account (a number/account on a provider such as Wazzup24, GreenAPI, Wappi, ChatPush, etc.) through which the platform sends and receives messages. ChannelSafeRead is the form returned by the API; it omits the provider credentials.

nameNamerequired

Human-readable channel name.

numberNumberrequired

The channel's phone number or account identifier.

credentials objectrequired

Provider-specific authentication credentials for the channel (validated per vendor).

wazzup24 object
anyOf
api_keyApi Keyrequired
channel_idChannel Idrequired

ID of the messaging channel this record relates to.

chatpush object
anyOf
api_keyApi Keyrequired
channel_idChannel Idrequired

ID of the messaging channel this record relates to.

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

ID of the messaging channel this record relates to.

wappi object
anyOf
channel_idChannel Idrequired

The Wappi profile identifier used for outbound API calls and inbound webhook matching.

api_key object

Optional per-channel Wappi API token override. When omitted, the global Wappi token from server config is used.

anyOf
string
is_max_botIs Max Bot

Set to true for Wappi MAX bot profiles so the connector routes MAX requests to the bot API surface instead of the personal-MAX one.

Default value: false
yandex_messenger object
anyOf
api_keyApi Keyrequired
channel_id object

ID of the messaging channel this record relates to.

anyOf
string
salebot object
anyOf
channel_idChannel Idrequired

ID of the messaging channel this record relates to.

api_keyApi Keyrequired
group_idsstring[]required
bothelp object
anyOf
channel_id object

ID of the messaging channel this record relates to.

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

Credentials for a Radist.online channel (vendor "radist"). Required when creating such a channel.

anyOf
api_keyApi Keyrequired

The Radist.online API token (sent as the X-Api-Key header).

company_idCompany Idrequired

The Radist.online company id — an integer, present in every Radist API URL.

chatapp object
anyOf
channel_id object

ID of the messaging channel this record relates to.

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

ID of the messaging channel this record relates to.

usedesk object
anyOf
channel_idChannel Idrequired

ID of the messaging channel this record relates to.

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

ID of the messaging channel this record relates to.

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

ID of the messaging channel this record relates to.

unipile object
anyOf
channel_idChannel Idrequired

ID of the messaging channel this record relates to.

api_keyApi Keyrequired
dsnDsnrequired
amocrm_salesbot object
anyOf
channel_idChannel Idrequired

ID of the messaging channel this record relates to.

bitrix24_openlines object

Routing credentials for a backend-managed Bitrix24 Open Lines channel. Clients normally do not create this channel manually.

anyOf
channel_idChannel Idrequired

ID of the Bitrix24 CRM integration that owns this synthetic channel.

config object

Channel-level configuration (JSON).

alias object

Optional CRM-facing value exactly matched when resolving imported chat-id contacts to this channel.

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

Backend-managed registry of Radist.online connections that already have this channel's inbound webhook (connection id → Radist webhook id). Populated automatically when a chat is resolved; do not edit it, and preserve the received value when updating the config.

property name*string
channel_typeChannel Typerequired

The messaging platform (e.g. 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

The provider/gateway powering the channel (e.g. 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

Whether the external provider session is connected/authorized.

Default value: true
is_activeIs Active

Whether the channel is enabled for use by the platform.

Default value: true
is_archivedIs Archived

Whether the channel is archived.

Default value: false
crm_integration_id object
anyOf
integer
deactivated_until object

If set, the channel is paused until this time (UTC).

anyOf
date-time
outreach_daily_limitOutreach Daily Limit

Max cold-outreach messages allowed through this channel per day.

Default value: 7
skip_outreach_until object

If set, cold outreach through this channel is paused until this time (UTC).

anyOf
date-time
sub_outreach_daily_limitSub Outreach Daily Limit

Max sub-outreach (into existing chats) messages per day — typically higher than cold outreach.

Default value: 1000
skip_sub_outreach_until object

If set, sub-outreach through this channel is paused until this time (UTC).

anyOf
date-time
add_outreach_interval_secondsAdd Outreach Interval Seconds

Minimum spacing between cold-outreach sends on this channel.

Default value: 300
add_sub_outreach_interval_secondsAdd Sub Outreach Interval Seconds

Minimum spacing between sub-outreach sends on this channel.

Default value: 20
is_testIs Test

Whether this is a test channel.

Default value: false
webhook_uuid object

Opaque identifier used to build the channel's inbound webhook URL.

anyOf
string
company_idCompany Idrequired

Company that will own the channel. The backend creates the company-channel link from this value.

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
}