1
0
mirror of https://github.com/danog/MadelineProto.git synced 2024-12-13 18:47:21 +01:00
MadelineProto/docs/API_docs/methods/messages_getUnreadMentions.md
Daniil Gentili d69a27867f Better docs
2017-08-28 12:44:50 +02:00

93 lines
2.2 KiB
Markdown

---
title: messages.getUnreadMentions
description: messages.getUnreadMentions parameters, return type and example
---
## Method: messages.getUnreadMentions
[Back to methods index](index.md)
### Parameters:
| Name | Type | Required |
|----------|---------------|----------|
|peer|[InputPeer](../types/InputPeer.md) | Yes|
|offset\_id|[int](../types/int.md) | Yes|
|add\_offset|[int](../types/int.md) | Yes|
|limit|[int](../types/int.md) | Yes|
|max\_id|[int](../types/int.md) | Yes|
|min\_id|[int](../types/int.md) | Yes|
### Return type: [messages\_Messages](../types/messages_Messages.md)
### Can bots use this method: **YES**
### Errors this method can return:
| Error | Description |
|----------|---------------|
|PEER_ID_INVALID|The provided peer id is invalid|
### Example:
```
$MadelineProto = new \danog\MadelineProto\API();
if (isset($token)) { // Login as a bot
$MadelineProto->bot_login($token);
}
if (isset($number)) { // Login as a user
$sentCode = $MadelineProto->phone_login($number);
echo 'Enter the code you received: ';
$code = '';
for ($x = 0; $x < $sentCode['type']['length']; $x++) {
$code .= fgetc(STDIN);
}
$MadelineProto->complete_phone_login($code);
}
$messages_Messages = $MadelineProto->messages->getUnreadMentions(['peer' => InputPeer, 'offset_id' => int, 'add_offset' => int, 'limit' => int, 'max_id' => int, 'min_id' => int, ]);
```
Or, if you're using the [PWRTelegram HTTP API](https://pwrtelegram.xyz):
### As a bot:
POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline`
Parameters:
* method - messages.getUnreadMentions
* params - `{"peer": InputPeer, "offset_id": int, "add_offset": int, "limit": int, "max_id": int, "min_id": int, }`
### As a user:
POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.getUnreadMentions`
Parameters:
peer - Json encoded InputPeer
offset_id - Json encoded int
add_offset - Json encoded int
limit - Json encoded int
max_id - Json encoded int
min_id - Json encoded int
Or, if you're into Lua:
```
messages_Messages = messages.getUnreadMentions({peer=InputPeer, offset_id=int, add_offset=int, limit=int, max_id=int, min_id=int, })
```