MadelineProto/docs/API_docs/methods/stickers_createStickerSet.md

96 lines
2.6 KiB
Markdown
Raw Normal View History

2017-06-30 15:36:33 +02:00
---
title: stickers.createStickerSet
description: stickers.createStickerSet parameters, return type and example
---
## Method: stickers.createStickerSet
[Back to methods index](index.md)
### Parameters:
| Name | Type | Required |
2017-08-20 11:05:56 +02:00
|----------|---------------|----------|
2017-06-30 15:36:33 +02:00
|masks|[Bool](../types/Bool.md) | Optional|
|user\_id|[InputUser](../types/InputUser.md) | Yes|
|title|[string](../types/string.md) | Yes|
|short\_name|[string](../types/string.md) | Yes|
|stickers|Array of [InputStickerSetItem](../types/InputStickerSetItem.md) | Yes|
### Return type: [messages\_StickerSet](../types/messages_StickerSet.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 |
|----------|---------------|
|BOT_MISSING|This method can only be run by a bot|
|PACK_SHORT_NAME_INVALID|Short pack name invalid|
2017-11-08 13:04:40 +01:00
|PACK_SHORT_NAME_OCCUPIED|A stickerpack with this name already exists|
2017-11-03 17:39:50 +01:00
|PEER_ID_INVALID|The provided peer id is invalid|
2017-11-08 13:04:40 +01:00
|STICKER_EMOJI_INVALID|Sticker emoji invalid|
|STICKER_FILE_INVALID|Sticker file invalid|
|STICKER_PNG_DIMENSIONS|Sticker png dimensions invalid|
2017-11-03 17:39:50 +01:00
|STICKERS_EMPTY|No sticker provided|
|USER_ID_INVALID|The provided user ID is invalid|
2017-06-30 15:36:33 +02:00
### Example:
```
$MadelineProto = new \danog\MadelineProto\API();
2017-12-11 12:12:38 +01:00
$MadelineProto->session = 'mySession.madeline';
2017-06-30 15:36:33 +02:00
if (isset($token)) { // Login as a bot
$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
2017-06-30 15:36:33 +02:00
$MadelineProto->complete_phone_login($code);
}
2017-07-23 16:33:46 +02:00
$messages_StickerSet = $MadelineProto->stickers->createStickerSet(['masks' => Bool, 'user_id' => InputUser, 'title' => 'string', 'short_name' => 'string', 'stickers' => [InputStickerSetItem], ]);
2017-06-30 15:36:33 +02: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 - stickers.createStickerSet
2017-07-23 16:40:54 +02:00
* params - `{"masks": Bool, "user_id": InputUser, "title": "string", "short_name": "string", "stickers": [InputStickerSetItem], }`
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/stickers.createStickerSet`
Parameters:
masks - Json encoded Bool
2017-08-20 19:09:52 +02:00
2017-07-23 16:11:02 +02:00
user_id - Json encoded InputUser
2017-08-20 19:09:52 +02:00
2017-07-23 16:11:02 +02:00
title - Json encoded string
2017-08-20 19:09:52 +02:00
2017-07-23 16:11:02 +02:00
short_name - Json encoded string
2017-08-20 19:09:52 +02:00
2017-07-23 16:11:02 +02:00
stickers - Json encoded array of InputStickerSetItem
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-06-30 15:36:33 +02:00
Or, if you're into Lua:
```
2017-07-23 16:33:46 +02:00
messages_StickerSet = stickers.createStickerSet({masks=Bool, user_id=InputUser, title='string', short_name='string', stickers={InputStickerSetItem}, })
2017-06-30 15:36:33 +02:00
```