Retrieves chat channel information.

Retrieves chat channel information

Method	`get.chat_channels`
Description	Retrieves chat channel information.
Who has access	Partners and clients

Request parameters

Name	Type	Required	Description
`access_token`	string	yes	Authentication session key
`limit`	number	no	Number of records returned. See section "Paging"
`offset`	number	no	Shift determines from which record number to return `"limit"` records. Default is "0". See section "Paging"
`filter`	object	no	See section "Filtering Criteria"
`fields`	array	no	See "View of Returned Data"

Response parameters

Name	Type	Valid values	Filtering	Sorting	Default response	Description
`id`	number		yes		yes	Unique channel identifier.
`name`	string		yes	yes	yes	Channel name.
`type`	enum	`comagic` `yandex.dialogs` `dataapi` `whatsapp` `telegram` `vkontakte_groups` `viber` `telegram_private` `realty_yandex` `avito` `auto_ru` `facebook` `offline_message` `instagram` `waba`	yes		yes	Channel type
`status`	string	`active` `deleted` `error` `idle` `inactive` `init`			yes	Channel status
`group_id`	number		yes		yes	ID of the group assigned to the channel
`group_name`	string				yes	Name of the group assigned to the channel
`employee_id`	number		yes		yes	ID of the employee assigned to the channel
`employee_full_name`	string				yes	Name of the employee assigned to the channel
`channel_external_id`	string				yes	Account to which the channel is created. It could be: -phone number for channel types whatsapp/telegram_private/waba; -name of the telegram bot for telegram; -name of the VK group for vkontakte_groups;

Example request

{
"jsonrpc":"2.0",
"id":"number",
"method":"get.chat_channels",
"params":{
"access_token":"string",
"limit":"number",
"offset":"number",
"sort":[
{
"field":"string",
"order":"string"
}
],
"filter":{
},
"fields":[
"string"
]

}
}

Example response

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

Possible errors

See the "Errors for get methods" section.