Отдаёт чаты канала: личные, группы и каналы, в Telegram — и ботов. Нужен, чтобы показать список переписок в вашей системе или найти chatId группы по названию.
| Запрос | GET /waInstance{idInstance}/getChats/{apiTokenInstance} |
| Тело | нет |
| Каналы | MAX, Telegram, WhatsApp, почта |
Пример запроса
Все чаты канала:
curl
curl "$GRATIO_URL/waInstance$GRATIO_ID/getChats/$GRATIO_TOKEN"
Python
import os
import requests
BASE = f"{os.environ['GRATIO_URL']}/waInstance{os.environ['GRATIO_ID']}"
TOKEN = os.environ["GRATIO_TOKEN"]
url = f"{BASE}/getChats/{TOKEN}"
response = requests.get(url, timeout=60)
print(response.status_code, response.json())
Node.js
const { GRATIO_URL, GRATIO_ID, GRATIO_TOKEN } = process.env;
const base = `${GRATIO_URL}/waInstance${GRATIO_ID}`;
const url = `${base}/getChats/${GRATIO_TOKEN}`;
const response = await fetch(url);
console.log(response.status, await response.json());
PHP
<?php
$base = getenv('GRATIO_URL') . '/waInstance' . getenv('GRATIO_ID');
$url = $base . '/getChats/' . getenv('GRATIO_TOKEN');
$ch = curl_init($url);
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_TIMEOUT => 90,
]);
$response = json_decode(curl_exec($ch), true);
echo curl_getinfo($ch, CURLINFO_HTTP_CODE), PHP_EOL;
print_r($response);
Пример ответа
Ответ 200 OK:
[
{"chatId": "8695836", "name": "Мария", "type": "user", "phoneNumber": 0},
{"chatId": "-80040066617372", "name": "3А · Робототехника", "type": "group", "phoneNumber": 0}
]
Поля ответа
| Поле | Тип | Описание |
|---|---|---|
chatId |
string | id чата — для sendMessage, getChatHistory и других методов |
name |
string | имя собеседника или название группы; бывает пустым |
type |
string | user — личный чат, group — группа, channel — канал, bot — бот (Telegram) |
phoneNumber |
integer | номер собеседника, если мессенджер его показывает, иначе 0 |
Особенности каналов
| Канал | Что в списке |
|---|---|
| MAX | чаты аккаунта, без «Избранного» |
| Telegram | до 500 диалогов: личные, боты, группы, каналы и «Избранное» |
| до 500 чатов с перепиской с момента привязки номера, свежие первыми | |
| Почта | собеседники последних писем «Входящих» и «Отправленных», свежие первыми |
- WhatsApp.
typeпока всегдаuser. Группу узнайте по адресу: он кончается на@g.us. - MAX. Номер собеседника MAX не показывает:
phoneNumber—0.
Ошибки
| Код | code |
Когда | Что делать |
|---|---|---|---|
400 |
not_authorized |
канал не на связи | проверить getStateInstance |
Общие правила — в статье Ответы и ошибки.
Что дальше
- getContacts — адресная книга и собеседники.
- getChatHistory — сообщения выбранного чата.
- getGroupData — участники и настройки группы.
