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

LastIncomingMessages#

Test Postman Apidog

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

Для метода используются ограничения на частоту запросов в секунду.

Запрос#

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

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

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

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

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

Ответ#

Поля ответа#

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

Поле Тип Описание
type string Вид сообщения, incoming - входящее сообщение
idMessage string Идентификатор входящего сообщения
timestamp integer Время принятия сообщения в UNIX-формате
typeMessage string Тип сообщения, возможные значения:
textMessage - текстовое сообщение
extendedTextMessage - сообщение со ссылкой и превью
chatId string Идентификатор чата, в котором получено сообщение. По умолчанию принимает значение 10000000
senderId string Идентификатор отправителя сообщения. По умолчанию принимает значение 10000000
senderName string Имя отправителя сообщения
senderContactName string Имя отправителя из списка контактов текущего аккаунта
isForwarded boolean Флаг указывает является ли сообщение пересланным
forwardingScore integer Количество пересылок сообщения
textMessage string Текст сообщения, если typeMessage=textMessage/extendedTextMessage
downloadUrl string Ссылка на скачивание файла, если typeMessage = imageMessage /videoMessage/documentMessage
caption string Описание файла, если typeMessage = imageMessage/videoMessage /documentMessage
fileName string Название файла, если typeMessage = imageMessage/videoMessage /documentMessage. Поле заполняется корректно только для typeMessage = documentMessage, в остальных случаях название файла генерируется автоматически
jpegThumbnail string Превью изображения в base64 кодировке, если typeMessage = imageMessage/videoMessage/documentMessage
mimeType string Тип файла, согласно класификации Media Types, если typeMessage = imageMessage/videoMessage/documentMessage
isAnimated boolean Флаг указывает анимирован ли файл, если typeMessage = imageMessage/videoMessage/documentMessage
extendedTextMessageData object Объект с реакцией, если typeMessage = reactionMessage
deletedMessageId string Временно не работает. Идентификатор сообщения которое удалили. Присутствует если сообщение было удалено
editedMessageId string Временно не работает. Идентификатор сообщения которое отредактировали. Присутствует если сообщение было отредактировано
isEdited boolean Временно не работает. Флаг указывает редактировали ли сообщение
isDeleted boolean Временно не работает. Флаг указывает удалили ли сообщение

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

Поле Тип Описание
text string Текст ссылки
description string Описание ссылки
title string Заголовок ссылки
previewType string Тип превью ссылки. Значение previewType:None устарело
jpegThumbnail string Превью изображения в base64 кодировке
forwardingScore integer Количество пересылок сообщения
isForwarded boolean Флаг указывает является ли сообщение пересланным
mediaType string Тип медиа сообщения, например "IMAGE" (только для рекламных сообщений)
thumbnailUrl string Ссылка на превью изображения (только для рекламных сообщений)

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

Поле Тип Описание
text string Реакция (эмоджи) на сообщение

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

[
    {
        "type": "incoming",
        "idMessage": "2755235290043",
        "timestamp": 1706522263,
        "typeMessage": "textMessage",
        "chatId": "10000000",
        "textMessage": "Я использую GREEN-API для отправки этого сообщения!",
        "senderId": "10000000",
        "senderName": "Ходабрыш Пробешёлов",
        "senderContactName": "Ходабрыш Пробешёлов",
        "deletedMessageId": "",
        "editedMessageId": "",
        "isEdited": false,
        "isDeleted": false
    },

]

Ошибки LastIncomingMessages#

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

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

import requests

url = "{{apiUrl}}/v3/waInstance{{idInstance}}/lastIncomingMessages/{{apiTokenInstance}}?minutes=3240"

payload = {}
headers= {}

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

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

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

System.out.println(response);
Sub LastIncomingMessages()
    Dim url As String
    Dim http As Object
    Dim response As String

    ' The apiUrl, idInstance and apiTokenInstance values are available in console, double brackets must be removed
    url = "{{apiUrl}}/v3/waInstance{{idInstance}}/lastIncomingMessages/{{apiTokenInstance}}"

    Set http = CreateObject("MSXML2.XMLHTTP")

    http.Open "GET", url, False
    http.send

    response = http.responseText

    Debug.Print response

    ' Outputting the answer to the desired cell
    Range("A1").Value = response

    Set http = Nothing
End Sub