Получение информации о каналах чата
Получение информации о каналах чата
| Метод | get.chat_channels |
|---|---|
| Описание | Получение информации о каналах чата |
| Кому доступен | Партнер, Клиент |
Параметры запроса
| Название | Тип | Обязательный | Допустимые значения | Описание |
|---|---|---|---|---|
access_token |
string | да | Ключ сессии аутентификации | |
limit |
number | нет | Количество возвращаемых записей. См. раздел "Постраничный вывод" | |
offset |
number | нет | Сдвиг, определяет с какого номера записи возвращать "limit" записей. По умолчанию "0". См. раздел "Постраничный вывод"
|
|
filter |
object | нет | См. раздел "Критерии фильтрации" | |
fields |
array | нет | См. раздел "Представление возвращаемых данных" | |
sort |
array | нет | См. раздел "Сортировка данных" |
Параметры ответа
| Название | Тип | Допустимые значения | Фильтрация | Сортировка | Ответ по умолчанию | Описание |
|---|---|---|---|---|---|---|
id |
number | да | да | Уникальный идентификатор канала. | ||
name |
string | да | да | да | Название канала. | |
type |
enum |
comagicyandex.dialogsdataapiwhatsapptelegramvkontakte_groupsvibertelegram_privaterealty_yandexavitoauto_rufacebookoffline_messageinstagramwaba
|
да | да | Тип канала | |
status |
string |
activedeletederroridleinactiveinit
|
да | Статус канала | ||
group_id |
number | да | да | ID группы, закрепленной за каналом | ||
group_name |
string | да | Название группы, закрепленной за каналом | |||
employee_id |
number | да | да | ID сотрудника, закрепленного за каналом | ||
employee_full_name |
string | да | Имя сотрудника, закрепленного за каналом | |||
channel_external_id |
string | да | Аккаунт, на который заведен канал. Это может быть: -номер телефона для типов каналов whatsapp/telegram_private/waba; -название телеграмм-бота для telegram; -название группы ВК для vkontakte_groups; |
JSON структура запроса
Копировать
{
"jsonrpc":"2.0",
"id":"number",
"method":"get.chat_channels",
"params":{
"access_token":"sting",
"limit":"number",
"offset":"number",
"sort":[
{
"field":"sting",
"order":"sting"
}
],
"filter":{
},
"fields":[
"string"
]
}
}
JSON структура ответа
Копировать
{
"jsonrpc": "2.0",
"id": "number",
"result": {
"metadata": {
},
"data": [
{
"id": "number",
"name": "string",
"type": "enum",
"status": "string",
"group_id": "number",
"group_name": "string",
"employee_id": "number",
"employee_full_name": "string",
"channel_external_id": "number"
}
]
}
}
Список возвращаемых ошибок
Смотрим раздел "Список ошибок для методов с глаголом get"