Getting information about chat channels
| Method | get.chat_channels |
|---|---|
| Description | Get information about chat channels |
| Available to | Partner, Client |
Request parameters
| Title | Type | Required | Valid values | 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 | comagicyandex.dialogsdataapiwhatsapptelegramvkontakte_groupsvibertelegram_privaterealty_yandexavitoauto_rufacebookoffline_messageinstagramwaba |
yes | yes | Channel type | |
status |
string |
activedeletederroridleinactiveinit
|
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; |
JSON request structure```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 response structure```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"
}
]
}
}
List of returned errors
See the section "List of errors for methods with the verb get"