Перейти к содержанию

GetIncomingStatuses#

Бета-версия

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

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

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

Запрос#

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

GET {{apiUrl}}/waInstance{{idInstance}}/getIncomingStatuses/{{apiTokenInstance}}?minutes={{minutes_count}}

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

Протестировать

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

Параметр Тип Обязательный Описание
minutes integer Нет время в минутах, за которое требуется показать статусы (по умолчанию равен 1440 минутам)

Ответ#

Поля ответа#

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

Поле Тип Описание
type string Вид сообщения, incoming - входящее сообщение
idMessage string Идентификатор входящего сообщения
timestamp integer Время принятия сообщения в UNIX-формате
typeMessage string Тип сообщения, возможные значения:
extendedTextMessage - Расширенное текстовое сообщение
imageMessage - сообщение с изображением
videoMessage - видео сообщение
audioMessage - аудио сообщение
chatId string Идентификатор чата отправителя сообщения
senderId string Идентификатор отправителя сообщения
senderName string Имя отправителя сообщения
senderContactName string Имя отправителя из списка контактов текущего аккаунта
textMessage string Текст сообщения, если typeMessage= extendedTextMessage
downloadUrl string Ссылка на скачивание файла, если typeMessage = imageMessage/videoMessage/audioMessage
caption string Описание файла, если typeMessage = imageMessage/videoMessage
fileName string Название файла, если typeMessage = imageMessage/videoMessage/audioMessage. Поле генерируется автоматически
jpegThumbnail string Превью изображения в base64 кодировке, если typeMessage = imageMessage/videoMessage
mimeType string Тип файла, согласно класификации Media Types, если typeMessage = imageMessage/videoMessage/audioMessage
extendedTextMessage object Объект с текстовым сообщением (расширенный), если typeMessage = extendedTextMessage

Поля объекта extendedTextMessage:

Поле Тип Описание
text string Текст сообщения
backgroundColor string Цвет фона сообщения. Значение по умолчанию: #FFFFFF. Пример сайта для получения значения цвета фона
font string Шрифт сообщения. Принимает значения:
SERIF - Так будет выглядеть ваш текст
SANS_SERIF - Так будет выглядеть ваш текст
NORICAN_REGULAR - Here is how your text will look
Шрифт применяется только для латинских букв
BRYNDAN_WRITE - Так будет выглядеть ваш текст
OSWALD_HEAVY - Так будет выглядеть ваш текст

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

[
    {
        "type": "incoming",
        "idMessage": "1E1A12D337F2BFA5FC0000000000000",
        "timestamp": 1710232595,
        "typeMessage": "extendedTextMessage",
        "chatId": "70000000001@c.us",
        "textMessage": "Прекрасное утро!",
        "extendedTextMessage": {
            "text": "Прекрасное утро!",
            "backgroundColor": "#228B22",
            "font": "SANS_SERIF"
        },
        "senderId": "70000000001@c.us",
        "senderName": "Николай",
        "senderContactName": "Коля",
    },
    {
        "type": "incoming",
        "idMessage": "38E322274FDEBA56047000000000000",
        "timestamp": 1710232636,
        "typeMessage": "imageMessage", // "videoMessage" / "audioMessage"
        "chatId": "70000000001@c.us",
        "downloadUrl": "https://sw-media.storage. greenapi.net/1101000000/dcf81410-bdbc-4aed-bf23-d1845c000000.jpg",
        "caption": "Прекрасное утро!",
        "fileName": "dcf81410-bdbc-4aed-bf23-d1845cd74754.jpg",
        "jpegThumbnail": "/9j/2wCEABALDA4MChAODQ4SERATGCgaGBYWGDEjJ",
        "mimeType": "image/jpeg",
        "senderId": "70000000001@c.us",
        "senderName": "Николай",
        "senderContactName": "Коля",
    }
]

Ошибки GetIncomingStatuses#

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

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

import requests

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

payload = {}
headers= {}

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

print(response.text.encode('utf8'))
curl --location '{{apiUrl}}/waInstance{{idInstance}}/getIncomingStatuses/{{apiTokenInstance}}?minutes=3240'
var restTemplate = new RestTemplate();
var requestUrl = new StringBuilder();
requestUrl
    .append({{apiUrl}})
    .append("/waInstance").append({{idInstance}})
    .append("/getIncomingStatuses/")
    .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("/getIncomingStatuses/")
    .append({{apiTokenInstance}});

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

System.out.println(response);