2018-04-01 13:19:25 +02:00
|
|
|
---
|
|
|
|
title: messages.getUnreadMentions
|
2019-12-27 17:48:04 +01:00
|
|
|
description: Get unread messages where we were mentioned
|
2018-04-04 19:52:48 +02:00
|
|
|
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
2019-12-27 18:46:25 +01:00
|
|
|
redirect_from: /API_docs/methods/messages_getUnreadMentions.html
|
2018-04-01 13:19:25 +02:00
|
|
|
---
|
2018-04-05 01:19:57 +02:00
|
|
|
# Method: messages.getUnreadMentions
|
2018-04-01 13:19:25 +02:00
|
|
|
[Back to methods index](index.md)
|
|
|
|
|
|
|
|
|
2019-12-27 17:48:04 +01:00
|
|
|
Get unread messages where we were mentioned
|
2018-04-01 13:19:25 +02:00
|
|
|
|
|
|
|
### Parameters:
|
|
|
|
|
2018-08-29 11:18:25 +02:00
|
|
|
| Name | Type | Description | Required |
|
|
|
|
|----------|---------------|-------------|----------|
|
2019-12-27 17:48:04 +01:00
|
|
|
|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Peer where to look for mentions | Optional|
|
|
|
|
|offset\_id|[int](../types/int.md) | [Offsets for pagination, for more info click here](https://core.telegram.org/api/offsets) | Yes|
|
|
|
|
|add\_offset|[int](../types/int.md) | [Offsets for pagination, for more info click here](https://core.telegram.org/api/offsets) | Yes|
|
|
|
|
|limit|[int](../types/int.md) | Maximum number of results to return, [see pagination](https://core.telegram.org/api/offsets) | Yes|
|
|
|
|
|max\_id|[int](../types/int.md) | Maximum message ID to return, [see pagination](https://core.telegram.org/api/offsets) | Yes|
|
|
|
|
|min\_id|[int](../types/int.md) | Minimum message ID to return, [see pagination](https://core.telegram.org/api/offsets) | Yes|
|
2018-04-01 13:19:25 +02:00
|
|
|
|
|
|
|
|
2019-12-27 18:25:37 +01:00
|
|
|
### Return type: [messages.Messages](../types/messages.Messages.md)
|
2018-04-01 13:19:25 +02:00
|
|
|
|
|
|
|
### Can bots use this method: **NO**
|
|
|
|
|
|
|
|
|
2019-06-02 13:49:54 +02:00
|
|
|
### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)):
|
2018-04-01 13:19:25 +02:00
|
|
|
|
|
|
|
|
2018-10-17 17:10:50 +02:00
|
|
|
```php
|
2018-04-01 13:19:25 +02:00
|
|
|
if (!file_exists('madeline.php')) {
|
|
|
|
copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php');
|
|
|
|
}
|
|
|
|
include 'madeline.php';
|
|
|
|
|
|
|
|
$MadelineProto = new \danog\MadelineProto\API('session.madeline');
|
|
|
|
$MadelineProto->start();
|
|
|
|
|
2019-12-27 18:25:37 +01:00
|
|
|
$messages.Messages = $MadelineProto->messages->getUnreadMentions(['peer' => InputPeer, 'offset_id' => int, 'add_offset' => int, 'limit' => int, 'max_id' => int, 'min_id' => int, ]);
|
2018-04-01 13:19:25 +02:00
|
|
|
```
|
|
|
|
|
|
|
|
Or, if you're into Lua:
|
|
|
|
|
2018-10-17 17:10:50 +02:00
|
|
|
```lua
|
2019-12-27 18:25:37 +01:00
|
|
|
messages.Messages = messages.getUnreadMentions({peer=InputPeer, offset_id=int, add_offset=int, limit=int, max_id=int, min_id=int, })
|
2018-04-01 13:19:25 +02:00
|
|
|
```
|
|
|
|
|
2019-09-02 17:41:28 +02:00
|
|
|
### Errors
|
2018-04-01 13:19:25 +02:00
|
|
|
|
2019-09-02 17:41:28 +02:00
|
|
|
| Code | Type | Description |
|
|
|
|
|------|----------|---------------|
|
|
|
|
|400|PEER_ID_INVALID|The provided peer id is invalid|
|
2018-04-01 13:19:25 +02:00
|
|
|
|
|
|
|
|