MadelineProtoDocs/docs/API_docs/methods/phone_setCallRating.md

73 lines
1.6 KiB
Markdown
Raw Normal View History

2018-04-01 13:19:25 +02:00
---
title: phone.setCallRating
description: Set phone call rating
2018-04-04 19:52:48 +02:00
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
2018-04-01 13:19:25 +02:00
---
2018-04-05 01:19:57 +02:00
# Method: phone.setCallRating
2018-04-01 13:19:25 +02:00
[Back to methods index](index.md)
Set phone call rating
### Parameters:
2018-08-29 11:18:25 +02:00
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|peer|[InputPhoneCall](../types/InputPhoneCall.md) | The phone call | Yes|
|rating|[int](../types/int.md) | Rating (1-5 stars) | Yes|
|comment|[string](../types/string.md) | An optional comment | Yes|
2018-04-01 13:19:25 +02:00
### Return type: [Updates](../types/Updates.md)
### Can bots use this method: **NO**
### MadelineProto Example:
```
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();
$Updates = $MadelineProto->phone->setCallRating(['peer' => InputPhoneCall, 'rating' => int, 'comment' => 'string', ]);
```
### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto):
### As a user:
POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/phone.setCallRating`
Parameters:
peer - Json encoded InputPhoneCall
rating - Json encoded int
comment - Json encoded string
Or, if you're into Lua:
```
Updates = phone.setCallRating({peer=InputPhoneCall, rating=int, comment='string', })
```
### Errors this method can return:
| Error | Description |
|----------|---------------|
|CALL_PEER_INVALID|The provided call peer object is invalid|