MadelineProto/old_docs/API_docs_v72/methods/messages_faveSticker.md

79 lines
1.6 KiB
Markdown
Raw Normal View History

---
2017-11-15 13:41:58 +01:00
title: messages.faveSticker
description: messages.faveSticker parameters, return type and example
---
2017-11-15 13:41:58 +01:00
## Method: messages.faveSticker
[Back to methods index](index.md)
### Parameters:
| Name | Type | Required |
2017-08-20 11:05:56 +02:00
|----------|---------------|----------|
2017-11-15 13:41:58 +01:00
|id|[InputDocument](../types/InputDocument.md) | Yes|
|unfave|[Bool](../types/Bool.md) | Yes|
2017-11-15 13:41:58 +01:00
### Return type: [Bool](../types/Bool.md)
2017-08-28 12:44:50 +02:00
### Can bots use this method: **YES**
2017-11-15 13:41:58 +01:00
### Errors this method can return:
| Error | Description |
|----------|---------------|
|STICKER_ID_INVALID|The provided sticker ID is invalid|
### Example:
```
$MadelineProto = new \danog\MadelineProto\API();
2017-12-11 12:12:38 +01:00
$MadelineProto->session = 'mySession.madeline';
if (isset($token)) { // Login as a bot
2017-06-19 18:56:47 +02:00
$MadelineProto->bot_login($token);
}
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
$MadelineProto->complete_phone_login($code);
}
2017-11-15 13:41:58 +01:00
$Bool = $MadelineProto->messages->faveSticker(['id' => InputDocument, 'unfave' => Bool, ]);
```
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:
2017-11-15 13:41:58 +01:00
* 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:
2017-11-15 13:41:58 +01:00
POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.faveSticker`
2017-07-23 16:11:02 +02:00
Parameters:
2017-11-15 13:41:58 +01:00
id - Json encoded InputDocument
2017-08-20 19:09:52 +02:00
2017-11-15 13:41:58 +01: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:
```
2017-11-15 13:41:58 +01:00
Bool = messages.faveSticker({id=InputDocument, unfave=Bool, })
```