MadelineProto/docs/API_docs/methods/messages_faveSticker.md

82 lines
1.6 KiB
Markdown
Raw Normal View History

---
title: messages.faveSticker
description: messages.faveSticker parameters, return type and example
---
## Method: messages.faveSticker
[Back to methods index](index.md)
### Parameters:
| Name | Type | Required |
|----------|---------------|----------|
|id|[InputDocument](../types/InputDocument.md) | Yes|
|unfave|[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|
### Example:
```
$MadelineProto = new \danog\MadelineProto\API();
if (isset($token)) { // Login as a bot
$MadelineProto->bot_login($token);
}
if (isset($number)) { // Login as a user
$sentCode = $MadelineProto->phone_login($number);
echo 'Enter the code you received: ';
$code = '';
for ($x = 0; $x < $sentCode['type']['length']; $x++) {
$code .= fgetc(STDIN);
}
$MadelineProto->complete_phone_login($code);
}
$Bool = $MadelineProto->messages->faveSticker(['id' => InputDocument, 'unfave' => Bool, ]);
```
Or, if you're using the [PWRTelegram HTTP API](https://pwrtelegram.xyz):
### As a bot:
POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline`
Parameters:
* method - messages.faveSticker
* params - `{"id": InputDocument, "unfave": Bool, }`
### As a user:
POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.faveSticker`
Parameters:
id - Json encoded InputDocument
unfave - Json encoded Bool
Or, if you're into Lua:
```
Bool = messages.faveSticker({id=InputDocument, unfave=Bool, })
```