diff --git a/docs/API_docs/methods/account_changePhone.md b/docs/API_docs/methods/account_changePhone.md index 1a1bf92a..ffa4bf37 100644 --- a/docs/API_docs/methods/account_changePhone.md +++ b/docs/API_docs/methods/account_changePhone.md @@ -17,14 +17,20 @@ 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 +46,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: diff --git a/docs/API_docs/methods/account_checkUsername.md b/docs/API_docs/methods/account_checkUsername.md index 95e5f1fe..654b4222 100644 --- a/docs/API_docs/methods/account_checkUsername.md +++ b/docs/API_docs/methods/account_checkUsername.md @@ -15,14 +15,20 @@ 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 +44,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: diff --git a/docs/API_docs/methods/account_confirmPhone.md b/docs/API_docs/methods/account_confirmPhone.md index 7067697b..9cb5151b 100644 --- a/docs/API_docs/methods/account_confirmPhone.md +++ b/docs/API_docs/methods/account_confirmPhone.md @@ -16,14 +16,20 @@ 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 +45,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: diff --git a/docs/API_docs/methods/account_deleteAccount.md b/docs/API_docs/methods/account_deleteAccount.md index 96eee8c2..5abcd0ec 100644 --- a/docs/API_docs/methods/account_deleteAccount.md +++ b/docs/API_docs/methods/account_deleteAccount.md @@ -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: diff --git a/docs/API_docs/methods/account_getAccountTTL.md b/docs/API_docs/methods/account_getAccountTTL.md index 897f2472..3520fbef 100644 --- a/docs/API_docs/methods/account_getAccountTTL.md +++ b/docs/API_docs/methods/account_getAccountTTL.md @@ -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: diff --git a/docs/API_docs/methods/account_getAuthorizations.md b/docs/API_docs/methods/account_getAuthorizations.md index 20c20cbf..91bbce5e 100644 --- a/docs/API_docs/methods/account_getAuthorizations.md +++ b/docs/API_docs/methods/account_getAuthorizations.md @@ -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: diff --git a/docs/API_docs/methods/account_getNotifySettings.md b/docs/API_docs/methods/account_getNotifySettings.md index 7ba4e226..8b93edce 100644 --- a/docs/API_docs/methods/account_getNotifySettings.md +++ b/docs/API_docs/methods/account_getNotifySettings.md @@ -15,14 +15,20 @@ 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 +44,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: diff --git a/docs/API_docs/methods/account_getPassword.md b/docs/API_docs/methods/account_getPassword.md index 83cda401..4d9fd015 100644 --- a/docs/API_docs/methods/account_getPassword.md +++ b/docs/API_docs/methods/account_getPassword.md @@ -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: diff --git a/docs/API_docs/methods/account_getPasswordSettings.md b/docs/API_docs/methods/account_getPasswordSettings.md index a341df1e..623cdd16 100644 --- a/docs/API_docs/methods/account_getPasswordSettings.md +++ b/docs/API_docs/methods/account_getPasswordSettings.md @@ -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: diff --git a/docs/API_docs/methods/account_getPrivacy.md b/docs/API_docs/methods/account_getPrivacy.md index 02dc06ec..feec1571 100644 --- a/docs/API_docs/methods/account_getPrivacy.md +++ b/docs/API_docs/methods/account_getPrivacy.md @@ -15,14 +15,20 @@ 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 +44,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: diff --git a/docs/API_docs/methods/account_getTmpPassword.md b/docs/API_docs/methods/account_getTmpPassword.md index 07cd5c70..9084b304 100644 --- a/docs/API_docs/methods/account_getTmpPassword.md +++ b/docs/API_docs/methods/account_getTmpPassword.md @@ -16,14 +16,20 @@ 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 +45,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: diff --git a/docs/API_docs/methods/account_getWallPapers.md b/docs/API_docs/methods/account_getWallPapers.md index 1c2fe4f8..88c8a701 100644 --- a/docs/API_docs/methods/account_getWallPapers.md +++ b/docs/API_docs/methods/account_getWallPapers.md @@ -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: diff --git a/docs/API_docs/methods/account_registerDevice.md b/docs/API_docs/methods/account_registerDevice.md index 2eeb7496..e5686879 100644 --- a/docs/API_docs/methods/account_registerDevice.md +++ b/docs/API_docs/methods/account_registerDevice.md @@ -16,14 +16,20 @@ 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 +45,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: diff --git a/docs/API_docs/methods/account_reportPeer.md b/docs/API_docs/methods/account_reportPeer.md index 39ad4fd8..31ab05e8 100644 --- a/docs/API_docs/methods/account_reportPeer.md +++ b/docs/API_docs/methods/account_reportPeer.md @@ -16,14 +16,20 @@ 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 +45,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: diff --git a/docs/API_docs/methods/account_resetAuthorization.md b/docs/API_docs/methods/account_resetAuthorization.md index b343815f..6899632b 100644 --- a/docs/API_docs/methods/account_resetAuthorization.md +++ b/docs/API_docs/methods/account_resetAuthorization.md @@ -15,14 +15,20 @@ 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 +44,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: diff --git a/docs/API_docs/methods/account_resetNotifySettings.md b/docs/API_docs/methods/account_resetNotifySettings.md index 3cb88f52..155ede68 100644 --- a/docs/API_docs/methods/account_resetNotifySettings.md +++ b/docs/API_docs/methods/account_resetNotifySettings.md @@ -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: diff --git a/docs/API_docs/methods/account_sendChangePhoneCode.md b/docs/API_docs/methods/account_sendChangePhoneCode.md index 25db7479..d606b195 100644 --- a/docs/API_docs/methods/account_sendChangePhoneCode.md +++ b/docs/API_docs/methods/account_sendChangePhoneCode.md @@ -17,14 +17,20 @@ 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 +46,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: diff --git a/docs/API_docs/methods/account_sendConfirmPhoneCode.md b/docs/API_docs/methods/account_sendConfirmPhoneCode.md index bb8bf0b5..3ca66b20 100644 --- a/docs/API_docs/methods/account_sendConfirmPhoneCode.md +++ b/docs/API_docs/methods/account_sendConfirmPhoneCode.md @@ -17,14 +17,20 @@ 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 +46,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: diff --git a/docs/API_docs/methods/account_setAccountTTL.md b/docs/API_docs/methods/account_setAccountTTL.md index 51f15120..835e6971 100644 --- a/docs/API_docs/methods/account_setAccountTTL.md +++ b/docs/API_docs/methods/account_setAccountTTL.md @@ -15,14 +15,20 @@ 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 +44,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: diff --git a/docs/API_docs/methods/account_setPrivacy.md b/docs/API_docs/methods/account_setPrivacy.md index 9374eb16..de559ab0 100644 --- a/docs/API_docs/methods/account_setPrivacy.md +++ b/docs/API_docs/methods/account_setPrivacy.md @@ -16,14 +16,20 @@ 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 +45,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: diff --git a/docs/API_docs/methods/account_unregisterDevice.md b/docs/API_docs/methods/account_unregisterDevice.md index ac525065..85c55814 100644 --- a/docs/API_docs/methods/account_unregisterDevice.md +++ b/docs/API_docs/methods/account_unregisterDevice.md @@ -16,14 +16,20 @@ 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 +45,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: diff --git a/docs/API_docs/methods/account_updateDeviceLocked.md b/docs/API_docs/methods/account_updateDeviceLocked.md index 9a4df1f9..37aeb59d 100644 --- a/docs/API_docs/methods/account_updateDeviceLocked.md +++ b/docs/API_docs/methods/account_updateDeviceLocked.md @@ -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: diff --git a/docs/API_docs/methods/account_updateNotifySettings.md b/docs/API_docs/methods/account_updateNotifySettings.md index e590d427..c8c742fc 100644 --- a/docs/API_docs/methods/account_updateNotifySettings.md +++ b/docs/API_docs/methods/account_updateNotifySettings.md @@ -16,14 +16,20 @@ 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 +45,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: diff --git a/docs/API_docs/methods/account_updatePasswordSettings.md b/docs/API_docs/methods/account_updatePasswordSettings.md index 44b888ac..e893736d 100644 --- a/docs/API_docs/methods/account_updatePasswordSettings.md +++ b/docs/API_docs/methods/account_updatePasswordSettings.md @@ -16,14 +16,20 @@ 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 +45,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: diff --git a/docs/API_docs/methods/account_updateProfile.md b/docs/API_docs/methods/account_updateProfile.md index bdb6fe54..0acbfaa7 100644 --- a/docs/API_docs/methods/account_updateProfile.md +++ b/docs/API_docs/methods/account_updateProfile.md @@ -17,14 +17,20 @@ 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 +46,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: diff --git a/docs/API_docs/methods/account_updateStatus.md b/docs/API_docs/methods/account_updateStatus.md index 21f9d64c..f2587037 100644 --- a/docs/API_docs/methods/account_updateStatus.md +++ b/docs/API_docs/methods/account_updateStatus.md @@ -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: diff --git a/docs/API_docs/methods/account_updateUsername.md b/docs/API_docs/methods/account_updateUsername.md index 5424909a..373a9b4d 100644 --- a/docs/API_docs/methods/account_updateUsername.md +++ b/docs/API_docs/methods/account_updateUsername.md @@ -15,14 +15,20 @@ 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 +44,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: diff --git a/docs/API_docs/methods/auth_bindTempAuthKey.md b/docs/API_docs/methods/auth_bindTempAuthKey.md index e7f589ab..2eff1092 100644 --- a/docs/API_docs/methods/auth_bindTempAuthKey.md +++ b/docs/API_docs/methods/auth_bindTempAuthKey.md @@ -18,6 +18,15 @@ 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: diff --git a/docs/API_docs/methods/auth_cancelCode.md b/docs/API_docs/methods/auth_cancelCode.md index 85823d38..dd8b528e 100644 --- a/docs/API_docs/methods/auth_cancelCode.md +++ b/docs/API_docs/methods/auth_cancelCode.md @@ -16,14 +16,20 @@ 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 +45,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: diff --git a/docs/API_docs/methods/auth_checkPassword.md b/docs/API_docs/methods/auth_checkPassword.md index d9fb3c3b..0d86804c 100644 --- a/docs/API_docs/methods/auth_checkPassword.md +++ b/docs/API_docs/methods/auth_checkPassword.md @@ -15,14 +15,20 @@ 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 +44,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: diff --git a/docs/API_docs/methods/auth_checkPhone.md b/docs/API_docs/methods/auth_checkPhone.md index 1a440a86..a8181371 100644 --- a/docs/API_docs/methods/auth_checkPhone.md +++ b/docs/API_docs/methods/auth_checkPhone.md @@ -15,14 +15,20 @@ 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 +44,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: diff --git a/docs/API_docs/methods/auth_dropTempAuthKeys.md b/docs/API_docs/methods/auth_dropTempAuthKeys.md index 78a18522..aba76766 100644 --- a/docs/API_docs/methods/auth_dropTempAuthKeys.md +++ b/docs/API_docs/methods/auth_dropTempAuthKeys.md @@ -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: diff --git a/docs/API_docs/methods/auth_exportAuthorization.md b/docs/API_docs/methods/auth_exportAuthorization.md index dc3b6107..016daec1 100644 --- a/docs/API_docs/methods/auth_exportAuthorization.md +++ b/docs/API_docs/methods/auth_exportAuthorization.md @@ -15,6 +15,15 @@ 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: diff --git a/docs/API_docs/methods/auth_importAuthorization.md b/docs/API_docs/methods/auth_importAuthorization.md index b5ad9857..032ec8d5 100644 --- a/docs/API_docs/methods/auth_importAuthorization.md +++ b/docs/API_docs/methods/auth_importAuthorization.md @@ -16,6 +16,15 @@ 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: diff --git a/docs/API_docs/methods/auth_recoverPassword.md b/docs/API_docs/methods/auth_recoverPassword.md index 24be798a..53989c8c 100644 --- a/docs/API_docs/methods/auth_recoverPassword.md +++ b/docs/API_docs/methods/auth_recoverPassword.md @@ -15,14 +15,20 @@ 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 +44,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: diff --git a/docs/API_docs/methods/auth_requestPasswordRecovery.md b/docs/API_docs/methods/auth_requestPasswordRecovery.md index c92df9e6..8c8a5225 100644 --- a/docs/API_docs/methods/auth_requestPasswordRecovery.md +++ b/docs/API_docs/methods/auth_requestPasswordRecovery.md @@ -10,14 +10,20 @@ 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 +39,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: diff --git a/docs/API_docs/methods/auth_resendCode.md b/docs/API_docs/methods/auth_resendCode.md index be40a03a..1ff8dfff 100644 --- a/docs/API_docs/methods/auth_resendCode.md +++ b/docs/API_docs/methods/auth_resendCode.md @@ -16,14 +16,20 @@ 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 +45,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: diff --git a/docs/API_docs/methods/auth_resetAuthorizations.md b/docs/API_docs/methods/auth_resetAuthorizations.md index 72d2624a..8d69e11d 100644 --- a/docs/API_docs/methods/auth_resetAuthorizations.md +++ b/docs/API_docs/methods/auth_resetAuthorizations.md @@ -10,14 +10,20 @@ 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 +39,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: diff --git a/docs/API_docs/methods/auth_sendInvites.md b/docs/API_docs/methods/auth_sendInvites.md index 51d492b7..d0d15e72 100644 --- a/docs/API_docs/methods/auth_sendInvites.md +++ b/docs/API_docs/methods/auth_sendInvites.md @@ -16,14 +16,20 @@ 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 +45,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: diff --git a/docs/API_docs/methods/bots_answerWebhookJSONQuery.md b/docs/API_docs/methods/bots_answerWebhookJSONQuery.md index 09f35e58..0fcc85c6 100644 --- a/docs/API_docs/methods/bots_answerWebhookJSONQuery.md +++ b/docs/API_docs/methods/bots_answerWebhookJSONQuery.md @@ -16,6 +16,15 @@ 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: diff --git a/docs/API_docs/methods/bots_sendCustomRequest.md b/docs/API_docs/methods/bots_sendCustomRequest.md index df868c1e..35350236 100644 --- a/docs/API_docs/methods/bots_sendCustomRequest.md +++ b/docs/API_docs/methods/bots_sendCustomRequest.md @@ -16,6 +16,15 @@ 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: diff --git a/docs/API_docs/methods/channels_checkUsername.md b/docs/API_docs/methods/channels_checkUsername.md index 8dd7ece0..8c9b0bbf 100644 --- a/docs/API_docs/methods/channels_checkUsername.md +++ b/docs/API_docs/methods/channels_checkUsername.md @@ -16,14 +16,20 @@ 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 +45,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: diff --git a/docs/API_docs/methods/channels_createChannel.md b/docs/API_docs/methods/channels_createChannel.md index 2c02909c..89ad273b 100644 --- a/docs/API_docs/methods/channels_createChannel.md +++ b/docs/API_docs/methods/channels_createChannel.md @@ -18,14 +18,20 @@ 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 +47,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: diff --git a/docs/API_docs/methods/channels_deleteChannel.md b/docs/API_docs/methods/channels_deleteChannel.md index 58b73fbf..51702104 100644 --- a/docs/API_docs/methods/channels_deleteChannel.md +++ b/docs/API_docs/methods/channels_deleteChannel.md @@ -15,14 +15,20 @@ 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 +44,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: diff --git a/docs/API_docs/methods/channels_deleteMessages.md b/docs/API_docs/methods/channels_deleteMessages.md index 682df196..c7fff6b7 100644 --- a/docs/API_docs/methods/channels_deleteMessages.md +++ b/docs/API_docs/methods/channels_deleteMessages.md @@ -16,6 +16,15 @@ 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: diff --git a/docs/API_docs/methods/channels_deleteUserHistory.md b/docs/API_docs/methods/channels_deleteUserHistory.md index a3cf467e..39a48bd7 100644 --- a/docs/API_docs/methods/channels_deleteUserHistory.md +++ b/docs/API_docs/methods/channels_deleteUserHistory.md @@ -16,14 +16,20 @@ 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 +45,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: diff --git a/docs/API_docs/methods/channels_editAbout.md b/docs/API_docs/methods/channels_editAbout.md index 430699a3..a21f8681 100644 --- a/docs/API_docs/methods/channels_editAbout.md +++ b/docs/API_docs/methods/channels_editAbout.md @@ -16,6 +16,15 @@ 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: diff --git a/docs/API_docs/methods/channels_editAdmin.md b/docs/API_docs/methods/channels_editAdmin.md index 642c5137..ad2c86d8 100644 --- a/docs/API_docs/methods/channels_editAdmin.md +++ b/docs/API_docs/methods/channels_editAdmin.md @@ -17,6 +17,15 @@ 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: diff --git a/docs/API_docs/methods/channels_editBanned.md b/docs/API_docs/methods/channels_editBanned.md index aa77d04a..69184472 100644 --- a/docs/API_docs/methods/channels_editBanned.md +++ b/docs/API_docs/methods/channels_editBanned.md @@ -17,6 +17,15 @@ 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| + ### Example: diff --git a/docs/API_docs/methods/channels_editPhoto.md b/docs/API_docs/methods/channels_editPhoto.md index 080db4d0..0894d9a2 100644 --- a/docs/API_docs/methods/channels_editPhoto.md +++ b/docs/API_docs/methods/channels_editPhoto.md @@ -16,6 +16,15 @@ 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: diff --git a/docs/API_docs/methods/channels_editTitle.md b/docs/API_docs/methods/channels_editTitle.md index c392a3a0..03fcd95e 100644 --- a/docs/API_docs/methods/channels_editTitle.md +++ b/docs/API_docs/methods/channels_editTitle.md @@ -16,6 +16,15 @@ 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: diff --git a/docs/API_docs/methods/channels_exportInvite.md b/docs/API_docs/methods/channels_exportInvite.md index dfd00f91..4f5d048d 100644 --- a/docs/API_docs/methods/channels_exportInvite.md +++ b/docs/API_docs/methods/channels_exportInvite.md @@ -15,6 +15,15 @@ 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: diff --git a/docs/API_docs/methods/channels_exportMessageLink.md b/docs/API_docs/methods/channels_exportMessageLink.md index 49263960..18091a3c 100644 --- a/docs/API_docs/methods/channels_exportMessageLink.md +++ b/docs/API_docs/methods/channels_exportMessageLink.md @@ -16,14 +16,20 @@ 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 +45,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: diff --git a/docs/API_docs/methods/channels_getAdminLog.md b/docs/API_docs/methods/channels_getAdminLog.md index a11da912..f5bfb7ea 100644 --- a/docs/API_docs/methods/channels_getAdminLog.md +++ b/docs/API_docs/methods/channels_getAdminLog.md @@ -21,14 +21,20 @@ 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 +50,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: diff --git a/docs/API_docs/methods/channels_getAdminedPublicChannels.md b/docs/API_docs/methods/channels_getAdminedPublicChannels.md index 065e35ec..7fceb026 100644 --- a/docs/API_docs/methods/channels_getAdminedPublicChannels.md +++ b/docs/API_docs/methods/channels_getAdminedPublicChannels.md @@ -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: diff --git a/docs/API_docs/methods/channels_getChannels.md b/docs/API_docs/methods/channels_getChannels.md index 172aa5b4..01729104 100644 --- a/docs/API_docs/methods/channels_getChannels.md +++ b/docs/API_docs/methods/channels_getChannels.md @@ -15,6 +15,15 @@ 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: diff --git a/docs/API_docs/methods/channels_getMessages.md b/docs/API_docs/methods/channels_getMessages.md index 355c3ab9..fb410541 100644 --- a/docs/API_docs/methods/channels_getMessages.md +++ b/docs/API_docs/methods/channels_getMessages.md @@ -16,6 +16,15 @@ 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: diff --git a/docs/API_docs/methods/channels_getParticipant.md b/docs/API_docs/methods/channels_getParticipant.md index d1605dc7..e6140afa 100644 --- a/docs/API_docs/methods/channels_getParticipant.md +++ b/docs/API_docs/methods/channels_getParticipant.md @@ -16,6 +16,15 @@ 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: diff --git a/docs/API_docs/methods/channels_inviteToChannel.md b/docs/API_docs/methods/channels_inviteToChannel.md index cb9817bb..ed0d0c87 100644 --- a/docs/API_docs/methods/channels_inviteToChannel.md +++ b/docs/API_docs/methods/channels_inviteToChannel.md @@ -16,14 +16,20 @@ 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_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 +45,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: diff --git a/docs/API_docs/methods/channels_joinChannel.md b/docs/API_docs/methods/channels_joinChannel.md index d3952442..255bffa0 100644 --- a/docs/API_docs/methods/channels_joinChannel.md +++ b/docs/API_docs/methods/channels_joinChannel.md @@ -15,14 +15,20 @@ 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 +44,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: diff --git a/docs/API_docs/methods/channels_leaveChannel.md b/docs/API_docs/methods/channels_leaveChannel.md index c26023df..99d83b42 100644 --- a/docs/API_docs/methods/channels_leaveChannel.md +++ b/docs/API_docs/methods/channels_leaveChannel.md @@ -15,6 +15,15 @@ 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: diff --git a/docs/API_docs/methods/channels_readHistory.md b/docs/API_docs/methods/channels_readHistory.md index 78e0aeb3..17ca824e 100644 --- a/docs/API_docs/methods/channels_readHistory.md +++ b/docs/API_docs/methods/channels_readHistory.md @@ -16,14 +16,20 @@ 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 +45,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: diff --git a/docs/API_docs/methods/channels_readMessageContents.md b/docs/API_docs/methods/channels_readMessageContents.md index 964aa74e..6b5d17ea 100644 --- a/docs/API_docs/methods/channels_readMessageContents.md +++ b/docs/API_docs/methods/channels_readMessageContents.md @@ -16,6 +16,15 @@ 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: diff --git a/docs/API_docs/methods/channels_reportSpam.md b/docs/API_docs/methods/channels_reportSpam.md index 4723cf82..d04a6987 100644 --- a/docs/API_docs/methods/channels_reportSpam.md +++ b/docs/API_docs/methods/channels_reportSpam.md @@ -17,14 +17,20 @@ 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 +46,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: diff --git a/docs/API_docs/methods/channels_setStickers.md b/docs/API_docs/methods/channels_setStickers.md index fac98aaa..75f7bec6 100644 --- a/docs/API_docs/methods/channels_setStickers.md +++ b/docs/API_docs/methods/channels_setStickers.md @@ -16,6 +16,15 @@ 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: diff --git a/docs/API_docs/methods/channels_toggleInvites.md b/docs/API_docs/methods/channels_toggleInvites.md index 2803b81c..b6f8b2a8 100644 --- a/docs/API_docs/methods/channels_toggleInvites.md +++ b/docs/API_docs/methods/channels_toggleInvites.md @@ -16,14 +16,20 @@ 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 +45,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: diff --git a/docs/API_docs/methods/channels_toggleSignatures.md b/docs/API_docs/methods/channels_toggleSignatures.md index f750f8cd..e77879b0 100644 --- a/docs/API_docs/methods/channels_toggleSignatures.md +++ b/docs/API_docs/methods/channels_toggleSignatures.md @@ -16,14 +16,20 @@ 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 +45,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: diff --git a/docs/API_docs/methods/channels_updatePinnedMessage.md b/docs/API_docs/methods/channels_updatePinnedMessage.md index ad80f92c..4cff44d2 100644 --- a/docs/API_docs/methods/channels_updatePinnedMessage.md +++ b/docs/API_docs/methods/channels_updatePinnedMessage.md @@ -17,6 +17,15 @@ description: channels.updatePinnedMessage 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||CHAT_NOT_MODIFIED|The pinned message wasn't modified| + ### Example: diff --git a/docs/API_docs/methods/channels_updateUsername.md b/docs/API_docs/methods/channels_updateUsername.md index 42dcd64b..177ab75c 100644 --- a/docs/API_docs/methods/channels_updateUsername.md +++ b/docs/API_docs/methods/channels_updateUsername.md @@ -16,14 +16,20 @@ description: channels.updateUsername 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_ADMIN_REQUIRED|You must be an admin in this chat to do this||USERNAME_INVALID|The provided username is not valid||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: '; @@ -39,15 +45,6 @@ $Bool = $MadelineProto->channels->updateUsername(['channel' => InputChannel, 'us 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.updateUsername -* params - `{"channel": InputChannel, "username": "string", }` - ### As a user: diff --git a/docs/API_docs/methods/contacts_block.md b/docs/API_docs/methods/contacts_block.md index 3f5a84d8..c9bcffac 100644 --- a/docs/API_docs/methods/contacts_block.md +++ b/docs/API_docs/methods/contacts_block.md @@ -15,14 +15,20 @@ description: contacts.block parameters, return type and example ### Return type: [Bool](../types/Bool.md) +### Can bots use this method: **NO** + + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONTACT_ID_INVALID|The provided contact 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 +44,6 @@ $Bool = $MadelineProto->contacts->block(['id' => InputUser, ]); 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 - contacts.block -* params - `{"id": InputUser, }` - ### As a user: diff --git a/docs/API_docs/methods/contacts_deleteContact.md b/docs/API_docs/methods/contacts_deleteContact.md index 17332c6d..249e0bd8 100644 --- a/docs/API_docs/methods/contacts_deleteContact.md +++ b/docs/API_docs/methods/contacts_deleteContact.md @@ -15,14 +15,20 @@ description: contacts.deleteContact parameters, return type and example ### Return type: [contacts\_Link](../types/contacts_Link.md) +### Can bots use this method: **NO** + + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONTACT_ID_INVALID|The provided contact 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 +44,6 @@ $contacts_Link = $MadelineProto->contacts->deleteContact(['id' => InputUser, ]); 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 - contacts.deleteContact -* params - `{"id": InputUser, }` - ### As a user: diff --git a/docs/API_docs/methods/contacts_deleteContacts.md b/docs/API_docs/methods/contacts_deleteContacts.md index ecf46473..599e11c0 100644 --- a/docs/API_docs/methods/contacts_deleteContacts.md +++ b/docs/API_docs/methods/contacts_deleteContacts.md @@ -15,14 +15,20 @@ description: contacts.deleteContacts parameters, return type and example ### Return type: [Bool](../types/Bool.md) +### Can bots use this method: **NO** + + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|NEED_MEMBER_INVALID|The provided member 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 +44,6 @@ $Bool = $MadelineProto->contacts->deleteContacts(['id' => [InputUser], ]); 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 - contacts.deleteContacts -* params - `{"id": [InputUser], }` - ### As a user: diff --git a/docs/API_docs/methods/contacts_exportCard.md b/docs/API_docs/methods/contacts_exportCard.md index 0bdbc825..63508076 100644 --- a/docs/API_docs/methods/contacts_exportCard.md +++ b/docs/API_docs/methods/contacts_exportCard.md @@ -10,14 +10,14 @@ description: contacts.exportCard parameters, return type and example ### Return type: [Vector\_of\_int](../types/int.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_int = $MadelineProto->contacts->exportCard(); 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 - contacts.exportCard -* params - `{}` - ### As a user: diff --git a/docs/API_docs/methods/contacts_getBlocked.md b/docs/API_docs/methods/contacts_getBlocked.md index 9ee740f0..f50792b4 100644 --- a/docs/API_docs/methods/contacts_getBlocked.md +++ b/docs/API_docs/methods/contacts_getBlocked.md @@ -16,14 +16,14 @@ description: contacts.getBlocked parameters, return type and example ### Return type: [contacts\_Blocked](../types/contacts_Blocked.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: '; @@ -39,15 +39,6 @@ $contacts_Blocked = $MadelineProto->contacts->getBlocked(['offset' => int, 'limi 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 - contacts.getBlocked -* params - `{"offset": int, "limit": int, }` - ### As a user: diff --git a/docs/API_docs/methods/contacts_getContacts.md b/docs/API_docs/methods/contacts_getContacts.md index 8e154654..dd231da2 100644 --- a/docs/API_docs/methods/contacts_getContacts.md +++ b/docs/API_docs/methods/contacts_getContacts.md @@ -15,14 +15,14 @@ description: contacts.getContacts parameters, return type and example ### Return type: [contacts\_Contacts](../types/contacts_Contacts.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 @@ $contacts_Contacts = $MadelineProto->contacts->getContacts(['hash' => 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 - contacts.getContacts -* params - `{"hash": int, }` - ### As a user: diff --git a/docs/API_docs/methods/contacts_getStatuses.md b/docs/API_docs/methods/contacts_getStatuses.md index 6ef4f337..d914e08d 100644 --- a/docs/API_docs/methods/contacts_getStatuses.md +++ b/docs/API_docs/methods/contacts_getStatuses.md @@ -10,14 +10,14 @@ description: contacts.getStatuses parameters, return type and example ### Return type: [Vector\_of\_ContactStatus](../types/ContactStatus.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_ContactStatus = $MadelineProto->contacts->getStatuses(); 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 - contacts.getStatuses -* params - `{}` - ### As a user: diff --git a/docs/API_docs/methods/contacts_getTopPeers.md b/docs/API_docs/methods/contacts_getTopPeers.md index fe761e32..2f83ea7f 100644 --- a/docs/API_docs/methods/contacts_getTopPeers.md +++ b/docs/API_docs/methods/contacts_getTopPeers.md @@ -23,14 +23,20 @@ description: contacts.getTopPeers parameters, return type and example ### Return type: [contacts\_TopPeers](../types/contacts_TopPeers.md) +### Can bots use this method: **NO** + + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|TYPES_EMPTY|The types field 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: '; @@ -46,15 +52,6 @@ $contacts_TopPeers = $MadelineProto->contacts->getTopPeers(['correspondents' => 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 - contacts.getTopPeers -* params - `{"correspondents": Bool, "bots_pm": Bool, "bots_inline": Bool, "phone_calls": Bool, "groups": Bool, "channels": Bool, "offset": int, "limit": int, "hash": int, }` - ### As a user: diff --git a/docs/API_docs/methods/contacts_importCard.md b/docs/API_docs/methods/contacts_importCard.md index 704ae608..b2b10e1b 100644 --- a/docs/API_docs/methods/contacts_importCard.md +++ b/docs/API_docs/methods/contacts_importCard.md @@ -15,14 +15,20 @@ description: contacts.importCard parameters, return type and example ### Return type: [User](../types/User.md) +### Can bots use this method: **NO** + + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|NEED_MEMBER_INVALID|The provided member 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 +44,6 @@ $User = $MadelineProto->contacts->importCard(['export_card' => [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 - contacts.importCard -* params - `{"export_card": [int], }` - ### As a user: diff --git a/docs/API_docs/methods/contacts_importContacts.md b/docs/API_docs/methods/contacts_importContacts.md index 5bdcec10..e7e84bea 100644 --- a/docs/API_docs/methods/contacts_importContacts.md +++ b/docs/API_docs/methods/contacts_importContacts.md @@ -15,14 +15,14 @@ description: contacts.importContacts parameters, return type and example ### Return type: [contacts\_ImportedContacts](../types/contacts_ImportedContacts.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 @@ $contacts_ImportedContacts = $MadelineProto->contacts->importContacts(['contacts 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 - contacts.importContacts -* params - `{"contacts": [InputContact], }` - ### As a user: diff --git a/docs/API_docs/methods/contacts_resetSaved.md b/docs/API_docs/methods/contacts_resetSaved.md index d78063f9..56838fd8 100644 --- a/docs/API_docs/methods/contacts_resetSaved.md +++ b/docs/API_docs/methods/contacts_resetSaved.md @@ -10,6 +10,9 @@ description: contacts.resetSaved parameters, return type and example ### Return type: [Bool](../types/Bool.md) +### Can bots use this method: **YES** + + ### Example: diff --git a/docs/API_docs/methods/contacts_resetTopPeerRating.md b/docs/API_docs/methods/contacts_resetTopPeerRating.md index 1ea40b10..70a9e958 100644 --- a/docs/API_docs/methods/contacts_resetTopPeerRating.md +++ b/docs/API_docs/methods/contacts_resetTopPeerRating.md @@ -16,14 +16,20 @@ description: contacts.resetTopPeerRating 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 +45,6 @@ $Bool = $MadelineProto->contacts->resetTopPeerRating(['category' => TopPeerCateg 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 - contacts.resetTopPeerRating -* params - `{"category": TopPeerCategory, "peer": InputPeer, }` - ### As a user: diff --git a/docs/API_docs/methods/contacts_search.md b/docs/API_docs/methods/contacts_search.md index 10f3b490..48c9d128 100644 --- a/docs/API_docs/methods/contacts_search.md +++ b/docs/API_docs/methods/contacts_search.md @@ -16,14 +16,20 @@ description: contacts.search parameters, return type and example ### Return type: [contacts\_Found](../types/contacts_Found.md) +### Can bots use this method: **NO** + + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|QUERY_TOO_SHORT|The query string is too short||SEARCH_QUERY_EMPTY|The search query 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 +45,6 @@ $contacts_Found = $MadelineProto->contacts->search(['q' => 'string', 'limit' => 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 - contacts.search -* params - `{"q": "string", "limit": int, }` - ### As a user: diff --git a/docs/API_docs/methods/contacts_unblock.md b/docs/API_docs/methods/contacts_unblock.md index b140442d..b8cae62c 100644 --- a/docs/API_docs/methods/contacts_unblock.md +++ b/docs/API_docs/methods/contacts_unblock.md @@ -15,14 +15,20 @@ description: contacts.unblock parameters, return type and example ### Return type: [Bool](../types/Bool.md) +### Can bots use this method: **NO** + + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CONTACT_ID_INVALID|The provided contact 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 +44,6 @@ $Bool = $MadelineProto->contacts->unblock(['id' => InputUser, ]); 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 - contacts.unblock -* params - `{"id": InputUser, }` - ### As a user: diff --git a/docs/API_docs/methods/contest_saveDeveloperInfo.md b/docs/API_docs/methods/contest_saveDeveloperInfo.md index d73fa557..eca7bfcf 100644 --- a/docs/API_docs/methods/contest_saveDeveloperInfo.md +++ b/docs/API_docs/methods/contest_saveDeveloperInfo.md @@ -19,6 +19,9 @@ description: contest.saveDeveloperInfo parameters, return type and example ### Return type: [Bool](../types/Bool.md) +### Can bots use this method: **YES** + + ### Example: diff --git a/docs/API_docs/methods/destroy_auth_key.md b/docs/API_docs/methods/destroy_auth_key.md index 6647862a..7d39ceec 100644 --- a/docs/API_docs/methods/destroy_auth_key.md +++ b/docs/API_docs/methods/destroy_auth_key.md @@ -10,6 +10,9 @@ description: destroy_auth_key parameters, return type and example ### Return type: [DestroyAuthKeyRes](../types/DestroyAuthKeyRes.md) +### Can bots use this method: **YES** + + ### Example: diff --git a/docs/API_docs/methods/destroy_session.md b/docs/API_docs/methods/destroy_session.md index 536f5288..0b732694 100644 --- a/docs/API_docs/methods/destroy_session.md +++ b/docs/API_docs/methods/destroy_session.md @@ -15,6 +15,9 @@ description: destroy_session parameters, return type and example ### Return type: [DestroySessionRes](../types/DestroySessionRes.md) +### Can bots use this method: **YES** + + ### Example: diff --git a/docs/API_docs/methods/get_future_salts.md b/docs/API_docs/methods/get_future_salts.md index b837faa3..d3b306ce 100644 --- a/docs/API_docs/methods/get_future_salts.md +++ b/docs/API_docs/methods/get_future_salts.md @@ -15,6 +15,9 @@ description: get_future_salts parameters, return type and example ### Return type: [FutureSalts](../types/FutureSalts.md) +### Can bots use this method: **YES** + + ### Example: diff --git a/docs/API_docs/methods/help_getAppChangelog.md b/docs/API_docs/methods/help_getAppChangelog.md index a2638362..9d8c3203 100644 --- a/docs/API_docs/methods/help_getAppChangelog.md +++ b/docs/API_docs/methods/help_getAppChangelog.md @@ -15,14 +15,14 @@ description: help.getAppChangelog parameters, return type and example ### Return type: [Updates](../types/Updates.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 @@ $Updates = $MadelineProto->help->getAppChangelog(['prev_app_version' => '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 - help.getAppChangelog -* params - `{"prev_app_version": "string", }` - ### As a user: diff --git a/docs/API_docs/methods/help_getAppUpdate.md b/docs/API_docs/methods/help_getAppUpdate.md index 74d41e36..0871f59d 100644 --- a/docs/API_docs/methods/help_getAppUpdate.md +++ b/docs/API_docs/methods/help_getAppUpdate.md @@ -10,14 +10,14 @@ description: help.getAppUpdate parameters, return type and example ### Return type: [help\_AppUpdate](../types/help_AppUpdate.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 @@ $help_AppUpdate = $MadelineProto->help->getAppUpdate(); 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 - help.getAppUpdate -* params - `{}` - ### As a user: diff --git a/docs/API_docs/methods/help_getCdnConfig.md b/docs/API_docs/methods/help_getCdnConfig.md index 6a29b880..82b9421e 100644 --- a/docs/API_docs/methods/help_getCdnConfig.md +++ b/docs/API_docs/methods/help_getCdnConfig.md @@ -10,6 +10,9 @@ description: help.getCdnConfig parameters, return type and example ### Return type: [CdnConfig](../types/CdnConfig.md) +### Can bots use this method: **YES** + + ### Example: diff --git a/docs/API_docs/methods/help_getConfig.md b/docs/API_docs/methods/help_getConfig.md index 40c5de27..b22f204a 100644 --- a/docs/API_docs/methods/help_getConfig.md +++ b/docs/API_docs/methods/help_getConfig.md @@ -10,6 +10,9 @@ description: help.getConfig parameters, return type and example ### Return type: [Config](../types/Config.md) +### Can bots use this method: **YES** + + ### Example: diff --git a/docs/API_docs/methods/help_getInviteText.md b/docs/API_docs/methods/help_getInviteText.md index de6f69dc..4bcbb77d 100644 --- a/docs/API_docs/methods/help_getInviteText.md +++ b/docs/API_docs/methods/help_getInviteText.md @@ -10,14 +10,14 @@ description: help.getInviteText parameters, return type and example ### Return type: [help\_InviteText](../types/help_InviteText.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 @@ $help_InviteText = $MadelineProto->help->getInviteText(); 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 - help.getInviteText -* params - `{}` - ### As a user: diff --git a/docs/API_docs/methods/help_getNearestDc.md b/docs/API_docs/methods/help_getNearestDc.md index e9ee4db0..c6f5c555 100644 --- a/docs/API_docs/methods/help_getNearestDc.md +++ b/docs/API_docs/methods/help_getNearestDc.md @@ -10,14 +10,14 @@ description: help.getNearestDc parameters, return type and example ### Return type: [NearestDc](../types/NearestDc.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 @@ $NearestDc = $MadelineProto->help->getNearestDc(); 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 - help.getNearestDc -* params - `{}` - ### As a user: diff --git a/docs/API_docs/methods/help_getSupport.md b/docs/API_docs/methods/help_getSupport.md index 8e8ebbaa..209edf03 100644 --- a/docs/API_docs/methods/help_getSupport.md +++ b/docs/API_docs/methods/help_getSupport.md @@ -10,14 +10,14 @@ description: help.getSupport parameters, return type and example ### Return type: [help\_Support](../types/help_Support.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 @@ $help_Support = $MadelineProto->help->getSupport(); 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 - help.getSupport -* params - `{}` - ### As a user: diff --git a/docs/API_docs/methods/help_getTermsOfService.md b/docs/API_docs/methods/help_getTermsOfService.md index 605f595a..8bc2e2fa 100644 --- a/docs/API_docs/methods/help_getTermsOfService.md +++ b/docs/API_docs/methods/help_getTermsOfService.md @@ -10,14 +10,14 @@ description: help.getTermsOfService parameters, return type and example ### Return type: [help\_TermsOfService](../types/help_TermsOfService.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 @@ $help_TermsOfService = $MadelineProto->help->getTermsOfService(); 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 - help.getTermsOfService -* params - `{}` - ### As a user: diff --git a/docs/API_docs/methods/help_saveAppLog.md b/docs/API_docs/methods/help_saveAppLog.md index 1df5d5f7..4f06434c 100644 --- a/docs/API_docs/methods/help_saveAppLog.md +++ b/docs/API_docs/methods/help_saveAppLog.md @@ -15,14 +15,14 @@ description: help.saveAppLog 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->help->saveAppLog(['events' => [InputAppEvent], ]); 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 - help.saveAppLog -* params - `{"events": [InputAppEvent], }` - ### As a user: diff --git a/docs/API_docs/methods/help_setBotUpdatesStatus.md b/docs/API_docs/methods/help_setBotUpdatesStatus.md index 18a7675c..55e1d2fe 100644 --- a/docs/API_docs/methods/help_setBotUpdatesStatus.md +++ b/docs/API_docs/methods/help_setBotUpdatesStatus.md @@ -16,6 +16,9 @@ description: help.setBotUpdatesStatus parameters, return type and example ### Return type: [Bool](../types/Bool.md) +### Can bots use this method: **YES** + + ### Example: diff --git a/docs/API_docs/methods/initConnection.md b/docs/API_docs/methods/initConnection.md index 2524e67b..6de9ef77 100644 --- a/docs/API_docs/methods/initConnection.md +++ b/docs/API_docs/methods/initConnection.md @@ -22,6 +22,15 @@ description: initConnection parameters, return type and example ### Return type: [X](../types/X.md) +### Can bots use this method: **YES** + + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|INPUT_FETCH_FAIL|Failed deserializing TL payload| + ### Example: diff --git a/docs/API_docs/methods/invokeAfterMsg.md b/docs/API_docs/methods/invokeAfterMsg.md index 29059786..c139fe8c 100644 --- a/docs/API_docs/methods/invokeAfterMsg.md +++ b/docs/API_docs/methods/invokeAfterMsg.md @@ -16,6 +16,9 @@ description: invokeAfterMsg parameters, return type and example ### Return type: [X](../types/X.md) +### Can bots use this method: **YES** + + ### Example: diff --git a/docs/API_docs/methods/invokeAfterMsgs.md b/docs/API_docs/methods/invokeAfterMsgs.md index 0bbde67e..35004296 100644 --- a/docs/API_docs/methods/invokeAfterMsgs.md +++ b/docs/API_docs/methods/invokeAfterMsgs.md @@ -16,6 +16,9 @@ description: invokeAfterMsgs parameters, return type and example ### Return type: [X](../types/X.md) +### Can bots use this method: **YES** + + ### Example: diff --git a/docs/API_docs/methods/invokeWithLayer.md b/docs/API_docs/methods/invokeWithLayer.md index d9ef913a..bbccdf5d 100644 --- a/docs/API_docs/methods/invokeWithLayer.md +++ b/docs/API_docs/methods/invokeWithLayer.md @@ -16,6 +16,15 @@ description: invokeWithLayer parameters, return type and example ### Return type: [X](../types/X.md) +### Can bots use this method: **YES** + + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|INPUT_LAYER_INVALID|The provided layer is invalid| + ### Example: diff --git a/docs/API_docs/methods/invokeWithoutUpdates.md b/docs/API_docs/methods/invokeWithoutUpdates.md index 1029648c..10c6bfcf 100644 --- a/docs/API_docs/methods/invokeWithoutUpdates.md +++ b/docs/API_docs/methods/invokeWithoutUpdates.md @@ -15,6 +15,9 @@ description: invokeWithoutUpdates parameters, return type and example ### Return type: [X](../types/X.md) +### Can bots use this method: **YES** + + ### Example: diff --git a/docs/API_docs/methods/langpack_getDifference.md b/docs/API_docs/methods/langpack_getDifference.md index 095780ba..e1da920b 100644 --- a/docs/API_docs/methods/langpack_getDifference.md +++ b/docs/API_docs/methods/langpack_getDifference.md @@ -15,14 +15,20 @@ description: langpack.getDifference parameters, return type and example ### Return type: [LangPackDifference](../types/LangPackDifference.md) +### Can bots use this method: **NO** + + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|LANG_PACK_INVALID|The provided language pack 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 +44,6 @@ $LangPackDifference = $MadelineProto->langpack->getDifference(['from_version' => 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 - langpack.getDifference -* params - `{"from_version": int, }` - ### As a user: diff --git a/docs/API_docs/methods/langpack_getLangPack.md b/docs/API_docs/methods/langpack_getLangPack.md index 5b84f00b..89c47e22 100644 --- a/docs/API_docs/methods/langpack_getLangPack.md +++ b/docs/API_docs/methods/langpack_getLangPack.md @@ -15,14 +15,20 @@ description: langpack.getLangPack parameters, return type and example ### Return type: [LangPackDifference](../types/LangPackDifference.md) +### Can bots use this method: **NO** + + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|LANG_PACK_INVALID|The provided language pack 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 +44,6 @@ $LangPackDifference = $MadelineProto->langpack->getLangPack(['lang_code' => 'str 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 - langpack.getLangPack -* params - `{"lang_code": "string", }` - ### As a user: diff --git a/docs/API_docs/methods/langpack_getLanguages.md b/docs/API_docs/methods/langpack_getLanguages.md index 5969cdd6..8f9c376a 100644 --- a/docs/API_docs/methods/langpack_getLanguages.md +++ b/docs/API_docs/methods/langpack_getLanguages.md @@ -10,14 +10,20 @@ description: langpack.getLanguages parameters, return type and example ### Return type: [Vector\_of\_LangPackLanguage](../types/LangPackLanguage.md) +### Can bots use this method: **NO** + + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|LANG_PACK_INVALID|The provided language pack 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: '; @@ -33,15 +39,6 @@ $Vector_of_LangPackLanguage = $MadelineProto->langpack->getLanguages(); 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 - langpack.getLanguages -* params - `{}` - ### As a user: diff --git a/docs/API_docs/methods/langpack_getStrings.md b/docs/API_docs/methods/langpack_getStrings.md index 50a6836d..c3e18ecd 100644 --- a/docs/API_docs/methods/langpack_getStrings.md +++ b/docs/API_docs/methods/langpack_getStrings.md @@ -16,14 +16,20 @@ description: langpack.getStrings parameters, return type and example ### Return type: [Vector\_of\_LangPackString](../types/LangPackString.md) +### Can bots use this method: **NO** + + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|LANG_PACK_INVALID|The provided language pack 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 +45,6 @@ $Vector_of_LangPackString = $MadelineProto->langpack->getStrings(['lang_code' => 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 - langpack.getStrings -* params - `{"lang_code": "string", "keys": ["string"], }` - ### As a user: diff --git a/docs/API_docs/methods/messages_addChatUser.md b/docs/API_docs/methods/messages_addChatUser.md index f88a8065..76f21e0b 100644 --- a/docs/API_docs/methods/messages_addChatUser.md +++ b/docs/API_docs/methods/messages_addChatUser.md @@ -17,14 +17,20 @@ description: messages.addChatUser parameters, return type and example ### Return type: [Updates](../types/Updates.md) +### Can bots use this method: **NO** + + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid||USER_ALREADY_PARTICIPANT|The user is already in the group||USER_ID_INVALID|The provided user ID is invalid||USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| + ### 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 +46,6 @@ $Updates = $MadelineProto->messages->addChatUser(['chat_id' => InputPeer, 'user_ 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.addChatUser -* params - `{"chat_id": InputPeer, "user_id": InputUser, "fwd_limit": int, }` - ### As a user: diff --git a/docs/API_docs/methods/messages_checkChatInvite.md b/docs/API_docs/methods/messages_checkChatInvite.md index 718d7fad..ec4168bf 100644 --- a/docs/API_docs/methods/messages_checkChatInvite.md +++ b/docs/API_docs/methods/messages_checkChatInvite.md @@ -15,14 +15,20 @@ description: messages.checkChatInvite parameters, return type and example ### Return type: [ChatInvite](../types/ChatInvite.md) +### Can bots use this method: **NO** + + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|INVITE_HASH_EMPTY|The invite hash 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 +44,6 @@ $ChatInvite = $MadelineProto->messages->checkChatInvite(['hash' => '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 - messages.checkChatInvite -* params - `{"hash": "string", }` - ### As a user: diff --git a/docs/API_docs/methods/messages_clearRecentStickers.md b/docs/API_docs/methods/messages_clearRecentStickers.md index 509cc63e..dda76d14 100644 --- a/docs/API_docs/methods/messages_clearRecentStickers.md +++ b/docs/API_docs/methods/messages_clearRecentStickers.md @@ -15,14 +15,14 @@ description: messages.clearRecentStickers 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->messages->clearRecentStickers(['attached' => 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.clearRecentStickers -* params - `{"attached": Bool, }` - ### As a user: diff --git a/docs/API_docs/methods/messages_createChat.md b/docs/API_docs/methods/messages_createChat.md index cc0090e5..fe22b00a 100644 --- a/docs/API_docs/methods/messages_createChat.md +++ b/docs/API_docs/methods/messages_createChat.md @@ -16,14 +16,20 @@ description: messages.createChat 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.||USERS_TOO_FEW|Not enough users (to create a chat, for example)| + ### 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 +45,6 @@ $Updates = $MadelineProto->messages->createChat(['users' => [InputUser], 'title' 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.createChat -* params - `{"users": [InputUser], "title": "string", }` - ### As a user: diff --git a/docs/API_docs/methods/messages_deleteChatUser.md b/docs/API_docs/methods/messages_deleteChatUser.md index a5bbf771..fc8f7ae8 100644 --- a/docs/API_docs/methods/messages_deleteChatUser.md +++ b/docs/API_docs/methods/messages_deleteChatUser.md @@ -16,6 +16,15 @@ description: messages.deleteChatUser parameters, return type and example ### Return type: [Updates](../types/Updates.md) +### Can bots use this method: **YES** + + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid||PEER_ID_INVALID|The provided peer id is invalid| + ### Example: diff --git a/docs/API_docs/methods/messages_deleteHistory.md b/docs/API_docs/methods/messages_deleteHistory.md index 6e1693ca..009e39c0 100644 --- a/docs/API_docs/methods/messages_deleteHistory.md +++ b/docs/API_docs/methods/messages_deleteHistory.md @@ -17,14 +17,20 @@ description: messages.deleteHistory 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 | +|----------|---------------| +|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: '; @@ -40,15 +46,6 @@ $messages_AffectedHistory = $MadelineProto->messages->deleteHistory(['just_clear 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.deleteHistory -* params - `{"just_clear": Bool, "peer": InputPeer, "max_id": int, }` - ### As a user: diff --git a/docs/API_docs/methods/messages_deleteMessages.md b/docs/API_docs/methods/messages_deleteMessages.md index e3ff6ddc..2949f64a 100644 --- a/docs/API_docs/methods/messages_deleteMessages.md +++ b/docs/API_docs/methods/messages_deleteMessages.md @@ -16,6 +16,9 @@ description: messages.deleteMessages parameters, return type and example ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) +### Can bots use this method: **YES** + + ### Example: diff --git a/docs/API_docs/methods/messages_editChatAdmin.md b/docs/API_docs/methods/messages_editChatAdmin.md index 67824450..b5a96b00 100644 --- a/docs/API_docs/methods/messages_editChatAdmin.md +++ b/docs/API_docs/methods/messages_editChatAdmin.md @@ -17,14 +17,20 @@ description: messages.editChatAdmin parameters, return type and example ### Return type: [Bool](../types/Bool.md) +### Can bots use this method: **NO** + + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|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: '; @@ -40,15 +46,6 @@ $Bool = $MadelineProto->messages->editChatAdmin(['chat_id' => InputPeer, '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 - messages.editChatAdmin -* params - `{"chat_id": InputPeer, "user_id": InputUser, "is_admin": Bool, }` - ### As a user: diff --git a/docs/API_docs/methods/messages_editChatPhoto.md b/docs/API_docs/methods/messages_editChatPhoto.md index e5fc45f9..7c3df45a 100644 --- a/docs/API_docs/methods/messages_editChatPhoto.md +++ b/docs/API_docs/methods/messages_editChatPhoto.md @@ -16,6 +16,15 @@ description: messages.editChatPhoto parameters, return type and example ### Return type: [Updates](../types/Updates.md) +### Can bots use this method: **YES** + + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid||PEER_ID_INVALID|The provided peer id is invalid| + ### Example: diff --git a/docs/API_docs/methods/messages_editChatTitle.md b/docs/API_docs/methods/messages_editChatTitle.md index f0cf3132..9c203aa7 100644 --- a/docs/API_docs/methods/messages_editChatTitle.md +++ b/docs/API_docs/methods/messages_editChatTitle.md @@ -16,6 +16,15 @@ description: messages.editChatTitle parameters, return type and example ### Return type: [Updates](../types/Updates.md) +### Can bots use this method: **YES** + + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|NEED_CHAT_INVALID|The provided chat is invalid| + ### Example: diff --git a/docs/API_docs/methods/messages_editInlineBotMessage.md b/docs/API_docs/methods/messages_editInlineBotMessage.md index 2ad6693f..a3fdbc64 100644 --- a/docs/API_docs/methods/messages_editInlineBotMessage.md +++ b/docs/API_docs/methods/messages_editInlineBotMessage.md @@ -20,6 +20,15 @@ description: messages.editInlineBotMessage parameters, return type and example ### Return type: [Bool](../types/Bool.md) +### Can bots use this method: **YES** + + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_ID_INVALID|The provided message id is invalid||MESSAGE_NOT_MODIFIED|The message text has not changed| + ### Example: diff --git a/docs/API_docs/methods/messages_editMessage.md b/docs/API_docs/methods/messages_editMessage.md index 75b9d35d..adc88b5a 100644 --- a/docs/API_docs/methods/messages_editMessage.md +++ b/docs/API_docs/methods/messages_editMessage.md @@ -21,6 +21,15 @@ description: messages.editMessage parameters, return type and example ### Return type: [Updates](../types/Updates.md) +### Can bots use this method: **YES** + + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_ID_INVALID|The provided message id is invalid||PEER_ID_INVALID|The provided peer id is invalid| + ### Example: diff --git a/docs/API_docs/methods/messages_exportChatInvite.md b/docs/API_docs/methods/messages_exportChatInvite.md index 090e95fd..cd5c23a7 100644 --- a/docs/API_docs/methods/messages_exportChatInvite.md +++ b/docs/API_docs/methods/messages_exportChatInvite.md @@ -15,14 +15,20 @@ description: messages.exportChatInvite parameters, return type and example ### Return type: [ExportedChatInvite](../types/ExportedChatInvite.md) +### Can bots use this method: **NO** + + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|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: '; @@ -38,15 +44,6 @@ $ExportedChatInvite = $MadelineProto->messages->exportChatInvite(['chat_id' => 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 - messages.exportChatInvite -* params - `{"chat_id": InputPeer, }` - ### As a user: diff --git a/docs/API_docs/methods/messages_faveSticker.md b/docs/API_docs/methods/messages_faveSticker.md index a664b134..0b37fc72 100644 --- a/docs/API_docs/methods/messages_faveSticker.md +++ b/docs/API_docs/methods/messages_faveSticker.md @@ -16,6 +16,15 @@ description: messages.faveSticker parameters, return type and example ### Return type: [Bool](../types/Bool.md) +### Can bots use this method: **YES** + + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|STICKER_ID_INVALID|The provided sticker ID is invalid| + ### Example: diff --git a/docs/API_docs/methods/messages_forwardMessage.md b/docs/API_docs/methods/messages_forwardMessage.md index 00b90611..9fed97e7 100644 --- a/docs/API_docs/methods/messages_forwardMessage.md +++ b/docs/API_docs/methods/messages_forwardMessage.md @@ -16,6 +16,15 @@ description: messages.forwardMessage parameters, return type and example ### Return type: [Updates](../types/Updates.md) +### Can bots use this method: **YES** + + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_ID_INVALID|The provided message id is invalid||PEER_ID_INVALID|The provided peer id is invalid| + ### Example: diff --git a/docs/API_docs/methods/messages_forwardMessages.md b/docs/API_docs/methods/messages_forwardMessages.md index 70b35f06..bdb38317 100644 --- a/docs/API_docs/methods/messages_forwardMessages.md +++ b/docs/API_docs/methods/messages_forwardMessages.md @@ -20,6 +20,15 @@ description: messages.forwardMessages parameters, return type and example ### Return type: [Updates](../types/Updates.md) +### Can bots use this method: **YES** + + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this||CHAT_WRITE_FORBIDDEN|You can't write in this chat||MESSAGE_ID_INVALID|The provided message id is invalid||MESSAGE_IDS_EMPTY|No message ids were provided||PEER_ID_INVALID|The provided peer id is invalid||RANDOM_ID_DUPLICATE|You provided a random ID that was already used||Timeout|A timeout occurred while fetching data from the bot| + ### Example: diff --git a/docs/API_docs/methods/messages_getAllChats.md b/docs/API_docs/methods/messages_getAllChats.md index 26af4acc..c5037003 100644 --- a/docs/API_docs/methods/messages_getAllChats.md +++ b/docs/API_docs/methods/messages_getAllChats.md @@ -15,14 +15,14 @@ description: messages.getAllChats parameters, return type and example ### 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: '; @@ -38,15 +38,6 @@ $messages_Chats = $MadelineProto->messages->getAllChats(['except_ids' => [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 - messages.getAllChats -* params - `{"except_ids": [int], }` - ### As a user: diff --git a/docs/API_docs/methods/messages_getAllDrafts.md b/docs/API_docs/methods/messages_getAllDrafts.md index 44a056d7..cc447864 100644 --- a/docs/API_docs/methods/messages_getAllDrafts.md +++ b/docs/API_docs/methods/messages_getAllDrafts.md @@ -10,14 +10,14 @@ description: messages.getAllDrafts parameters, return type and example ### Return type: [Updates](../types/Updates.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 @@ $Updates = $MadelineProto->messages->getAllDrafts(); 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.getAllDrafts -* params - `{}` - ### As a user: diff --git a/docs/API_docs/methods/messages_getAllStickers.md b/docs/API_docs/methods/messages_getAllStickers.md index cbffb64b..dc9e2432 100644 --- a/docs/API_docs/methods/messages_getAllStickers.md +++ b/docs/API_docs/methods/messages_getAllStickers.md @@ -15,14 +15,14 @@ description: messages.getAllStickers parameters, return type and example ### Return type: [messages\_AllStickers](../types/messages_AllStickers.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 @@ $messages_AllStickers = $MadelineProto->messages->getAllStickers(['hash' => 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 - messages.getAllStickers -* params - `{"hash": int, }` - ### As a user: diff --git a/docs/API_docs/methods/messages_getArchivedStickers.md b/docs/API_docs/methods/messages_getArchivedStickers.md index 73a14a0b..dddcc748 100644 --- a/docs/API_docs/methods/messages_getArchivedStickers.md +++ b/docs/API_docs/methods/messages_getArchivedStickers.md @@ -17,14 +17,14 @@ description: messages.getArchivedStickers parameters, return type and example ### Return type: [messages\_ArchivedStickers](../types/messages_ArchivedStickers.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: '; @@ -40,15 +40,6 @@ $messages_ArchivedStickers = $MadelineProto->messages->getArchivedStickers(['mas 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.getArchivedStickers -* params - `{"masks": Bool, "offset_id": long, "limit": int, }` - ### As a user: diff --git a/docs/API_docs/methods/messages_getAttachedStickers.md b/docs/API_docs/methods/messages_getAttachedStickers.md index a9901261..250db6a8 100644 --- a/docs/API_docs/methods/messages_getAttachedStickers.md +++ b/docs/API_docs/methods/messages_getAttachedStickers.md @@ -15,14 +15,14 @@ description: messages.getAttachedStickers parameters, return type and example ### Return type: [Vector\_of\_StickerSetCovered](../types/StickerSetCovered.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 @@ $Vector_of_StickerSetCovered = $MadelineProto->messages->getAttachedStickers(['m 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.getAttachedStickers -* params - `{"media": InputStickeredMedia, }` - ### As a user: diff --git a/docs/API_docs/methods/messages_getBotCallbackAnswer.md b/docs/API_docs/methods/messages_getBotCallbackAnswer.md index 0f9106a6..53764b17 100644 --- a/docs/API_docs/methods/messages_getBotCallbackAnswer.md +++ b/docs/API_docs/methods/messages_getBotCallbackAnswer.md @@ -18,14 +18,20 @@ description: messages.getBotCallbackAnswer parameters, return type and example ### Return type: [messages\_BotCallbackAnswer](../types/messages_BotCallbackAnswer.md) +### Can bots use this method: **NO** + + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_ID_INVALID|The provided message id is invalid||PEER_ID_INVALID|The provided peer id is invalid||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: '; @@ -41,15 +47,6 @@ $messages_BotCallbackAnswer = $MadelineProto->messages->getBotCallbackAnswer(['g 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.getBotCallbackAnswer -* params - `{"game": Bool, "peer": InputPeer, "msg_id": int, "data": "bytes", }` - ### As a user: diff --git a/docs/API_docs/methods/messages_getChats.md b/docs/API_docs/methods/messages_getChats.md index 4e449720..4866ed19 100644 --- a/docs/API_docs/methods/messages_getChats.md +++ b/docs/API_docs/methods/messages_getChats.md @@ -15,6 +15,15 @@ description: messages.getChats 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 | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid||PEER_ID_INVALID|The provided peer id is invalid| + ### Example: diff --git a/docs/API_docs/methods/messages_getCommonChats.md b/docs/API_docs/methods/messages_getCommonChats.md index 5b93ccf3..efd905ff 100644 --- a/docs/API_docs/methods/messages_getCommonChats.md +++ b/docs/API_docs/methods/messages_getCommonChats.md @@ -17,14 +17,20 @@ description: messages.getCommonChats parameters, return type and example ### Return type: [messages\_Chats](../types/messages_Chats.md) +### Can bots use this method: **NO** + + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|USER_ID_INVALID|The provided user 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: '; @@ -40,15 +46,6 @@ $messages_Chats = $MadelineProto->messages->getCommonChats(['user_id' => InputUs 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.getCommonChats -* params - `{"user_id": InputUser, "max_id": int, "limit": int, }` - ### As a user: diff --git a/docs/API_docs/methods/messages_getDhConfig.md b/docs/API_docs/methods/messages_getDhConfig.md index 682dfe05..8a4094bc 100644 --- a/docs/API_docs/methods/messages_getDhConfig.md +++ b/docs/API_docs/methods/messages_getDhConfig.md @@ -16,14 +16,20 @@ description: messages.getDhConfig parameters, return type and example ### Return type: [messages\_DhConfig](../types/messages_DhConfig.md) +### Can bots use this method: **NO** + + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|RANDOM_LENGTH_INVALID|Random length 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 +45,6 @@ $messages_DhConfig = $MadelineProto->messages->getDhConfig(['version' => int, 'r 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.getDhConfig -* params - `{"version": int, "random_length": int, }` - ### As a user: diff --git a/docs/API_docs/methods/messages_getDialogs.md b/docs/API_docs/methods/messages_getDialogs.md index fd84cdc0..a0ffc327 100644 --- a/docs/API_docs/methods/messages_getDialogs.md +++ b/docs/API_docs/methods/messages_getDialogs.md @@ -19,14 +19,20 @@ description: messages.getDialogs parameters, return type and example ### Return type: [messages\_Dialogs](../types/messages_Dialogs.md) +### Can bots use this method: **NO** + + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login| + ### 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: '; @@ -42,15 +48,6 @@ $messages_Dialogs = $MadelineProto->messages->getDialogs(['exclude_pinned' => Bo 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.getDialogs -* params - `{"exclude_pinned": Bool, "offset_date": int, "offset_id": int, "offset_peer": InputPeer, "limit": int, }` - ### As a user: diff --git a/docs/API_docs/methods/messages_getDocumentByHash.md b/docs/API_docs/methods/messages_getDocumentByHash.md index 6f530058..65146bb2 100644 --- a/docs/API_docs/methods/messages_getDocumentByHash.md +++ b/docs/API_docs/methods/messages_getDocumentByHash.md @@ -17,6 +17,15 @@ description: messages.getDocumentByHash parameters, return type and example ### Return type: [Document](../types/Document.md) +### Can bots use this method: **YES** + + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SHA256_HASH_INVALID|The provided SHA256 hash is invalid| + ### Example: diff --git a/docs/API_docs/methods/messages_getFavedStickers.md b/docs/API_docs/methods/messages_getFavedStickers.md index 932bab6d..482b8fc5 100644 --- a/docs/API_docs/methods/messages_getFavedStickers.md +++ b/docs/API_docs/methods/messages_getFavedStickers.md @@ -15,6 +15,9 @@ description: messages.getFavedStickers parameters, return type and example ### Return type: [messages\_FavedStickers](../types/messages_FavedStickers.md) +### Can bots use this method: **YES** + + ### Example: diff --git a/docs/API_docs/methods/messages_getFeaturedStickers.md b/docs/API_docs/methods/messages_getFeaturedStickers.md index c4f66eef..9573464a 100644 --- a/docs/API_docs/methods/messages_getFeaturedStickers.md +++ b/docs/API_docs/methods/messages_getFeaturedStickers.md @@ -15,14 +15,14 @@ description: messages.getFeaturedStickers parameters, return type and example ### Return type: [messages\_FeaturedStickers](../types/messages_FeaturedStickers.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 @@ $messages_FeaturedStickers = $MadelineProto->messages->getFeaturedStickers(['has 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.getFeaturedStickers -* params - `{"hash": int, }` - ### As a user: diff --git a/docs/API_docs/methods/messages_getGameHighScores.md b/docs/API_docs/methods/messages_getGameHighScores.md index 949570c9..602bf5e8 100644 --- a/docs/API_docs/methods/messages_getGameHighScores.md +++ b/docs/API_docs/methods/messages_getGameHighScores.md @@ -17,6 +17,15 @@ description: messages.getGameHighScores parameters, return type and example ### Return type: [messages\_HighScores](../types/messages_HighScores.md) +### Can bots use this method: **YES** + + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid||USER_BOT_REQUIRED|This method can only be called by a bot| + ### Example: diff --git a/docs/API_docs/methods/messages_getHistory.md b/docs/API_docs/methods/messages_getHistory.md index 48df8880..f8232d25 100644 --- a/docs/API_docs/methods/messages_getHistory.md +++ b/docs/API_docs/methods/messages_getHistory.md @@ -21,14 +21,20 @@ description: messages.getHistory parameters, return type and example ### Return type: [messages\_Messages](../types/messages_Messages.md) +### Can bots use this method: **NO** + + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHANNEL_PRIVATE|You haven't joined this channel/supergroup||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: '; @@ -44,15 +50,6 @@ $messages_Messages = $MadelineProto->messages->getHistory(['peer' => InputPeer, 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.getHistory -* params - `{"peer": InputPeer, "offset_id": int, "offset_date": int, "add_offset": int, "limit": int, "max_id": int, "min_id": int, }` - ### As a user: diff --git a/docs/API_docs/methods/messages_getInlineBotResults.md b/docs/API_docs/methods/messages_getInlineBotResults.md index 4f649e6e..259408a8 100644 --- a/docs/API_docs/methods/messages_getInlineBotResults.md +++ b/docs/API_docs/methods/messages_getInlineBotResults.md @@ -19,14 +19,20 @@ description: messages.getInlineBotResults parameters, return type and example ### Return type: [messages\_BotResults](../types/messages_BotResults.md) +### Can bots use this method: **NO** + + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_INLINE_DISABLED|This bot can't be used in inline mode||BOT_INVALID|This is not a valid bot||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: '; @@ -42,15 +48,6 @@ $messages_BotResults = $MadelineProto->messages->getInlineBotResults(['bot' => 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 - messages.getInlineBotResults -* params - `{"bot": InputUser, "peer": InputPeer, "geo_point": InputGeoPoint, "query": "string", "offset": "string", }` - ### As a user: diff --git a/docs/API_docs/methods/messages_getInlineGameHighScores.md b/docs/API_docs/methods/messages_getInlineGameHighScores.md index 6035961c..9f66fb76 100644 --- a/docs/API_docs/methods/messages_getInlineGameHighScores.md +++ b/docs/API_docs/methods/messages_getInlineGameHighScores.md @@ -16,6 +16,15 @@ description: messages.getInlineGameHighScores parameters, return type and exampl ### Return type: [messages\_HighScores](../types/messages_HighScores.md) +### Can bots use this method: **YES** + + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_ID_INVALID|The provided message id is invalid||USER_BOT_REQUIRED|This method can only be called by a bot| + ### Example: diff --git a/docs/API_docs/methods/messages_getMaskStickers.md b/docs/API_docs/methods/messages_getMaskStickers.md index f63bc5e7..0ab194df 100644 --- a/docs/API_docs/methods/messages_getMaskStickers.md +++ b/docs/API_docs/methods/messages_getMaskStickers.md @@ -15,14 +15,14 @@ description: messages.getMaskStickers parameters, return type and example ### Return type: [messages\_AllStickers](../types/messages_AllStickers.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 @@ $messages_AllStickers = $MadelineProto->messages->getMaskStickers(['hash' => 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 - messages.getMaskStickers -* params - `{"hash": int, }` - ### As a user: diff --git a/docs/API_docs/methods/messages_getMessageEditData.md b/docs/API_docs/methods/messages_getMessageEditData.md index d762c542..62e130c8 100644 --- a/docs/API_docs/methods/messages_getMessageEditData.md +++ b/docs/API_docs/methods/messages_getMessageEditData.md @@ -16,14 +16,20 @@ description: messages.getMessageEditData parameters, return type and example ### Return type: [messages\_MessageEditData](../types/messages_MessageEditData.md) +### Can bots use this method: **NO** + + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_AUTHOR_REQUIRED|Message author required||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 +45,6 @@ $messages_MessageEditData = $MadelineProto->messages->getMessageEditData(['peer' 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.getMessageEditData -* params - `{"peer": InputPeer, "id": int, }` - ### As a user: diff --git a/docs/API_docs/methods/messages_getMessages.md b/docs/API_docs/methods/messages_getMessages.md index 73657f3e..5a970246 100644 --- a/docs/API_docs/methods/messages_getMessages.md +++ b/docs/API_docs/methods/messages_getMessages.md @@ -15,6 +15,9 @@ description: messages.getMessages parameters, return type and example ### Return type: [messages\_Messages](../types/messages_Messages.md) +### Can bots use this method: **YES** + + ### Example: diff --git a/docs/API_docs/methods/messages_getMessagesViews.md b/docs/API_docs/methods/messages_getMessagesViews.md index c50b8bd3..45bf654d 100644 --- a/docs/API_docs/methods/messages_getMessagesViews.md +++ b/docs/API_docs/methods/messages_getMessagesViews.md @@ -17,14 +17,20 @@ description: messages.getMessagesViews parameters, return type and example ### Return type: [Vector\_of\_int](../types/int.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: '; @@ -40,15 +46,6 @@ $Vector_of_int = $MadelineProto->messages->getMessagesViews(['peer' => InputPeer 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.getMessagesViews -* params - `{"peer": InputPeer, "id": [int], "increment": Bool, }` - ### As a user: diff --git a/docs/API_docs/methods/messages_getPeerDialogs.md b/docs/API_docs/methods/messages_getPeerDialogs.md index 015aa909..6eaf48ff 100644 --- a/docs/API_docs/methods/messages_getPeerDialogs.md +++ b/docs/API_docs/methods/messages_getPeerDialogs.md @@ -15,14 +15,20 @@ description: messages.getPeerDialogs parameters, return type and example ### Return type: [messages\_PeerDialogs](../types/messages_PeerDialogs.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 +44,6 @@ $messages_PeerDialogs = $MadelineProto->messages->getPeerDialogs(['peers' => [In 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.getPeerDialogs -* params - `{"peers": [InputPeer], }` - ### As a user: diff --git a/docs/API_docs/methods/messages_getPeerSettings.md b/docs/API_docs/methods/messages_getPeerSettings.md index baa5afc9..b62bfd2c 100644 --- a/docs/API_docs/methods/messages_getPeerSettings.md +++ b/docs/API_docs/methods/messages_getPeerSettings.md @@ -15,14 +15,20 @@ description: messages.getPeerSettings parameters, return type and example ### Return type: [PeerSettings](../types/PeerSettings.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 +44,6 @@ $PeerSettings = $MadelineProto->messages->getPeerSettings(['peer' => InputPeer, 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.getPeerSettings -* params - `{"peer": InputPeer, }` - ### As a user: diff --git a/docs/API_docs/methods/messages_getPinnedDialogs.md b/docs/API_docs/methods/messages_getPinnedDialogs.md index 2238bca9..110eab05 100644 --- a/docs/API_docs/methods/messages_getPinnedDialogs.md +++ b/docs/API_docs/methods/messages_getPinnedDialogs.md @@ -10,14 +10,14 @@ description: messages.getPinnedDialogs parameters, return type and example ### Return type: [messages\_PeerDialogs](../types/messages_PeerDialogs.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_PeerDialogs = $MadelineProto->messages->getPinnedDialogs(); 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.getPinnedDialogs -* params - `{}` - ### As a user: diff --git a/docs/API_docs/methods/messages_getRecentStickers.md b/docs/API_docs/methods/messages_getRecentStickers.md index 6e04d957..10d1a0df 100644 --- a/docs/API_docs/methods/messages_getRecentStickers.md +++ b/docs/API_docs/methods/messages_getRecentStickers.md @@ -16,14 +16,14 @@ description: messages.getRecentStickers parameters, return type and example ### Return type: [messages\_RecentStickers](../types/messages_RecentStickers.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: '; @@ -39,15 +39,6 @@ $messages_RecentStickers = $MadelineProto->messages->getRecentStickers(['attache 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.getRecentStickers -* params - `{"attached": Bool, "hash": int, }` - ### As a user: diff --git a/docs/API_docs/methods/messages_getSavedGifs.md b/docs/API_docs/methods/messages_getSavedGifs.md index 99ae002f..7cce4ffe 100644 --- a/docs/API_docs/methods/messages_getSavedGifs.md +++ b/docs/API_docs/methods/messages_getSavedGifs.md @@ -15,14 +15,14 @@ description: messages.getSavedGifs parameters, return type and example ### Return type: [messages\_SavedGifs](../types/messages_SavedGifs.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 @@ $messages_SavedGifs = $MadelineProto->messages->getSavedGifs(['hash' => 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 - messages.getSavedGifs -* params - `{"hash": int, }` - ### As a user: diff --git a/docs/API_docs/methods/messages_getStickerSet.md b/docs/API_docs/methods/messages_getStickerSet.md index 1dc79781..9f133060 100644 --- a/docs/API_docs/methods/messages_getStickerSet.md +++ b/docs/API_docs/methods/messages_getStickerSet.md @@ -15,6 +15,15 @@ description: messages.getStickerSet parameters, return type and example ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) +### Can bots use this method: **YES** + + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|STICKERSET_INVALID|The provided sticker set is invalid| + ### Example: diff --git a/docs/API_docs/methods/messages_getUnreadMentions.md b/docs/API_docs/methods/messages_getUnreadMentions.md index 2fa2c019..9db984df 100644 --- a/docs/API_docs/methods/messages_getUnreadMentions.md +++ b/docs/API_docs/methods/messages_getUnreadMentions.md @@ -20,6 +20,15 @@ description: messages.getUnreadMentions 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 | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid| + ### Example: diff --git a/docs/API_docs/methods/messages_getWebPage.md b/docs/API_docs/methods/messages_getWebPage.md index 93516301..81591daf 100644 --- a/docs/API_docs/methods/messages_getWebPage.md +++ b/docs/API_docs/methods/messages_getWebPage.md @@ -16,14 +16,14 @@ description: messages.getWebPage parameters, return type and example ### Return type: [WebPage](../types/WebPage.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: '; @@ -39,15 +39,6 @@ $WebPage = $MadelineProto->messages->getWebPage(['url' => 'string', 'hash' => in 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.getWebPage -* params - `{"url": "string", "hash": int, }` - ### As a user: diff --git a/docs/API_docs/methods/messages_getWebPagePreview.md b/docs/API_docs/methods/messages_getWebPagePreview.md index be811463..a89600b1 100644 --- a/docs/API_docs/methods/messages_getWebPagePreview.md +++ b/docs/API_docs/methods/messages_getWebPagePreview.md @@ -15,14 +15,14 @@ description: messages.getWebPagePreview parameters, return type and example ### Return type: [MessageMedia](../types/MessageMedia.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 @@ $MessageMedia = $MadelineProto->messages->getWebPagePreview(['message' => 'strin 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.getWebPagePreview -* params - `{"message": "string", }` - ### As a user: diff --git a/docs/API_docs/methods/messages_hideReportSpam.md b/docs/API_docs/methods/messages_hideReportSpam.md index 55f18a3d..4bfe8ab1 100644 --- a/docs/API_docs/methods/messages_hideReportSpam.md +++ b/docs/API_docs/methods/messages_hideReportSpam.md @@ -15,14 +15,20 @@ description: messages.hideReportSpam 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: '; @@ -38,15 +44,6 @@ $Bool = $MadelineProto->messages->hideReportSpam(['peer' => InputPeer, ]); 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.hideReportSpam -* params - `{"peer": InputPeer, }` - ### As a user: diff --git a/docs/API_docs/methods/messages_importChatInvite.md b/docs/API_docs/methods/messages_importChatInvite.md index e194b8f8..06e75616 100644 --- a/docs/API_docs/methods/messages_importChatInvite.md +++ b/docs/API_docs/methods/messages_importChatInvite.md @@ -15,14 +15,20 @@ description: messages.importChatInvite parameters, return type and example ### Return type: [Updates](../types/Updates.md) +### Can bots use this method: **NO** + + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|INVITE_HASH_EMPTY|The invite hash is empty||INVITE_HASH_EXPIRED|The invite link has expired||INVITE_HASH_INVALID|The invite hash is invalid||USER_ALREADY_PARTICIPANT|The user is already in the group||USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)| + ### 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 +44,6 @@ $Updates = $MadelineProto->messages->importChatInvite(['hash' => '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 - messages.importChatInvite -* params - `{"hash": "string", }` - ### As a user: diff --git a/docs/API_docs/methods/messages_installStickerSet.md b/docs/API_docs/methods/messages_installStickerSet.md index 29baa8f8..c0cfa607 100644 --- a/docs/API_docs/methods/messages_installStickerSet.md +++ b/docs/API_docs/methods/messages_installStickerSet.md @@ -16,14 +16,20 @@ description: messages.installStickerSet parameters, return type and example ### Return type: [messages\_StickerSetInstallResult](../types/messages_StickerSetInstallResult.md) +### Can bots use this method: **NO** + + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|STICKERSET_INVALID|The provided sticker set 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 +45,6 @@ $messages_StickerSetInstallResult = $MadelineProto->messages->installStickerSet( 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.installStickerSet -* params - `{"stickerset": InputStickerSet, "archived": Bool, }` - ### As a user: diff --git a/docs/API_docs/methods/messages_migrateChat.md b/docs/API_docs/methods/messages_migrateChat.md index 5a2edb4c..bd096e90 100644 --- a/docs/API_docs/methods/messages_migrateChat.md +++ b/docs/API_docs/methods/messages_migrateChat.md @@ -15,14 +15,20 @@ description: messages.migrateChat parameters, return type and example ### Return type: [Updates](../types/Updates.md) +### Can bots use this method: **NO** + + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CHAT_ID_INVALID|The provided chat id is invalid||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 +44,6 @@ $Updates = $MadelineProto->messages->migrateChat(['chat_id' => InputPeer, ]); 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.migrateChat -* params - `{"chat_id": InputPeer, }` - ### As a user: diff --git a/docs/API_docs/methods/messages_readEncryptedHistory.md b/docs/API_docs/methods/messages_readEncryptedHistory.md index 164b0c87..5e350960 100644 --- a/docs/API_docs/methods/messages_readEncryptedHistory.md +++ b/docs/API_docs/methods/messages_readEncryptedHistory.md @@ -16,6 +16,15 @@ description: messages.readEncryptedHistory parameters, return type and example ### Return type: [Bool](../types/Bool.md) +### Can bots use this method: **YES** + + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MSG_WAIT_FAILED|A waiting call returned an error| + ### Example: diff --git a/docs/API_docs/methods/messages_readFeaturedStickers.md b/docs/API_docs/methods/messages_readFeaturedStickers.md index 9d3ed82a..c7ce7aca 100644 --- a/docs/API_docs/methods/messages_readFeaturedStickers.md +++ b/docs/API_docs/methods/messages_readFeaturedStickers.md @@ -15,14 +15,14 @@ description: messages.readFeaturedStickers 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->messages->readFeaturedStickers(['id' => [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 - messages.readFeaturedStickers -* params - `{"id": [long], }` - ### As a user: diff --git a/docs/API_docs/methods/messages_readHistory.md b/docs/API_docs/methods/messages_readHistory.md index d7e5e025..ad0492e8 100644 --- a/docs/API_docs/methods/messages_readHistory.md +++ b/docs/API_docs/methods/messages_readHistory.md @@ -16,14 +16,20 @@ description: messages.readHistory parameters, return type and example ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.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 +45,6 @@ $messages_AffectedMessages = $MadelineProto->messages->readHistory(['peer' => In 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.readHistory -* params - `{"peer": InputPeer, "max_id": int, }` - ### As a user: diff --git a/docs/API_docs/methods/messages_readMessageContents.md b/docs/API_docs/methods/messages_readMessageContents.md index fb039505..4b1abda0 100644 --- a/docs/API_docs/methods/messages_readMessageContents.md +++ b/docs/API_docs/methods/messages_readMessageContents.md @@ -15,14 +15,14 @@ description: messages.readMessageContents parameters, return type and example ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.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 @@ $messages_AffectedMessages = $MadelineProto->messages->readMessageContents(['id' 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.readMessageContents -* params - `{"id": [int], }` - ### As a user: diff --git a/docs/API_docs/methods/messages_receivedMessages.md b/docs/API_docs/methods/messages_receivedMessages.md index c2c5e58e..588ac5cf 100644 --- a/docs/API_docs/methods/messages_receivedMessages.md +++ b/docs/API_docs/methods/messages_receivedMessages.md @@ -15,14 +15,14 @@ description: messages.receivedMessages parameters, return type and example ### Return type: [Vector\_of\_ReceivedNotifyMessage](../types/ReceivedNotifyMessage.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 @@ $Vector_of_ReceivedNotifyMessage = $MadelineProto->messages->receivedMessages([' 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.receivedMessages -* params - `{"max_id": int, }` - ### As a user: diff --git a/docs/API_docs/methods/messages_receivedQueue.md b/docs/API_docs/methods/messages_receivedQueue.md index 06a86e8c..51453efa 100644 --- a/docs/API_docs/methods/messages_receivedQueue.md +++ b/docs/API_docs/methods/messages_receivedQueue.md @@ -15,6 +15,15 @@ description: messages.receivedQueue parameters, return type and example ### Return type: [Vector\_of\_long](../types/long.md) +### Can bots use this method: **YES** + + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MSG_WAIT_FAILED|A waiting call returned an error| + ### Example: diff --git a/docs/API_docs/methods/messages_reorderPinnedDialogs.md b/docs/API_docs/methods/messages_reorderPinnedDialogs.md index 2cc4f6ad..72a278f5 100644 --- a/docs/API_docs/methods/messages_reorderPinnedDialogs.md +++ b/docs/API_docs/methods/messages_reorderPinnedDialogs.md @@ -16,14 +16,20 @@ description: messages.reorderPinnedDialogs 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 +45,6 @@ $Bool = $MadelineProto->messages->reorderPinnedDialogs(['force' => Bool, 'order' 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.reorderPinnedDialogs -* params - `{"force": Bool, "order": [InputPeer], }` - ### As a user: diff --git a/docs/API_docs/methods/messages_reorderStickerSets.md b/docs/API_docs/methods/messages_reorderStickerSets.md index 68a1f6f0..5c47f174 100644 --- a/docs/API_docs/methods/messages_reorderStickerSets.md +++ b/docs/API_docs/methods/messages_reorderStickerSets.md @@ -16,14 +16,14 @@ description: messages.reorderStickerSets 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: '; @@ -39,15 +39,6 @@ $Bool = $MadelineProto->messages->reorderStickerSets(['masks' => Bool, 'order' = 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.reorderStickerSets -* params - `{"masks": Bool, "order": [long], }` - ### As a user: diff --git a/docs/API_docs/methods/messages_reportEncryptedSpam.md b/docs/API_docs/methods/messages_reportEncryptedSpam.md index 8fec3610..8fbc8649 100644 --- a/docs/API_docs/methods/messages_reportEncryptedSpam.md +++ b/docs/API_docs/methods/messages_reportEncryptedSpam.md @@ -15,14 +15,20 @@ description: messages.reportEncryptedSpam parameters, return type and example ### Return type: [Bool](../types/Bool.md) +### Can bots use this method: **NO** + + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|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: '; @@ -38,15 +44,6 @@ $Bool = $MadelineProto->messages->reportEncryptedSpam(['peer' => InputEncryptedC 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.reportEncryptedSpam -* params - `{"peer": InputEncryptedChat, }` - ### As a user: diff --git a/docs/API_docs/methods/messages_reportSpam.md b/docs/API_docs/methods/messages_reportSpam.md index f2110362..30cb42a0 100644 --- a/docs/API_docs/methods/messages_reportSpam.md +++ b/docs/API_docs/methods/messages_reportSpam.md @@ -15,14 +15,20 @@ description: messages.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 | +|----------|---------------| +|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 +44,6 @@ $Bool = $MadelineProto->messages->reportSpam(['peer' => InputPeer, ]); 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.reportSpam -* params - `{"peer": InputPeer, }` - ### As a user: diff --git a/docs/API_docs/methods/messages_saveDraft.md b/docs/API_docs/methods/messages_saveDraft.md index 7c2960d2..5c9d4b8f 100644 --- a/docs/API_docs/methods/messages_saveDraft.md +++ b/docs/API_docs/methods/messages_saveDraft.md @@ -20,14 +20,20 @@ description: messages.saveDraft 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: '; @@ -43,15 +49,6 @@ $Bool = $MadelineProto->messages->saveDraft(['no_webpage' => Bool, 'reply_to_msg 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.saveDraft -* params - `{"no_webpage": Bool, "reply_to_msg_id": int, "peer": InputPeer, "message": "string", "entities": [MessageEntity], "parse_mode": "string"}` - ### As a user: diff --git a/docs/API_docs/methods/messages_saveGif.md b/docs/API_docs/methods/messages_saveGif.md index bf2d13e3..9893c9b3 100644 --- a/docs/API_docs/methods/messages_saveGif.md +++ b/docs/API_docs/methods/messages_saveGif.md @@ -16,14 +16,20 @@ description: messages.saveGif parameters, return type and example ### Return type: [Bool](../types/Bool.md) +### Can bots use this method: **NO** + + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|GIF_ID_INVALID|The provided GIF 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 +45,6 @@ $Bool = $MadelineProto->messages->saveGif(['id' => InputDocument, 'unsave' => Bo 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.saveGif -* params - `{"id": InputDocument, "unsave": Bool, }` - ### As a user: diff --git a/docs/API_docs/methods/messages_saveRecentSticker.md b/docs/API_docs/methods/messages_saveRecentSticker.md index c9c7b08b..45caff91 100644 --- a/docs/API_docs/methods/messages_saveRecentSticker.md +++ b/docs/API_docs/methods/messages_saveRecentSticker.md @@ -17,14 +17,20 @@ description: messages.saveRecentSticker parameters, return type and example ### Return type: [Bool](../types/Bool.md) +### Can bots use this method: **NO** + + +### 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: '; @@ -40,15 +46,6 @@ $Bool = $MadelineProto->messages->saveRecentSticker(['attached' => Bool, 'id' => 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.saveRecentSticker -* params - `{"attached": Bool, "id": InputDocument, "unsave": Bool, }` - ### As a user: diff --git a/docs/API_docs/methods/messages_search.md b/docs/API_docs/methods/messages_search.md index a02a9a80..874cf6ac 100644 --- a/docs/API_docs/methods/messages_search.md +++ b/docs/API_docs/methods/messages_search.md @@ -25,14 +25,20 @@ description: messages.search parameters, return type and example ### Return type: [messages\_Messages](../types/messages_Messages.md) +### Can bots use this method: **NO** + + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid||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: '; @@ -48,15 +54,6 @@ $messages_Messages = $MadelineProto->messages->search(['peer' => InputPeer, 'q' 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.search -* params - `{"peer": InputPeer, "q": "string", "from_id": InputUser, "filter": MessagesFilter, "min_date": int, "max_date": int, "offset_id": int, "add_offset": int, "limit": int, "max_id": int, "min_id": int, }` - ### As a user: diff --git a/docs/API_docs/methods/messages_searchGifs.md b/docs/API_docs/methods/messages_searchGifs.md index 4e5c924f..9ab08068 100644 --- a/docs/API_docs/methods/messages_searchGifs.md +++ b/docs/API_docs/methods/messages_searchGifs.md @@ -16,14 +16,20 @@ description: messages.searchGifs parameters, return type and example ### Return type: [messages\_FoundGifs](../types/messages_FoundGifs.md) +### Can bots use this method: **NO** + + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SEARCH_QUERY_EMPTY|The search query 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 +45,6 @@ $messages_FoundGifs = $MadelineProto->messages->searchGifs(['q' => 'string', 'of 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.searchGifs -* params - `{"q": "string", "offset": int, }` - ### As a user: diff --git a/docs/API_docs/methods/messages_searchGlobal.md b/docs/API_docs/methods/messages_searchGlobal.md index 48cedd5f..1d919a4b 100644 --- a/docs/API_docs/methods/messages_searchGlobal.md +++ b/docs/API_docs/methods/messages_searchGlobal.md @@ -19,14 +19,20 @@ description: messages.searchGlobal parameters, return type and example ### Return type: [messages\_Messages](../types/messages_Messages.md) +### Can bots use this method: **NO** + + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|SEARCH_QUERY_EMPTY|The search query 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: '; @@ -42,15 +48,6 @@ $messages_Messages = $MadelineProto->messages->searchGlobal(['q' => 'string', 'o 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.searchGlobal -* params - `{"q": "string", "offset_date": int, "offset_peer": InputPeer, "offset_id": int, "limit": int, }` - ### As a user: diff --git a/docs/API_docs/methods/messages_sendEncrypted.md b/docs/API_docs/methods/messages_sendEncrypted.md index fe3d685c..05d56922 100644 --- a/docs/API_docs/methods/messages_sendEncrypted.md +++ b/docs/API_docs/methods/messages_sendEncrypted.md @@ -16,6 +16,15 @@ description: messages.sendEncrypted parameters, return type and example ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) +### Can bots use this method: **YES** + + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|DATA_INVALID|Encrypted data invalid||MSG_WAIT_FAILED|A waiting call returned an error| + ### Example: diff --git a/docs/API_docs/methods/messages_sendEncryptedFile.md b/docs/API_docs/methods/messages_sendEncryptedFile.md index 520a405a..84726d74 100644 --- a/docs/API_docs/methods/messages_sendEncryptedFile.md +++ b/docs/API_docs/methods/messages_sendEncryptedFile.md @@ -17,6 +17,15 @@ description: messages.sendEncryptedFile parameters, return type and example ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) +### Can bots use this method: **YES** + + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MSG_WAIT_FAILED|A waiting call returned an error| + ### Example: diff --git a/docs/API_docs/methods/messages_sendEncryptedService.md b/docs/API_docs/methods/messages_sendEncryptedService.md index 10bd5d39..04d2b4ea 100644 --- a/docs/API_docs/methods/messages_sendEncryptedService.md +++ b/docs/API_docs/methods/messages_sendEncryptedService.md @@ -16,6 +16,15 @@ description: messages.sendEncryptedService parameters, return type and example ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) +### Can bots use this method: **YES** + + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MSG_WAIT_FAILED|A waiting call returned an error| + ### Example: diff --git a/docs/API_docs/methods/messages_sendInlineBotResult.md b/docs/API_docs/methods/messages_sendInlineBotResult.md index 6d82e390..74925e93 100644 --- a/docs/API_docs/methods/messages_sendInlineBotResult.md +++ b/docs/API_docs/methods/messages_sendInlineBotResult.md @@ -21,14 +21,20 @@ description: messages.sendInlineBotResult parameters, return type and example ### Return type: [Updates](../types/Updates.md) +### Can bots use this method: **NO** + + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|INLINE_RESULT_EXPIRED|The inline query expired||QUERY_ID_EMPTY|The query ID 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: '; @@ -44,15 +50,6 @@ $Updates = $MadelineProto->messages->sendInlineBotResult(['silent' => Bool, 'bac 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.sendInlineBotResult -* params - `{"silent": Bool, "background": Bool, "clear_draft": Bool, "peer": InputPeer, "reply_to_msg_id": int, "query_id": long, "id": "string", }` - ### As a user: diff --git a/docs/API_docs/methods/messages_sendMedia.md b/docs/API_docs/methods/messages_sendMedia.md index fa868410..0f9a9fd2 100644 --- a/docs/API_docs/methods/messages_sendMedia.md +++ b/docs/API_docs/methods/messages_sendMedia.md @@ -21,6 +21,15 @@ description: messages.sendMedia parameters, return type and example ### Return type: [Updates](../types/Updates.md) +### Can bots use this method: **YES** + + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|FILE_PARTS_INVALID|The number of file parts is invalid||MEDIA_CAPTION_TOO_LONG|The caption is too long||MEDIA_EMPTY|The provided media object is invalid||PEER_ID_INVALID|The provided peer id is invalid||PHOTO_EXT_INVALID|The extension of the photo is invalid||STORAGE_CHECK_FAILED|Server storage check failed||WEBPAGE_CURL_FAILED|Failure while fetching the webpage with cURL| + ### Example: diff --git a/docs/API_docs/methods/messages_sendMessage.md b/docs/API_docs/methods/messages_sendMessage.md index 3983af01..83ab594e 100644 --- a/docs/API_docs/methods/messages_sendMessage.md +++ b/docs/API_docs/methods/messages_sendMessage.md @@ -24,6 +24,15 @@ description: messages.sendMessage 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||CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this||CHAT_WRITE_FORBIDDEN|You can't write in this chat||MESSAGE_EMPTY|The provided message is empty||PEER_ID_INVALID|The provided peer id is invalid||USER_BANNED_IN_CHANNEL|You're banned from sending messages in supergroups/channels||USER_IS_BLOCKED|User is blocked||USER_IS_BOT|Bots can't send messages to other bots||YOU_BLOCKED_USER|You blocked this user| + ### Example: diff --git a/docs/API_docs/methods/messages_sendScreenshotNotification.md b/docs/API_docs/methods/messages_sendScreenshotNotification.md index 1154b365..ea0390d3 100644 --- a/docs/API_docs/methods/messages_sendScreenshotNotification.md +++ b/docs/API_docs/methods/messages_sendScreenshotNotification.md @@ -16,14 +16,20 @@ description: messages.sendScreenshotNotification parameters, return type and exa ### Return type: [Updates](../types/Updates.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 +45,6 @@ $Updates = $MadelineProto->messages->sendScreenshotNotification(['peer' => Input 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.sendScreenshotNotification -* params - `{"peer": InputPeer, "reply_to_msg_id": int, }` - ### As a user: diff --git a/docs/API_docs/methods/messages_setBotCallbackAnswer.md b/docs/API_docs/methods/messages_setBotCallbackAnswer.md index 4f8ef4c4..a0610ec0 100644 --- a/docs/API_docs/methods/messages_setBotCallbackAnswer.md +++ b/docs/API_docs/methods/messages_setBotCallbackAnswer.md @@ -19,6 +19,15 @@ description: messages.setBotCallbackAnswer 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| + ### Example: diff --git a/docs/API_docs/methods/messages_setBotPrecheckoutResults.md b/docs/API_docs/methods/messages_setBotPrecheckoutResults.md index 617b8966..c8dff6f6 100644 --- a/docs/API_docs/methods/messages_setBotPrecheckoutResults.md +++ b/docs/API_docs/methods/messages_setBotPrecheckoutResults.md @@ -17,6 +17,15 @@ description: messages.setBotPrecheckoutResults parameters, return type and examp ### Return type: [Bool](../types/Bool.md) +### Can bots use this method: **YES** + + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|ERROR_TEXT_EMPTY|The provided error message is empty| + ### Example: diff --git a/docs/API_docs/methods/messages_setBotShippingResults.md b/docs/API_docs/methods/messages_setBotShippingResults.md index fc1fa24d..bc6aaebd 100644 --- a/docs/API_docs/methods/messages_setBotShippingResults.md +++ b/docs/API_docs/methods/messages_setBotShippingResults.md @@ -17,6 +17,15 @@ description: messages.setBotShippingResults 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| + ### Example: diff --git a/docs/API_docs/methods/messages_setEncryptedTyping.md b/docs/API_docs/methods/messages_setEncryptedTyping.md index 81ece840..fbae16b0 100644 --- a/docs/API_docs/methods/messages_setEncryptedTyping.md +++ b/docs/API_docs/methods/messages_setEncryptedTyping.md @@ -16,14 +16,20 @@ description: messages.setEncryptedTyping parameters, return type and example ### Return type: [Bool](../types/Bool.md) +### Can bots use this method: **NO** + + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|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 +45,6 @@ $Bool = $MadelineProto->messages->setEncryptedTyping(['peer' => InputEncryptedCh 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.setEncryptedTyping -* params - `{"peer": InputEncryptedChat, "typing": Bool, }` - ### As a user: diff --git a/docs/API_docs/methods/messages_setGameScore.md b/docs/API_docs/methods/messages_setGameScore.md index b2994765..587e0a60 100644 --- a/docs/API_docs/methods/messages_setGameScore.md +++ b/docs/API_docs/methods/messages_setGameScore.md @@ -20,6 +20,15 @@ description: messages.setGameScore parameters, return type and example ### Return type: [Updates](../types/Updates.md) +### Can bots use this method: **YES** + + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid||USER_BOT_REQUIRED|This method can only be called by a bot| + ### Example: diff --git a/docs/API_docs/methods/messages_setInlineBotResults.md b/docs/API_docs/methods/messages_setInlineBotResults.md index 0afc3c1a..423d8b69 100644 --- a/docs/API_docs/methods/messages_setInlineBotResults.md +++ b/docs/API_docs/methods/messages_setInlineBotResults.md @@ -21,6 +21,15 @@ description: messages.setInlineBotResults parameters, return type and example ### Return type: [Bool](../types/Bool.md) +### Can bots use this method: **YES** + + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|ARTICLE_TITLE_EMPTY|The title of the article is empty||BUTTON_DATA_INVALID|The provided button data is invalid||BUTTON_TYPE_INVALID|The type of one of the buttons you provided is invalid||BUTTON_URL_INVALID|Button URL invalid||MESSAGE_EMPTY|The provided message is empty||QUERY_ID_INVALID|The query ID is invalid||REPLY_MARKUP_INVALID|The provided reply markup is invalid||RESULT_TYPE_INVALID|Result type invalid||SEND_MESSAGE_TYPE_INVALID|The message type is invalid||START_PARAM_INVALID|Start parameter invalid||USER_BOT_INVALID|This method can only be called by a bot| + ### Example: diff --git a/docs/API_docs/methods/messages_setInlineGameScore.md b/docs/API_docs/methods/messages_setInlineGameScore.md index 72e657a7..ddb7ba31 100644 --- a/docs/API_docs/methods/messages_setInlineGameScore.md +++ b/docs/API_docs/methods/messages_setInlineGameScore.md @@ -19,6 +19,15 @@ description: messages.setInlineGameScore parameters, return type and example ### Return type: [Bool](../types/Bool.md) +### Can bots use this method: **YES** + + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_ID_INVALID|The provided message id is invalid||USER_BOT_REQUIRED|This method can only be called by a bot| + ### Example: diff --git a/docs/API_docs/methods/messages_setTyping.md b/docs/API_docs/methods/messages_setTyping.md index 32f76e21..e20b126c 100644 --- a/docs/API_docs/methods/messages_setTyping.md +++ b/docs/API_docs/methods/messages_setTyping.md @@ -16,6 +16,15 @@ description: messages.setTyping 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||CHANNEL_PRIVATE|You haven't joined this channel/supergroup||CHAT_ID_INVALID|The provided chat id is invalid||PEER_ID_INVALID|The provided peer id is invalid| + ### Example: diff --git a/docs/API_docs/methods/messages_startBot.md b/docs/API_docs/methods/messages_startBot.md index 92c2458b..3203d211 100644 --- a/docs/API_docs/methods/messages_startBot.md +++ b/docs/API_docs/methods/messages_startBot.md @@ -17,14 +17,20 @@ description: messages.startBot parameters, return type and example ### Return type: [Updates](../types/Updates.md) +### Can bots use this method: **NO** + + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|PEER_ID_INVALID|The provided peer id is invalid||START_PARAM_EMPTY|The start parameter is empty||START_PARAM_INVALID|Start parameter 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 +46,6 @@ $Updates = $MadelineProto->messages->startBot(['bot' => InputUser, 'peer' => Inp 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.startBot -* params - `{"bot": InputUser, "peer": InputPeer, "start_param": "string", }` - ### As a user: diff --git a/docs/API_docs/methods/messages_toggleChatAdmins.md b/docs/API_docs/methods/messages_toggleChatAdmins.md index 0c5060f9..53684128 100644 --- a/docs/API_docs/methods/messages_toggleChatAdmins.md +++ b/docs/API_docs/methods/messages_toggleChatAdmins.md @@ -16,14 +16,20 @@ description: messages.toggleChatAdmins parameters, return type and example ### Return type: [Updates](../types/Updates.md) +### Can bots use this method: **NO** + + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|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 +45,6 @@ $Updates = $MadelineProto->messages->toggleChatAdmins(['chat_id' => InputPeer, ' 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.toggleChatAdmins -* params - `{"chat_id": InputPeer, "enabled": Bool, }` - ### As a user: diff --git a/docs/API_docs/methods/messages_toggleDialogPin.md b/docs/API_docs/methods/messages_toggleDialogPin.md index 4dd3aee2..82326978 100644 --- a/docs/API_docs/methods/messages_toggleDialogPin.md +++ b/docs/API_docs/methods/messages_toggleDialogPin.md @@ -16,14 +16,20 @@ description: messages.toggleDialogPin 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 +45,6 @@ $Bool = $MadelineProto->messages->toggleDialogPin(['pinned' => Bool, 'peer' => 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 - messages.toggleDialogPin -* params - `{"pinned": Bool, "peer": InputPeer, }` - ### As a user: diff --git a/docs/API_docs/methods/messages_uninstallStickerSet.md b/docs/API_docs/methods/messages_uninstallStickerSet.md index b112523b..dee50742 100644 --- a/docs/API_docs/methods/messages_uninstallStickerSet.md +++ b/docs/API_docs/methods/messages_uninstallStickerSet.md @@ -15,14 +15,20 @@ description: messages.uninstallStickerSet parameters, return type and example ### Return type: [Bool](../types/Bool.md) +### Can bots use this method: **NO** + + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|STICKERSET_INVALID|The provided sticker set 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 +44,6 @@ $Bool = $MadelineProto->messages->uninstallStickerSet(['stickerset' => InputStic 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.uninstallStickerSet -* params - `{"stickerset": InputStickerSet, }` - ### As a user: diff --git a/docs/API_docs/methods/messages_uploadMedia.md b/docs/API_docs/methods/messages_uploadMedia.md index 74bfb789..24f004c8 100644 --- a/docs/API_docs/methods/messages_uploadMedia.md +++ b/docs/API_docs/methods/messages_uploadMedia.md @@ -16,6 +16,15 @@ description: messages.uploadMedia parameters, return type and example ### Return type: [MessageMedia](../types/MessageMedia.md) +### Can bots use this method: **YES** + + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_MISSING|This method can only be run by a bot||PEER_ID_INVALID|The provided peer id is invalid| + ### Example: diff --git a/docs/API_docs/methods/payments_clearSavedInfo.md b/docs/API_docs/methods/payments_clearSavedInfo.md index 0c6673ca..a77c50d9 100644 --- a/docs/API_docs/methods/payments_clearSavedInfo.md +++ b/docs/API_docs/methods/payments_clearSavedInfo.md @@ -16,14 +16,14 @@ description: payments.clearSavedInfo 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: '; @@ -39,15 +39,6 @@ $Bool = $MadelineProto->payments->clearSavedInfo(['credentials' => Bool, 'info' 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 - payments.clearSavedInfo -* params - `{"credentials": Bool, "info": Bool, }` - ### As a user: diff --git a/docs/API_docs/methods/payments_getPaymentForm.md b/docs/API_docs/methods/payments_getPaymentForm.md index d2b32728..e8be5464 100644 --- a/docs/API_docs/methods/payments_getPaymentForm.md +++ b/docs/API_docs/methods/payments_getPaymentForm.md @@ -15,14 +15,20 @@ description: payments.getPaymentForm parameters, return type and example ### Return type: [payments\_PaymentForm](../types/payments_PaymentForm.md) +### Can bots use this method: **NO** + + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_ID_INVALID|The provided message 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 +44,6 @@ $payments_PaymentForm = $MadelineProto->payments->getPaymentForm(['msg_id' => in 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 - payments.getPaymentForm -* params - `{"msg_id": int, }` - ### As a user: diff --git a/docs/API_docs/methods/payments_getPaymentReceipt.md b/docs/API_docs/methods/payments_getPaymentReceipt.md index bf1b9e10..7331d5eb 100644 --- a/docs/API_docs/methods/payments_getPaymentReceipt.md +++ b/docs/API_docs/methods/payments_getPaymentReceipt.md @@ -15,14 +15,20 @@ description: payments.getPaymentReceipt parameters, return type and example ### Return type: [payments\_PaymentReceipt](../types/payments_PaymentReceipt.md) +### Can bots use this method: **NO** + + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_ID_INVALID|The provided message 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 +44,6 @@ $payments_PaymentReceipt = $MadelineProto->payments->getPaymentReceipt(['msg_id' 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 - payments.getPaymentReceipt -* params - `{"msg_id": int, }` - ### As a user: diff --git a/docs/API_docs/methods/payments_getSavedInfo.md b/docs/API_docs/methods/payments_getSavedInfo.md index 04df7212..a586dcd9 100644 --- a/docs/API_docs/methods/payments_getSavedInfo.md +++ b/docs/API_docs/methods/payments_getSavedInfo.md @@ -10,14 +10,14 @@ description: payments.getSavedInfo parameters, return type and example ### Return type: [payments\_SavedInfo](../types/payments_SavedInfo.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 @@ $payments_SavedInfo = $MadelineProto->payments->getSavedInfo(); 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 - payments.getSavedInfo -* params - `{}` - ### As a user: diff --git a/docs/API_docs/methods/payments_sendPaymentForm.md b/docs/API_docs/methods/payments_sendPaymentForm.md index 22c69333..66788ffd 100644 --- a/docs/API_docs/methods/payments_sendPaymentForm.md +++ b/docs/API_docs/methods/payments_sendPaymentForm.md @@ -18,14 +18,20 @@ description: payments.sendPaymentForm parameters, return type and example ### Return type: [payments\_PaymentResult](../types/payments_PaymentResult.md) +### Can bots use this method: **NO** + + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_ID_INVALID|The provided message 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: '; @@ -41,15 +47,6 @@ $payments_PaymentResult = $MadelineProto->payments->sendPaymentForm(['msg_id' => 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 - payments.sendPaymentForm -* params - `{"msg_id": int, "requested_info_id": "string", "shipping_option_id": "string", "credentials": InputPaymentCredentials, }` - ### As a user: diff --git a/docs/API_docs/methods/payments_validateRequestedInfo.md b/docs/API_docs/methods/payments_validateRequestedInfo.md index 0f40df21..05285a37 100644 --- a/docs/API_docs/methods/payments_validateRequestedInfo.md +++ b/docs/API_docs/methods/payments_validateRequestedInfo.md @@ -17,14 +17,20 @@ description: payments.validateRequestedInfo parameters, return type and example ### Return type: [payments\_ValidatedRequestedInfo](../types/payments_ValidatedRequestedInfo.md) +### Can bots use this method: **NO** + + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MESSAGE_ID_INVALID|The provided message 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: '; @@ -40,15 +46,6 @@ $payments_ValidatedRequestedInfo = $MadelineProto->payments->validateRequestedIn 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 - payments.validateRequestedInfo -* params - `{"save": Bool, "msg_id": int, "info": PaymentRequestedInfo, }` - ### As a user: diff --git a/docs/API_docs/methods/phone_getCallConfig.md b/docs/API_docs/methods/phone_getCallConfig.md index 07ead7f9..a85fed0e 100644 --- a/docs/API_docs/methods/phone_getCallConfig.md +++ b/docs/API_docs/methods/phone_getCallConfig.md @@ -10,14 +10,14 @@ description: phone.getCallConfig parameters, return type and example ### Return type: [DataJSON](../types/DataJSON.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 @@ $DataJSON = $MadelineProto->phone->getCallConfig(); 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 - phone.getCallConfig -* params - `{}` - ### As a user: diff --git a/docs/API_docs/methods/phone_receivedCall.md b/docs/API_docs/methods/phone_receivedCall.md index c71b867d..71a1f0f9 100644 --- a/docs/API_docs/methods/phone_receivedCall.md +++ b/docs/API_docs/methods/phone_receivedCall.md @@ -15,14 +15,20 @@ description: phone.receivedCall parameters, return type and example ### Return type: [Bool](../types/Bool.md) +### Can bots use this method: **NO** + + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CALL_PEER_INVALID|The provided call peer object 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 +44,6 @@ $Bool = $MadelineProto->phone->receivedCall(['peer' => InputPhoneCall, ]); 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 - phone.receivedCall -* params - `{"peer": InputPhoneCall, }` - ### As a user: diff --git a/docs/API_docs/methods/phone_saveCallDebug.md b/docs/API_docs/methods/phone_saveCallDebug.md index 2f99ee8d..7b62c78c 100644 --- a/docs/API_docs/methods/phone_saveCallDebug.md +++ b/docs/API_docs/methods/phone_saveCallDebug.md @@ -16,14 +16,20 @@ description: phone.saveCallDebug parameters, return type and example ### Return type: [Bool](../types/Bool.md) +### Can bots use this method: **NO** + + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CALL_PEER_INVALID|The provided call peer object is invalid||DATA_JSON_INVALID|The provided JSON data 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 +45,6 @@ $Bool = $MadelineProto->phone->saveCallDebug(['peer' => InputPhoneCall, 'debug' 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 - phone.saveCallDebug -* params - `{"peer": InputPhoneCall, "debug": DataJSON, }` - ### As a user: diff --git a/docs/API_docs/methods/phone_setCallRating.md b/docs/API_docs/methods/phone_setCallRating.md index b5765787..d2fa4acc 100644 --- a/docs/API_docs/methods/phone_setCallRating.md +++ b/docs/API_docs/methods/phone_setCallRating.md @@ -17,14 +17,20 @@ description: phone.setCallRating parameters, return type and example ### Return type: [Updates](../types/Updates.md) +### Can bots use this method: **NO** + + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|CALL_PEER_INVALID|The provided call peer object 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 +46,6 @@ $Updates = $MadelineProto->phone->setCallRating(['peer' => InputPhoneCall, 'rati 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 - phone.setCallRating -* params - `{"peer": InputPhoneCall, "rating": int, "comment": "string", }` - ### As a user: diff --git a/docs/API_docs/methods/photos_deletePhotos.md b/docs/API_docs/methods/photos_deletePhotos.md index 9b04a8a3..e9cd459d 100644 --- a/docs/API_docs/methods/photos_deletePhotos.md +++ b/docs/API_docs/methods/photos_deletePhotos.md @@ -15,14 +15,14 @@ description: photos.deletePhotos parameters, return type and example ### Return type: [Vector\_of\_long](../types/long.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 @@ $Vector_of_long = $MadelineProto->photos->deletePhotos(['id' => [InputPhoto], ]) 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 - photos.deletePhotos -* params - `{"id": [InputPhoto], }` - ### As a user: diff --git a/docs/API_docs/methods/photos_getUserPhotos.md b/docs/API_docs/methods/photos_getUserPhotos.md index b1e6276d..eb56db90 100644 --- a/docs/API_docs/methods/photos_getUserPhotos.md +++ b/docs/API_docs/methods/photos_getUserPhotos.md @@ -18,6 +18,15 @@ description: photos.getUserPhotos parameters, return type and example ### Return type: [photos\_Photos](../types/photos_Photos.md) +### Can bots use this method: **YES** + + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|MAX_ID_INVALID|The provided max ID is invalid||USER_ID_INVALID|The provided user ID is invalid| + ### Example: diff --git a/docs/API_docs/methods/photos_updateProfilePhoto.md b/docs/API_docs/methods/photos_updateProfilePhoto.md index 1d117934..ea3b78ec 100644 --- a/docs/API_docs/methods/photos_updateProfilePhoto.md +++ b/docs/API_docs/methods/photos_updateProfilePhoto.md @@ -15,14 +15,14 @@ description: photos.updateProfilePhoto parameters, return type and example ### Return type: [UserProfilePhoto](../types/UserProfilePhoto.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 @@ $UserProfilePhoto = $MadelineProto->photos->updateProfilePhoto(['id' => InputPho 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 - photos.updateProfilePhoto -* params - `{"id": InputPhoto, }` - ### As a user: diff --git a/docs/API_docs/methods/photos_uploadProfilePhoto.md b/docs/API_docs/methods/photos_uploadProfilePhoto.md index ebf99bec..b8c6ad66 100644 --- a/docs/API_docs/methods/photos_uploadProfilePhoto.md +++ b/docs/API_docs/methods/photos_uploadProfilePhoto.md @@ -15,14 +15,20 @@ description: photos.uploadProfilePhoto parameters, return type and example ### Return type: [photos\_Photo](../types/photos_Photo.md) +### Can bots use this method: **NO** + + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|FILE_PARTS_INVALID|The number of file parts 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 +44,6 @@ $photos_Photo = $MadelineProto->photos->uploadProfilePhoto(['file' => InputFile, 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 - photos.uploadProfilePhoto -* params - `{"file": InputFile, }` - ### As a user: diff --git a/docs/API_docs/methods/ping.md b/docs/API_docs/methods/ping.md index e8f51ca5..5bfe9dde 100644 --- a/docs/API_docs/methods/ping.md +++ b/docs/API_docs/methods/ping.md @@ -15,6 +15,9 @@ description: ping parameters, return type and example ### Return type: [Pong](../types/Pong.md) +### Can bots use this method: **YES** + + ### Example: diff --git a/docs/API_docs/methods/ping_delay_disconnect.md b/docs/API_docs/methods/ping_delay_disconnect.md index 2cda1ac7..b4b1e265 100644 --- a/docs/API_docs/methods/ping_delay_disconnect.md +++ b/docs/API_docs/methods/ping_delay_disconnect.md @@ -16,6 +16,9 @@ description: ping_delay_disconnect parameters, return type and example ### Return type: [Pong](../types/Pong.md) +### Can bots use this method: **YES** + + ### Example: diff --git a/docs/API_docs/methods/req_DH_params.md b/docs/API_docs/methods/req_DH_params.md index ce723bc4..51632fe0 100644 --- a/docs/API_docs/methods/req_DH_params.md +++ b/docs/API_docs/methods/req_DH_params.md @@ -20,6 +20,9 @@ description: req_DH_params parameters, return type and example ### Return type: [Server\_DH\_Params](../types/Server_DH_Params.md) +### Can bots use this method: **YES** + + ### Example: diff --git a/docs/API_docs/methods/req_pq.md b/docs/API_docs/methods/req_pq.md index a3464d54..2f005ce2 100644 --- a/docs/API_docs/methods/req_pq.md +++ b/docs/API_docs/methods/req_pq.md @@ -15,6 +15,9 @@ description: req_pq parameters, return type and example ### Return type: [ResPQ](../types/ResPQ.md) +### Can bots use this method: **YES** + + ### Example: diff --git a/docs/API_docs/methods/rpc_drop_answer.md b/docs/API_docs/methods/rpc_drop_answer.md index 71ddc7f9..48e894a9 100644 --- a/docs/API_docs/methods/rpc_drop_answer.md +++ b/docs/API_docs/methods/rpc_drop_answer.md @@ -15,6 +15,9 @@ description: rpc_drop_answer parameters, return type and example ### Return type: [RpcDropAnswer](../types/RpcDropAnswer.md) +### Can bots use this method: **YES** + + ### Example: diff --git a/docs/API_docs/methods/set_client_DH_params.md b/docs/API_docs/methods/set_client_DH_params.md index efb846f9..25f0f387 100644 --- a/docs/API_docs/methods/set_client_DH_params.md +++ b/docs/API_docs/methods/set_client_DH_params.md @@ -17,6 +17,9 @@ description: set_client_DH_params parameters, return type and example ### Return type: [Set\_client\_DH\_params\_answer](../types/Set_client_DH_params_answer.md) +### Can bots use this method: **YES** + + ### Example: diff --git a/docs/API_docs/methods/stickers_addStickerToSet.md b/docs/API_docs/methods/stickers_addStickerToSet.md index 3743965e..e02d05f9 100644 --- a/docs/API_docs/methods/stickers_addStickerToSet.md +++ b/docs/API_docs/methods/stickers_addStickerToSet.md @@ -16,6 +16,15 @@ description: stickers.addStickerToSet parameters, return type and example ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) +### Can bots use this method: **YES** + + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_MISSING|This method can only be run by a bot||STICKERSET_INVALID|The provided sticker set is invalid| + ### Example: diff --git a/docs/API_docs/methods/stickers_changeStickerPosition.md b/docs/API_docs/methods/stickers_changeStickerPosition.md index 85d63f5f..8a920ec8 100644 --- a/docs/API_docs/methods/stickers_changeStickerPosition.md +++ b/docs/API_docs/methods/stickers_changeStickerPosition.md @@ -16,6 +16,15 @@ description: stickers.changeStickerPosition parameters, return type and example ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) +### Can bots use this method: **YES** + + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_MISSING|This method can only be run by a bot||STICKER_INVALID|The provided sticker is invalid| + ### Example: diff --git a/docs/API_docs/methods/stickers_createStickerSet.md b/docs/API_docs/methods/stickers_createStickerSet.md index 91b96290..e396f531 100644 --- a/docs/API_docs/methods/stickers_createStickerSet.md +++ b/docs/API_docs/methods/stickers_createStickerSet.md @@ -19,6 +19,15 @@ description: stickers.createStickerSet parameters, return type and example ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) +### Can bots use this method: **YES** + + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_MISSING|This method can only be run by a bot||USER_ID_INVALID|The provided user ID is invalid| + ### Example: diff --git a/docs/API_docs/methods/stickers_removeStickerFromSet.md b/docs/API_docs/methods/stickers_removeStickerFromSet.md index 3f9856d4..796d0817 100644 --- a/docs/API_docs/methods/stickers_removeStickerFromSet.md +++ b/docs/API_docs/methods/stickers_removeStickerFromSet.md @@ -15,6 +15,15 @@ description: stickers.removeStickerFromSet parameters, return type and example ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) +### Can bots use this method: **YES** + + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|BOT_MISSING|This method can only be run by a bot||STICKER_INVALID|The provided sticker is invalid| + ### Example: diff --git a/docs/API_docs/methods/upload_getWebFile.md b/docs/API_docs/methods/upload_getWebFile.md index ec26e533..a4eff18d 100644 --- a/docs/API_docs/methods/upload_getWebFile.md +++ b/docs/API_docs/methods/upload_getWebFile.md @@ -17,14 +17,20 @@ description: upload.getWebFile parameters, return type and example ### Return type: [upload\_WebFile](../types/upload_WebFile.md) +### Can bots use this method: **NO** + + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|LOCATION_INVALID|The provided location 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 +46,6 @@ $upload_WebFile = $MadelineProto->upload->getWebFile(['location' => InputWebFile 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 - upload.getWebFile -* params - `{"location": InputWebFileLocation, "offset": int, "limit": int, }` - ### As a user: diff --git a/docs/API_docs/methods/users_getUsers.md b/docs/API_docs/methods/users_getUsers.md index 93019120..bf639973 100644 --- a/docs/API_docs/methods/users_getUsers.md +++ b/docs/API_docs/methods/users_getUsers.md @@ -15,6 +15,15 @@ description: users.getUsers parameters, return type and example ### Return type: [Vector\_of\_User](../types/User.md) +### Can bots use this method: **YES** + + +### Errors this method can return: + +| Error | Description | +|----------|---------------| +|NEED_MEMBER_INVALID|The provided member is invalid| + ### Example: diff --git a/docs/MTProto_docs/methods/destroy_session.md b/docs/MTProto_docs/methods/destroy_session.md index 536f5288..0b732694 100644 --- a/docs/MTProto_docs/methods/destroy_session.md +++ b/docs/MTProto_docs/methods/destroy_session.md @@ -15,6 +15,9 @@ description: destroy_session parameters, return type and example ### Return type: [DestroySessionRes](../types/DestroySessionRes.md) +### Can bots use this method: **YES** + + ### Example: diff --git a/docs/MTProto_docs/methods/get_future_salts.md b/docs/MTProto_docs/methods/get_future_salts.md index b837faa3..d3b306ce 100644 --- a/docs/MTProto_docs/methods/get_future_salts.md +++ b/docs/MTProto_docs/methods/get_future_salts.md @@ -15,6 +15,9 @@ description: get_future_salts parameters, return type and example ### Return type: [FutureSalts](../types/FutureSalts.md) +### Can bots use this method: **YES** + + ### Example: diff --git a/docs/MTProto_docs/methods/http_wait.md b/docs/MTProto_docs/methods/http_wait.md index a441b514..179a96e0 100644 --- a/docs/MTProto_docs/methods/http_wait.md +++ b/docs/MTProto_docs/methods/http_wait.md @@ -17,6 +17,9 @@ description: http_wait parameters, return type and example ### Return type: [HttpWait](../types/HttpWait.md) +### Can bots use this method: **YES** + + ### Example: diff --git a/docs/MTProto_docs/methods/ping.md b/docs/MTProto_docs/methods/ping.md index e8f51ca5..5bfe9dde 100644 --- a/docs/MTProto_docs/methods/ping.md +++ b/docs/MTProto_docs/methods/ping.md @@ -15,6 +15,9 @@ description: ping parameters, return type and example ### Return type: [Pong](../types/Pong.md) +### Can bots use this method: **YES** + + ### Example: diff --git a/docs/MTProto_docs/methods/ping_delay_disconnect.md b/docs/MTProto_docs/methods/ping_delay_disconnect.md index 2cda1ac7..b4b1e265 100644 --- a/docs/MTProto_docs/methods/ping_delay_disconnect.md +++ b/docs/MTProto_docs/methods/ping_delay_disconnect.md @@ -16,6 +16,9 @@ description: ping_delay_disconnect parameters, return type and example ### Return type: [Pong](../types/Pong.md) +### Can bots use this method: **YES** + + ### Example: diff --git a/docs/MTProto_docs/methods/req_DH_params.md b/docs/MTProto_docs/methods/req_DH_params.md index 2ffcf4c2..34bc4846 100644 --- a/docs/MTProto_docs/methods/req_DH_params.md +++ b/docs/MTProto_docs/methods/req_DH_params.md @@ -20,6 +20,9 @@ description: req_DH_params parameters, return type and example ### Return type: [Server\_DH\_Params](../types/Server_DH_Params.md) +### Can bots use this method: **YES** + + ### Example: diff --git a/docs/MTProto_docs/methods/req_pq.md b/docs/MTProto_docs/methods/req_pq.md index a3464d54..2f005ce2 100644 --- a/docs/MTProto_docs/methods/req_pq.md +++ b/docs/MTProto_docs/methods/req_pq.md @@ -15,6 +15,9 @@ description: req_pq parameters, return type and example ### Return type: [ResPQ](../types/ResPQ.md) +### Can bots use this method: **YES** + + ### Example: diff --git a/docs/MTProto_docs/methods/rpc_drop_answer.md b/docs/MTProto_docs/methods/rpc_drop_answer.md index 71ddc7f9..48e894a9 100644 --- a/docs/MTProto_docs/methods/rpc_drop_answer.md +++ b/docs/MTProto_docs/methods/rpc_drop_answer.md @@ -15,6 +15,9 @@ description: rpc_drop_answer parameters, return type and example ### Return type: [RpcDropAnswer](../types/RpcDropAnswer.md) +### Can bots use this method: **YES** + + ### Example: diff --git a/docs/MTProto_docs/methods/set_client_DH_params.md b/docs/MTProto_docs/methods/set_client_DH_params.md index 68e2972a..e0a02dc2 100644 --- a/docs/MTProto_docs/methods/set_client_DH_params.md +++ b/docs/MTProto_docs/methods/set_client_DH_params.md @@ -17,6 +17,9 @@ description: set_client_DH_params parameters, return type and example ### Return type: [Set\_client\_DH\_params\_answer](../types/Set_client_DH_params_answer.md) +### Can bots use this method: **YES** + + ### Example: diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html index 107b0cc9..5c9ff302 100644 --- a/docs/_layouts/default.html +++ b/docs/_layouts/default.html @@ -20,9 +20,9 @@ html{font-family:sans-serif;-ms-text-size-adjust:100%;-webkit-text-size-adjust:1 - +