danog/MadelineProto
2
2
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Merge branch 'master' of https://github.com/danog/Madelineproto

Browse Source
This commit is contained in:
Daniil Gentili 2017-09-17 16:21:17 +00:00
commit 980a7fef27
4187 changed files with 38918 additions and 44224 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -1,5 +1,7 @@
# MadelineProto, a PHP MTProto telegram client
Do join the official channel, [@MadelineProto](https://t.me/MadelineProto)!
This library can be used to create php telegram bots (like bot API bots, only better) and php telegram userbots (like tg-cli userbots, only better).
This library can also be used to create lua telegram bots (like bot API bots, only better) and lua telegram userbots (like tg-cli userbots, only better).
@ -154,6 +156,9 @@ Use `bot_login` to login as a bot, see [here for the parameters and the result](
Note that when you login as a bot, MadelineProto also logins using the [PWRTelegram](https://pwrtelegram.xyz) API, to allow persistant storage of peers, even after a logout and another login.
Use `logout` to logout, see [here for the parameters and the result](https://daniil.it/MadelineProto/logout.html).
Use `get_pwr_chat` to get chat info, see [here for the parameters and the result](https://daniil.it/MadelineProto/get_pwr_chat.html).
You can also use `get_info` to get chat info, see [here for the parameters and the result](https://daniil.it/MadelineProto/get_info.html)
You can also use `get_full_info` to get chat info, see [here for the parameters and the result](https://daniil.it/MadelineProto/get_full_info.html).
@ -618,9 +623,23 @@ An istance of MadelineProto can be safely serialized or unserialized. To seriali
$MadelineProto = \danog\MadelineProto\Serialization::deserialize('session.madeline');
// Do stuff
\danog\MadelineProto\Serialization::serialize('session.madeline', $MadelineProto);
// or
$MadelineProto->serialize('session.madeline');
```
THe deserialize method accepts a second optional parameter, `$no_updates`, that can be set to true to avoid fetching updates on deserialization, and postpone parsing of updates received through the socket until the next deserialization.
Or
```
$MadelineProto = \danog\MadelineProto\Serialization::deserialize('session.madeline');
$MadelineProto->session = 'session.madeline';
```
This way, if the scripts shutsdown normally (without ctrl+c or fatal errors/exceptions), the session will be serialized automatically.
It is still recommended to serialize the session at every update.
The deserialize method accepts a second optional parameter, `$no_updates`, that can be set to true to avoid fetching updates on deserialization, and postpone parsing of updates received through the socket until the next deserialization.
That class serializes using [MagicalSerializer](https://github.com/danog/MagicalSerializer).
The same should be done when serializing to another destination manually, to avoid conflicts with other PHP scripts that are trying to serialize another instance of the class.

1
build_docs.php
View File

@ -30,6 +30,7 @@ $docs = [
'description' => 'MadelineProto API documentation (td-lib)',
'output_dir' => __DIR__.'/docs/TD_docs',
'readme' => false,
'td' => true,
],
[
'tl_schema' => ['mtproto' => __DIR__.'/src/danog/MadelineProto/TL_mtproto_v1.json'],

12
docs/API_docs/constructors/messageEntityBold.md
View File

@ -1,20 +1,18 @@
---
title: messageEntityBold
description: Bold text
description: messageEntityBold attributes, type and example
---
## Constructor: messageEntityBold
[Back to constructors index](index.md)
Bold text
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|offset|[int](../types/int.md) | Yes|Offset of the entity in UTF-16 code points|
|length|[int](../types/int.md) | Yes|Length of the entity in UTF-16 code points|
| Name | Type | Required |
|----------|---------------|----------|
|offset|[int](../types/int.md) | Yes|
|length|[int](../types/int.md) | Yes|

12
docs/API_docs/constructors/messageEntityBotCommand.md
View File

@ -1,20 +1,18 @@
---
title: messageEntityBotCommand
description: Bot command beginning with /
description: messageEntityBotCommand attributes, type and example
---
## Constructor: messageEntityBotCommand
[Back to constructors index](index.md)
Bot command beginning with /
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|offset|[int](../types/int.md) | Yes|Offset of the entity in UTF-16 code points|
|length|[int](../types/int.md) | Yes|Length of the entity in UTF-16 code points|
| Name | Type | Required |
|----------|---------------|----------|
|offset|[int](../types/int.md) | Yes|
|length|[int](../types/int.md) | Yes|

12
docs/API_docs/constructors/messageEntityCode.md
View File

@ -1,20 +1,18 @@
---
title: messageEntityCode
description: Text needs to be formatted as inside of code HTML tag
description: messageEntityCode attributes, type and example
---
## Constructor: messageEntityCode
[Back to constructors index](index.md)
Text needs to be formatted as inside of code HTML tag
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|offset|[int](../types/int.md) | Yes|Offset of the entity in UTF-16 code points|
|length|[int](../types/int.md) | Yes|Length of the entity in UTF-16 code points|
| Name | Type | Required |
|----------|---------------|----------|
|offset|[int](../types/int.md) | Yes|
|length|[int](../types/int.md) | Yes|

12
docs/API_docs/constructors/messageEntityEmail.md
View File

@ -1,20 +1,18 @@
---
title: messageEntityEmail
description: Email
description: messageEntityEmail attributes, type and example
---
## Constructor: messageEntityEmail
[Back to constructors index](index.md)
Email
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|offset|[int](../types/int.md) | Yes|Offset of the entity in UTF-16 code points|
|length|[int](../types/int.md) | Yes|Length of the entity in UTF-16 code points|
| Name | Type | Required |
|----------|---------------|----------|
|offset|[int](../types/int.md) | Yes|
|length|[int](../types/int.md) | Yes|

12
docs/API_docs/constructors/messageEntityHashtag.md
View File

@ -1,20 +1,18 @@
---
title: messageEntityHashtag
description: Hashtag beginning with #
description: messageEntityHashtag attributes, type and example
---
## Constructor: messageEntityHashtag
[Back to constructors index](index.md)
Hashtag beginning with #
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|offset|[int](../types/int.md) | Yes|Offset of the entity in UTF-16 code points|
|length|[int](../types/int.md) | Yes|Length of the entity in UTF-16 code points|
| Name | Type | Required |
|----------|---------------|----------|
|offset|[int](../types/int.md) | Yes|
|length|[int](../types/int.md) | Yes|

12
docs/API_docs/constructors/messageEntityItalic.md
View File

@ -1,20 +1,18 @@
---
title: messageEntityItalic
description: Italic text
description: messageEntityItalic attributes, type and example
---
## Constructor: messageEntityItalic
[Back to constructors index](index.md)
Italic text
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|offset|[int](../types/int.md) | Yes|Offset of the entity in UTF-16 code points|
|length|[int](../types/int.md) | Yes|Length of the entity in UTF-16 code points|
| Name | Type | Required |
|----------|---------------|----------|
|offset|[int](../types/int.md) | Yes|
|length|[int](../types/int.md) | Yes|

12
docs/API_docs/constructors/messageEntityMention.md
View File

@ -1,20 +1,18 @@
---
title: messageEntityMention
description: Mention of the user by his username
description: messageEntityMention attributes, type and example
---
## Constructor: messageEntityMention
[Back to constructors index](index.md)
Mention of the user by his username
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|offset|[int](../types/int.md) | Yes|Offset of the entity in UTF-16 code points|
|length|[int](../types/int.md) | Yes|Length of the entity in UTF-16 code points|
| Name | Type | Required |
|----------|---------------|----------|
|offset|[int](../types/int.md) | Yes|
|length|[int](../types/int.md) | Yes|

14
docs/API_docs/constructors/messageEntityMentionName.md
View File

@ -1,21 +1,19 @@
---
title: messageEntityMentionName
description: Mention of the user by some text
description: messageEntityMentionName attributes, type and example
---
## Constructor: messageEntityMentionName
[Back to constructors index](index.md)
Mention of the user by some text
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|offset|[int](../types/int.md) | Yes|Offset of the entity in UTF-16 code points|
|length|[int](../types/int.md) | Yes|Length of the entity in UTF-16 code points|
|user\_id|[int](../types/int.md) | Yes|Identifier of the mentioned user|
| Name | Type | Required |
|----------|---------------|----------|
|offset|[int](../types/int.md) | Yes|
|length|[int](../types/int.md) | Yes|
|user\_id|[int](../types/int.md) | Yes|

14
docs/API_docs/constructors/messageEntityTextUrl.md
View File

@ -1,21 +1,19 @@
---
title: messageEntityTextUrl
description: Text description showed instead of the url
description: messageEntityTextUrl attributes, type and example
---
## Constructor: messageEntityTextUrl
[Back to constructors index](index.md)
Text description showed instead of the url
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|offset|[int](../types/int.md) | Yes|Offset of the entity in UTF-16 code points|
|length|[int](../types/int.md) | Yes|Length of the entity in UTF-16 code points|
|url|[string](../types/string.md) | Yes|Url to be opened after link will be clicked|
| Name | Type | Required |
|----------|---------------|----------|
|offset|[int](../types/int.md) | Yes|
|length|[int](../types/int.md) | Yes|
|url|[string](../types/string.md) | Yes|

12
docs/API_docs/constructors/messageEntityUrl.md
View File

@ -1,20 +1,18 @@
---
title: messageEntityUrl
description: Url beginning with http
description: messageEntityUrl attributes, type and example
---
## Constructor: messageEntityUrl
[Back to constructors index](index.md)
Url beginning with http
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|offset|[int](../types/int.md) | Yes|Offset of the entity in UTF-16 code points|
|length|[int](../types/int.md) | Yes|Length of the entity in UTF-16 code points|
| Name | Type | Required |
|----------|---------------|----------|
|offset|[int](../types/int.md) | Yes|
|length|[int](../types/int.md) | Yes|

10
docs/API_docs/constructors/pageBlockAnchor.md
View File

@ -1,17 +1,19 @@
---
title: pageBlockAnchor
description: pageBlockAnchor attributes, type and example
description: Invisible anchor on a page which can be used in a URL to open a page from the specified anchor
---
## Constructor: pageBlockAnchor
[Back to constructors index](index.md)
Invisible anchor on a page which can be used in a URL to open a page from the specified anchor
### Attributes:
| Name | Type | Required |
|----------|---------------|----------|
|name|[string](../types/string.md) | Yes|
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|name|[string](../types/string.md) | Yes|Name of the anchor|

10
docs/API_docs/constructors/pageBlockCover.md
View File

@ -1,17 +1,19 @@
---
title: pageBlockCover
description: pageBlockCover attributes, type and example
description: Page cover
---
## Constructor: pageBlockCover
[Back to constructors index](index.md)
Page cover
### Attributes:
| Name | Type | Required |
|----------|---------------|----------|
|cover|[PageBlock](../types/PageBlock.md) | Yes|
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|cover|[PageBlock](../types/PageBlock.md) | Yes|The cover|

8
docs/API_docs/constructors/pageBlockDivider.md
View File

@ -1,12 +1,18 @@
---
title: pageBlockDivider
description: pageBlockDivider attributes, type and example
description: An empty block separating parts of a page
---
## Constructor: pageBlockDivider
[Back to constructors index](index.md)
An empty block separating parts of a page
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|

10
docs/API_docs/constructors/pageBlockParagraph.md
View File

@ -1,17 +1,19 @@
---
title: pageBlockParagraph
description: pageBlockParagraph attributes, type and example
description: A text paragraph
---
## Constructor: pageBlockParagraph
[Back to constructors index](index.md)
A text paragraph
### Attributes:
| Name | Type | Required |
|----------|---------------|----------|
|text|[RichText](../types/RichText.md) | Yes|
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|text|[RichText](../types/RichText.md) | Yes|Paragraph text|

12
docs/API_docs/constructors/pageBlockPreformatted.md
View File

@ -1,18 +1,20 @@
---
title: pageBlockPreformatted
description: pageBlockPreformatted attributes, type and example
description: Preformatted text paragraph
---
## Constructor: pageBlockPreformatted
[Back to constructors index](index.md)
Preformatted text paragraph
### Attributes:
| Name | Type | Required |
|----------|---------------|----------|
|text|[RichText](../types/RichText.md) | Yes|
|language|[string](../types/string.md) | Yes|
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|text|[RichText](../types/RichText.md) | Yes|Paragraph text|
|language|[string](../types/string.md) | Yes|Programming language for which the text should be formatted|

8
docs/API_docs/constructors/sendMessageCancelAction.md
View File

@ -1,18 +1,12 @@
---
title: sendMessageCancelAction
description: User cancels typing
description: sendMessageCancelAction attributes, type and example
---
## Constructor: sendMessageCancelAction
[Back to constructors index](index.md)
User cancels typing
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|

8
docs/API_docs/constructors/sendMessageCancelAction_17.md
View File

@ -1,18 +1,12 @@
---
title: sendMessageCancelAction
description: User cancels typing
description: sendMessageCancelAction attributes, type and example
---
## Constructor: sendMessageCancelAction\_17
[Back to constructors index](index.md)
User cancels typing
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|

8
docs/API_docs/constructors/sendMessageChooseContactAction.md
View File

@ -1,18 +1,12 @@
---
title: sendMessageChooseContactAction
description: User chooses contact to send
description: sendMessageChooseContactAction attributes, type and example
---
## Constructor: sendMessageChooseContactAction
[Back to constructors index](index.md)
User chooses contact to send
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|

8
docs/API_docs/constructors/sendMessageChooseContactAction_17.md
View File

@ -1,18 +1,12 @@
---
title: sendMessageChooseContactAction
description: User chooses contact to send
description: sendMessageChooseContactAction attributes, type and example
---
## Constructor: sendMessageChooseContactAction\_17
[Back to constructors index](index.md)
User chooses contact to send
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|

8
docs/API_docs/constructors/sendMessageGeoLocationAction.md
View File

@ -1,18 +1,12 @@
---
title: sendMessageGeoLocationAction
description: User sends geolocation
description: sendMessageGeoLocationAction attributes, type and example
---
## Constructor: sendMessageGeoLocationAction
[Back to constructors index](index.md)
User sends geolocation
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|

8
docs/API_docs/constructors/sendMessageGeoLocationAction_17.md
View File

@ -1,18 +1,12 @@
---
title: sendMessageGeoLocationAction
description: User sends geolocation
description: sendMessageGeoLocationAction attributes, type and example
---
## Constructor: sendMessageGeoLocationAction\_17
[Back to constructors index](index.md)
User sends geolocation
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|

8
docs/API_docs/constructors/sendMessageRecordVideoAction.md
View File

@ -1,18 +1,12 @@
---
title: sendMessageRecordVideoAction
description: User records a video
description: sendMessageRecordVideoAction attributes, type and example
---
## Constructor: sendMessageRecordVideoAction
[Back to constructors index](index.md)
User records a video
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|

8
docs/API_docs/constructors/sendMessageRecordVideoAction_17.md
View File

@ -1,18 +1,12 @@
---
title: sendMessageRecordVideoAction
description: User records a video
description: sendMessageRecordVideoAction attributes, type and example
---
## Constructor: sendMessageRecordVideoAction\_17
[Back to constructors index](index.md)
User records a video
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|

8
docs/API_docs/constructors/sendMessageTypingAction.md
View File

@ -1,18 +1,12 @@
---
title: sendMessageTypingAction
description: User typing message
description: sendMessageTypingAction attributes, type and example
---
## Constructor: sendMessageTypingAction
[Back to constructors index](index.md)
User typing message
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|

8
docs/API_docs/constructors/sendMessageTypingAction_17.md
View File

@ -1,18 +1,12 @@
---
title: sendMessageTypingAction
description: User typing message
description: sendMessageTypingAction attributes, type and example
---
## Constructor: sendMessageTypingAction\_17
[Back to constructors index](index.md)
User typing message
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|

10
docs/API_docs/constructors/sendMessageUploadDocumentAction.md
View File

@ -1,19 +1,17 @@
---
title: sendMessageUploadDocumentAction
description: User uploads a document
description: sendMessageUploadDocumentAction attributes, type and example
---
## Constructor: sendMessageUploadDocumentAction
[Back to constructors index](index.md)
User uploads a document
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|progress|[int](../types/int.md) | Yes|Upload progress in percents|
| Name | Type | Required |
|----------|---------------|----------|
|progress|[int](../types/int.md) | Yes|

8
docs/API_docs/constructors/sendMessageUploadDocumentAction_17.md
View File

@ -1,18 +1,12 @@
---
title: sendMessageUploadDocumentAction
description: User uploads a document
description: sendMessageUploadDocumentAction attributes, type and example
---
## Constructor: sendMessageUploadDocumentAction\_17
[Back to constructors index](index.md)
User uploads a document
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|

10
docs/API_docs/constructors/sendMessageUploadPhotoAction.md
View File

@ -1,19 +1,17 @@
---
title: sendMessageUploadPhotoAction
description: User uploads a photo
description: sendMessageUploadPhotoAction attributes, type and example
---
## Constructor: sendMessageUploadPhotoAction
[Back to constructors index](index.md)
User uploads a photo
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|progress|[int](../types/int.md) | Yes|Upload progress in percents|
| Name | Type | Required |
|----------|---------------|----------|
|progress|[int](../types/int.md) | Yes|

8
docs/API_docs/constructors/sendMessageUploadPhotoAction_17.md
View File

@ -1,18 +1,12 @@
---
title: sendMessageUploadPhotoAction
description: User uploads a photo
description: sendMessageUploadPhotoAction attributes, type and example
---
## Constructor: sendMessageUploadPhotoAction\_17
[Back to constructors index](index.md)
User uploads a photo
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|

10
docs/API_docs/constructors/sendMessageUploadVideoAction.md
View File

@ -1,19 +1,17 @@
---
title: sendMessageUploadVideoAction
description: User uploads a video
description: sendMessageUploadVideoAction attributes, type and example
---
## Constructor: sendMessageUploadVideoAction
[Back to constructors index](index.md)
User uploads a video
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|progress|[int](../types/int.md) | Yes|Upload progress in percents|
| Name | Type | Required |
|----------|---------------|----------|
|progress|[int](../types/int.md) | Yes|

8
docs/API_docs/constructors/sendMessageUploadVideoAction_17.md
View File

@ -1,18 +1,12 @@
---
title: sendMessageUploadVideoAction
description: User uploads a video
description: sendMessageUploadVideoAction attributes, type and example
---
## Constructor: sendMessageUploadVideoAction\_17
[Back to constructors index](index.md)
User uploads a video
### Attributes:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|

22
docs/API_docs/methods/account_changePhone.md
View File

@ -17,14 +17,21 @@ description: account.changePhone parameters, return type and example
### Return type: [User](../types/User.md)
### Can bots use this method: **NO**
### Errors this method can return:
| Error | Description |
|----------|---------------|
|PHONE_NUMBER_INVALID|The phone number 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: ';
@ -40,15 +47,6 @@ $User = $MadelineProto->account->changePhone(['phone_number' => 'string', 'phone
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 - account.changePhone
* params - `{"phone_number": "string", "phone_code_hash": "string", "phone_code": "string", }`
### As a user:

22
docs/API_docs/methods/account_checkUsername.md
View File

@ -15,14 +15,21 @@ description: account.checkUsername parameters, return type and example
### Return type: [Bool](../types/Bool.md)
### Can bots use this method: **NO**
### Errors this method can return:
| Error | Description |
|----------|---------------|
|USERNAME_INVALID|The provided username is not valid|
### 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: ';
@ -38,15 +45,6 @@ $Bool = $MadelineProto->account->checkUsername(['username' => 'string', ]);
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 - account.checkUsername
* params - `{"username": "string", }`
### As a user:

22
docs/API_docs/methods/account_confirmPhone.md
View File

@ -16,14 +16,21 @@ description: account.confirmPhone parameters, return type and example
### Return type: [Bool](../types/Bool.md)
### Can bots use this method: **NO**
### Errors this method can return:
| Error | Description |
|----------|---------------|
|PHONE_CODE_EMPTY|phone_code is missing|
### 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: ';
@ -39,15 +46,6 @@ $Bool = $MadelineProto->account->confirmPhone(['phone_code_hash' => 'string', 'p
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 - account.confirmPhone
* params - `{"phone_code_hash": "string", "phone_code": "string", }`
### As a user:

15
docs/API_docs/methods/account_deleteAccount.md
View File

@ -15,14 +15,14 @@ description: account.deleteAccount parameters, return type and example
### Return type: [Bool](../types/Bool.md)
### Can bots use this method: **NO**
### 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: ';
@ -38,15 +38,6 @@ $Bool = $MadelineProto->account->deleteAccount(['reason' => 'string', ]);
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 - account.deleteAccount
* params - `{"reason": "string", }`
### As a user:

15
docs/API_docs/methods/account_getAccountTTL.md
View File

@ -10,14 +10,14 @@ description: account.getAccountTTL parameters, return type and example
### Return type: [AccountDaysTTL](../types/AccountDaysTTL.md)
### Can bots use this method: **NO**
### 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: ';
@ -33,15 +33,6 @@ $AccountDaysTTL = $MadelineProto->account->getAccountTTL();
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 - account.getAccountTTL
* params - `{}`
### As a user:

15
docs/API_docs/methods/account_getAuthorizations.md
View File

@ -10,14 +10,14 @@ description: account.getAuthorizations parameters, return type and example
### Return type: [account\_Authorizations](../types/account_Authorizations.md)
### Can bots use this method: **NO**
### 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: ';
@ -33,15 +33,6 @@ $account_Authorizations = $MadelineProto->account->getAuthorizations();
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 - account.getAuthorizations
* params - `{}`
### As a user:

22
docs/API_docs/methods/account_getNotifySettings.md
View File

@ -15,14 +15,21 @@ description: account.getNotifySettings parameters, return type and example
### Return type: [PeerNotifySettings](../types/PeerNotifySettings.md)
### Can bots use this method: **NO**
### Errors this method can return:
| Error | Description |
|----------|---------------|
|PEER_ID_INVALID|The provided peer 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: ';
@ -38,15 +45,6 @@ $PeerNotifySettings = $MadelineProto->account->getNotifySettings(['peer' => Inpu
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 - account.getNotifySettings
* params - `{"peer": InputNotifyPeer, }`
### As a user:

15
docs/API_docs/methods/account_getPassword.md
View File

@ -10,14 +10,14 @@ description: account.getPassword parameters, return type and example
### Return type: [account\_Password](../types/account_Password.md)
### Can bots use this method: **NO**
### 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: ';
@ -33,15 +33,6 @@ $account_Password = $MadelineProto->account->getPassword();
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 - account.getPassword
* params - `{}`
### As a user:

15
docs/API_docs/methods/account_getPasswordSettings.md
View File

@ -15,14 +15,14 @@ description: account.getPasswordSettings parameters, return type and example
### Return type: [account\_PasswordSettings](../types/account_PasswordSettings.md)
### Can bots use this method: **NO**
### 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: ';
@ -38,15 +38,6 @@ $account_PasswordSettings = $MadelineProto->account->getPasswordSettings(['curre
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 - account.getPasswordSettings
* params - `{"current_password_hash": "bytes", }`
### As a user:

22
docs/API_docs/methods/account_getPrivacy.md
View File

@ -15,14 +15,21 @@ description: account.getPrivacy parameters, return type and example
### Return type: [account\_PrivacyRules](../types/account_PrivacyRules.md)
### Can bots use this method: **NO**
### Errors this method can return:
| Error | Description |
|----------|---------------|
|PRIVACY_KEY_INVALID|The privacy key 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: ';
@ -38,15 +45,6 @@ $account_PrivacyRules = $MadelineProto->account->getPrivacy(['key' => InputPriva
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 - account.getPrivacy
* params - `{"key": InputPrivacyKey, }`
### As a user:

22
docs/API_docs/methods/account_getTmpPassword.md
View File

@ -16,14 +16,21 @@ description: account.getTmpPassword parameters, return type and example
### Return type: [account\_TmpPassword](../types/account_TmpPassword.md)
### Can bots use this method: **NO**
### Errors this method can return:
| Error | Description |
|----------|---------------|
|TMP_PASSWORD_DISABLED|The temporary password is disabled|
### 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: ';
@ -39,15 +46,6 @@ $account_TmpPassword = $MadelineProto->account->getTmpPassword(['password_hash'
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 - account.getTmpPassword
* params - `{"password_hash": "bytes", "period": int, }`
### As a user:

15
docs/API_docs/methods/account_getWallPapers.md
View File

@ -10,14 +10,14 @@ description: account.getWallPapers parameters, return type and example
### Return type: [Vector\_of\_WallPaper](../types/WallPaper.md)
### Can bots use this method: **NO**
### 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: ';
@ -33,15 +33,6 @@ $Vector_of_WallPaper = $MadelineProto->account->getWallPapers();
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 - account.getWallPapers
* params - `{}`
### As a user:

22
docs/API_docs/methods/account_registerDevice.md
View File

@ -16,14 +16,21 @@ description: account.registerDevice parameters, return type and example
### Return type: [Bool](../types/Bool.md)
### Can bots use this method: **NO**
### Errors this method can return:
| Error | Description |
|----------|---------------|
|TOKEN_INVALID|The provided token 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: ';
@ -39,15 +46,6 @@ $Bool = $MadelineProto->account->registerDevice(['token_type' => int, 'token' =>
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 - account.registerDevice
* params - `{"token_type": int, "token": "string", }`
### As a user:

22
docs/API_docs/methods/account_reportPeer.md
View File

@ -16,14 +16,21 @@ description: account.reportPeer parameters, return type and example
### Return type: [Bool](../types/Bool.md)
### Can bots use this method: **NO**
### Errors this method can return:
| Error | Description |
|----------|---------------|
|PEER_ID_INVALID|The provided peer 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: ';
@ -39,15 +46,6 @@ $Bool = $MadelineProto->account->reportPeer(['peer' => InputPeer, 'reason' => Re
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 - account.reportPeer
* params - `{"peer": InputPeer, "reason": ReportReason, }`
### As a user:

22
docs/API_docs/methods/account_resetAuthorization.md
View File

@ -15,14 +15,21 @@ description: account.resetAuthorization parameters, return type and example
### Return type: [Bool](../types/Bool.md)
### Can bots use this method: **NO**
### Errors this method can return:
| Error | Description |
|----------|---------------|
|HASH_INVALID|The provided hash 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: ';
@ -38,15 +45,6 @@ $Bool = $MadelineProto->account->resetAuthorization(['hash' => long, ]);
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 - account.resetAuthorization
* params - `{"hash": long, }`
### As a user:

15
docs/API_docs/methods/account_resetNotifySettings.md
View File

@ -10,14 +10,14 @@ description: account.resetNotifySettings parameters, return type and example
### Return type: [Bool](../types/Bool.md)
### Can bots use this method: **NO**
### 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: ';
@ -33,15 +33,6 @@ $Bool = $MadelineProto->account->resetNotifySettings();
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 - account.resetNotifySettings
* params - `{}`
### As a user:

22
docs/API_docs/methods/account_sendChangePhoneCode.md
View File

@ -17,14 +17,21 @@ description: account.sendChangePhoneCode parameters, return type and example
### Return type: [auth\_SentCode](../types/auth_SentCode.md)
### Can bots use this method: **NO**
### Errors this method can return:
| Error | Description |
|----------|---------------|
|PHONE_NUMBER_INVALID|The phone number 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: ';
@ -40,15 +47,6 @@ $auth_SentCode = $MadelineProto->account->sendChangePhoneCode(['allow_flashcall'
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 - account.sendChangePhoneCode
* params - `{"allow_flashcall": Bool, "phone_number": "string", "current_number": Bool, }`
### As a user:

22
docs/API_docs/methods/account_sendConfirmPhoneCode.md
View File

@ -17,14 +17,21 @@ description: account.sendConfirmPhoneCode parameters, return type and example
### Return type: [auth\_SentCode](../types/auth_SentCode.md)
### Can bots use this method: **NO**
### Errors this method can return:
| Error | Description |
|----------|---------------|
|HASH_INVALID|The provided hash 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: ';
@ -40,15 +47,6 @@ $auth_SentCode = $MadelineProto->account->sendConfirmPhoneCode(['allow_flashcall
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 - account.sendConfirmPhoneCode
* params - `{"allow_flashcall": Bool, "hash": "string", "current_number": Bool, }`
### As a user:

22
docs/API_docs/methods/account_setAccountTTL.md
View File

@ -15,14 +15,21 @@ description: account.setAccountTTL parameters, return type and example
### Return type: [Bool](../types/Bool.md)
### Can bots use this method: **NO**
### Errors this method can return:
| Error | Description |
|----------|---------------|
|TTL_DAYS_INVALID|The provided TTL 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: ';
@ -38,15 +45,6 @@ $Bool = $MadelineProto->account->setAccountTTL(['ttl' => AccountDaysTTL, ]);
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 - account.setAccountTTL
* params - `{"ttl": AccountDaysTTL, }`
### As a user:

22
docs/API_docs/methods/account_setPrivacy.md
View File

@ -16,14 +16,21 @@ description: account.setPrivacy parameters, return type and example
### Return type: [account\_PrivacyRules](../types/account_PrivacyRules.md)
### Can bots use this method: **NO**
### Errors this method can return:
| Error | Description |
|----------|---------------|
|PRIVACY_KEY_INVALID|The privacy key 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: ';
@ -39,15 +46,6 @@ $account_PrivacyRules = $MadelineProto->account->setPrivacy(['key' => InputPriva
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 - account.setPrivacy
* params - `{"key": InputPrivacyKey, "rules": [InputPrivacyRule], }`
### As a user:

22
docs/API_docs/methods/account_unregisterDevice.md
View File

@ -16,14 +16,21 @@ description: account.unregisterDevice parameters, return type and example
### Return type: [Bool](../types/Bool.md)
### Can bots use this method: **NO**
### Errors this method can return:
| Error | Description |
|----------|---------------|
|TOKEN_INVALID|The provided token 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: ';
@ -39,15 +46,6 @@ $Bool = $MadelineProto->account->unregisterDevice(['token_type' => int, 'token'
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 - account.unregisterDevice
* params - `{"token_type": int, "token": "string", }`
### As a user:

15
docs/API_docs/methods/account_updateDeviceLocked.md
View File

@ -15,14 +15,14 @@ description: account.updateDeviceLocked parameters, return type and example
### Return type: [Bool](../types/Bool.md)
### Can bots use this method: **NO**
### 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: ';
@ -38,15 +38,6 @@ $Bool = $MadelineProto->account->updateDeviceLocked(['period' => int, ]);
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 - account.updateDeviceLocked
* params - `{"period": int, }`
### As a user:

22
docs/API_docs/methods/account_updateNotifySettings.md
View File

@ -16,14 +16,21 @@ description: account.updateNotifySettings parameters, return type and example
### Return type: [Bool](../types/Bool.md)
### Can bots use this method: **NO**
### Errors this method can return:
| Error | Description |
|----------|---------------|
|PEER_ID_INVALID|The provided peer 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: ';
@ -39,15 +46,6 @@ $Bool = $MadelineProto->account->updateNotifySettings(['peer' => InputNotifyPeer
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 - account.updateNotifySettings
* params - `{"peer": InputNotifyPeer, "settings": InputPeerNotifySettings, }`
### As a user:

22
docs/API_docs/methods/account_updatePasswordSettings.md
View File

@ -16,14 +16,21 @@ description: account.updatePasswordSettings parameters, return type and example
### Return type: [Bool](../types/Bool.md)
### Can bots use this method: **NO**
### Errors this method can return:
| Error | Description |
|----------|---------------|
|NEW_SETTINGS_INVALID|The new settings are 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: ';
@ -39,15 +46,6 @@ $Bool = $MadelineProto->account->updatePasswordSettings(['current_password_hash'
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 - account.updatePasswordSettings
* params - `{"current_password_hash": "bytes", "new_settings": account_PasswordInputSettings, }`
### As a user:

23
docs/API_docs/methods/account_updateProfile.md
View File

@ -17,14 +17,22 @@ description: account.updateProfile parameters, return type and example
### Return type: [User](../types/User.md)
### Can bots use this method: **NO**
### Errors this method can return:
| Error | Description |
|----------|---------------|
|ABOUT_TOO_LONG|The provided bio is too long|
|FIRSTNAME_INVALID|The first name 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: ';
@ -40,15 +48,6 @@ $User = $MadelineProto->account->updateProfile(['first_name' => 'string', 'last_
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 - account.updateProfile
* params - `{"first_name": "string", "last_name": "string", "about": "string", }`
### As a user:

15
docs/API_docs/methods/account_updateStatus.md
View File

@ -15,14 +15,14 @@ description: account.updateStatus parameters, return type and example
### Return type: [Bool](../types/Bool.md)
### Can bots use this method: **NO**
### 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: ';
@ -38,15 +38,6 @@ $Bool = $MadelineProto->account->updateStatus(['offline' => 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 - account.updateStatus
* params - `{"offline": Bool, }`
### As a user:

24
docs/API_docs/methods/account_updateUsername.md
View File

@ -15,14 +15,23 @@ description: account.updateUsername parameters, return type and example
### Return type: [User](../types/User.md)
### Can bots use this method: **NO**
### Errors this method can return:
| Error | Description |
|----------|---------------|
|USERNAME_INVALID|The provided username is not valid|
|USERNAME_NOT_MODIFIED|The username was not modified|
|USERNAME_OCCUPIED|The provided username is already occupied|
### 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: ';
@ -38,15 +47,6 @@ $User = $MadelineProto->account->updateUsername(['username' => 'string', ]);
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 - account.updateUsername
* params - `{"username": "string", }`
### As a user:

11
docs/API_docs/methods/auth_bindTempAuthKey.md
View File

@ -18,6 +18,17 @@ description: auth.bindTempAuthKey parameters, return type and example
### Return type: [Bool](../types/Bool.md)
### Can bots use this method: **YES**
### Errors this method can return:
| Error | Description |
|----------|---------------|
|ENCRYPTED_MESSAGE_INVALID|Encrypted message invalid|
|INPUT_REQUEST_TOO_LONG|The request is too big|
### Example:

22
docs/API_docs/methods/auth_cancelCode.md
View File

@ -16,14 +16,21 @@ description: auth.cancelCode parameters, return type and example
### Return type: [Bool](../types/Bool.md)
### Can bots use this method: **NO**
### Errors this method can return:
| Error | Description |
|----------|---------------|
|PHONE_NUMBER_INVALID|The phone number 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: ';
@ -39,15 +46,6 @@ $Bool = $MadelineProto->auth->cancelCode(['phone_number' => 'string', 'phone_cod
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 - auth.cancelCode
* params - `{"phone_number": "string", "phone_code_hash": "string", }`
### As a user:

22
docs/API_docs/methods/auth_checkPassword.md
View File

@ -15,14 +15,21 @@ description: auth.checkPassword parameters, return type and example
### Return type: [auth\_Authorization](../types/auth_Authorization.md)
### Can bots use this method: **NO**
### Errors this method can return:
| Error | Description |
|----------|---------------|
|PASSWORD_HASH_INVALID|The provided password hash 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: ';
@ -38,15 +45,6 @@ $auth_Authorization = $MadelineProto->auth->checkPassword(['password_hash' => 'b
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 - auth.checkPassword
* params - `{"password_hash": "bytes", }`
### As a user:

23
docs/API_docs/methods/auth_checkPhone.md
View File

@ -15,14 +15,22 @@ description: auth.checkPhone parameters, return type and example
### Return type: [auth\_CheckedPhone](../types/auth_CheckedPhone.md)
### Can bots use this method: **NO**
### Errors this method can return:
| Error | Description |
|----------|---------------|
|PHONE_NUMBER_BANNED|The provided phone number is banned from telegram|
|PHONE_NUMBER_INVALID|The phone number 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: ';
@ -38,15 +46,6 @@ $auth_CheckedPhone = $MadelineProto->auth->checkPhone(['phone_number' => 'string
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 - auth.checkPhone
* params - `{"phone_number": "string", }`
### As a user:

3
docs/API_docs/methods/auth_dropTempAuthKeys.md
View File

@ -15,6 +15,9 @@ description: auth.dropTempAuthKeys parameters, return type and example
### Return type: [Bool](../types/Bool.md)
### Can bots use this method: **YES**
### Example:

10
docs/API_docs/methods/auth_exportAuthorization.md
View File

@ -15,6 +15,16 @@ description: auth.exportAuthorization parameters, return type and example
### Return type: [auth\_ExportedAuthorization](../types/auth_ExportedAuthorization.md)
### Can bots use this method: **YES**
### Errors this method can return:
| Error | Description |
|----------|---------------|
|DC_ID_INVALID|The provided DC ID is invalid|
### Example:

11
docs/API_docs/methods/auth_importAuthorization.md
View File

@ -16,6 +16,17 @@ description: auth.importAuthorization parameters, return type and example
### Return type: [auth\_Authorization](../types/auth_Authorization.md)
### Can bots use this method: **YES**
### Errors this method can return:
| Error | Description |
|----------|---------------|
|AUTH_BYTES_INVALID|The provided authorization is invalid|
|USER_ID_INVALID|The provided user ID is invalid|
### Example:

22
docs/API_docs/methods/auth_recoverPassword.md
View File

@ -15,14 +15,21 @@ description: auth.recoverPassword parameters, return type and example
### Return type: [auth\_Authorization](../types/auth_Authorization.md)
### Can bots use this method: **NO**
### Errors this method can return:
| Error | Description |
|----------|---------------|
|CODE_EMPTY|The provided code is empty|
### 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: ';
@ -38,15 +45,6 @@ $auth_Authorization = $MadelineProto->auth->recoverPassword(['code' => 'string',
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 - auth.recoverPassword
* params - `{"code": "string", }`
### As a user:

22
docs/API_docs/methods/auth_requestPasswordRecovery.md
View File

@ -10,14 +10,21 @@ description: auth.requestPasswordRecovery parameters, return type and example
### Return type: [auth\_PasswordRecovery](../types/auth_PasswordRecovery.md)
### Can bots use this method: **NO**
### Errors this method can return:
| Error | Description |
|----------|---------------|
|PASSWORD_EMPTY|The provided password is empty|
### 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: ';
@ -33,15 +40,6 @@ $auth_PasswordRecovery = $MadelineProto->auth->requestPasswordRecovery();
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 - auth.requestPasswordRecovery
* params - `{}`
### As a user:

22
docs/API_docs/methods/auth_resendCode.md
View File

@ -16,14 +16,21 @@ description: auth.resendCode parameters, return type and example
### Return type: [auth\_SentCode](../types/auth_SentCode.md)
### Can bots use this method: **NO**
### Errors this method can return:
| Error | Description |
|----------|---------------|
|PHONE_NUMBER_INVALID|The phone number 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: ';
@ -39,15 +46,6 @@ $auth_SentCode = $MadelineProto->auth->resendCode(['phone_number' => 'string', '
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 - auth.resendCode
* params - `{"phone_number": "string", "phone_code_hash": "string", }`
### As a user:

22
docs/API_docs/methods/auth_resetAuthorizations.md
View File

@ -10,14 +10,21 @@ description: auth.resetAuthorizations parameters, return type and example
### Return type: [Bool](../types/Bool.md)
### Can bots use this method: **NO**
### Errors this method can return:
| Error | Description |
|----------|---------------|
|Timeout|A timeout occurred while fetching data from the bot|
### 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: ';
@ -33,15 +40,6 @@ $Bool = $MadelineProto->auth->resetAuthorizations();
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 - auth.resetAuthorizations
* params - `{}`
### As a user:

22
docs/API_docs/methods/auth_sendInvites.md
View File

@ -16,14 +16,21 @@ description: auth.sendInvites parameters, return type and example
### Return type: [Bool](../types/Bool.md)
### Can bots use this method: **NO**
### Errors this method can return:
| Error | Description |
|----------|---------------|
|MESSAGE_EMPTY|The provided message is empty|
### 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: ';
@ -39,15 +46,6 @@ $Bool = $MadelineProto->auth->sendInvites(['phone_numbers' => ['string'], 'messa
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 - auth.sendInvites
* params - `{"phone_numbers": ["string"], "message": "string", }`
### As a user:

11
docs/API_docs/methods/bots_answerWebhookJSONQuery.md
View File

@ -16,6 +16,17 @@ description: bots.answerWebhookJSONQuery parameters, return type and example
### Return type: [Bool](../types/Bool.md)
### Can bots use this method: **YES**
### Errors this method can return:
| Error | Description |
|----------|---------------|
|QUERY_ID_INVALID|The query ID is invalid|
|USER_BOT_INVALID|This method can only be called by a bot|
### Example:

10
docs/API_docs/methods/bots_sendCustomRequest.md
View File

@ -16,6 +16,16 @@ description: bots.sendCustomRequest parameters, return type and example
### Return type: [DataJSON](../types/DataJSON.md)
### Can bots use this method: **YES**
### Errors this method can return:
| Error | Description |
|----------|---------------|
|USER_BOT_INVALID|This method can only be called by a bot|
### Example:

23
docs/API_docs/methods/channels_checkUsername.md
View File

@ -16,14 +16,22 @@ description: channels.checkUsername parameters, return type and example
### Return type: [Bool](../types/Bool.md)
### Can bots use this method: **NO**
### Errors this method can return:
| Error | Description |
|----------|---------------|
|CHANNEL_INVALID|The provided channel is invalid|
|CHAT_ID_INVALID|The provided chat 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: ';
@ -39,15 +47,6 @@ $Bool = $MadelineProto->channels->checkUsername(['channel' => InputChannel, 'use
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 - channels.checkUsername
* params - `{"channel": InputChannel, "username": "string", }`
### As a user:

22
docs/API_docs/methods/channels_createChannel.md
View File

@ -18,14 +18,21 @@ description: channels.createChannel parameters, return type and example
### Return type: [Updates](../types/Updates.md)
### Can bots use this method: **NO**
### Errors this method can return:
| Error | Description |
|----------|---------------|
|USER_RESTRICTED|You're spamreported, you can't create channels or chats.|
### 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: ';
@ -41,15 +48,6 @@ $Updates = $MadelineProto->channels->createChannel(['broadcast' => Bool, 'megagr
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 - channels.createChannel
* params - `{"broadcast": Bool, "megagroup": Bool, "title": "string", "about": "string", }`
### As a user:

23
docs/API_docs/methods/channels_deleteChannel.md
View File

@ -15,14 +15,22 @@ description: channels.deleteChannel parameters, return type and example
### Return type: [Updates](../types/Updates.md)
### Can bots use this method: **NO**
### Errors this method can return:
| Error | Description |
|----------|---------------|
|CHANNEL_INVALID|The provided channel is invalid|
|CHANNEL_PRIVATE|You haven't joined this channel/supergroup|
### 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: ';
@ -38,15 +46,6 @@ $Updates = $MadelineProto->channels->deleteChannel(['channel' => InputChannel, ]
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 - channels.deleteChannel
* params - `{"channel": InputChannel, }`
### As a user:

11
docs/API_docs/methods/channels_deleteMessages.md
View File

@ -16,6 +16,17 @@ description: channels.deleteMessages parameters, return type and example
### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md)
### Can bots use this method: **YES**
### Errors this method can return:
| Error | Description |
|----------|---------------|
|CHANNEL_INVALID|The provided channel is invalid|
|MESSAGE_DELETE_FORBIDDEN|You can't delete one of the messages you tried to delete, most likely because it is a service message.|
### Example:

23
docs/API_docs/methods/channels_deleteUserHistory.md
View File

@ -16,14 +16,22 @@ description: channels.deleteUserHistory parameters, return type and example
### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md)
### Can bots use this method: **NO**
### Errors this method can return:
| Error | Description |
|----------|---------------|
|CHANNEL_INVALID|The provided channel is invalid|
|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this|
### 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: ';
@ -39,15 +47,6 @@ $messages_AffectedHistory = $MadelineProto->channels->deleteUserHistory(['channe
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 - channels.deleteUserHistory
* params - `{"channel": InputChannel, "user_id": InputUser, }`
### As a user:

10
docs/API_docs/methods/channels_editAbout.md
View File

@ -16,6 +16,16 @@ description: channels.editAbout parameters, return type and example
### Return type: [Bool](../types/Bool.md)
### Can bots use this method: **YES**
### Errors this method can return:
| Error | Description |
|----------|---------------|
|CHANNEL_INVALID|The provided channel is invalid|
### Example:

13
docs/API_docs/methods/channels_editAdmin.md
View File

@ -17,6 +17,19 @@ description: channels.editAdmin parameters, return type and example
### Return type: [Updates](../types/Updates.md)
### Can bots use this method: **YES**
### Errors this method can return:
| Error | Description |
|----------|---------------|
|CHANNEL_INVALID|The provided channel is invalid|
|CHAT_ADMIN_INVITE_REQUIRED|You do not have the rights to do this|
|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this|
|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact|
### Example:

13
docs/API_docs/methods/channels_editBanned.md
View File

@ -17,6 +17,19 @@ description: channels.editBanned parameters, return type and example
### Return type: [Updates](../types/Updates.md)
### Can bots use this method: **YES**
### Errors this method can return:
| Error | Description |
|----------|---------------|
|CHANNEL_INVALID|The provided channel is invalid|
|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this|
|USER_ADMIN_INVALID|You're not an admin|
|USER_ID_INVALID|The provided user ID is invalid|
### Example:

10
docs/API_docs/methods/channels_editPhoto.md
View File

@ -16,6 +16,16 @@ description: channels.editPhoto parameters, return type and example
### Return type: [Updates](../types/Updates.md)
### Can bots use this method: **YES**
### Errors this method can return:
| Error | Description |
|----------|---------------|
|CHANNEL_INVALID|The provided channel is invalid|
### Example:

10
docs/API_docs/methods/channels_editTitle.md
View File

@ -16,6 +16,16 @@ description: channels.editTitle parameters, return type and example
### Return type: [Updates](../types/Updates.md)
### Can bots use this method: **YES**
### Errors this method can return:
| Error | Description |
|----------|---------------|
|CHANNEL_INVALID|The provided channel is invalid|
### Example:

11
docs/API_docs/methods/channels_exportInvite.md
View File

@ -15,6 +15,17 @@ description: channels.exportInvite parameters, return type and example
### Return type: [ExportedChatInvite](../types/ExportedChatInvite.md)
### Can bots use this method: **YES**
### Errors this method can return:
| Error | Description |
|----------|---------------|
|CHANNEL_INVALID|The provided channel is invalid|
|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this|
### Example:

22
docs/API_docs/methods/channels_exportMessageLink.md
View File

@ -16,14 +16,21 @@ description: channels.exportMessageLink parameters, return type and example
### Return type: [ExportedMessageLink](../types/ExportedMessageLink.md)
### Can bots use this method: **NO**
### Errors this method can return:
| Error | Description |
|----------|---------------|
|CHANNEL_INVALID|The provided channel 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: ';
@ -39,15 +46,6 @@ $ExportedMessageLink = $MadelineProto->channels->exportMessageLink(['channel' =>
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 - channels.exportMessageLink
* params - `{"channel": InputChannel, "id": int, }`
### As a user:

23
docs/API_docs/methods/channels_getAdminLog.md
View File

@ -21,14 +21,22 @@ description: channels.getAdminLog parameters, return type and example
### Return type: [channels\_AdminLogResults](../types/channels_AdminLogResults.md)
### Can bots use this method: **NO**
### Errors this method can return:
| Error | Description |
|----------|---------------|
|CHANNEL_INVALID|The provided channel is invalid|
|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this|
### 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: ';
@ -44,15 +52,6 @@ $channels_AdminLogResults = $MadelineProto->channels->getAdminLog(['channel' =>
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 - channels.getAdminLog
* params - `{"channel": InputChannel, "q": "string", "events_filter": ChannelAdminLogEventsFilter, "admins": [InputUser], "max_id": long, "min_id": long, "limit": int, }`
### As a user:

15
docs/API_docs/methods/channels_getAdminedPublicChannels.md
View File

@ -10,14 +10,14 @@ description: channels.getAdminedPublicChannels parameters, return type and examp
### Return type: [messages\_Chats](../types/messages_Chats.md)
### Can bots use this method: **NO**
### 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: ';
@ -33,15 +33,6 @@ $messages_Chats = $MadelineProto->channels->getAdminedPublicChannels();
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 - channels.getAdminedPublicChannels
* params - `{}`
### As a user:

10
docs/API_docs/methods/channels_getChannels.md
View File

@ -15,6 +15,16 @@ description: channels.getChannels parameters, return type and example
### Return type: [messages\_Chats](../types/messages_Chats.md)
### Can bots use this method: **YES**
### Errors this method can return:
| Error | Description |
|----------|---------------|
|NEED_CHAT_INVALID|The provided chat is invalid|
### Example:

10
docs/API_docs/methods/channels_getMessages.md
View File

@ -16,6 +16,16 @@ description: channels.getMessages parameters, return type and example
### Return type: [messages\_Messages](../types/messages_Messages.md)
### Can bots use this method: **YES**
### Errors this method can return:
| Error | Description |
|----------|---------------|
|CHANNEL_INVALID|The provided channel is invalid|
### Example:

11
docs/API_docs/methods/channels_getParticipant.md
View File

@ -16,6 +16,17 @@ description: channels.getParticipant parameters, return type and example
### Return type: [channels\_ChannelParticipant](../types/channels_ChannelParticipant.md)
### Can bots use this method: **YES**
### Errors this method can return:
| Error | Description |
|----------|---------------|
|CHANNEL_INVALID|The provided channel is invalid|
|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel|
### Example:

34
docs/API_docs/methods/channels_inviteToChannel.md
View File

@ -16,14 +16,33 @@ description: channels.inviteToChannel parameters, return type and example
### Return type: [Updates](../types/Updates.md)
### Can bots use this method: **NO**
### Errors this method can return:
| Error | Description |
|----------|---------------|
|BOT_GROUPS_BLOCKED|This bot can't be added to groups|
|BOTS_TOO_MUCH|There are too many bots in this chat/channel|
|CHANNEL_INVALID|The provided channel is invalid|
|CHANNEL_PRIVATE|You haven't joined this channel/supergroup|
|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this|
|CHAT_WRITE_FORBIDDEN|You can't write in this chat|
|INPUT_USER_DEACTIVATED|The specified user was deleted|
|USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels|
|USER_CHANNELS_TOO_MUCH|One of the users you tried to add is already in too many channels/supergroups|
|USER_ID_INVALID|The provided user ID is invalid|
|USER_KICKED|This user was kicked from this supergroup/channel|
|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact|
|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this|
### 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: ';
@ -39,15 +58,6 @@ $Updates = $MadelineProto->channels->inviteToChannel(['channel' => InputChannel,
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 - channels.inviteToChannel
* params - `{"channel": InputChannel, "users": [InputUser], }`
### As a user:

23
docs/API_docs/methods/channels_joinChannel.md
View File

@ -15,14 +15,22 @@ description: channels.joinChannel parameters, return type and example
### Return type: [Updates](../types/Updates.md)
### Can bots use this method: **NO**
### Errors this method can return:
| Error | Description |
|----------|---------------|
|CHANNEL_INVALID|The provided channel is invalid|
|CHANNEL_PRIVATE|You haven't joined this channel/supergroup|
### 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: ';
@ -38,15 +46,6 @@ $Updates = $MadelineProto->channels->joinChannel(['channel' => InputChannel, ]);
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 - channels.joinChannel
* params - `{"channel": InputChannel, }`
### As a user:

13
docs/API_docs/methods/channels_leaveChannel.md
View File

@ -15,6 +15,19 @@ description: channels.leaveChannel parameters, return type and example
### Return type: [Updates](../types/Updates.md)
### Can bots use this method: **YES**
### Errors this method can return:
| Error | Description |
|----------|---------------|
|CHANNEL_INVALID|The provided channel is invalid|
|CHANNEL_PRIVATE|You haven't joined this channel/supergroup|
|USER_CREATOR|You can't leave this channel, because you're its creator|
|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel|
### Example:

22
docs/API_docs/methods/channels_readHistory.md
View File

@ -16,14 +16,21 @@ description: channels.readHistory parameters, return type and example
### Return type: [Bool](../types/Bool.md)
### Can bots use this method: **NO**
### Errors this method can return:
| Error | Description |
|----------|---------------|
|CHANNEL_INVALID|The provided channel 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: ';
@ -39,15 +46,6 @@ $Bool = $MadelineProto->channels->readHistory(['channel' => InputChannel, 'max_i
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 - channels.readHistory
* params - `{"channel": InputChannel, "max_id": int, }`
### As a user:

10
docs/API_docs/methods/channels_readMessageContents.md
View File

@ -16,6 +16,16 @@ description: channels.readMessageContents parameters, return type and example
### Return type: [Bool](../types/Bool.md)
### Can bots use this method: **YES**
### Errors this method can return:
| Error | Description |
|----------|---------------|
|CHANNEL_INVALID|The provided channel is invalid|
### Example:

22
docs/API_docs/methods/channels_reportSpam.md
View File

@ -17,14 +17,21 @@ description: channels.reportSpam parameters, return type and example
### Return type: [Bool](../types/Bool.md)
### Can bots use this method: **NO**
### Errors this method can return:
| Error | Description |
|----------|---------------|
|CHANNEL_INVALID|The provided channel 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: ';
@ -40,15 +47,6 @@ $Bool = $MadelineProto->channels->reportSpam(['channel' => InputChannel, 'user_i
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 - channels.reportSpam
* params - `{"channel": InputChannel, "user_id": InputUser, "id": [int], }`
### As a user:

10
docs/API_docs/methods/channels_setStickers.md
View File

@ -16,6 +16,16 @@ description: channels.setStickers parameters, return type and example
### Return type: [Bool](../types/Bool.md)
### Can bots use this method: **YES**
### Errors this method can return:
| Error | Description |
|----------|---------------|
|CHANNEL_INVALID|The provided channel is invalid|
### Example:

22
docs/API_docs/methods/channels_toggleInvites.md
View File

@ -16,14 +16,21 @@ description: channels.toggleInvites parameters, return type and example
### Return type: [Updates](../types/Updates.md)
### Can bots use this method: **NO**
### Errors this method can return:
| Error | Description |
|----------|---------------|
|CHANNEL_INVALID|The provided channel 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: ';
@ -39,15 +46,6 @@ $Updates = $MadelineProto->channels->toggleInvites(['channel' => InputChannel, '
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 - channels.toggleInvites
* params - `{"channel": InputChannel, "enabled": Bool, }`
### As a user:

22
docs/API_docs/methods/channels_toggleSignatures.md
View File

@ -16,14 +16,21 @@ description: channels.toggleSignatures parameters, return type and example
### Return type: [Updates](../types/Updates.md)
### Can bots use this method: **NO**
### Errors this method can return:
| Error | Description |
|----------|---------------|
|CHANNEL_INVALID|The provided channel 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: ';
@ -39,15 +46,6 @@ $Updates = $MadelineProto->channels->toggleSignatures(['channel' => InputChannel
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 - channels.toggleSignatures
* params - `{"channel": InputChannel, "enabled": Bool, }`
### As a user:

Some files were not shown because too many files have changed in this diff Show More