Skip to content

GetMessages.md

Latest commit

 

History

History
116 lines (100 loc) · 4.19 KB

GetMessages.md

File metadata and controls

116 lines (100 loc) · 4.19 KB

GetMessages

dev.max.ru/docs-api/methods/GET/messages

Метод предназначен для получения списка сообщений по ID чата или точному списку ID сообщений.

Запрос {#request}

Поля запроса {#request-parameters}

Поле Тип Обязательный Описание
chat_id integer Да* Идентификатор чата
*(обязательно, если не указан MessageIDs)
message_ids array Да* Массив точных идентификаторов сообщений
*(обязательно, если нет chat_id)
from integer Нет Время начала для запрашиваемых сообщений (в формате Unix timestamp)
to integer Нет Время окончания для запрашиваемых сообщений (в формате Unix timestamp)
count integer Нет Максимальное количество сообщений в ответе (по умолчанию 50)

Пример запроса {#request-example}

Синхронный запрос:

response = bot.messages.GetMessages(GetMessagesReq(
    chat_id=123456
))

Асинхронный запрос:

response = await bot.messages.GetMessagesAsync(GetMessagesReq(
    message_ids=[
        "mid.000000000782a4e0019d002654056aed",
        "mid.000000000782a4e0019d0004e58330de",
        "mid.000000000782a4e0019d0004e3424fbd"
    ]
))

Ответ {#response}

Поля ответа {#response-parameters}

Поле Тип Описание
messages array Массив объектов сообщений

Пример тела ответа {#response-example-body}

{
        "recipient": {
            "chat_id": 123456789,
            "chat_type": "dialog",
            "user_id": 111222333
        },
        "timestamp": 1773835378770,
        "body": {
            "mid": "mid.000000000782a4e0019d00d3e0525a17",
            "seq": 116250075383093783,
            "text": "Hello!"
        },
        "sender": {
            "user_id": 987654321,
            "first_name": "Jane",
            "last_name": "",
            "is_bot": false,
            "last_activity_time": 1773838157000,
            "name": "Jane"
        }
    },
    {
        "recipient": {
            "chat_id": 123456789,
            "chat_type": "dialog",
            "user_id": 987654321
        },
        "timestamp": 1773824005332,
        "body": {
            "mid": "mid.000000000782a4e0019d002654d46aec",
            "seq": 116249330013465324,
            "text": "What's up?"
        },
        "sender": {
            "user_id": 111222333,
            "first_name": "GREEN-API test",
            "username": "id5047259512_1_bot",
            "is_bot": true,
            "last_activity_time": 1773838164201,
            "name": "GREEN-API test"
        }
    },
    {
        "recipient": {
            "chat_id": 123456789,
            "chat_type": "dialog",
            "user_id": 111222333
        },
        "timestamp": 1773824005125,
        "body": {
            "mid": "mid.000000000782a4e0019d002654056aed",
            "seq": 116249329999899373,
            "text": "Wanna hang out?"
        },
        "sender": {
            "user_id": 987654321,
            "first_name": "Jane",
            "last_name": "",
            "is_bot": false,
            "last_activity_time": 1773838157000,
            "name": "Jane"
        }
    }