Sign in

v3

latestOpenAPI 3.1.02026-08-01264769.0 KB
Bot

Get chat history

Returns a page of messages from a private conversation or chat. Supply exactly one of user_id or chat_id, and use offset_message_id to request older messages.

get/bot{token}/getChatHistory

Path parameters

tokenstring required

Required bot token included in the URL path.

Query parameters

user_idstring

A positive decimal Inline user identifier

Example:123456789

Target a private conversation with this user. Supply exactly one of user_id or chat_id.

chat_idstring

A positive decimal Inline chat identifier

Example:123456789

Target this chat. Supply exactly one of chat_id or user_id.

limitstring

A signed decimal integer string within JavaScript's safe-integer range

Example:42

Maximum number of messages to return.

offset_message_idstring

A positive decimal Inline message identifier

Example:123456789

Pagination cursor. When supplied, return messages older than this message.

Headers

authorizationstring

Optional bot token using the Bearer scheme. When supplied, it takes precedence over the token in the URL.

Response

Successful getChatHistory response.

oktrue required

Always true for a successful request.

Example response

{
  "ok": true,
  "result": {
    "messages": [
      {
        "message_id": 1808,
        "chat_id": 73143,
        "chat": {
          "chat_id": 73143,
          "title": "Maya Chen",
          "is_public": false,
          "last_message_id": 1808,
          "last_message": {
            "message_id": 1808,
            "from_id": 284901,
            "from": {
              "id": 284901,
              "is_bot": true,
              "username": "deploy_bot",
              "first_name": "Deploy Bot"
            },
            "date": 1784332860,
            "text": "Deployment finished successfully.",
            "entities": [
              {
                "type": "bold",
                "offset": 0,
                "length": 10
              }
            ]
          }
        },
        "peer": {
          "user_id": 391204
        },
        "from_id": 284901,
        "from": {
          "id": 284901,
          "is_bot": true,
          "username": "deploy_bot",
          "first_name": "Deploy Bot"
        },
        "date": 1784332860,
        "text": "Deployment finished successfully.",
        "entities": [
          {
            "type": "bold",
            "offset": 0,
            "length": 10
          }
        ]
      }
    ]
  }
}