Skip to main content

ChannelSafeRead

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.

idIdrequired

Unique numeric identifier of the record.

created_atdate-timerequired

Creation time (UTC, ISO 8601).

nameNamerequired

Human-readable channel name.

numberNumberrequired

The channel's phone number or account identifier.

config objectrequired

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
accept_postbacksAccept Postbacks

FastTrack channels only. When true, a customer's button press (postback) is answered as if the customer had typed the button's label. Defaults to false, in which case button presses are ignored and create no lead or dialogue. Note that config is replaced as a whole on update — send the full object with only this flag changed.

Default value: false
incoming_dialogue_router_enabledIncoming Dialogue Router Enabled

Whether an LLM router picks the target dialogue when several active dialogues share one physical chat on this channel (products/agents on a shared channel). Set to false to skip the LLM and always continue the newest dialogue. Defaults to true; only meaningful on shared channels. Note that config is replaced as a whole on update — send the full object with only this flag changed.

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
bitrix24_openlines_skip_operator_held_chatsBitrix24 Openlines Skip Operator Held Chats
Default value: true
spam_block objectrequired

Latest Telegram SpamBot check state for this channel, if the channel supports that check.

statusStatus

Current spam-block check status.

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

Default value: unknown
limited_until object

When Telegram says the account limitation will be lifted, if parsed from SpamBot.

anyOf
date-time
check_started_at object

When the latest check request was started.

anyOf
date-time
last_response_at object

Timestamp of the latest SpamBot response seen for this channel.

anyOf
date-time
last_response_text object

Raw latest SpamBot response text kept for operator diagnostics.

anyOf
string
last_error object

Last send or parse error, if the check failed.

anyOf
string
request_message_id object

External Wappi message id for the latest /start request, if available.

anyOf
string
request_task_id object

External Wappi task id for the latest /start request, if available.

anyOf
string
source object

What started the latest check — manual user action or scheduled automation.

anyOf
string

Possible values: [manual, scheduled]

requested_by_user_id object

User id that manually started the latest check, if any.

anyOf
integer
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, self_tg_bot).

Possible values: [wazzup24, self_wz, self_tg_bot, 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

Whether the external provider session is connected/authorized.

is_activeIs Activerequired

Whether the channel is enabled for use by the platform.

is_archivedIs Archivedrequired

Whether the channel is archived (retired). Archiving also disables the channel — is_active and is_session_active are set to false in the same update, whatever values the request carries. While a channel is archived, requests to enable it are ignored; unarchive it first. Unarchiving does not re-enable it by itself.

crm_integration_id objectrequired
anyOf
integer
deactivated_until objectrequired

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

anyOf
date-time
session_lost_at object

When the provider session was last lost (UTC); empty while the session is connected. Read-only.

anyOf
date-time
deactivated_at object

When the channel was last disabled (UTC); empty while it is enabled. Read-only. Cold outreach waits 24 hours (15 minutes for an archived channel) for a channel that lost its session or was disabled with no end date, then reroutes planned messages to other live channels.

anyOf
date-time
outreach_daily_limitOutreach Daily Limitrequired

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

skip_outreach_until objectrequired

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

anyOf
date-time
add_outreach_interval_secondsAdd Outreach Interval Secondsrequired

Minimum spacing between cold-outreach sends on this channel.

sub_outreach_daily_limitSub Outreach Daily Limitrequired

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

skip_sub_outreach_until objectrequired

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

anyOf
date-time
add_sub_outreach_interval_secondsAdd Sub Outreach Interval Secondsrequired

Minimum spacing between sub-outreach sends on this channel.

ping_interval_secondsPing Interval Seconds
Default value: 0
is_testIs Test

Whether this is a test channel.

Default value: false
is_internalIs Internal

Whether the channel belongs to the platform itself (demo/test/warmup pool). Internal channels are never billed to a client and may be shared between companies.

Default value: false
webhook_uuid object

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

anyOf
string
webhook_url objectrequired

The inbound webhook URL the provider should call for this channel (derived from 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,
    "accept_postbacks": false,
    "incoming_dialogue_router_enabled": true,
    "fetch_only_unread": true,
    "last_seen_msg_id": "string",
    "radist_webhook_connection_ids": {},
    "bitrix24_openlines_skip_operator_held_chats": true
  },
  "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",
  "session_lost_at": "2024-07-29T15:51:28.071Z",
  "deactivated_at": "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,
  "ping_interval_seconds": 0,
  "is_test": false,
  "is_internal": false,
  "webhook_uuid": "string",
  "webhook_url": "string"
}