MadelineProto/old_docs/API_docs_v73/methods/messages_faveSticker.md

81 lines
1.7 KiB
Markdown
Raw Normal View History

2016-12-20 13:15:22 +01:00
---
title: messages.faveSticker
description: messages.faveSticker parameters, return type and example
2016-12-20 13:15:22 +01:00
---
## Method: messages.faveSticker
2016-12-20 13:15:22 +01:00
[Back to methods index](index.md)
### Parameters:
| Name | Type | Required |
2017-08-20 11:05:56 +02:00
|----------|---------------|----------|
|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|
2018-03-20 16:42:05 +01:00
|unfave|[CLICK ME Bool](../types/Bool.md) | Yes|
### Return type: [Bool](../types/Bool.md)
2017-08-28 12:44:50 +02:00
### Can bots use this method: **YES**
2017-11-03 17:39:50 +01:00
### Errors this method can return:
| Error | Description |
|----------|---------------|
|STICKER_ID_INVALID|The provided sticker ID is invalid|
2017-11-03 17:39:50 +01:00
### Example:
```
if (!file_exists('madeline.php')) {
copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php');
}
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();
$Bool = $MadelineProto->messages->faveSticker(['id' => InputDocument, 'unfave' => Bool, ]);
2017-02-13 04:33:06 +01:00
```
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
### As a bot:
POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline`
Parameters:
* method - messages.faveSticker
* params - `{"id": InputDocument, "unfave": Bool, }`
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/messages.faveSticker`
2017-07-23 16:11:02 +02:00
Parameters:
id - Json encoded InputDocument
2017-08-20 19:09:52 +02:00
unfave - Json encoded Bool
2017-07-23 16:11:02 +02:00
2017-07-23 16:40:54 +02:00
2017-07-23 16:11:02 +02:00
2017-08-20 19:09:52 +02:00
Or, if you're into Lua:
```
Bool = messages.faveSticker({id=InputDocument, unfave=Bool, })
```