MadelineProto/old_docs/API_docs_v72/methods/messages_getUnreadMentions.md

84 lines
2.0 KiB
Markdown
Raw Normal View History

2017-11-15 13:41:58 +01:00
---
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|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|
2018-03-20 16:42:05 +01:00
|offset\_id|[CLICK ME int](../types/int.md) | Yes|
|add\_offset|[CLICK ME int](../types/int.md) | Yes|
|limit|[CLICK ME int](../types/int.md) | Yes|
|max\_id|[CLICK ME int](../types/int.md) | Yes|
|min\_id|[CLICK ME int](../types/int.md) | Yes|
2017-11-15 13:41:58 +01:00
### Return type: [messages\_Messages](../types/messages_Messages.md)
### Can bots use this method: **NO**
### Errors this method can return:
| Error | Description |
|----------|---------------|
|PEER_ID_INVALID|The provided peer id is invalid|
### Example:
```
if (!file_exists('madeline.php')) {
copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php');
2017-11-15 13:41:58 +01:00
}
include 'madeline.php';
// !!! This API id/API hash combination will not work !!!
// !!! You must get your own @ my.telegram.org !!!
$api_id = 0;
$api_hash = '';
$MadelineProto = new \danog\MadelineProto\API('session.madeline', ['app_info' => ['api_id' => $api_id, 'api_hash' => $api_hash]]);
$MadelineProto->start();
2017-11-15 13:41:58 +01:00
$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 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, })
```