MadelineProto/old_docs/API_docs_v65/methods/contacts_resetTopPeerRating.md

67 lines
1.5 KiB
Markdown
Raw Normal View History

2017-04-21 13:27:04 +02:00
---
title: contacts.resetTopPeerRating
description: contacts.resetTopPeerRating parameters, return type and example
---
## Method: contacts.resetTopPeerRating
[Back to methods index](index.md)
### Parameters:
| Name | Type | Required |
2017-08-20 11:05:56 +02:00
|----------|---------------|----------|
2017-04-21 13:27:04 +02:00
|category|[TopPeerCategory](../types/TopPeerCategory.md) | Yes|
|peer|[InputPeer](../types/InputPeer.md) | Optional|
2017-04-21 13:27:04 +02:00
### Return type: [Bool](../types/Bool.md)
2017-08-28 12:44:50 +02:00
### Can bots use this method: **NO**
2017-11-03 17:39:50 +01:00
### Errors this method can return:
| Error | Description |
|----------|---------------|
|PEER_ID_INVALID|The provided peer id is invalid|
2017-04-21 13:27:04 +02:00
### Example:
```
$MadelineProto = new \danog\MadelineProto\API();
2017-12-11 12:12:38 +01:00
$MadelineProto->session = 'mySession.madeline';
2017-04-21 13:27:04 +02:00
if (isset($number)) { // Login as a user
2017-12-11 12:12:38 +01:00
$MadelineProto->phone_login($number);
$code = readline('Enter the code you received: '); // Or do this in two separate steps in an HTTP API
2017-04-21 13:27:04 +02:00
$MadelineProto->complete_phone_login($code);
}
$Bool = $MadelineProto->contacts->resetTopPeerRating(['category' => TopPeerCategory, 'peer' => InputPeer, ]);
```
2017-07-24 01:32:29 +02:00
Or, if you're using the [PWRTelegram HTTP API](https://pwrtelegram.xyz):
2017-07-23 16:11:02 +02:00
2017-07-23 16:34:36 +02:00
2017-07-23 16:11:02 +02:00
### As a user:
POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/contacts.resetTopPeerRating`
Parameters:
category - Json encoded TopPeerCategory
2017-08-20 19:09:52 +02:00
2017-07-23 16:11:02 +02:00
peer - Json encoded InputPeer
2017-07-23 16:40:54 +02:00
2017-07-23 16:11:02 +02:00
2017-08-20 19:09:52 +02:00
2017-04-21 13:27:04 +02:00
Or, if you're into Lua:
```
Bool = contacts.resetTopPeerRating({category=TopPeerCategory, peer=InputPeer, })
```