Skip to main content

ChannelCredentials

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.

ChannelCredentials
{
  "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"
  }
}