Получить список контактов
Получает список контактов аккаунта
- Параметры
- Расширенный вызов ?
Функция ПолучитьСписокКонтактов(Знач ПараметрыДоступа, Знач Количество = Неопределено) Экспорт
| Параметр | CLI опция | Тип | Обяз. | Назначение |
|---|---|---|---|---|
| ПараметрыДоступа | --access | Структура Из КлючИЗначение | ✔ | Параметры доступа. См. СформироватьПараметрыДоступа |
| Количество | --count | Число | ✖ | Количество контактов для получения. Все, если не указано |
Возвращаемое значение
Массив Из Соответствие - сериализованный JSON ответа от Green API
| Параметр | Описание |
|---|---|
| proxy | ИнтернетПрокси или структура полей Протокол, Сервер, Порт, Пользователь, Пароль, ИспользоватьАутентификациюОС |
| timeout | Таймаут выполнения запроса |
| adv_response | Оформляет ответ в виде полной структуры HTTP-ответа с полями code, body и headers |
| retries | Число попыток отправки HTTP-запроса при коде 5** или внутренних ошибках клиента |
| dontwait | Создает фоновое задание и возвращает его данные (только для 1С и OneScript) |
подсказка
Метод в документации API: GetContacts
Пример использования для 1С:Предприятие/OneScript
ApiUrl = "https://3100.api.green-api.com/v3";
MediaUrl = "https://3100.api.green-api.com/v3";
IdInstance = "31003...";
ApiTokenInstance = "17915d8e0b4b4975a183478da...";
Количество = 1;
ПараметрыДоступа = OPI_GreenMax.СформироватьПараметрыДоступа(ApiUrl, MediaUrl, IdInstance, ApiTokenInstance);
Результат = OPI_GreenMax.ПолучитьСписокКонтактов(ПараметрыДоступа, Количество);
- Bash
- CMD/Bat
# JSON данные также могут быть переданы как путь к файлу .json
oint greenmax ПолучитьСписокКонтактов \
--access "{'apiUrl':'***','mediaUrl':'https://3100.api.green-api.com/v3','idInstance':'3100309139','apiTokenInstance':'***'}" \
--count 1
:: JSON данные также могут быть переданы как путь к файлу .json
oint greenmax ПолучитьСписокКонтактов ^
--access "{'apiUrl':'***','mediaUrl':'https://3100.api.green-api.com/v3','idInstance':'3100309139','apiTokenInstance':'***'}" ^
--count 1
Результат
[
{
"chatId": "***",
"name": "Тест",
"contactName": "Тест",
"type": "user",
"phoneNumber": "***"
}
]