GetStatusStatistic#

Бета-версия

Функциональность находится в режиме бета-версии. Функции могут быть изменены, а также могут работать нестабильно. В будущем за функционал может взиматься дополнительная плата.
Подключение к функционалу можно запросить через техподдержку Green API

Метод возвращает массив получателей со статусами, отмеченных как отправлено/доставлено/прочитано, для данного статуса.

Для получения статусов сообщений, необходимо включить настройку Получать уведомления о статусах отправленных сообщений методом SetSettings или через личный кабинет (статусы сообщения полученные до включения настройки не обновятся).

Применение настроек занимает до 5 минут.

Список контактов подтягивается методом GetContacts по значению поля contactName. Чтобы получить актуальный список контактов, требуется переименовать контакт и заново авторизоваться, пересканировав QR код.

Запрос#

Для получения статистики статусов требуется выполнить запрос по адресу:

GET

{{apiUrl}}/waInstance{{idInstance}}/getStatusStatistic/{{apiTokenInstance}}?idMessage={{id_Message}}

Для получения параметров запроса apiUrl, idInstance и apiTokenInstance обратитесь к разделу Перед началом работы.

Параметры URL запроса#

Параметр	Тип	Обязательный	Описание
`idMessage`	string	Да	ID сообщения статуса

Ответ#

Поля ответа#

Массив объектов с полями:

Поле	Тип	Описание
`participant`	array	Идентификатор контакта
`timestamp`	integer	Время крайнего действия по сообщению в UNIX-формате
`status`	string	Статус исходящего статуса, возможные значения:
		`pending` - сообщение отправляется
		`sent` - отправлено
		`delivered` - доставлено
		`read` - прочитано/просмотрено/прослушано

Пример тела ответа#

[
    {
        "participant": "11001234567@c.us",
        "timestamp": 1587129319,
        "status": "read",
    },
    {
        "participant": "71234567891@c.us",
        "timestamp": 1587129319,
        "status": "delivered",
    },
]

Ошибки GetStatusStatistic#

Перечень общих для всех методов ошибок смотрите в разделе Стандартные ошибки.

Код HTTP	Идентификатор ошибки	Описание
403	`Forbidden`	Доступ к функционалу бета-версии методов статусов отсутствует. Подключение к функционалу можно запросить через техподдержку Green API

Примеры кода#

PythoncURLJava - SpringJava - Unirest

import requests

url = "{{apiUrl}}/waInstance{{idInstance}}/getStatusStatistic/{{apiTokenInstance}}"

payload = {}
headers= {}

response = requests.request("GET", url, headers=headers, data = payload)

print(response.text.encode('utf8'))

curl --location '{{apiUrl}}/waInstance{{idInstance}}/getStatusStatistic/{{apiTokenInstance}}?idMessage=BAE57C4EEC000000'

var restTemplate = new RestTemplate();
var requestUrl = new StringBuilder();
requestUrl
    .append({{apiUrl}})
    .append("/waInstance").append({{idInstance}})
    .append("/getStatusStatistic/")
    .append({{apiTokenInstance}});

var response = restTemplate.exchange(requestUrl.toString(), HttpMethod.GET, null, String.class);
System.out.println(response);

var requestUrl = new StringBuilder();
requestUrl
    .append({{apiUrl}})
    .append("/waInstance").append({{idInstance}})
    .append("/getStatusStatistic/")
    .append({{apiTokenInstance}});

var response = Unirest.get(requestUrl.toString())
    .header("Content-Type", "application/json")
    .asString();

System.out.println(response);