diff --git a/docs/API_docs/methods/account_registerDevice.md b/docs/API_docs/methods/account_registerDevice.md index 7211e4a9..a55ac844 100644 --- a/docs/API_docs/methods/account_registerDevice.md +++ b/docs/API_docs/methods/account_registerDevice.md @@ -12,10 +12,10 @@ Register device for push notifications | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and oTher, see source code of official apps for more info| +|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and oTher, see source code of official apps for more info| |app\_sandbox|[CLICK ME Bool](../types/Bool.md) | Yes|Should the app run in a sandbox?| -|other\_uids|Array of [CLICK ME int](../types/int.md) | Yes|Other UUIDs| +|other\_uids|Array of [CLICK ME int](../types/int.md) | Yes|| ### Return type: [Bool](../types/Bool.md) diff --git a/docs/API_docs/methods/account_unregisterDevice.md b/docs/API_docs/methods/account_unregisterDevice.md index 68c9b295..f07b043f 100644 --- a/docs/API_docs/methods/account_unregisterDevice.md +++ b/docs/API_docs/methods/account_unregisterDevice.md @@ -12,9 +12,9 @@ Stop sending PUSH notifications to app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| -|other\_uids|Array of [CLICK ME int](../types/int.md) | Yes|Other UUIDs| +|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and oTher, see source code of official apps for more info| +|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and oTher, see source code of official apps for more info| +|other\_uids|Array of [CLICK ME int](../types/int.md) | Yes|| ### Return type: [Bool](../types/Bool.md) diff --git a/docs/API_docs/methods/bots_answerWebhookJSONQuery.md b/docs/API_docs/methods/bots_answerWebhookJSONQuery.md index 205b30f9..61056bb4 100644 --- a/docs/API_docs/methods/bots_answerWebhookJSONQuery.md +++ b/docs/API_docs/methods/bots_answerWebhookJSONQuery.md @@ -1,17 +1,19 @@ --- title: bots.answerWebhookJSONQuery -description: bots.answerWebhookJSONQuery parameters, return type and example +description: Send webhook request via bot API --- ## Method: bots.answerWebhookJSONQuery [Back to methods index](index.md) +Send webhook request via bot API + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|query\_id|[CLICK ME long](../types/long.md) | Yes| -|data|[CLICK ME DataJSON](../types/DataJSON.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|query\_id|[CLICK ME long](../types/long.md) | Yes|The query ID| +|data|[CLICK ME DataJSON](../types/DataJSON.md) | Yes|The parameters| ### Return type: [Bool](../types/Bool.md) diff --git a/docs/API_docs/methods/bots_sendCustomRequest.md b/docs/API_docs/methods/bots_sendCustomRequest.md index 590c47b6..fc8e764d 100644 --- a/docs/API_docs/methods/bots_sendCustomRequest.md +++ b/docs/API_docs/methods/bots_sendCustomRequest.md @@ -1,17 +1,19 @@ --- title: bots.sendCustomRequest -description: bots.sendCustomRequest parameters, return type and example +description: Send a custom request to the bot API --- ## Method: bots.sendCustomRequest [Back to methods index](index.md) +Send a custom request to the bot API + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|custom\_method|[CLICK ME string](../types/string.md) | Yes| -|params|[CLICK ME DataJSON](../types/DataJSON.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|custom\_method|[CLICK ME string](../types/string.md) | Yes|The method to call| +|params|[CLICK ME DataJSON](../types/DataJSON.md) | Yes|Method parameters| ### Return type: [DataJSON](../types/DataJSON.md) diff --git a/docs/API_docs/methods/channels_checkUsername.md b/docs/API_docs/methods/channels_checkUsername.md index 371f4cd3..7bc7c245 100644 --- a/docs/API_docs/methods/channels_checkUsername.md +++ b/docs/API_docs/methods/channels_checkUsername.md @@ -1,17 +1,19 @@ --- title: channels.checkUsername -description: channels.checkUsername parameters, return type and example +description: Check if this username is free and can be assigned to a channel/supergroup --- ## Method: channels.checkUsername [Back to methods index](index.md) +Check if this username is free and can be assigned to a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|username|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|username|[CLICK ME string](../types/string.md) | Yes|The new username for this channel/supergroup| ### Return type: [Bool](../types/Bool.md) diff --git a/docs/API_docs/methods/channels_createChannel.md b/docs/API_docs/methods/channels_createChannel.md index c5d21585..1305e4fb 100644 --- a/docs/API_docs/methods/channels_createChannel.md +++ b/docs/API_docs/methods/channels_createChannel.md @@ -1,19 +1,21 @@ --- title: channels.createChannel -description: channels.createChannel parameters, return type and example +description: Create channel/supergroup --- ## Method: channels.createChannel [Back to methods index](index.md) +Create channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|broadcast|[CLICK ME Bool](../types/Bool.md) | Optional| -|megagroup|[CLICK ME Bool](../types/Bool.md) | Optional| -|title|[CLICK ME string](../types/string.md) | Yes| -|about|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|broadcast|[CLICK ME Bool](../types/Bool.md) | Optional|Set this to true to create a channel| +|megagroup|[CLICK ME Bool](../types/Bool.md) | Optional|Set this to true to create a supergroup| +|title|[CLICK ME string](../types/string.md) | Yes|Supergroup/channel title| +|about|[CLICK ME string](../types/string.md) | Yes|About text| ### Return type: [Updates](../types/Updates.md) diff --git a/docs/API_docs/methods/channels_deleteChannel.md b/docs/API_docs/methods/channels_deleteChannel.md index 61b29eac..e660d25c 100644 --- a/docs/API_docs/methods/channels_deleteChannel.md +++ b/docs/API_docs/methods/channels_deleteChannel.md @@ -1,16 +1,18 @@ --- title: channels.deleteChannel -description: channels.deleteChannel parameters, return type and example +description: Delete a channel/supergroup --- ## Method: channels.deleteChannel [Back to methods index](index.md) +Delete a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup to delete| ### Return type: [Updates](../types/Updates.md) diff --git a/docs/API_docs/methods/channels_deleteHistory.md b/docs/API_docs/methods/channels_deleteHistory.md index 35fcf2f1..55a5e371 100644 --- a/docs/API_docs/methods/channels_deleteHistory.md +++ b/docs/API_docs/methods/channels_deleteHistory.md @@ -1,17 +1,19 @@ --- title: channels.deleteHistory -description: channels.deleteHistory parameters, return type and example +description: Delete the history of a supergroup/channel --- ## Method: channels.deleteHistory [Back to methods index](index.md) +Delete the history of a supergroup/channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|max\_id|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to delete| ### Return type: [Bool](../types/Bool.md) diff --git a/docs/API_docs/methods/channels_deleteMessages.md b/docs/API_docs/methods/channels_deleteMessages.md index 87a968c5..fb9d3cc2 100644 --- a/docs/API_docs/methods/channels_deleteMessages.md +++ b/docs/API_docs/methods/channels_deleteMessages.md @@ -1,17 +1,19 @@ --- title: channels.deleteMessages -description: channels.deleteMessages parameters, return type and example +description: Delete channel/supergroup messages --- ## Method: channels.deleteMessages [Back to methods index](index.md) +Delete channel/supergroup messages + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|id|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to delete| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/docs/API_docs/methods/channels_deleteUserHistory.md b/docs/API_docs/methods/channels_deleteUserHistory.md index ee828f45..fbe34341 100644 --- a/docs/API_docs/methods/channels_deleteUserHistory.md +++ b/docs/API_docs/methods/channels_deleteUserHistory.md @@ -1,17 +1,19 @@ --- title: channels.deleteUserHistory -description: channels.deleteUserHistory parameters, return type and example +description: Delete all messages of a user in a channel/supergroup --- ## Method: channels.deleteUserHistory [Back to methods index](index.md) +Delete all messages of a user in a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) diff --git a/docs/API_docs/methods/channels_editAbout.md b/docs/API_docs/methods/channels_editAbout.md index 94be2503..8908f29e 100644 --- a/docs/API_docs/methods/channels_editAbout.md +++ b/docs/API_docs/methods/channels_editAbout.md @@ -1,17 +1,19 @@ --- title: channels.editAbout -description: channels.editAbout parameters, return type and example +description: Edit the about text of a channel/supergroup --- ## Method: channels.editAbout [Back to methods index](index.md) +Edit the about text of a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|about|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|about|[CLICK ME string](../types/string.md) | Yes|The new about text| ### Return type: [Bool](../types/Bool.md) diff --git a/docs/API_docs/methods/channels_editAdmin.md b/docs/API_docs/methods/channels_editAdmin.md index 08707ff4..dcec7d2f 100644 --- a/docs/API_docs/methods/channels_editAdmin.md +++ b/docs/API_docs/methods/channels_editAdmin.md @@ -1,18 +1,20 @@ --- title: channels.editAdmin -description: channels.editAdmin parameters, return type and example +description: Edit admin permissions of a user in a channel/supergroup --- ## Method: channels.editAdmin [Back to methods index](index.md) +Edit admin permissions of a user in a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|admin\_rights|[CLICK ME ChannelAdminRights](../types/ChannelAdminRights.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| +|admin\_rights|[CLICK ME ChannelAdminRights](../types/ChannelAdminRights.md) | Yes|The new admin rights| ### Return type: [Updates](../types/Updates.md) diff --git a/docs/API_docs/methods/channels_editBanned.md b/docs/API_docs/methods/channels_editBanned.md index 1d896393..9859bcae 100644 --- a/docs/API_docs/methods/channels_editBanned.md +++ b/docs/API_docs/methods/channels_editBanned.md @@ -1,18 +1,20 @@ --- title: channels.editBanned -description: channels.editBanned parameters, return type and example +description: Kick or ban a user from a channel/supergroup --- ## Method: channels.editBanned [Back to methods index](index.md) +Kick or ban a user from a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|banned\_rights|[CLICK ME ChannelBannedRights](../types/ChannelBannedRights.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to kick/ban| +|banned\_rights|[CLICK ME ChannelBannedRights](../types/ChannelBannedRights.md) | Yes|Banned/kicked permissions| ### Return type: [Updates](../types/Updates.md) diff --git a/docs/API_docs/methods/channels_editPhoto.md b/docs/API_docs/methods/channels_editPhoto.md index 3a2c794b..9ccd864f 100644 --- a/docs/API_docs/methods/channels_editPhoto.md +++ b/docs/API_docs/methods/channels_editPhoto.md @@ -1,17 +1,19 @@ --- title: channels.editPhoto -description: channels.editPhoto parameters, return type and example +description: Edit the photo of a supergroup/channel --- ## Method: channels.editPhoto [Back to methods index](index.md) +Edit the photo of a supergroup/channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new photo| ### Return type: [Updates](../types/Updates.md) diff --git a/docs/API_docs/methods/channels_editTitle.md b/docs/API_docs/methods/channels_editTitle.md index ec60e10f..b1024faf 100644 --- a/docs/API_docs/methods/channels_editTitle.md +++ b/docs/API_docs/methods/channels_editTitle.md @@ -1,17 +1,19 @@ --- title: channels.editTitle -description: channels.editTitle parameters, return type and example +description: Edit the title of a supergroup/channel --- ## Method: channels.editTitle [Back to methods index](index.md) +Edit the title of a supergroup/channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|title|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|title|[CLICK ME string](../types/string.md) | Yes|The new channel/supergroup title| ### Return type: [Updates](../types/Updates.md) diff --git a/docs/API_docs/methods/channels_exportInvite.md b/docs/API_docs/methods/channels_exportInvite.md index 3c10f832..f0c737d5 100644 --- a/docs/API_docs/methods/channels_exportInvite.md +++ b/docs/API_docs/methods/channels_exportInvite.md @@ -1,16 +1,18 @@ --- title: channels.exportInvite -description: channels.exportInvite parameters, return type and example +description: Export the invite link of a channel --- ## Method: channels.exportInvite [Back to methods index](index.md) +Export the invite link of a channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| ### Return type: [ExportedChatInvite](../types/ExportedChatInvite.md) diff --git a/docs/API_docs/methods/channels_exportMessageLink.md b/docs/API_docs/methods/channels_exportMessageLink.md index 17524d88..1a1752d4 100644 --- a/docs/API_docs/methods/channels_exportMessageLink.md +++ b/docs/API_docs/methods/channels_exportMessageLink.md @@ -1,18 +1,20 @@ --- title: channels.exportMessageLink -description: channels.exportMessageLink parameters, return type and example +description: Get the link of a message in a channel --- ## Method: channels.exportMessageLink [Back to methods index](index.md) +Get the link of a message in a channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|id|[CLICK ME int](../types/int.md) | Yes| -|grouped|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|id|[CLICK ME int](../types/int.md) | Yes|The ID of the message| +|grouped|[CLICK ME Bool](../types/Bool.md) | Yes|Is this an album?| ### Return type: [ExportedMessageLink](../types/ExportedMessageLink.md) diff --git a/docs/API_docs/methods/channels_getAdminLog.md b/docs/API_docs/methods/channels_getAdminLog.md index 0585e157..5c1b805e 100644 --- a/docs/API_docs/methods/channels_getAdminLog.md +++ b/docs/API_docs/methods/channels_getAdminLog.md @@ -1,22 +1,24 @@ --- title: channels.getAdminLog -description: channels.getAdminLog parameters, return type and example +description: Get admin log of a channel/supergruop --- ## Method: channels.getAdminLog [Back to methods index](index.md) +Get admin log of a channel/supergruop + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|q|[CLICK ME string](../types/string.md) | Yes| -|events\_filter|[CLICK ME ChannelAdminLogEventsFilter](../types/ChannelAdminLogEventsFilter.md) | Optional| -|admins|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|max\_id|[CLICK ME long](../types/long.md) | Yes| -|min\_id|[CLICK ME long](../types/long.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|q|[CLICK ME string](../types/string.md) | Yes|Search query| +|events\_filter|[CLICK ME ChannelAdminLogEventsFilter](../types/ChannelAdminLogEventsFilter.md) | Optional|Event filter| +|admins|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|Fetch only actions from these admins| +|max\_id|[CLICK ME long](../types/long.md) | Yes|Maximum message ID to fetch| +|min\_id|[CLICK ME long](../types/long.md) | Yes|Minimum message ID to fetch| +|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to fetch| ### Return type: [channels\_AdminLogResults](../types/channels_AdminLogResults.md) diff --git a/docs/API_docs/methods/channels_getAdminedPublicChannels.md b/docs/API_docs/methods/channels_getAdminedPublicChannels.md index f2b48050..9646f529 100644 --- a/docs/API_docs/methods/channels_getAdminedPublicChannels.md +++ b/docs/API_docs/methods/channels_getAdminedPublicChannels.md @@ -1,11 +1,13 @@ --- title: channels.getAdminedPublicChannels -description: channels.getAdminedPublicChannels parameters, return type and example +description: Get all supergroups/channels where you're admin --- ## Method: channels.getAdminedPublicChannels [Back to methods index](index.md) +Get all supergroups/channels where you're admin + ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/docs/API_docs/methods/channels_getChannels.md b/docs/API_docs/methods/channels_getChannels.md index bd5958d6..9cd9e798 100644 --- a/docs/API_docs/methods/channels_getChannels.md +++ b/docs/API_docs/methods/channels_getChannels.md @@ -1,16 +1,18 @@ --- title: channels.getChannels -description: channels.getChannels parameters, return type and example +description: Get info about multiple channels/supergroups --- ## Method: channels.getChannels [Back to methods index](index.md) +Get info about multiple channels/supergroups + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|Array of [Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|Array of [Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Yes|The channel/supergroup MTProto IDs| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/docs/API_docs/methods/channels_getMessages.md b/docs/API_docs/methods/channels_getMessages.md index 2e18fbbe..9e7a1b57 100644 --- a/docs/API_docs/methods/channels_getMessages.md +++ b/docs/API_docs/methods/channels_getMessages.md @@ -1,17 +1,19 @@ --- title: channels.getMessages -description: channels.getMessages parameters, return type and example +description: Get channel/supergroup messages --- ## Method: channels.getMessages [Back to methods index](index.md) +Get channel/supergroup messages + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|id|Array of [Message ID or InputMessage](../types/InputMessage.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|id|Array of [Message ID or InputMessage](../types/InputMessage.md) | Yes|The message IDs| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/docs/API_docs/methods/channels_getParticipant.md b/docs/API_docs/methods/channels_getParticipant.md index c1819b6b..db9b1fc6 100644 --- a/docs/API_docs/methods/channels_getParticipant.md +++ b/docs/API_docs/methods/channels_getParticipant.md @@ -1,17 +1,19 @@ --- title: channels.getParticipant -description: channels.getParticipant parameters, return type and example +description: Get info about a certain channel/supergroup participant --- ## Method: channels.getParticipant [Back to methods index](index.md) +Get info about a certain channel/supergroup participant + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to fetch info about| ### Return type: [channels\_ChannelParticipant](../types/channels_ChannelParticipant.md) diff --git a/docs/API_docs/methods/channels_getParticipants.md b/docs/API_docs/methods/channels_getParticipants.md index c2716da9..9b2b6c2a 100644 --- a/docs/API_docs/methods/channels_getParticipants.md +++ b/docs/API_docs/methods/channels_getParticipants.md @@ -1,20 +1,22 @@ --- title: channels.getParticipants -description: channels.getParticipants parameters, return type and example +description: Get channel/supergroup participants (you should use `$MadelineProto->get_pwr_chat($id)` instead) --- ## Method: channels.getParticipants [Back to methods index](index.md) +Get channel/supergroup participants (you should use `$MadelineProto->get_pwr_chat($id)` instead) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|filter|[CLICK ME ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) | Yes| -|offset|[CLICK ME int](../types/int.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| -|hash|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|filter|[CLICK ME ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) | Yes|Member filter| +|offset|[CLICK ME int](../types/int.md) | Yes|Offset| +|limit|[CLICK ME int](../types/int.md) | Yes|Limit| +|hash|[CLICK ME int](../types/int.md) | Yes|$MadelineProto->gen_vector_hash(ids of previously fetched participant IDs)| ### Return type: [channels\_ChannelParticipants](../types/channels_ChannelParticipants.md) diff --git a/docs/API_docs/methods/channels_inviteToChannel.md b/docs/API_docs/methods/channels_inviteToChannel.md index 9bca2967..676f800c 100644 --- a/docs/API_docs/methods/channels_inviteToChannel.md +++ b/docs/API_docs/methods/channels_inviteToChannel.md @@ -1,17 +1,19 @@ --- title: channels.inviteToChannel -description: channels.inviteToChannel parameters, return type and example +description: Add users to channel/supergroup --- ## Method: channels.inviteToChannel [Back to methods index](index.md) +Add users to channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to add| ### Return type: [Updates](../types/Updates.md) diff --git a/docs/API_docs/methods/channels_joinChannel.md b/docs/API_docs/methods/channels_joinChannel.md index 9ecdbe75..721f707c 100644 --- a/docs/API_docs/methods/channels_joinChannel.md +++ b/docs/API_docs/methods/channels_joinChannel.md @@ -1,16 +1,18 @@ --- title: channels.joinChannel -description: channels.joinChannel parameters, return type and example +description: Join a channel/supergroup --- ## Method: channels.joinChannel [Back to methods index](index.md) +Join a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup to join| ### Return type: [Updates](../types/Updates.md) diff --git a/docs/API_docs/methods/channels_leaveChannel.md b/docs/API_docs/methods/channels_leaveChannel.md index 62c20a00..7f02e08c 100644 --- a/docs/API_docs/methods/channels_leaveChannel.md +++ b/docs/API_docs/methods/channels_leaveChannel.md @@ -1,16 +1,18 @@ --- title: channels.leaveChannel -description: channels.leaveChannel parameters, return type and example +description: Leave a channel/supergroup --- ## Method: channels.leaveChannel [Back to methods index](index.md) +Leave a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup to leave| ### Return type: [Updates](../types/Updates.md) diff --git a/docs/API_docs/methods/channels_readHistory.md b/docs/API_docs/methods/channels_readHistory.md index 745893f6..cca891f0 100644 --- a/docs/API_docs/methods/channels_readHistory.md +++ b/docs/API_docs/methods/channels_readHistory.md @@ -1,17 +1,19 @@ --- title: channels.readHistory -description: channels.readHistory parameters, return type and example +description: Mark channel/supergroup history as read --- ## Method: channels.readHistory [Back to methods index](index.md) +Mark channel/supergroup history as read + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|max\_id|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to mark as read| ### Return type: [Bool](../types/Bool.md) diff --git a/docs/API_docs/methods/channels_readMessageContents.md b/docs/API_docs/methods/channels_readMessageContents.md index 8d1d6891..861844c4 100644 --- a/docs/API_docs/methods/channels_readMessageContents.md +++ b/docs/API_docs/methods/channels_readMessageContents.md @@ -1,17 +1,19 @@ --- title: channels.readMessageContents -description: channels.readMessageContents parameters, return type and example +description: Mark channel/supergroup messages as read --- ## Method: channels.readMessageContents [Back to methods index](index.md) +Mark channel/supergroup messages as read + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|id|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|id|Array of [CLICK ME int](../types/int.md) | Yes|List of message IDs| ### Return type: [Bool](../types/Bool.md) diff --git a/docs/API_docs/methods/channels_reportSpam.md b/docs/API_docs/methods/channels_reportSpam.md index 47dd7cff..09af14e0 100644 --- a/docs/API_docs/methods/channels_reportSpam.md +++ b/docs/API_docs/methods/channels_reportSpam.md @@ -1,18 +1,20 @@ --- title: channels.reportSpam -description: channels.reportSpam parameters, return type and example +description: Report a supergroup/channel for spam --- ## Method: channels.reportSpam [Back to methods index](index.md) +Report a supergroup/channel for spam + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|id|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that added you to this channel| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to report| ### Return type: [Bool](../types/Bool.md) diff --git a/docs/API_docs/methods/channels_setStickers.md b/docs/API_docs/methods/channels_setStickers.md index 1b900e48..9ed5bd55 100644 --- a/docs/API_docs/methods/channels_setStickers.md +++ b/docs/API_docs/methods/channels_setStickers.md @@ -1,17 +1,19 @@ --- title: channels.setStickers -description: channels.setStickers parameters, return type and example +description: Set the supergroup/channel stickerpack --- ## Method: channels.setStickers [Back to methods index](index.md) +Set the supergroup/channel stickerpack + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergoup| +|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset| ### Return type: [Bool](../types/Bool.md) diff --git a/docs/API_docs/methods/channels_toggleInvites.md b/docs/API_docs/methods/channels_toggleInvites.md index b6771ed3..5b541f67 100644 --- a/docs/API_docs/methods/channels_toggleInvites.md +++ b/docs/API_docs/methods/channels_toggleInvites.md @@ -1,17 +1,19 @@ --- title: channels.toggleInvites -description: channels.toggleInvites parameters, return type and example +description: Allow or disallow any user to invite users to this channel/supergroup --- ## Method: channels.toggleInvites [Back to methods index](index.md) +Allow or disallow any user to invite users to this channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Allow or disallow| ### Return type: [Updates](../types/Updates.md) diff --git a/docs/API_docs/methods/channels_togglePreHistoryHidden.md b/docs/API_docs/methods/channels_togglePreHistoryHidden.md index 489472b0..9327de90 100644 --- a/docs/API_docs/methods/channels_togglePreHistoryHidden.md +++ b/docs/API_docs/methods/channels_togglePreHistoryHidden.md @@ -1,17 +1,19 @@ --- title: channels.togglePreHistoryHidden -description: channels.togglePreHistoryHidden parameters, return type and example +description: Enable or disable hidden history for new channel/supergroup users --- ## Method: channels.togglePreHistoryHidden [Back to methods index](index.md) +Enable or disable hidden history for new channel/supergroup users + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Enable or disable hidden history for new channel/supergroup users| ### Return type: [Updates](../types/Updates.md) diff --git a/docs/API_docs/methods/channels_toggleSignatures.md b/docs/API_docs/methods/channels_toggleSignatures.md index e8ff70a8..f233a8e1 100644 --- a/docs/API_docs/methods/channels_toggleSignatures.md +++ b/docs/API_docs/methods/channels_toggleSignatures.md @@ -1,17 +1,19 @@ --- title: channels.toggleSignatures -description: channels.toggleSignatures parameters, return type and example +description: Toggle channel signatures --- ## Method: channels.toggleSignatures [Back to methods index](index.md) +Toggle channel signatures + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Enable or disable channel signatures?| ### Return type: [Updates](../types/Updates.md) diff --git a/docs/API_docs/methods/channels_updatePinnedMessage.md b/docs/API_docs/methods/channels_updatePinnedMessage.md index 7a14b68b..f06d1f0f 100644 --- a/docs/API_docs/methods/channels_updatePinnedMessage.md +++ b/docs/API_docs/methods/channels_updatePinnedMessage.md @@ -1,18 +1,20 @@ --- title: channels.updatePinnedMessage -description: channels.updatePinnedMessage parameters, return type and example +description: Set the pinned message of a channel/supergroup --- ## Method: channels.updatePinnedMessage [Back to methods index](index.md) +Set the pinned message of a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|id|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Pin silently| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|id|[CLICK ME int](../types/int.md) | Yes|The ID of the message to pin| ### Return type: [Updates](../types/Updates.md) diff --git a/docs/API_docs/methods/channels_updateUsername.md b/docs/API_docs/methods/channels_updateUsername.md index 19647598..ad34490a 100644 --- a/docs/API_docs/methods/channels_updateUsername.md +++ b/docs/API_docs/methods/channels_updateUsername.md @@ -1,17 +1,19 @@ --- title: channels.updateUsername -description: channels.updateUsername parameters, return type and example +description: Update the username of a supergroup/channel --- ## Method: channels.updateUsername [Back to methods index](index.md) +Update the username of a supergroup/channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|username|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|username|[CLICK ME string](../types/string.md) | Yes|The new username| ### Return type: [Bool](../types/Bool.md) diff --git a/docs/API_docs/methods/contacts_getBlocked.md b/docs/API_docs/methods/contacts_getBlocked.md index d7d8c5cc..300025af 100644 --- a/docs/API_docs/methods/contacts_getBlocked.md +++ b/docs/API_docs/methods/contacts_getBlocked.md @@ -12,7 +12,7 @@ Get blocked users | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, then set to the number of blocked contacts previously fetched| +|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, Then set to the number of blocked contacts previously fetched| |limit|[CLICK ME int](../types/int.md) | Yes|How many blocked contacts to fetch| diff --git a/docs/API_docs/methods/contacts_getTopPeers.md b/docs/API_docs/methods/contacts_getTopPeers.md index 226d3aa0..d7b21757 100644 --- a/docs/API_docs/methods/contacts_getTopPeers.md +++ b/docs/API_docs/methods/contacts_getTopPeers.md @@ -18,7 +18,7 @@ Get most used chats |phone\_calls|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch phone calls?| |groups|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch groups?| |channels|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch channels and supergroups?| -|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, then `$offset += $contacts_TopPeers['categories']['count'];`| +|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, Then `$offset += $contacts_TopPeers['categories']['count'];`| |limit|[CLICK ME int](../types/int.md) | Yes|How many results to fetch| |hash|[CLICK ME int](../types/int.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched peer ids);| diff --git a/docs/API_docs/methods/help_getAppChangelog.md b/docs/API_docs/methods/help_getAppChangelog.md index ea7192f6..477df2f8 100644 --- a/docs/API_docs/methods/help_getAppChangelog.md +++ b/docs/API_docs/methods/help_getAppChangelog.md @@ -1,16 +1,18 @@ --- title: help.getAppChangelog -description: help.getAppChangelog parameters, return type and example +description: Get the changelog of this app --- ## Method: help.getAppChangelog [Back to methods index](index.md) +Get the changelog of this app + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|prev\_app\_version|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|prev\_app\_version|[CLICK ME string](../types/string.md) | Yes|Previous app version| ### Return type: [Updates](../types/Updates.md) diff --git a/docs/API_docs/methods/help_getAppUpdate.md b/docs/API_docs/methods/help_getAppUpdate.md index ef72cce2..b88906ae 100644 --- a/docs/API_docs/methods/help_getAppUpdate.md +++ b/docs/API_docs/methods/help_getAppUpdate.md @@ -1,11 +1,13 @@ --- title: help.getAppUpdate -description: help.getAppUpdate parameters, return type and example +description: Get info about app updates --- ## Method: help.getAppUpdate [Back to methods index](index.md) +Get info about app updates + ### Return type: [help\_AppUpdate](../types/help_AppUpdate.md) diff --git a/docs/API_docs/methods/help_getCdnConfig.md b/docs/API_docs/methods/help_getCdnConfig.md index 55a6e6fd..809ea1fb 100644 --- a/docs/API_docs/methods/help_getCdnConfig.md +++ b/docs/API_docs/methods/help_getCdnConfig.md @@ -1,11 +1,13 @@ --- title: help.getCdnConfig -description: help.getCdnConfig parameters, return type and example +description: Get CDN configuration --- ## Method: help.getCdnConfig [Back to methods index](index.md) +Get CDN configuration + ### Return type: [CdnConfig](../types/CdnConfig.md) diff --git a/docs/API_docs/methods/help_getConfig.md b/docs/API_docs/methods/help_getConfig.md index 885ad5d3..16e25c68 100644 --- a/docs/API_docs/methods/help_getConfig.md +++ b/docs/API_docs/methods/help_getConfig.md @@ -1,11 +1,13 @@ --- title: help.getConfig -description: help.getConfig parameters, return type and example +description: Get server configuration --- ## Method: help.getConfig [Back to methods index](index.md) +Get server configuration + ### Return type: [Config](../types/Config.md) diff --git a/docs/API_docs/methods/help_getInviteText.md b/docs/API_docs/methods/help_getInviteText.md index 101ead40..6b226bff 100644 --- a/docs/API_docs/methods/help_getInviteText.md +++ b/docs/API_docs/methods/help_getInviteText.md @@ -1,11 +1,13 @@ --- title: help.getInviteText -description: help.getInviteText parameters, return type and example +description: Get invitation text --- ## Method: help.getInviteText [Back to methods index](index.md) +Get invitation text + ### Return type: [help\_InviteText](../types/help_InviteText.md) diff --git a/docs/API_docs/methods/help_getNearestDc.md b/docs/API_docs/methods/help_getNearestDc.md index 6196890b..35a8bf91 100644 --- a/docs/API_docs/methods/help_getNearestDc.md +++ b/docs/API_docs/methods/help_getNearestDc.md @@ -1,11 +1,13 @@ --- title: help.getNearestDc -description: help.getNearestDc parameters, return type and example +description: Get nearest datacenter --- ## Method: help.getNearestDc [Back to methods index](index.md) +Get nearest datacenter + ### Return type: [NearestDc](../types/NearestDc.md) diff --git a/docs/API_docs/methods/help_getRecentMeUrls.md b/docs/API_docs/methods/help_getRecentMeUrls.md index bec8a8e0..43a47dad 100644 --- a/docs/API_docs/methods/help_getRecentMeUrls.md +++ b/docs/API_docs/methods/help_getRecentMeUrls.md @@ -1,16 +1,18 @@ --- title: help.getRecentMeUrls -description: help.getRecentMeUrls parameters, return type and example +description: Get recent t.me URLs --- ## Method: help.getRecentMeUrls [Back to methods index](index.md) +Get recent t.me URLs + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|referer|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|referer|[CLICK ME string](../types/string.md) | Yes|Referrer| ### Return type: [help\_RecentMeUrls](../types/help_RecentMeUrls.md) diff --git a/docs/API_docs/methods/help_getSupport.md b/docs/API_docs/methods/help_getSupport.md index 9b269f78..a5bab0f2 100644 --- a/docs/API_docs/methods/help_getSupport.md +++ b/docs/API_docs/methods/help_getSupport.md @@ -1,11 +1,13 @@ --- title: help.getSupport -description: help.getSupport parameters, return type and example +description: Get info of support user --- ## Method: help.getSupport [Back to methods index](index.md) +Get info of support user + ### Return type: [help\_Support](../types/help_Support.md) diff --git a/docs/API_docs/methods/help_getTermsOfService.md b/docs/API_docs/methods/help_getTermsOfService.md index f63807ab..487cd83a 100644 --- a/docs/API_docs/methods/help_getTermsOfService.md +++ b/docs/API_docs/methods/help_getTermsOfService.md @@ -1,11 +1,13 @@ --- title: help.getTermsOfService -description: help.getTermsOfService parameters, return type and example +description: Get terms of service --- ## Method: help.getTermsOfService [Back to methods index](index.md) +Get terms of service + ### Return type: [help\_TermsOfService](../types/help_TermsOfService.md) diff --git a/docs/API_docs/methods/help_saveAppLog.md b/docs/API_docs/methods/help_saveAppLog.md index af6e94e2..0165b6e3 100644 --- a/docs/API_docs/methods/help_saveAppLog.md +++ b/docs/API_docs/methods/help_saveAppLog.md @@ -1,16 +1,18 @@ --- title: help.saveAppLog -description: help.saveAppLog parameters, return type and example +description: Log data for developer of this app --- ## Method: help.saveAppLog [Back to methods index](index.md) +Log data for developer of this app + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|events|Array of [CLICK ME InputAppEvent](../types/InputAppEvent.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|events|Array of [CLICK ME InputAppEvent](../types/InputAppEvent.md) | Yes|Event list| ### Return type: [Bool](../types/Bool.md) diff --git a/docs/API_docs/methods/help_setBotUpdatesStatus.md b/docs/API_docs/methods/help_setBotUpdatesStatus.md index 3351fab4..ff314b5c 100644 --- a/docs/API_docs/methods/help_setBotUpdatesStatus.md +++ b/docs/API_docs/methods/help_setBotUpdatesStatus.md @@ -1,17 +1,19 @@ --- title: help.setBotUpdatesStatus -description: help.setBotUpdatesStatus parameters, return type and example +description: Set the update status of webhook --- ## Method: help.setBotUpdatesStatus [Back to methods index](index.md) +Set the update status of webhook + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|pending\_updates\_count|[CLICK ME int](../types/int.md) | Yes| -|message|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|pending\_updates\_count|[CLICK ME int](../types/int.md) | Yes|Pending update count| +|message|[CLICK ME string](../types/string.md) | Yes|Message| ### Return type: [Bool](../types/Bool.md) diff --git a/docs/API_docs/methods/messages_checkChatInvite.md b/docs/API_docs/methods/messages_checkChatInvite.md index 4ddf5084..de1d9ff4 100644 --- a/docs/API_docs/methods/messages_checkChatInvite.md +++ b/docs/API_docs/methods/messages_checkChatInvite.md @@ -1,16 +1,18 @@ --- title: messages.checkChatInvite -description: messages.checkChatInvite parameters, return type and example +description: Check if an invitation link is valid --- ## Method: messages.checkChatInvite [Back to methods index](index.md) +Check if an invitation link is valid + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| ### Return type: [ChatInvite](../types/ChatInvite.md) diff --git a/docs/API_docs/methods/messages_clearRecentStickers.md b/docs/API_docs/methods/messages_clearRecentStickers.md index f017087f..9c1b3754 100644 --- a/docs/API_docs/methods/messages_clearRecentStickers.md +++ b/docs/API_docs/methods/messages_clearRecentStickers.md @@ -1,16 +1,18 @@ --- title: messages.clearRecentStickers -description: messages.clearRecentStickers parameters, return type and example +description: Clear all recent stickers --- ## Method: messages.clearRecentStickers [Back to methods index](index.md) +Clear all recent stickers + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|attached|[CLICK ME Bool](../types/Bool.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|attached|[CLICK ME Bool](../types/Bool.md) | Optional|Clear recent stickers attached to images?| ### Return type: [Bool](../types/Bool.md) diff --git a/docs/API_docs/methods/messages_deleteChatUser.md b/docs/API_docs/methods/messages_deleteChatUser.md index a71f4aaf..0a6830de 100644 --- a/docs/API_docs/methods/messages_deleteChatUser.md +++ b/docs/API_docs/methods/messages_deleteChatUser.md @@ -12,7 +12,7 @@ Delete a user from a chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The MTProto ID of the chat| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to delete (pass @me to leave the chat)| diff --git a/docs/API_docs/methods/messages_editChatAdmin.md b/docs/API_docs/methods/messages_editChatAdmin.md index 6bc8f9ae..7916f8b1 100644 --- a/docs/API_docs/methods/messages_editChatAdmin.md +++ b/docs/API_docs/methods/messages_editChatAdmin.md @@ -1,18 +1,20 @@ --- title: messages.editChatAdmin -description: messages.editChatAdmin parameters, return type and example +description: Edit admin permissions --- ## Method: messages.editChatAdmin [Back to methods index](index.md) +Edit admin permissions + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|is\_admin|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat ID (no supergroups)| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user ID| +|is\_admin|[CLICK ME Bool](../types/Bool.md) | Yes|Should the user be admin?| ### Return type: [Bool](../types/Bool.md) diff --git a/docs/API_docs/methods/messages_editChatPhoto.md b/docs/API_docs/methods/messages_editChatPhoto.md index 8848eca7..122913c4 100644 --- a/docs/API_docs/methods/messages_editChatPhoto.md +++ b/docs/API_docs/methods/messages_editChatPhoto.md @@ -12,7 +12,7 @@ Edit the photo of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The MTProto ID of the chat| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| |photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| diff --git a/docs/API_docs/methods/messages_editChatTitle.md b/docs/API_docs/methods/messages_editChatTitle.md index 1c1c7a16..3a1e974b 100644 --- a/docs/API_docs/methods/messages_editChatTitle.md +++ b/docs/API_docs/methods/messages_editChatTitle.md @@ -12,7 +12,7 @@ Edit the title of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The MTProto ID of the chat| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| |title|[CLICK ME string](../types/string.md) | Yes|The new title| diff --git a/docs/API_docs/methods/messages_editInlineBotMessage.md b/docs/API_docs/methods/messages_editInlineBotMessage.md index 9c4ef8d8..3c7fa055 100644 --- a/docs/API_docs/methods/messages_editInlineBotMessage.md +++ b/docs/API_docs/methods/messages_editInlineBotMessage.md @@ -1,23 +1,25 @@ --- title: messages.editInlineBotMessage -description: messages.editInlineBotMessage parameters, return type and example +description: Edit a sent inline message --- ## Method: messages.editInlineBotMessage [Back to methods index](index.md) +Edit a sent inline message + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional| -|stop\_geo\_live|[CLICK ME Bool](../types/Bool.md) | Optional| -|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes| -|message|[CLICK ME string](../types/string.md) | Optional| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview| +|stop\_geo\_live|[CLICK ME Bool](../types/Bool.md) | Optional|Stop live location| +|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The message ID| +|message|[CLICK ME string](../types/string.md) | Optional|The new message| +|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| +|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| -|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional| +|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional|The new location| ### Return type: [Bool](../types/Bool.md) diff --git a/docs/API_docs/methods/messages_editMessage.md b/docs/API_docs/methods/messages_editMessage.md index 6953a15f..f2533fc2 100644 --- a/docs/API_docs/methods/messages_editMessage.md +++ b/docs/API_docs/methods/messages_editMessage.md @@ -1,24 +1,26 @@ --- title: messages.editMessage -description: messages.editMessage parameters, return type and example +description: Edit a message --- ## Method: messages.editMessage [Back to methods index](index.md) +Edit a message + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional| -|stop\_geo\_live|[CLICK ME Bool](../types/Bool.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|id|[CLICK ME int](../types/int.md) | Yes| -|message|[CLICK ME string](../types/string.md) | Optional| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview| +|stop\_geo\_live|[CLICK ME Bool](../types/Bool.md) | Optional|Stop live location| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| +|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|message|[CLICK ME string](../types/string.md) | Optional|The new message| +|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| +|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| -|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional| +|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional|The new location| ### Return type: [Updates](../types/Updates.md) diff --git a/docs/API_docs/methods/messages_exportChatInvite.md b/docs/API_docs/methods/messages_exportChatInvite.md index 74d70c21..98685d96 100644 --- a/docs/API_docs/methods/messages_exportChatInvite.md +++ b/docs/API_docs/methods/messages_exportChatInvite.md @@ -1,16 +1,18 @@ --- title: messages.exportChatInvite -description: messages.exportChatInvite parameters, return type and example +description: Export chat invite --- ## Method: messages.exportChatInvite [Back to methods index](index.md) +Export chat invite + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat id | ### Return type: [ExportedChatInvite](../types/ExportedChatInvite.md) diff --git a/docs/API_docs/methods/messages_faveSticker.md b/docs/API_docs/methods/messages_faveSticker.md index b9d9a033..c1ffb16a 100644 --- a/docs/API_docs/methods/messages_faveSticker.md +++ b/docs/API_docs/methods/messages_faveSticker.md @@ -1,17 +1,19 @@ --- title: messages.faveSticker -description: messages.faveSticker parameters, return type and example +description: Add a sticker to favorites --- ## Method: messages.faveSticker [Back to methods index](index.md) +Add a sticker to favorites + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional| -|unfave|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker to add to favorites| +|unfave|[CLICK ME Bool](../types/Bool.md) | Yes|Remove it from favorites?| ### Return type: [Bool](../types/Bool.md) diff --git a/docs/API_docs/methods/messages_getAllChats.md b/docs/API_docs/methods/messages_getAllChats.md index 4b87df49..127456e4 100644 --- a/docs/API_docs/methods/messages_getAllChats.md +++ b/docs/API_docs/methods/messages_getAllChats.md @@ -1,16 +1,18 @@ --- title: messages.getAllChats -description: messages.getAllChats parameters, return type and example +description: Get all chats (not supergroups or channels) --- ## Method: messages.getAllChats [Back to methods index](index.md) +Get all chats (not supergroups or channels) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|except\_ids|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|except\_ids|Array of [CLICK ME int](../types/int.md) | Yes|Do not fetch these chats (MTProto id)| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/docs/API_docs/methods/messages_getAllDrafts.md b/docs/API_docs/methods/messages_getAllDrafts.md index a5dd59f6..2c0ecd42 100644 --- a/docs/API_docs/methods/messages_getAllDrafts.md +++ b/docs/API_docs/methods/messages_getAllDrafts.md @@ -1,11 +1,13 @@ --- title: messages.getAllDrafts -description: messages.getAllDrafts parameters, return type and example +description: Get all message drafts --- ## Method: messages.getAllDrafts [Back to methods index](index.md) +Get all message drafts + ### Return type: [Updates](../types/Updates.md) diff --git a/docs/API_docs/methods/messages_getAllStickers.md b/docs/API_docs/methods/messages_getAllStickers.md index 575fcd49..16fdba6c 100644 --- a/docs/API_docs/methods/messages_getAllStickers.md +++ b/docs/API_docs/methods/messages_getAllStickers.md @@ -1,16 +1,18 @@ --- title: messages.getAllStickers -description: messages.getAllStickers parameters, return type and example +description: Get all stickerpacks --- ## Method: messages.getAllStickers [Back to methods index](index.md) +Get all stickerpacks + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/docs/API_docs/methods/messages_getArchivedStickers.md b/docs/API_docs/methods/messages_getArchivedStickers.md index 1b4aaa93..f037e1bc 100644 --- a/docs/API_docs/methods/messages_getArchivedStickers.md +++ b/docs/API_docs/methods/messages_getArchivedStickers.md @@ -1,18 +1,20 @@ --- title: messages.getArchivedStickers -description: messages.getArchivedStickers parameters, return type and example +description: Get all archived stickers --- ## Method: messages.getArchivedStickers [Back to methods index](index.md) +Get all archived stickers + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|masks|[CLICK ME Bool](../types/Bool.md) | Optional| -|offset\_id|[CLICK ME long](../types/long.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|masks|[CLICK ME Bool](../types/Bool.md) | Optional|Get masks?| +|offset\_id|[CLICK ME long](../types/long.md) | Yes|Sticker ID offset| +|limit|[CLICK ME int](../types/int.md) | Yes|Number of stickers to fetch| ### Return type: [messages\_ArchivedStickers](../types/messages_ArchivedStickers.md) diff --git a/docs/API_docs/methods/messages_getAttachedStickers.md b/docs/API_docs/methods/messages_getAttachedStickers.md index a0d89b31..890680cd 100644 --- a/docs/API_docs/methods/messages_getAttachedStickers.md +++ b/docs/API_docs/methods/messages_getAttachedStickers.md @@ -1,16 +1,18 @@ --- title: messages.getAttachedStickers -description: messages.getAttachedStickers parameters, return type and example +description: Get stickers attachable to images --- ## Method: messages.getAttachedStickers [Back to methods index](index.md) +Get stickers attachable to images + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|media|[CLICK ME InputStickeredMedia](../types/InputStickeredMedia.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|media|[CLICK ME InputStickeredMedia](../types/InputStickeredMedia.md) | Yes|The stickered media| ### Return type: [Vector\_of\_StickerSetCovered](../types/StickerSetCovered.md) diff --git a/docs/API_docs/methods/messages_getBotCallbackAnswer.md b/docs/API_docs/methods/messages_getBotCallbackAnswer.md index 7ccd0d1b..09c283f5 100644 --- a/docs/API_docs/methods/messages_getBotCallbackAnswer.md +++ b/docs/API_docs/methods/messages_getBotCallbackAnswer.md @@ -1,19 +1,21 @@ --- title: messages.getBotCallbackAnswer -description: messages.getBotCallbackAnswer parameters, return type and example +description: Get the callback answer of a bot (after clicking a button) --- ## Method: messages.getBotCallbackAnswer [Back to methods index](index.md) +Get the callback answer of a bot (after clicking a button) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|game|[CLICK ME Bool](../types/Bool.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|msg\_id|[CLICK ME int](../types/int.md) | Yes| -|data|[CLICK ME bytes](../types/bytes.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|game|[CLICK ME Bool](../types/Bool.md) | Optional|Is this a game?| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| +|msg\_id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|data|[CLICK ME bytes](../types/bytes.md) | Optional|The data to send to the bot| ### Return type: [messages\_BotCallbackAnswer](../types/messages_BotCallbackAnswer.md) diff --git a/docs/API_docs/methods/messages_getCommonChats.md b/docs/API_docs/methods/messages_getCommonChats.md index a57d7f5a..e6eca283 100644 --- a/docs/API_docs/methods/messages_getCommonChats.md +++ b/docs/API_docs/methods/messages_getCommonChats.md @@ -1,18 +1,20 @@ --- title: messages.getCommonChats -description: messages.getCommonChats parameters, return type and example +description: Get chats in common with a user --- ## Method: messages.getCommonChats [Back to methods index](index.md) +Get chats in common with a user + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|max\_id|[CLICK ME int](../types/int.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| +|max\_id|[CLICK ME int](../types/int.md) | Yes|The maximum chat ID to fetch| +|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to fetch| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/docs/API_docs/methods/messages_getDocumentByHash.md b/docs/API_docs/methods/messages_getDocumentByHash.md index b7c45398..1af5bad4 100644 --- a/docs/API_docs/methods/messages_getDocumentByHash.md +++ b/docs/API_docs/methods/messages_getDocumentByHash.md @@ -1,18 +1,20 @@ --- title: messages.getDocumentByHash -description: messages.getDocumentByHash parameters, return type and example +description: Get document by SHA256 hash --- ## Method: messages.getDocumentByHash [Back to methods index](index.md) +Get document by SHA256 hash + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|sha256|[CLICK ME bytes](../types/bytes.md) | Yes| -|size|[CLICK ME int](../types/int.md) | Yes| -|mime\_type|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|sha256|[CLICK ME bytes](../types/bytes.md) | Yes|`hash('sha256', $filename, true);`| +|size|[CLICK ME int](../types/int.md) | Yes|The file size| +|mime\_type|[CLICK ME string](../types/string.md) | Yes|The mime type of the file| ### Return type: [Document](../types/Document.md) diff --git a/docs/API_docs/methods/messages_getFavedStickers.md b/docs/API_docs/methods/messages_getFavedStickers.md index e95d0133..1be542be 100644 --- a/docs/API_docs/methods/messages_getFavedStickers.md +++ b/docs/API_docs/methods/messages_getFavedStickers.md @@ -1,16 +1,18 @@ --- title: messages.getFavedStickers -description: messages.getFavedStickers parameters, return type and example +description: Get favorite stickers --- ## Method: messages.getFavedStickers [Back to methods index](index.md) +Get favorite stickers + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_FavedStickers](../types/messages_FavedStickers.md) diff --git a/docs/API_docs/methods/messages_getFeaturedStickers.md b/docs/API_docs/methods/messages_getFeaturedStickers.md index 88b5609c..512f2e85 100644 --- a/docs/API_docs/methods/messages_getFeaturedStickers.md +++ b/docs/API_docs/methods/messages_getFeaturedStickers.md @@ -1,16 +1,18 @@ --- title: messages.getFeaturedStickers -description: messages.getFeaturedStickers parameters, return type and example +description: Get featured stickers --- ## Method: messages.getFeaturedStickers [Back to methods index](index.md) +Get featured stickers + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_FeaturedStickers](../types/messages_FeaturedStickers.md) diff --git a/docs/API_docs/methods/messages_getGameHighScores.md b/docs/API_docs/methods/messages_getGameHighScores.md index 2c95af05..5137baea 100644 --- a/docs/API_docs/methods/messages_getGameHighScores.md +++ b/docs/API_docs/methods/messages_getGameHighScores.md @@ -1,18 +1,20 @@ --- title: messages.getGameHighScores -description: messages.getGameHighScores parameters, return type and example +description: Get high scores of a game --- ## Method: messages.getGameHighScores [Back to methods index](index.md) +Get high scores of a game + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|id|[CLICK ME int](../types/int.md) | Yes| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| +|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the high scores| ### Return type: [messages\_HighScores](../types/messages_HighScores.md) diff --git a/docs/API_docs/methods/messages_getInlineBotResults.md b/docs/API_docs/methods/messages_getInlineBotResults.md index 5b2bb254..8ab5bf78 100644 --- a/docs/API_docs/methods/messages_getInlineBotResults.md +++ b/docs/API_docs/methods/messages_getInlineBotResults.md @@ -1,20 +1,22 @@ --- title: messages.getInlineBotResults -description: messages.getInlineBotResults parameters, return type and example +description: Call inline bot --- ## Method: messages.getInlineBotResults [Back to methods index](index.md) +Call inline bot + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional| -|query|[CLICK ME string](../types/string.md) | Yes| -|offset|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot to call| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to call the bot| +|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional|The current location| +|query|[CLICK ME string](../types/string.md) | Yes|The query to send to the bot| +|offset|[CLICK ME string](../types/string.md) | Yes|The offset to send to the bot| ### Return type: [messages\_BotResults](../types/messages_BotResults.md) diff --git a/docs/API_docs/methods/messages_getInlineGameHighScores.md b/docs/API_docs/methods/messages_getInlineGameHighScores.md index 447a55dd..790bfdd9 100644 --- a/docs/API_docs/methods/messages_getInlineGameHighScores.md +++ b/docs/API_docs/methods/messages_getInlineGameHighScores.md @@ -1,17 +1,19 @@ --- title: messages.getInlineGameHighScores -description: messages.getInlineGameHighScores parameters, return type and example +description: Get high scores of a game sent in an inline message --- ## Method: messages.getInlineGameHighScores [Back to methods index](index.md) +Get high scores of a game sent in an inline message + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The inline message| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the high scores| ### Return type: [messages\_HighScores](../types/messages_HighScores.md) diff --git a/docs/API_docs/methods/messages_getMaskStickers.md b/docs/API_docs/methods/messages_getMaskStickers.md index 80c16471..f4ed9411 100644 --- a/docs/API_docs/methods/messages_getMaskStickers.md +++ b/docs/API_docs/methods/messages_getMaskStickers.md @@ -1,16 +1,18 @@ --- title: messages.getMaskStickers -description: messages.getMaskStickers parameters, return type and example +description: Get masks --- ## Method: messages.getMaskStickers [Back to methods index](index.md) +Get masks + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/docs/API_docs/methods/messages_getMessageEditData.md b/docs/API_docs/methods/messages_getMessageEditData.md index 339678bd..12e71bee 100644 --- a/docs/API_docs/methods/messages_getMessageEditData.md +++ b/docs/API_docs/methods/messages_getMessageEditData.md @@ -1,17 +1,19 @@ --- title: messages.getMessageEditData -description: messages.getMessageEditData parameters, return type and example +description: Check if about to edit a message or a media caption --- ## Method: messages.getMessageEditData [Back to methods index](index.md) +Check if about to edit a message or a media caption + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|id|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| +|id|[CLICK ME int](../types/int.md) | Yes|The message ID| ### Return type: [messages\_MessageEditData](../types/messages_MessageEditData.md) diff --git a/docs/API_docs/methods/messages_getMessagesViews.md b/docs/API_docs/methods/messages_getMessagesViews.md index e3f4e4ea..b8d78c85 100644 --- a/docs/API_docs/methods/messages_getMessagesViews.md +++ b/docs/API_docs/methods/messages_getMessagesViews.md @@ -1,18 +1,20 @@ --- title: messages.getMessagesViews -description: messages.getMessagesViews parameters, return type and example +description: Get and increase message views --- ## Method: messages.getMessagesViews [Back to methods index](index.md) +Get and increase message views + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|id|Array of [CLICK ME int](../types/int.md) | Yes| -|increment|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the message is located| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs messages to get| +|increment|[CLICK ME Bool](../types/Bool.md) | Yes|Increase message views?| ### Return type: [Vector\_of\_int](../types/int.md) diff --git a/docs/API_docs/methods/messages_getPeerDialogs.md b/docs/API_docs/methods/messages_getPeerDialogs.md index fe8a821c..da82cfc6 100644 --- a/docs/API_docs/methods/messages_getPeerDialogs.md +++ b/docs/API_docs/methods/messages_getPeerDialogs.md @@ -1,16 +1,18 @@ --- title: messages.getPeerDialogs -description: messages.getPeerDialogs parameters, return type and example +description: Get dialog info of peers --- ## Method: messages.getPeerDialogs [Back to methods index](index.md) +Get dialog info of peers + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peers|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peers|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Yes|The peers| ### Return type: [messages\_PeerDialogs](../types/messages_PeerDialogs.md) diff --git a/docs/API_docs/methods/messages_getPinnedDialogs.md b/docs/API_docs/methods/messages_getPinnedDialogs.md index 99ff5651..d12779fe 100644 --- a/docs/API_docs/methods/messages_getPinnedDialogs.md +++ b/docs/API_docs/methods/messages_getPinnedDialogs.md @@ -1,11 +1,13 @@ --- title: messages.getPinnedDialogs -description: messages.getPinnedDialogs parameters, return type and example +description: Get pinned dialogs --- ## Method: messages.getPinnedDialogs [Back to methods index](index.md) +Get pinned dialogs + ### Return type: [messages\_PeerDialogs](../types/messages_PeerDialogs.md) diff --git a/docs/API_docs/methods/messages_getRecentLocations.md b/docs/API_docs/methods/messages_getRecentLocations.md index 3a8de92f..1f73943d 100644 --- a/docs/API_docs/methods/messages_getRecentLocations.md +++ b/docs/API_docs/methods/messages_getRecentLocations.md @@ -1,17 +1,19 @@ --- title: messages.getRecentLocations -description: messages.getRecentLocations parameters, return type and example +description: Get recent locations --- ## Method: messages.getRecentLocations [Back to methods index](index.md) +Get recent locations + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to search locations| +|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to return| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/docs/API_docs/methods/messages_getRecentStickers.md b/docs/API_docs/methods/messages_getRecentStickers.md index abab7f44..d76a2160 100644 --- a/docs/API_docs/methods/messages_getRecentStickers.md +++ b/docs/API_docs/methods/messages_getRecentStickers.md @@ -1,17 +1,19 @@ --- title: messages.getRecentStickers -description: messages.getRecentStickers parameters, return type and example +description: Get recent stickers --- ## Method: messages.getRecentStickers [Back to methods index](index.md) +Get recent stickers + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|attached|[CLICK ME Bool](../types/Bool.md) | Optional| -|hash|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|attached|[CLICK ME Bool](../types/Bool.md) | Optional|Get stickers attached to image?| +|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_RecentStickers](../types/messages_RecentStickers.md) diff --git a/docs/API_docs/methods/messages_getSavedGifs.md b/docs/API_docs/methods/messages_getSavedGifs.md index 08dc4be6..f61348ce 100644 --- a/docs/API_docs/methods/messages_getSavedGifs.md +++ b/docs/API_docs/methods/messages_getSavedGifs.md @@ -1,16 +1,18 @@ --- title: messages.getSavedGifs -description: messages.getSavedGifs parameters, return type and example +description: Get saved gifs --- ## Method: messages.getSavedGifs [Back to methods index](index.md) +Get saved gifs + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_SavedGifs](../types/messages_SavedGifs.md) diff --git a/docs/API_docs/methods/messages_getStickerSet.md b/docs/API_docs/methods/messages_getStickerSet.md index 70bdd9ba..c86807e4 100644 --- a/docs/API_docs/methods/messages_getStickerSet.md +++ b/docs/API_docs/methods/messages_getStickerSet.md @@ -1,16 +1,18 @@ --- title: messages.getStickerSet -description: messages.getStickerSet parameters, return type and example +description: Get a stickerset --- ## Method: messages.getStickerSet [Back to methods index](index.md) +Get a stickerset + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset to get| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/docs/API_docs/methods/messages_getStickers.md b/docs/API_docs/methods/messages_getStickers.md index 178b897c..4854696d 100644 --- a/docs/API_docs/methods/messages_getStickers.md +++ b/docs/API_docs/methods/messages_getStickers.md @@ -1,17 +1,19 @@ --- title: messages.getStickers -description: messages.getStickers parameters, return type and example +description: Get stickers --- ## Method: messages.getStickers [Back to methods index](index.md) +Get stickers + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|emoticon|[CLICK ME string](../types/string.md) | Yes| -|hash|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|emoticon|[CLICK ME string](../types/string.md) | Yes|Search by emoji| +|hash|[CLICK ME string](../types/string.md) | Yes|0 or $MadelineProto->gen_vector_hash(previously fetched sticker IDs)| ### Return type: [messages\_Stickers](../types/messages_Stickers.md) diff --git a/docs/API_docs/methods/messages_getUnreadMentions.md b/docs/API_docs/methods/messages_getUnreadMentions.md index 959c52fc..d318506c 100644 --- a/docs/API_docs/methods/messages_getUnreadMentions.md +++ b/docs/API_docs/methods/messages_getUnreadMentions.md @@ -1,21 +1,23 @@ --- title: messages.getUnreadMentions -description: messages.getUnreadMentions parameters, return type and example +description: Get unread mentions --- ## Method: messages.getUnreadMentions [Back to methods index](index.md) +Get unread mentions + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|offset\_id|[CLICK ME int](../types/int.md) | Yes| -|add\_offset|[CLICK ME int](../types/int.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| -|max\_id|[CLICK ME int](../types/int.md) | Yes| -|min\_id|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to get unread mentions| +|offset\_id|[CLICK ME int](../types/int.md) | Yes|The offset| +|add\_offset|[CLICK ME int](../types/int.md) | Yes|The additional offset| +|limit|[CLICK ME int](../types/int.md) | Yes|The number of results to fetch| +|max\_id|[CLICK ME int](../types/int.md) | Yes|The maximum message ID to fetch| +|min\_id|[CLICK ME int](../types/int.md) | Yes|The minumum message ID to fetch| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/docs/API_docs/methods/messages_getWebPage.md b/docs/API_docs/methods/messages_getWebPage.md index b29e5d25..129f8f06 100644 --- a/docs/API_docs/methods/messages_getWebPage.md +++ b/docs/API_docs/methods/messages_getWebPage.md @@ -1,17 +1,19 @@ --- title: messages.getWebPage -description: messages.getWebPage parameters, return type and example +description: Get webpage preview --- ## Method: messages.getWebPage [Back to methods index](index.md) +Get webpage preview + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|url|[CLICK ME string](../types/string.md) | Yes| -|hash|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|url|[CLICK ME string](../types/string.md) | Yes|URL| +|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [WebPage](../types/WebPage.md) diff --git a/docs/API_docs/methods/messages_getWebPagePreview.md b/docs/API_docs/methods/messages_getWebPagePreview.md index e7221d0f..8b6bbe76 100644 --- a/docs/API_docs/methods/messages_getWebPagePreview.md +++ b/docs/API_docs/methods/messages_getWebPagePreview.md @@ -1,17 +1,19 @@ --- title: messages.getWebPagePreview -description: messages.getWebPagePreview parameters, return type and example +description: Get webpage preview --- ## Method: messages.getWebPagePreview [Back to methods index](index.md) +Get webpage preview + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|message|[CLICK ME string](../types/string.md) | Yes| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|message|[CLICK ME string](../types/string.md) | Yes|Extract preview from this message| +|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|Entities for styled text| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/docs/API_docs/methods/messages_importChatInvite.md b/docs/API_docs/methods/messages_importChatInvite.md index 2bea5247..0d6cd7c8 100644 --- a/docs/API_docs/methods/messages_importChatInvite.md +++ b/docs/API_docs/methods/messages_importChatInvite.md @@ -1,16 +1,18 @@ --- title: messages.importChatInvite -description: messages.importChatInvite parameters, return type and example +description: Import chat invite --- ## Method: messages.importChatInvite [Back to methods index](index.md) +Import chat invite + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| ### Return type: [Updates](../types/Updates.md) diff --git a/docs/API_docs/methods/messages_installStickerSet.md b/docs/API_docs/methods/messages_installStickerSet.md index 61513182..9f6f098c 100644 --- a/docs/API_docs/methods/messages_installStickerSet.md +++ b/docs/API_docs/methods/messages_installStickerSet.md @@ -1,17 +1,19 @@ --- title: messages.installStickerSet -description: messages.installStickerSet parameters, return type and example +description: Add a sticker set --- ## Method: messages.installStickerSet [Back to methods index](index.md) +Add a sticker set + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional| -|archived|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to add| +|archived|[CLICK ME Bool](../types/Bool.md) | Yes|Archive this set?| ### Return type: [messages\_StickerSetInstallResult](../types/messages_StickerSetInstallResult.md) diff --git a/docs/API_docs/methods/messages_migrateChat.md b/docs/API_docs/methods/messages_migrateChat.md index 5021ad45..db57adfa 100644 --- a/docs/API_docs/methods/messages_migrateChat.md +++ b/docs/API_docs/methods/messages_migrateChat.md @@ -1,16 +1,18 @@ --- title: messages.migrateChat -description: messages.migrateChat parameters, return type and example +description: Convert chat to supergroup --- ## Method: messages.migrateChat [Back to methods index](index.md) +Convert chat to supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat to convert| ### Return type: [Updates](../types/Updates.md) diff --git a/docs/API_docs/methods/messages_readEncryptedHistory.md b/docs/API_docs/methods/messages_readEncryptedHistory.md index 4d341809..39b110e3 100644 --- a/docs/API_docs/methods/messages_readEncryptedHistory.md +++ b/docs/API_docs/methods/messages_readEncryptedHistory.md @@ -1,17 +1,19 @@ --- title: messages.readEncryptedHistory -description: messages.readEncryptedHistory parameters, return type and example +description: Mark messages as read in secret chats --- ## Method: messages.readEncryptedHistory [Back to methods index](index.md) +Mark messages as read in secret chats + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|max\_date|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to mark messages as read| +|max\_date|[CLICK ME int](../types/int.md) | Yes|Maximum date of messages to mark| ### Return type: [Bool](../types/Bool.md) diff --git a/docs/API_docs/methods/messages_readFeaturedStickers.md b/docs/API_docs/methods/messages_readFeaturedStickers.md index 0631ca5b..4035c76d 100644 --- a/docs/API_docs/methods/messages_readFeaturedStickers.md +++ b/docs/API_docs/methods/messages_readFeaturedStickers.md @@ -1,16 +1,18 @@ --- title: messages.readFeaturedStickers -description: messages.readFeaturedStickers parameters, return type and example +description: Mark new featured stickers as read --- ## Method: messages.readFeaturedStickers [Back to methods index](index.md) +Mark new featured stickers as read + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|Array of [CLICK ME long](../types/long.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|Array of [CLICK ME long](../types/long.md) | Yes|The stickers to mark as read| ### Return type: [Bool](../types/Bool.md) diff --git a/docs/API_docs/methods/messages_readMentions.md b/docs/API_docs/methods/messages_readMentions.md index 113657e8..e30fbfaf 100644 --- a/docs/API_docs/methods/messages_readMentions.md +++ b/docs/API_docs/methods/messages_readMentions.md @@ -1,16 +1,18 @@ --- title: messages.readMentions -description: messages.readMentions parameters, return type and example +description: Mark mentions as read --- ## Method: messages.readMentions [Back to methods index](index.md) +Mark mentions as read + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) diff --git a/docs/API_docs/methods/messages_readMessageContents.md b/docs/API_docs/methods/messages_readMessageContents.md index 0d27c209..9bb1bee8 100644 --- a/docs/API_docs/methods/messages_readMessageContents.md +++ b/docs/API_docs/methods/messages_readMessageContents.md @@ -1,16 +1,18 @@ --- title: messages.readMessageContents -description: messages.readMessageContents parameters, return type and example +description: Mark message as read --- ## Method: messages.readMessageContents [Back to methods index](index.md) +Mark message as read + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/docs/API_docs/methods/messages_receivedQueue.md b/docs/API_docs/methods/messages_receivedQueue.md index c91caa37..4ad78ba2 100644 --- a/docs/API_docs/methods/messages_receivedQueue.md +++ b/docs/API_docs/methods/messages_receivedQueue.md @@ -1,77 +1,13 @@ --- title: messages.receivedQueue -description: messages.receivedQueue parameters, return type and example +description: You cannot use this method directly --- ## Method: messages.receivedQueue [Back to methods index](index.md) -### Parameters: - -| Name | Type | Required | -|----------|---------------|----------| -|max\_qts|[CLICK ME int](../types/int.md) | Yes| - - -### 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| - - -### MadelineProto Example: - - -``` -if (!file_exists('madeline.php')) { - copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); -} -include 'madeline.php'; - -// !!! This API id/API hash combination will not work !!! -// !!! You must get your own @ my.telegram.org !!! -$api_id = 0; -$api_hash = ''; - -$MadelineProto = new \danog\MadelineProto\API('session.madeline', ['app_info' => ['api_id' => $api_id, 'api_hash' => $api_hash]]); -$MadelineProto->start(); - -$Vector_of_long = $MadelineProto->messages->receivedQueue(['max_qts' => int, ]); -``` - -### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): - -### As a bot: - -POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` - -Parameters: - -* method - messages.receivedQueue -* params - `{"max_qts": int, }` - - - -### As a user: - -POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.receivedQueue` - -Parameters: - -max_qts - Json encoded int +**You cannot use this method directly** -Or, if you're into Lua: - -``` -Vector_of_long = messages.receivedQueue({max_qts=int, }) -``` - diff --git a/docs/API_docs/methods/messages_reorderPinnedDialogs.md b/docs/API_docs/methods/messages_reorderPinnedDialogs.md index 0bf5e073..710caf10 100644 --- a/docs/API_docs/methods/messages_reorderPinnedDialogs.md +++ b/docs/API_docs/methods/messages_reorderPinnedDialogs.md @@ -1,17 +1,19 @@ --- title: messages.reorderPinnedDialogs -description: messages.reorderPinnedDialogs parameters, return type and example +description: Reorder pinned dialogs --- ## Method: messages.reorderPinnedDialogs [Back to methods index](index.md) +Reorder pinned dialogs + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|force|[CLICK ME Bool](../types/Bool.md) | Optional| -|order|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|force|[CLICK ME Bool](../types/Bool.md) | Optional|Force reordering| +|order|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Yes|New order| ### Return type: [Bool](../types/Bool.md) diff --git a/docs/API_docs/methods/messages_reorderStickerSets.md b/docs/API_docs/methods/messages_reorderStickerSets.md index e4f1623c..ddc78dd0 100644 --- a/docs/API_docs/methods/messages_reorderStickerSets.md +++ b/docs/API_docs/methods/messages_reorderStickerSets.md @@ -1,17 +1,19 @@ --- title: messages.reorderStickerSets -description: messages.reorderStickerSets parameters, return type and example +description: Reorder sticker sets --- ## Method: messages.reorderStickerSets [Back to methods index](index.md) +Reorder sticker sets + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|masks|[CLICK ME Bool](../types/Bool.md) | Optional| -|order|Array of [CLICK ME long](../types/long.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|masks|[CLICK ME Bool](../types/Bool.md) | Optional|Reorder masks?| +|order|Array of [CLICK ME long](../types/long.md) | Yes|The order| ### Return type: [Bool](../types/Bool.md) diff --git a/docs/API_docs/methods/messages_reportEncryptedSpam.md b/docs/API_docs/methods/messages_reportEncryptedSpam.md index 44482c76..58b684d1 100644 --- a/docs/API_docs/methods/messages_reportEncryptedSpam.md +++ b/docs/API_docs/methods/messages_reportEncryptedSpam.md @@ -1,16 +1,18 @@ --- title: messages.reportEncryptedSpam -description: messages.reportEncryptedSpam parameters, return type and example +description: Report for spam a secret chat --- ## Method: messages.reportEncryptedSpam [Back to methods index](index.md) +Report for spam a secret chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat to report| ### Return type: [Bool](../types/Bool.md) diff --git a/docs/API_docs/methods/messages_saveDraft.md b/docs/API_docs/methods/messages_saveDraft.md index 9104df33..bbeed707 100644 --- a/docs/API_docs/methods/messages_saveDraft.md +++ b/docs/API_docs/methods/messages_saveDraft.md @@ -1,20 +1,22 @@ --- title: messages.saveDraft -description: messages.saveDraft parameters, return type and example +description: Save a message draft --- ## Method: messages.saveDraft [Back to methods index](index.md) +Save a message draft + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|message|[CLICK ME string](../types/string.md) | Yes| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview| +|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| +|message|[CLICK ME string](../types/string.md) | Yes|The message| +|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|The entities (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/docs/API_docs/methods/messages_saveGif.md b/docs/API_docs/methods/messages_saveGif.md index 4a3b6166..6f608c4c 100644 --- a/docs/API_docs/methods/messages_saveGif.md +++ b/docs/API_docs/methods/messages_saveGif.md @@ -1,17 +1,19 @@ --- title: messages.saveGif -description: messages.saveGif parameters, return type and example +description: Save a GIF --- ## Method: messages.saveGif [Back to methods index](index.md) +Save a GIF + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional| -|unsave|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The GIF to save| +|unsave|[CLICK ME Bool](../types/Bool.md) | Yes|Remove the gif?| ### Return type: [Bool](../types/Bool.md) diff --git a/docs/API_docs/methods/messages_saveRecentSticker.md b/docs/API_docs/methods/messages_saveRecentSticker.md index b4f43e13..81ad5d48 100644 --- a/docs/API_docs/methods/messages_saveRecentSticker.md +++ b/docs/API_docs/methods/messages_saveRecentSticker.md @@ -1,18 +1,20 @@ --- title: messages.saveRecentSticker -description: messages.saveRecentSticker parameters, return type and example +description: Add a sticker to recent stickers --- ## Method: messages.saveRecentSticker [Back to methods index](index.md) +Add a sticker to recent stickers + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|attached|[CLICK ME Bool](../types/Bool.md) | Optional| -|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional| -|unsave|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|attached|[CLICK ME Bool](../types/Bool.md) | Optional|Get stickers attached to image?| +|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker| +|unsave|[CLICK ME Bool](../types/Bool.md) | Yes|Remove the sticker from recent stickers?| ### Return type: [Bool](../types/Bool.md) diff --git a/docs/API_docs/methods/messages_searchGifs.md b/docs/API_docs/methods/messages_searchGifs.md index fefef1d7..103ebfeb 100644 --- a/docs/API_docs/methods/messages_searchGifs.md +++ b/docs/API_docs/methods/messages_searchGifs.md @@ -1,17 +1,19 @@ --- title: messages.searchGifs -description: messages.searchGifs parameters, return type and example +description: Search gifs --- ## Method: messages.searchGifs [Back to methods index](index.md) +Search gifs + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|q|[CLICK ME string](../types/string.md) | Yes| -|offset|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|q|[CLICK ME string](../types/string.md) | Yes|The search query| +|offset|[CLICK ME int](../types/int.md) | Yes|The offset | ### Return type: [messages\_FoundGifs](../types/messages_FoundGifs.md) diff --git a/docs/API_docs/methods/messages_searchGlobal.md b/docs/API_docs/methods/messages_searchGlobal.md index 32ddd175..0edd1e40 100644 --- a/docs/API_docs/methods/messages_searchGlobal.md +++ b/docs/API_docs/methods/messages_searchGlobal.md @@ -1,20 +1,22 @@ --- title: messages.searchGlobal -description: messages.searchGlobal parameters, return type and example +description: Global message search --- ## Method: messages.searchGlobal [Back to methods index](index.md) +Global message search + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|q|[CLICK ME string](../types/string.md) | Yes| -|offset\_date|[CLICK ME int](../types/int.md) | Yes| -|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|offset\_id|[CLICK ME int](../types/int.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|q|[CLICK ME string](../types/string.md) | Yes|The query| +|offset\_date|[CLICK ME int](../types/int.md) | Yes|0 or the date offset| +|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|0 or the peer offset| +|offset\_id|[CLICK ME int](../types/int.md) | Yes|0 or the message ID offset| +|limit|[CLICK ME int](../types/int.md) | Yes|The number of results to return| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/docs/API_docs/methods/messages_sendEncrypted.md b/docs/API_docs/methods/messages_sendEncrypted.md index 23461760..d48f88d7 100644 --- a/docs/API_docs/methods/messages_sendEncrypted.md +++ b/docs/API_docs/methods/messages_sendEncrypted.md @@ -1,17 +1,19 @@ --- title: messages.sendEncrypted -description: messages.sendEncrypted parameters, return type and example +description: Send message to secret chat --- ## Method: messages.sendEncrypted [Back to methods index](index.md) +Send message to secret chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the message| +|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/docs/API_docs/methods/messages_sendEncryptedFile.md b/docs/API_docs/methods/messages_sendEncryptedFile.md index 64919abe..4fd0648e 100644 --- a/docs/API_docs/methods/messages_sendEncryptedFile.md +++ b/docs/API_docs/methods/messages_sendEncryptedFile.md @@ -1,18 +1,20 @@ --- title: messages.sendEncryptedFile -description: messages.sendEncryptedFile parameters, return type and example +description: Send a file to a secret chat --- ## Method: messages.sendEncryptedFile [Back to methods index](index.md) +Send a file to a secret chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes| -|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the file| +|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| +|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional|The file (optional)| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/docs/API_docs/methods/messages_sendEncryptedService.md b/docs/API_docs/methods/messages_sendEncryptedService.md index 0a0eea8a..d66894bf 100644 --- a/docs/API_docs/methods/messages_sendEncryptedService.md +++ b/docs/API_docs/methods/messages_sendEncryptedService.md @@ -1,17 +1,19 @@ --- title: messages.sendEncryptedService -description: messages.sendEncryptedService parameters, return type and example +description: Send a service message to a secret chat --- ## Method: messages.sendEncryptedService [Back to methods index](index.md) +Send a service message to a secret chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the service message| +|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/docs/API_docs/methods/messages_sendInlineBotResult.md b/docs/API_docs/methods/messages_sendInlineBotResult.md index 4cb9243e..386ac7e3 100644 --- a/docs/API_docs/methods/messages_sendInlineBotResult.md +++ b/docs/API_docs/methods/messages_sendInlineBotResult.md @@ -1,22 +1,24 @@ --- title: messages.sendInlineBotResult -description: messages.sendInlineBotResult parameters, return type and example +description: Send a received bot result to the chat --- ## Method: messages.sendInlineBotResult [Back to methods index](index.md) +Send a received bot result to the chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional| -|background|[CLICK ME Bool](../types/Bool.md) | Optional| -|clear\_draft|[CLICK ME Bool](../types/Bool.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional| -|query\_id|[CLICK ME long](../types/long.md) | Yes| -|id|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Disable notifications?| +|background|[CLICK ME Bool](../types/Bool.md) | Optional|Disable background notifications?| +|clear\_draft|[CLICK ME Bool](../types/Bool.md) | Optional|Clear the message draft?| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the message| +|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| +|query\_id|[CLICK ME long](../types/long.md) | Yes|The inline query ID| +|id|[CLICK ME string](../types/string.md) | Yes|The result ID| ### Return type: [Updates](../types/Updates.md) diff --git a/docs/API_docs/methods/messages_sendMultiMedia.md b/docs/API_docs/methods/messages_sendMultiMedia.md index 38babb1f..08a7a8a1 100644 --- a/docs/API_docs/methods/messages_sendMultiMedia.md +++ b/docs/API_docs/methods/messages_sendMultiMedia.md @@ -1,21 +1,23 @@ --- title: messages.sendMultiMedia -description: messages.sendMultiMedia parameters, return type and example +description: Send an album --- ## Method: messages.sendMultiMedia [Back to methods index](index.md) +Send an album + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional| -|background|[CLICK ME Bool](../types/Bool.md) | Optional| -|clear\_draft|[CLICK ME Bool](../types/Bool.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional| -|multi\_media|Array of [CLICK ME InputSingleMedia](../types/InputSingleMedia.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Disable notifications?| +|background|[CLICK ME Bool](../types/Bool.md) | Optional|Disable background notification?| +|clear\_draft|[CLICK ME Bool](../types/Bool.md) | Optional|Clear draft?| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the album| +|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| +|multi\_media|Array of [CLICK ME InputSingleMedia](../types/InputSingleMedia.md) | Yes|The album| ### Return type: [Updates](../types/Updates.md) diff --git a/docs/API_docs/methods/messages_sendScreenshotNotification.md b/docs/API_docs/methods/messages_sendScreenshotNotification.md index c9d1d555..f64f1682 100644 --- a/docs/API_docs/methods/messages_sendScreenshotNotification.md +++ b/docs/API_docs/methods/messages_sendScreenshotNotification.md @@ -1,17 +1,19 @@ --- title: messages.sendScreenshotNotification -description: messages.sendScreenshotNotification parameters, return type and example +description: Send screenshot notification --- ## Method: messages.sendScreenshotNotification [Back to methods index](index.md) +Send screenshot notification + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the notification| +|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Yes|Reply to message by ID| ### Return type: [Updates](../types/Updates.md) diff --git a/docs/API_docs/methods/messages_setBotCallbackAnswer.md b/docs/API_docs/methods/messages_setBotCallbackAnswer.md index 5590828e..e6dc6b09 100644 --- a/docs/API_docs/methods/messages_setBotCallbackAnswer.md +++ b/docs/API_docs/methods/messages_setBotCallbackAnswer.md @@ -1,20 +1,22 @@ --- title: messages.setBotCallbackAnswer -description: messages.setBotCallbackAnswer parameters, return type and example +description: Bots only: set the callback answer (after a button was clicked) --- ## Method: messages.setBotCallbackAnswer [Back to methods index](index.md) +Bots only: set the callback answer (after a button was clicked) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|alert|[CLICK ME Bool](../types/Bool.md) | Optional| -|query\_id|[CLICK ME long](../types/long.md) | Yes| -|message|[CLICK ME string](../types/string.md) | Optional| -|url|[CLICK ME string](../types/string.md) | Optional| -|cache\_time|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|alert|[CLICK ME Bool](../types/Bool.md) | Optional|Is this an alert?| +|query\_id|[CLICK ME long](../types/long.md) | Yes|The query ID| +|message|[CLICK ME string](../types/string.md) | Optional|The message| +|url|[CLICK ME string](../types/string.md) | Optional|The URL| +|cache\_time|[CLICK ME int](../types/int.md) | Yes|Cache time| ### Return type: [Bool](../types/Bool.md) diff --git a/docs/API_docs/methods/messages_setBotPrecheckoutResults.md b/docs/API_docs/methods/messages_setBotPrecheckoutResults.md index 5afa7789..722bff81 100644 --- a/docs/API_docs/methods/messages_setBotPrecheckoutResults.md +++ b/docs/API_docs/methods/messages_setBotPrecheckoutResults.md @@ -1,18 +1,20 @@ --- title: messages.setBotPrecheckoutResults -description: messages.setBotPrecheckoutResults parameters, return type and example +description: Bots only: set precheckout results --- ## Method: messages.setBotPrecheckoutResults [Back to methods index](index.md) +Bots only: set precheckout results + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|success|[CLICK ME Bool](../types/Bool.md) | Optional| -|query\_id|[CLICK ME long](../types/long.md) | Yes| -|error|[CLICK ME string](../types/string.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|success|[CLICK ME Bool](../types/Bool.md) | Optional|Success?| +|query\_id|[CLICK ME long](../types/long.md) | Yes|Query ID| +|error|[CLICK ME string](../types/string.md) | Optional|Error| ### Return type: [Bool](../types/Bool.md) diff --git a/docs/API_docs/methods/messages_setBotShippingResults.md b/docs/API_docs/methods/messages_setBotShippingResults.md index b36dacce..d364a04d 100644 --- a/docs/API_docs/methods/messages_setBotShippingResults.md +++ b/docs/API_docs/methods/messages_setBotShippingResults.md @@ -1,18 +1,20 @@ --- title: messages.setBotShippingResults -description: messages.setBotShippingResults parameters, return type and example +description: Bots only: set shipping results --- ## Method: messages.setBotShippingResults [Back to methods index](index.md) +Bots only: set shipping results + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|query\_id|[CLICK ME long](../types/long.md) | Yes| -|error|[CLICK ME string](../types/string.md) | Optional| -|shipping\_options|Array of [CLICK ME ShippingOption](../types/ShippingOption.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|query\_id|[CLICK ME long](../types/long.md) | Yes|Query ID| +|error|[CLICK ME string](../types/string.md) | Optional|Error| +|shipping\_options|Array of [CLICK ME ShippingOption](../types/ShippingOption.md) | Optional|Shipping options| ### Return type: [Bool](../types/Bool.md) diff --git a/docs/API_docs/methods/messages_setEncryptedTyping.md b/docs/API_docs/methods/messages_setEncryptedTyping.md index 3183fedf..e9afe99c 100644 --- a/docs/API_docs/methods/messages_setEncryptedTyping.md +++ b/docs/API_docs/methods/messages_setEncryptedTyping.md @@ -12,8 +12,8 @@ Send typing notification to secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|| -|typing|[CLICK ME Bool](../types/Bool.md) | Yes|| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to send the notification| +|typing|[CLICK ME Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| ### Return type: [Bool](../types/Bool.md) diff --git a/docs/API_docs/methods/messages_setGameScore.md b/docs/API_docs/methods/messages_setGameScore.md index c44145c0..aa1f4f0c 100644 --- a/docs/API_docs/methods/messages_setGameScore.md +++ b/docs/API_docs/methods/messages_setGameScore.md @@ -1,21 +1,23 @@ --- title: messages.setGameScore -description: messages.setGameScore parameters, return type and example +description: Set the game score --- ## Method: messages.setGameScore [Back to methods index](index.md) +Set the game score + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|edit\_message|[CLICK ME Bool](../types/Bool.md) | Optional| -|force|[CLICK ME Bool](../types/Bool.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|id|[CLICK ME int](../types/int.md) | Yes| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|score|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|edit\_message|[CLICK ME Bool](../types/Bool.md) | Optional|Should the message with the game be edited?| +|force|[CLICK ME Bool](../types/Bool.md) | Optional|Force setting the game score| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the game was sent| +|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the score| +|score|[CLICK ME int](../types/int.md) | Yes|The score| ### Return type: [Updates](../types/Updates.md) diff --git a/docs/API_docs/methods/messages_setInlineBotResults.md b/docs/API_docs/methods/messages_setInlineBotResults.md index 915e3a4e..79493009 100644 --- a/docs/API_docs/methods/messages_setInlineBotResults.md +++ b/docs/API_docs/methods/messages_setInlineBotResults.md @@ -1,22 +1,24 @@ --- title: messages.setInlineBotResults -description: messages.setInlineBotResults parameters, return type and example +description: Bots only: set the results of an inline query --- ## Method: messages.setInlineBotResults [Back to methods index](index.md) +Bots only: set the results of an inline query + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|gallery|[CLICK ME Bool](../types/Bool.md) | Optional| -|private|[CLICK ME Bool](../types/Bool.md) | Optional| -|query\_id|[CLICK ME long](../types/long.md) | Yes| -|results|Array of [CLICK ME InputBotInlineResult](../types/InputBotInlineResult.md) | Yes| -|cache\_time|[CLICK ME int](../types/int.md) | Yes| -|next\_offset|[CLICK ME string](../types/string.md) | Optional| -|switch\_pm|[CLICK ME InlineBotSwitchPM](../types/InlineBotSwitchPM.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|gallery|[CLICK ME Bool](../types/Bool.md) | Optional|Is this a gallery?| +|private|[CLICK ME Bool](../types/Bool.md) | Optional|Is this result private (not cached)?| +|query\_id|[CLICK ME long](../types/long.md) | Yes|Query ID| +|results|Array of [CLICK ME InputBotInlineResult](../types/InputBotInlineResult.md) | Yes|Results| +|cache\_time|[CLICK ME int](../types/int.md) | Yes|Cache time| +|next\_offset|[CLICK ME string](../types/string.md) | Optional|The next offset| +|switch\_pm|[CLICK ME InlineBotSwitchPM](../types/InlineBotSwitchPM.md) | Optional|Switch to PM?| ### Return type: [Bool](../types/Bool.md) diff --git a/docs/API_docs/methods/messages_setInlineGameScore.md b/docs/API_docs/methods/messages_setInlineGameScore.md index 55e2c063..385c8308 100644 --- a/docs/API_docs/methods/messages_setInlineGameScore.md +++ b/docs/API_docs/methods/messages_setInlineGameScore.md @@ -1,20 +1,22 @@ --- title: messages.setInlineGameScore -description: messages.setInlineGameScore parameters, return type and example +description: Set the game score of an inline message --- ## Method: messages.setInlineGameScore [Back to methods index](index.md) +Set the game score of an inline message + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|edit\_message|[CLICK ME Bool](../types/Bool.md) | Optional| -|force|[CLICK ME Bool](../types/Bool.md) | Optional| -|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|score|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|edit\_message|[CLICK ME Bool](../types/Bool.md) | Optional|Should the message with the game be edited?| +|force|[CLICK ME Bool](../types/Bool.md) | Optional|Force setting the game score| +|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The ID of the inline message| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the score| +|score|[CLICK ME int](../types/int.md) | Yes|The score| ### Return type: [Bool](../types/Bool.md) diff --git a/docs/API_docs/methods/messages_startBot.md b/docs/API_docs/methods/messages_startBot.md index 0de0f1a5..94a4d86a 100644 --- a/docs/API_docs/methods/messages_startBot.md +++ b/docs/API_docs/methods/messages_startBot.md @@ -1,18 +1,20 @@ --- title: messages.startBot -description: messages.startBot parameters, return type and example +description: Start a bot --- ## Method: messages.startBot [Back to methods index](index.md) +Start a bot + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|start\_param|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot's ID or username| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to start the bot (@me or group ID/username)| +|start\_param|[CLICK ME string](../types/string.md) | Yes|The bot's start parameter| ### Return type: [Updates](../types/Updates.md) diff --git a/docs/API_docs/methods/messages_toggleChatAdmins.md b/docs/API_docs/methods/messages_toggleChatAdmins.md index d56e5753..ab591fd9 100644 --- a/docs/API_docs/methods/messages_toggleChatAdmins.md +++ b/docs/API_docs/methods/messages_toggleChatAdmins.md @@ -1,17 +1,19 @@ --- title: messages.toggleChatAdmins -description: messages.toggleChatAdmins parameters, return type and example +description: Enable all users are admins in normal groups (not supergroups) --- ## Method: messages.toggleChatAdmins [Back to methods index](index.md) +Enable all users are admins in normal groups (not supergroups) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Group ID| +|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Enable all users are admins| ### Return type: [Updates](../types/Updates.md) diff --git a/docs/API_docs/methods/messages_toggleDialogPin.md b/docs/API_docs/methods/messages_toggleDialogPin.md index d6dc9692..2bd6a03d 100644 --- a/docs/API_docs/methods/messages_toggleDialogPin.md +++ b/docs/API_docs/methods/messages_toggleDialogPin.md @@ -1,17 +1,19 @@ --- title: messages.toggleDialogPin -description: messages.toggleDialogPin parameters, return type and example +description: Pin or unpin dialog --- ## Method: messages.toggleDialogPin [Back to methods index](index.md) +Pin or unpin dialog + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|pinned|[CLICK ME Bool](../types/Bool.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|pinned|[CLICK ME Bool](../types/Bool.md) | Optional|Pin or unpin the dialog?| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer to pin| ### Return type: [Bool](../types/Bool.md) diff --git a/docs/API_docs/methods/messages_uninstallStickerSet.md b/docs/API_docs/methods/messages_uninstallStickerSet.md index 60b0ca0c..6d04e847 100644 --- a/docs/API_docs/methods/messages_uninstallStickerSet.md +++ b/docs/API_docs/methods/messages_uninstallStickerSet.md @@ -1,16 +1,18 @@ --- title: messages.uninstallStickerSet -description: messages.uninstallStickerSet parameters, return type and example +description: Remove a sticker set --- ## Method: messages.uninstallStickerSet [Back to methods index](index.md) +Remove a sticker set + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to remove| ### Return type: [Bool](../types/Bool.md) diff --git a/docs/API_docs/methods/messages_uploadEncryptedFile.md b/docs/API_docs/methods/messages_uploadEncryptedFile.md index a8bdc698..0c9bed76 100644 --- a/docs/API_docs/methods/messages_uploadEncryptedFile.md +++ b/docs/API_docs/methods/messages_uploadEncryptedFile.md @@ -1,17 +1,19 @@ --- title: messages.uploadEncryptedFile -description: messages.uploadEncryptedFile parameters, return type and example +description: Upload a secret chat file without sending it to anyone --- ## Method: messages.uploadEncryptedFile [Back to methods index](index.md) +Upload a secret chat file without sending it to anyone + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|Ignore this| +|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional|The file| ### Return type: [EncryptedFile](../types/EncryptedFile.md) diff --git a/docs/API_docs/methods/messages_uploadMedia.md b/docs/API_docs/methods/messages_uploadMedia.md index 5c25333d..c982a860 100644 --- a/docs/API_docs/methods/messages_uploadMedia.md +++ b/docs/API_docs/methods/messages_uploadMedia.md @@ -1,17 +1,19 @@ --- title: messages.uploadMedia -description: messages.uploadMedia parameters, return type and example +description: Upload a file without sending it to anyone --- ## Method: messages.uploadMedia [Back to methods index](index.md) +Upload a file without sending it to anyone + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Nothing| +|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media to upload| ### Return type: [MessageMedia](../types/MessageMedia.md) diff --git a/docs/API_docs/methods/payments_clearSavedInfo.md b/docs/API_docs/methods/payments_clearSavedInfo.md index 53fab36f..44050dde 100644 --- a/docs/API_docs/methods/payments_clearSavedInfo.md +++ b/docs/API_docs/methods/payments_clearSavedInfo.md @@ -1,17 +1,19 @@ --- title: payments.clearSavedInfo -description: payments.clearSavedInfo parameters, return type and example +description: Clear saved payments info --- ## Method: payments.clearSavedInfo [Back to methods index](index.md) +Clear saved payments info + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|credentials|[CLICK ME Bool](../types/Bool.md) | Optional| -|info|[CLICK ME Bool](../types/Bool.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|credentials|[CLICK ME Bool](../types/Bool.md) | Optional|Clear credentials?| +|info|[CLICK ME Bool](../types/Bool.md) | Optional|Clear payment info?| ### Return type: [Bool](../types/Bool.md) diff --git a/docs/API_docs/methods/payments_getPaymentForm.md b/docs/API_docs/methods/payments_getPaymentForm.md index 00b4bddc..16a32d11 100644 --- a/docs/API_docs/methods/payments_getPaymentForm.md +++ b/docs/API_docs/methods/payments_getPaymentForm.md @@ -1,16 +1,18 @@ --- title: payments.getPaymentForm -description: payments.getPaymentForm parameters, return type and example +description: Get payment form --- ## Method: payments.getPaymentForm [Back to methods index](index.md) +Get payment form + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|msg\_id|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|msg\_id|[CLICK ME int](../types/int.md) | Yes|Message ID| ### Return type: [payments\_PaymentForm](../types/payments_PaymentForm.md) diff --git a/docs/API_docs/methods/payments_getPaymentReceipt.md b/docs/API_docs/methods/payments_getPaymentReceipt.md index 40b73a4b..857585f6 100644 --- a/docs/API_docs/methods/payments_getPaymentReceipt.md +++ b/docs/API_docs/methods/payments_getPaymentReceipt.md @@ -1,16 +1,18 @@ --- title: payments.getPaymentReceipt -description: payments.getPaymentReceipt parameters, return type and example +description: Get payment receipt --- ## Method: payments.getPaymentReceipt [Back to methods index](index.md) +Get payment receipt + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|msg\_id|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|msg\_id|[CLICK ME int](../types/int.md) | Yes|The message ID| ### Return type: [payments\_PaymentReceipt](../types/payments_PaymentReceipt.md) diff --git a/docs/API_docs/methods/payments_getSavedInfo.md b/docs/API_docs/methods/payments_getSavedInfo.md index ccaaff75..04ac7374 100644 --- a/docs/API_docs/methods/payments_getSavedInfo.md +++ b/docs/API_docs/methods/payments_getSavedInfo.md @@ -1,11 +1,13 @@ --- title: payments.getSavedInfo -description: payments.getSavedInfo parameters, return type and example +description: Get saved payments info --- ## Method: payments.getSavedInfo [Back to methods index](index.md) +Get saved payments info + ### Return type: [payments\_SavedInfo](../types/payments_SavedInfo.md) diff --git a/docs/API_docs/methods/payments_sendPaymentForm.md b/docs/API_docs/methods/payments_sendPaymentForm.md index eb843715..0a9df99f 100644 --- a/docs/API_docs/methods/payments_sendPaymentForm.md +++ b/docs/API_docs/methods/payments_sendPaymentForm.md @@ -1,19 +1,21 @@ --- title: payments.sendPaymentForm -description: payments.sendPaymentForm parameters, return type and example +description: Bots only: send payment form --- ## Method: payments.sendPaymentForm [Back to methods index](index.md) +Bots only: send payment form + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|msg\_id|[CLICK ME int](../types/int.md) | Yes| -|requested\_info\_id|[CLICK ME string](../types/string.md) | Optional| -|shipping\_option\_id|[CLICK ME string](../types/string.md) | Optional| -|credentials|[CLICK ME InputPaymentCredentials](../types/InputPaymentCredentials.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|msg\_id|[CLICK ME int](../types/int.md) | Yes|Message ID| +|requested\_info\_id|[CLICK ME string](../types/string.md) | Optional|ID of requested info| +|shipping\_option\_id|[CLICK ME string](../types/string.md) | Optional|Shipping option ID| +|credentials|[CLICK ME InputPaymentCredentials](../types/InputPaymentCredentials.md) | Yes|Payment credentials| ### Return type: [payments\_PaymentResult](../types/payments_PaymentResult.md) diff --git a/docs/API_docs/methods/payments_validateRequestedInfo.md b/docs/API_docs/methods/payments_validateRequestedInfo.md index 32702965..e36f0e42 100644 --- a/docs/API_docs/methods/payments_validateRequestedInfo.md +++ b/docs/API_docs/methods/payments_validateRequestedInfo.md @@ -1,18 +1,20 @@ --- title: payments.validateRequestedInfo -description: payments.validateRequestedInfo parameters, return type and example +description: Validate requested payment info --- ## Method: payments.validateRequestedInfo [Back to methods index](index.md) +Validate requested payment info + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|save|[CLICK ME Bool](../types/Bool.md) | Optional| -|msg\_id|[CLICK ME int](../types/int.md) | Yes| -|info|[CLICK ME PaymentRequestedInfo](../types/PaymentRequestedInfo.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|save|[CLICK ME Bool](../types/Bool.md) | Optional|Save payment info?| +|msg\_id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|info|[CLICK ME PaymentRequestedInfo](../types/PaymentRequestedInfo.md) | Yes|The requested payment info| ### Return type: [payments\_ValidatedRequestedInfo](../types/payments_ValidatedRequestedInfo.md) diff --git a/docs/API_docs/methods/photos_deletePhotos.md b/docs/API_docs/methods/photos_deletePhotos.md index 104459b7..b9daca10 100644 --- a/docs/API_docs/methods/photos_deletePhotos.md +++ b/docs/API_docs/methods/photos_deletePhotos.md @@ -1,16 +1,18 @@ --- title: photos.deletePhotos -description: photos.deletePhotos parameters, return type and example +description: Delete profile photos --- ## Method: photos.deletePhotos [Back to methods index](index.md) +Delete profile photos + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Yes|The profile photos to delete| ### Return type: [Vector\_of\_long](../types/long.md) diff --git a/docs/API_docs/methods/photos_getUserPhotos.md b/docs/API_docs/methods/photos_getUserPhotos.md index 1a7515ba..ea27a44f 100644 --- a/docs/API_docs/methods/photos_getUserPhotos.md +++ b/docs/API_docs/methods/photos_getUserPhotos.md @@ -1,19 +1,21 @@ --- title: photos.getUserPhotos -description: photos.getUserPhotos parameters, return type and example +description: Get the profile photos of a user --- ## Method: photos.getUserPhotos [Back to methods index](index.md) +Get the profile photos of a user + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|offset|[CLICK ME int](../types/int.md) | Yes| -|max\_id|[CLICK ME long](../types/long.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| +|offset|[CLICK ME int](../types/int.md) | Yes|Offset| +|max\_id|[CLICK ME long](../types/long.md) | Yes|Maximum ID of photo to return| +|limit|[CLICK ME int](../types/int.md) | Yes|Number of photos to return| ### Return type: [photos\_Photos](../types/photos_Photos.md) diff --git a/docs/API_docs/methods/photos_updateProfilePhoto.md b/docs/API_docs/methods/photos_updateProfilePhoto.md index 28ab5fbf..7f0a4c69 100644 --- a/docs/API_docs/methods/photos_updateProfilePhoto.md +++ b/docs/API_docs/methods/photos_updateProfilePhoto.md @@ -1,16 +1,18 @@ --- title: photos.updateProfilePhoto -description: photos.updateProfilePhoto parameters, return type and example +description: Update the profile photo (use photos->uploadProfilePhoto to upload the photo) --- ## Method: photos.updateProfilePhoto [Back to methods index](index.md) +Update the profile photo (use photos->uploadProfilePhoto to upload the photo) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional|The photo to use| ### Return type: [UserProfilePhoto](../types/UserProfilePhoto.md) diff --git a/docs/API_docs/methods/photos_uploadProfilePhoto.md b/docs/API_docs/methods/photos_uploadProfilePhoto.md index 7cc9e9e5..efa08bb0 100644 --- a/docs/API_docs/methods/photos_uploadProfilePhoto.md +++ b/docs/API_docs/methods/photos_uploadProfilePhoto.md @@ -1,16 +1,18 @@ --- title: photos.uploadProfilePhoto -description: photos.uploadProfilePhoto parameters, return type and example +description: Upload profile photo --- ## Method: photos.uploadProfilePhoto [Back to methods index](index.md) +Upload profile photo + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|file|[File path or InputFile](../types/InputFile.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|file|[File path or InputFile](../types/InputFile.md) | Yes|The photo| ### Return type: [photos\_Photo](../types/photos_Photo.md) diff --git a/docs/API_docs/methods/stickers_addStickerToSet.md b/docs/API_docs/methods/stickers_addStickerToSet.md index 82a9dbd7..1f90028c 100644 --- a/docs/API_docs/methods/stickers_addStickerToSet.md +++ b/docs/API_docs/methods/stickers_addStickerToSet.md @@ -1,17 +1,19 @@ --- title: stickers.addStickerToSet -description: stickers.addStickerToSet parameters, return type and example +description: Add sticker to stickerset --- ## Method: stickers.addStickerToSet [Back to methods index](index.md) +Add sticker to stickerset + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional| -|sticker|[CLICK ME InputStickerSetItem](../types/InputStickerSetItem.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset| +|sticker|[CLICK ME InputStickerSetItem](../types/InputStickerSetItem.md) | Yes|The sticker| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/docs/API_docs/methods/stickers_changeStickerPosition.md b/docs/API_docs/methods/stickers_changeStickerPosition.md index a1a663f7..45552df9 100644 --- a/docs/API_docs/methods/stickers_changeStickerPosition.md +++ b/docs/API_docs/methods/stickers_changeStickerPosition.md @@ -1,17 +1,19 @@ --- title: stickers.changeStickerPosition -description: stickers.changeStickerPosition parameters, return type and example +description: Change sticker position in photo --- ## Method: stickers.changeStickerPosition [Back to methods index](index.md) +Change sticker position in photo + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|sticker|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional| -|position|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|sticker|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker| +|position|[CLICK ME int](../types/int.md) | Yes|New position| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/docs/API_docs/methods/stickers_createStickerSet.md b/docs/API_docs/methods/stickers_createStickerSet.md index b99874a0..c4e85852 100644 --- a/docs/API_docs/methods/stickers_createStickerSet.md +++ b/docs/API_docs/methods/stickers_createStickerSet.md @@ -1,20 +1,22 @@ --- title: stickers.createStickerSet -description: stickers.createStickerSet parameters, return type and example +description: Create stickerset --- ## Method: stickers.createStickerSet [Back to methods index](index.md) +Create stickerset + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|masks|[CLICK ME Bool](../types/Bool.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|title|[CLICK ME string](../types/string.md) | Yes| -|short\_name|[CLICK ME string](../types/string.md) | Yes| -|stickers|Array of [CLICK ME InputStickerSetItem](../types/InputStickerSetItem.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|masks|[CLICK ME Bool](../types/Bool.md) | Optional|Masks?| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user ID associated to this stickerset| +|title|[CLICK ME string](../types/string.md) | Yes|The stickerset title| +|short\_name|[CLICK ME string](../types/string.md) | Yes|The stickerset short name| +|stickers|Array of [CLICK ME InputStickerSetItem](../types/InputStickerSetItem.md) | Yes|The stickers to add| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/docs/API_docs/methods/stickers_removeStickerFromSet.md b/docs/API_docs/methods/stickers_removeStickerFromSet.md index 34f85cb0..4ae30345 100644 --- a/docs/API_docs/methods/stickers_removeStickerFromSet.md +++ b/docs/API_docs/methods/stickers_removeStickerFromSet.md @@ -1,16 +1,18 @@ --- title: stickers.removeStickerFromSet -description: stickers.removeStickerFromSet parameters, return type and example +description: Remove sticker from stickerset --- ## Method: stickers.removeStickerFromSet [Back to methods index](index.md) +Remove sticker from stickerset + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|sticker|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|sticker|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker to remove| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/docs/API_docs/methods/upload_getWebFile.md b/docs/API_docs/methods/upload_getWebFile.md index 30bd3a1f..e864e4b7 100644 --- a/docs/API_docs/methods/upload_getWebFile.md +++ b/docs/API_docs/methods/upload_getWebFile.md @@ -1,18 +1,20 @@ --- title: upload.getWebFile -description: upload.getWebFile parameters, return type and example +description: Download a file through telegram --- ## Method: upload.getWebFile [Back to methods index](index.md) +Download a file through telegram + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|location|[CLICK ME InputWebFileLocation](../types/InputWebFileLocation.md) | Yes| -|offset|[CLICK ME int](../types/int.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|location|[CLICK ME InputWebFileLocation](../types/InputWebFileLocation.md) | Yes|The file| +|offset|[CLICK ME int](../types/int.md) | Yes|The offset in bytes| +|limit|[CLICK ME int](../types/int.md) | Yes|The number of bytes to fetch| ### Return type: [upload\_WebFile](../types/upload_WebFile.md) diff --git a/docs/MTProto_docs/methods/http_wait.md b/docs/MTProto_docs/methods/http_wait.md index b5dd94b0..059e8df9 100644 --- a/docs/MTProto_docs/methods/http_wait.md +++ b/docs/MTProto_docs/methods/http_wait.md @@ -13,7 +13,7 @@ Makes the server send messages waiting in the buffer | Name | Type | Required | Description | |----------|---------------|----------|-------------| |max\_delay|[CLICK ME int](../types/int.md) | Yes|Denotes the maximum number of milliseconds that has elapsed between the first message for this session and the transmission of an HTTP response| -|wait\_after|[CLICK ME int](../types/int.md) | Yes|after the receipt of the latest message for a particular session, the server waits another wait_after milliseconds in case there are more messages. If there are no additional messages, the result is transmitted (a container with all the messages).| +|wait\_after|[CLICK ME int](../types/int.md) | Yes|after the receipt of the latest message for a particular session, the server waits anoTher wait_after milliseconds in case There are more messages. If There are no additional messages, the result is transmitted (a container with all the messages).| |max\_wait|[CLICK ME int](../types/int.md) | Yes|If more messages appear, the wait_after timer is reset.| diff --git a/old_docs/API_docs_v18/methods/account_registerDevice.md b/old_docs/API_docs_v18/methods/account_registerDevice.md index 1752afde..0a40f49c 100644 --- a/old_docs/API_docs_v18/methods/account_registerDevice.md +++ b/old_docs/API_docs_v18/methods/account_registerDevice.md @@ -12,8 +12,8 @@ Register device for push notifications | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and oTher, see source code of official apps for more info| +|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and oTher, see source code of official apps for more info| |device\_model|[CLICK ME string](../types/string.md) | Yes|| |system\_version|[CLICK ME string](../types/string.md) | Yes|| |app\_version|[CLICK ME string](../types/string.md) | Yes|| diff --git a/old_docs/API_docs_v18/methods/account_unregisterDevice.md b/old_docs/API_docs_v18/methods/account_unregisterDevice.md index 1d2b7670..32e44495 100644 --- a/old_docs/API_docs_v18/methods/account_unregisterDevice.md +++ b/old_docs/API_docs_v18/methods/account_unregisterDevice.md @@ -12,8 +12,8 @@ Stop sending PUSH notifications to app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and oTher, see source code of official apps for more info| +|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and oTher, see source code of official apps for more info| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v18/methods/contacts_getBlocked.md b/old_docs/API_docs_v18/methods/contacts_getBlocked.md index d7d8c5cc..300025af 100644 --- a/old_docs/API_docs_v18/methods/contacts_getBlocked.md +++ b/old_docs/API_docs_v18/methods/contacts_getBlocked.md @@ -12,7 +12,7 @@ Get blocked users | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, then set to the number of blocked contacts previously fetched| +|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, Then set to the number of blocked contacts previously fetched| |limit|[CLICK ME int](../types/int.md) | Yes|How many blocked contacts to fetch| diff --git a/old_docs/API_docs_v18/methods/help_getAppUpdate.md b/old_docs/API_docs_v18/methods/help_getAppUpdate.md index d13d6263..f3eacbd6 100644 --- a/old_docs/API_docs_v18/methods/help_getAppUpdate.md +++ b/old_docs/API_docs_v18/methods/help_getAppUpdate.md @@ -1,19 +1,21 @@ --- title: help.getAppUpdate -description: help.getAppUpdate parameters, return type and example +description: Get info about app updates --- ## Method: help.getAppUpdate [Back to methods index](index.md) +Get info about app updates + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|device\_model|[CLICK ME string](../types/string.md) | Yes| -|system\_version|[CLICK ME string](../types/string.md) | Yes| -|app\_version|[CLICK ME string](../types/string.md) | Yes| -|lang\_code|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|device\_model|[CLICK ME string](../types/string.md) | Yes|| +|system\_version|[CLICK ME string](../types/string.md) | Yes|| +|app\_version|[CLICK ME string](../types/string.md) | Yes|| +|lang\_code|[CLICK ME string](../types/string.md) | Yes|| ### Return type: [help\_AppUpdate](../types/help_AppUpdate.md) diff --git a/old_docs/API_docs_v18/methods/help_getConfig.md b/old_docs/API_docs_v18/methods/help_getConfig.md index 885ad5d3..16e25c68 100644 --- a/old_docs/API_docs_v18/methods/help_getConfig.md +++ b/old_docs/API_docs_v18/methods/help_getConfig.md @@ -1,11 +1,13 @@ --- title: help.getConfig -description: help.getConfig parameters, return type and example +description: Get server configuration --- ## Method: help.getConfig [Back to methods index](index.md) +Get server configuration + ### Return type: [Config](../types/Config.md) diff --git a/old_docs/API_docs_v18/methods/help_getInviteText.md b/old_docs/API_docs_v18/methods/help_getInviteText.md index aeebae28..d9ae8e0d 100644 --- a/old_docs/API_docs_v18/methods/help_getInviteText.md +++ b/old_docs/API_docs_v18/methods/help_getInviteText.md @@ -1,16 +1,18 @@ --- title: help.getInviteText -description: help.getInviteText parameters, return type and example +description: Get invitation text --- ## Method: help.getInviteText [Back to methods index](index.md) +Get invitation text + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|lang\_code|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|lang\_code|[CLICK ME string](../types/string.md) | Yes|| ### Return type: [help\_InviteText](../types/help_InviteText.md) diff --git a/old_docs/API_docs_v18/methods/help_getNearestDc.md b/old_docs/API_docs_v18/methods/help_getNearestDc.md index 6196890b..35a8bf91 100644 --- a/old_docs/API_docs_v18/methods/help_getNearestDc.md +++ b/old_docs/API_docs_v18/methods/help_getNearestDc.md @@ -1,11 +1,13 @@ --- title: help.getNearestDc -description: help.getNearestDc parameters, return type and example +description: Get nearest datacenter --- ## Method: help.getNearestDc [Back to methods index](index.md) +Get nearest datacenter + ### Return type: [NearestDc](../types/NearestDc.md) diff --git a/old_docs/API_docs_v18/methods/help_getSupport.md b/old_docs/API_docs_v18/methods/help_getSupport.md index 9b269f78..a5bab0f2 100644 --- a/old_docs/API_docs_v18/methods/help_getSupport.md +++ b/old_docs/API_docs_v18/methods/help_getSupport.md @@ -1,11 +1,13 @@ --- title: help.getSupport -description: help.getSupport parameters, return type and example +description: Get info of support user --- ## Method: help.getSupport [Back to methods index](index.md) +Get info of support user + ### Return type: [help\_Support](../types/help_Support.md) diff --git a/old_docs/API_docs_v18/methods/help_saveAppLog.md b/old_docs/API_docs_v18/methods/help_saveAppLog.md index af6e94e2..0165b6e3 100644 --- a/old_docs/API_docs_v18/methods/help_saveAppLog.md +++ b/old_docs/API_docs_v18/methods/help_saveAppLog.md @@ -1,16 +1,18 @@ --- title: help.saveAppLog -description: help.saveAppLog parameters, return type and example +description: Log data for developer of this app --- ## Method: help.saveAppLog [Back to methods index](index.md) +Log data for developer of this app + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|events|Array of [CLICK ME InputAppEvent](../types/InputAppEvent.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|events|Array of [CLICK ME InputAppEvent](../types/InputAppEvent.md) | Yes|Event list| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v18/methods/messages_deleteChatUser.md b/old_docs/API_docs_v18/methods/messages_deleteChatUser.md index d5f7f835..163a9250 100644 --- a/old_docs/API_docs_v18/methods/messages_deleteChatUser.md +++ b/old_docs/API_docs_v18/methods/messages_deleteChatUser.md @@ -12,7 +12,7 @@ Delete a user from a chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The MTProto ID of the chat| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to delete (pass @me to leave the chat)| diff --git a/old_docs/API_docs_v18/methods/messages_editChatPhoto.md b/old_docs/API_docs_v18/methods/messages_editChatPhoto.md index 4e5907aa..4decf9cd 100644 --- a/old_docs/API_docs_v18/methods/messages_editChatPhoto.md +++ b/old_docs/API_docs_v18/methods/messages_editChatPhoto.md @@ -12,7 +12,7 @@ Edit the photo of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The MTProto ID of the chat| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| |photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| diff --git a/old_docs/API_docs_v18/methods/messages_editChatTitle.md b/old_docs/API_docs_v18/methods/messages_editChatTitle.md index 5cfbea8b..cff2e5e6 100644 --- a/old_docs/API_docs_v18/methods/messages_editChatTitle.md +++ b/old_docs/API_docs_v18/methods/messages_editChatTitle.md @@ -12,7 +12,7 @@ Edit the title of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The MTProto ID of the chat| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| |title|[CLICK ME string](../types/string.md) | Yes|The new title| diff --git a/old_docs/API_docs_v18/methods/messages_readEncryptedHistory.md b/old_docs/API_docs_v18/methods/messages_readEncryptedHistory.md index 4d341809..39b110e3 100644 --- a/old_docs/API_docs_v18/methods/messages_readEncryptedHistory.md +++ b/old_docs/API_docs_v18/methods/messages_readEncryptedHistory.md @@ -1,17 +1,19 @@ --- title: messages.readEncryptedHistory -description: messages.readEncryptedHistory parameters, return type and example +description: Mark messages as read in secret chats --- ## Method: messages.readEncryptedHistory [Back to methods index](index.md) +Mark messages as read in secret chats + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|max\_date|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to mark messages as read| +|max\_date|[CLICK ME int](../types/int.md) | Yes|Maximum date of messages to mark| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v18/methods/messages_readMessageContents.md b/old_docs/API_docs_v18/methods/messages_readMessageContents.md index 3b22c4e0..286ec24a 100644 --- a/old_docs/API_docs_v18/methods/messages_readMessageContents.md +++ b/old_docs/API_docs_v18/methods/messages_readMessageContents.md @@ -1,16 +1,18 @@ --- title: messages.readMessageContents -description: messages.readMessageContents parameters, return type and example +description: Mark message as read --- ## Method: messages.readMessageContents [Back to methods index](index.md) +Mark message as read + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| ### Return type: [Vector\_of\_int](../types/int.md) diff --git a/old_docs/API_docs_v18/methods/messages_receivedQueue.md b/old_docs/API_docs_v18/methods/messages_receivedQueue.md index c91caa37..4ad78ba2 100644 --- a/old_docs/API_docs_v18/methods/messages_receivedQueue.md +++ b/old_docs/API_docs_v18/methods/messages_receivedQueue.md @@ -1,77 +1,13 @@ --- title: messages.receivedQueue -description: messages.receivedQueue parameters, return type and example +description: You cannot use this method directly --- ## Method: messages.receivedQueue [Back to methods index](index.md) -### Parameters: - -| Name | Type | Required | -|----------|---------------|----------| -|max\_qts|[CLICK ME int](../types/int.md) | Yes| - - -### 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| - - -### MadelineProto Example: - - -``` -if (!file_exists('madeline.php')) { - copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); -} -include 'madeline.php'; - -// !!! This API id/API hash combination will not work !!! -// !!! You must get your own @ my.telegram.org !!! -$api_id = 0; -$api_hash = ''; - -$MadelineProto = new \danog\MadelineProto\API('session.madeline', ['app_info' => ['api_id' => $api_id, 'api_hash' => $api_hash]]); -$MadelineProto->start(); - -$Vector_of_long = $MadelineProto->messages->receivedQueue(['max_qts' => int, ]); -``` - -### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): - -### As a bot: - -POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` - -Parameters: - -* method - messages.receivedQueue -* params - `{"max_qts": int, }` - - - -### As a user: - -POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.receivedQueue` - -Parameters: - -max_qts - Json encoded int +**You cannot use this method directly** -Or, if you're into Lua: - -``` -Vector_of_long = messages.receivedQueue({max_qts=int, }) -``` - diff --git a/old_docs/API_docs_v18/methods/messages_sendEncrypted.md b/old_docs/API_docs_v18/methods/messages_sendEncrypted.md index 23461760..d48f88d7 100644 --- a/old_docs/API_docs_v18/methods/messages_sendEncrypted.md +++ b/old_docs/API_docs_v18/methods/messages_sendEncrypted.md @@ -1,17 +1,19 @@ --- title: messages.sendEncrypted -description: messages.sendEncrypted parameters, return type and example +description: Send message to secret chat --- ## Method: messages.sendEncrypted [Back to methods index](index.md) +Send message to secret chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the message| +|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v18/methods/messages_sendEncryptedFile.md b/old_docs/API_docs_v18/methods/messages_sendEncryptedFile.md index 64919abe..4fd0648e 100644 --- a/old_docs/API_docs_v18/methods/messages_sendEncryptedFile.md +++ b/old_docs/API_docs_v18/methods/messages_sendEncryptedFile.md @@ -1,18 +1,20 @@ --- title: messages.sendEncryptedFile -description: messages.sendEncryptedFile parameters, return type and example +description: Send a file to a secret chat --- ## Method: messages.sendEncryptedFile [Back to methods index](index.md) +Send a file to a secret chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes| -|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the file| +|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| +|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional|The file (optional)| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v18/methods/messages_sendEncryptedService.md b/old_docs/API_docs_v18/methods/messages_sendEncryptedService.md index 0a0eea8a..d66894bf 100644 --- a/old_docs/API_docs_v18/methods/messages_sendEncryptedService.md +++ b/old_docs/API_docs_v18/methods/messages_sendEncryptedService.md @@ -1,17 +1,19 @@ --- title: messages.sendEncryptedService -description: messages.sendEncryptedService parameters, return type and example +description: Send a service message to a secret chat --- ## Method: messages.sendEncryptedService [Back to methods index](index.md) +Send a service message to a secret chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the service message| +|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v18/methods/messages_setEncryptedTyping.md b/old_docs/API_docs_v18/methods/messages_setEncryptedTyping.md index 3183fedf..e9afe99c 100644 --- a/old_docs/API_docs_v18/methods/messages_setEncryptedTyping.md +++ b/old_docs/API_docs_v18/methods/messages_setEncryptedTyping.md @@ -12,8 +12,8 @@ Send typing notification to secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|| -|typing|[CLICK ME Bool](../types/Bool.md) | Yes|| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to send the notification| +|typing|[CLICK ME Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v18/methods/photos_deletePhotos.md b/old_docs/API_docs_v18/methods/photos_deletePhotos.md index 104459b7..b9daca10 100644 --- a/old_docs/API_docs_v18/methods/photos_deletePhotos.md +++ b/old_docs/API_docs_v18/methods/photos_deletePhotos.md @@ -1,16 +1,18 @@ --- title: photos.deletePhotos -description: photos.deletePhotos parameters, return type and example +description: Delete profile photos --- ## Method: photos.deletePhotos [Back to methods index](index.md) +Delete profile photos + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Yes|The profile photos to delete| ### Return type: [Vector\_of\_long](../types/long.md) diff --git a/old_docs/API_docs_v18/methods/photos_getUserPhotos.md b/old_docs/API_docs_v18/methods/photos_getUserPhotos.md index 4b0db928..a5adfd7a 100644 --- a/old_docs/API_docs_v18/methods/photos_getUserPhotos.md +++ b/old_docs/API_docs_v18/methods/photos_getUserPhotos.md @@ -1,19 +1,21 @@ --- title: photos.getUserPhotos -description: photos.getUserPhotos parameters, return type and example +description: Get the profile photos of a user --- ## Method: photos.getUserPhotos [Back to methods index](index.md) +Get the profile photos of a user + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|offset|[CLICK ME int](../types/int.md) | Yes| -|max\_id|[CLICK ME int](../types/int.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| +|offset|[CLICK ME int](../types/int.md) | Yes|Offset| +|max\_id|[CLICK ME int](../types/int.md) | Yes|| +|limit|[CLICK ME int](../types/int.md) | Yes|Number of photos to return| ### Return type: [photos\_Photos](../types/photos_Photos.md) diff --git a/old_docs/API_docs_v18/methods/photos_updateProfilePhoto.md b/old_docs/API_docs_v18/methods/photos_updateProfilePhoto.md index 386970d5..dc6edd6b 100644 --- a/old_docs/API_docs_v18/methods/photos_updateProfilePhoto.md +++ b/old_docs/API_docs_v18/methods/photos_updateProfilePhoto.md @@ -1,17 +1,19 @@ --- title: photos.updateProfilePhoto -description: photos.updateProfilePhoto parameters, return type and example +description: Update the profile photo (use photos->uploadProfilePhoto to upload the photo) --- ## Method: photos.updateProfilePhoto [Back to methods index](index.md) +Update the profile photo (use photos->uploadProfilePhoto to upload the photo) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional| -|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional|The photo to use| +|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|| ### Return type: [UserProfilePhoto](../types/UserProfilePhoto.md) diff --git a/old_docs/API_docs_v18/methods/photos_uploadProfilePhoto.md b/old_docs/API_docs_v18/methods/photos_uploadProfilePhoto.md index 07b9936c..fb0bc534 100644 --- a/old_docs/API_docs_v18/methods/photos_uploadProfilePhoto.md +++ b/old_docs/API_docs_v18/methods/photos_uploadProfilePhoto.md @@ -1,19 +1,21 @@ --- title: photos.uploadProfilePhoto -description: photos.uploadProfilePhoto parameters, return type and example +description: Upload profile photo --- ## Method: photos.uploadProfilePhoto [Back to methods index](index.md) +Upload profile photo + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|file|[File path or InputFile](../types/InputFile.md) | Yes| -|caption|[CLICK ME string](../types/string.md) | Yes| -|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional| -|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|file|[File path or InputFile](../types/InputFile.md) | Yes|The photo| +|caption|[CLICK ME string](../types/string.md) | Yes|| +|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional|| +|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|| ### Return type: [photos\_Photo](../types/photos_Photo.md) diff --git a/old_docs/API_docs_v23/methods/account_registerDevice.md b/old_docs/API_docs_v23/methods/account_registerDevice.md index 1752afde..0a40f49c 100644 --- a/old_docs/API_docs_v23/methods/account_registerDevice.md +++ b/old_docs/API_docs_v23/methods/account_registerDevice.md @@ -12,8 +12,8 @@ Register device for push notifications | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and oTher, see source code of official apps for more info| +|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and oTher, see source code of official apps for more info| |device\_model|[CLICK ME string](../types/string.md) | Yes|| |system\_version|[CLICK ME string](../types/string.md) | Yes|| |app\_version|[CLICK ME string](../types/string.md) | Yes|| diff --git a/old_docs/API_docs_v23/methods/account_unregisterDevice.md b/old_docs/API_docs_v23/methods/account_unregisterDevice.md index 1d2b7670..32e44495 100644 --- a/old_docs/API_docs_v23/methods/account_unregisterDevice.md +++ b/old_docs/API_docs_v23/methods/account_unregisterDevice.md @@ -12,8 +12,8 @@ Stop sending PUSH notifications to app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and oTher, see source code of official apps for more info| +|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and oTher, see source code of official apps for more info| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v23/methods/contacts_getBlocked.md b/old_docs/API_docs_v23/methods/contacts_getBlocked.md index d7d8c5cc..300025af 100644 --- a/old_docs/API_docs_v23/methods/contacts_getBlocked.md +++ b/old_docs/API_docs_v23/methods/contacts_getBlocked.md @@ -12,7 +12,7 @@ Get blocked users | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, then set to the number of blocked contacts previously fetched| +|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, Then set to the number of blocked contacts previously fetched| |limit|[CLICK ME int](../types/int.md) | Yes|How many blocked contacts to fetch| diff --git a/old_docs/API_docs_v23/methods/help_getAppUpdate.md b/old_docs/API_docs_v23/methods/help_getAppUpdate.md index d13d6263..f3eacbd6 100644 --- a/old_docs/API_docs_v23/methods/help_getAppUpdate.md +++ b/old_docs/API_docs_v23/methods/help_getAppUpdate.md @@ -1,19 +1,21 @@ --- title: help.getAppUpdate -description: help.getAppUpdate parameters, return type and example +description: Get info about app updates --- ## Method: help.getAppUpdate [Back to methods index](index.md) +Get info about app updates + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|device\_model|[CLICK ME string](../types/string.md) | Yes| -|system\_version|[CLICK ME string](../types/string.md) | Yes| -|app\_version|[CLICK ME string](../types/string.md) | Yes| -|lang\_code|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|device\_model|[CLICK ME string](../types/string.md) | Yes|| +|system\_version|[CLICK ME string](../types/string.md) | Yes|| +|app\_version|[CLICK ME string](../types/string.md) | Yes|| +|lang\_code|[CLICK ME string](../types/string.md) | Yes|| ### Return type: [help\_AppUpdate](../types/help_AppUpdate.md) diff --git a/old_docs/API_docs_v23/methods/help_getConfig.md b/old_docs/API_docs_v23/methods/help_getConfig.md index 885ad5d3..16e25c68 100644 --- a/old_docs/API_docs_v23/methods/help_getConfig.md +++ b/old_docs/API_docs_v23/methods/help_getConfig.md @@ -1,11 +1,13 @@ --- title: help.getConfig -description: help.getConfig parameters, return type and example +description: Get server configuration --- ## Method: help.getConfig [Back to methods index](index.md) +Get server configuration + ### Return type: [Config](../types/Config.md) diff --git a/old_docs/API_docs_v23/methods/help_getInviteText.md b/old_docs/API_docs_v23/methods/help_getInviteText.md index aeebae28..d9ae8e0d 100644 --- a/old_docs/API_docs_v23/methods/help_getInviteText.md +++ b/old_docs/API_docs_v23/methods/help_getInviteText.md @@ -1,16 +1,18 @@ --- title: help.getInviteText -description: help.getInviteText parameters, return type and example +description: Get invitation text --- ## Method: help.getInviteText [Back to methods index](index.md) +Get invitation text + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|lang\_code|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|lang\_code|[CLICK ME string](../types/string.md) | Yes|| ### Return type: [help\_InviteText](../types/help_InviteText.md) diff --git a/old_docs/API_docs_v23/methods/help_getNearestDc.md b/old_docs/API_docs_v23/methods/help_getNearestDc.md index 6196890b..35a8bf91 100644 --- a/old_docs/API_docs_v23/methods/help_getNearestDc.md +++ b/old_docs/API_docs_v23/methods/help_getNearestDc.md @@ -1,11 +1,13 @@ --- title: help.getNearestDc -description: help.getNearestDc parameters, return type and example +description: Get nearest datacenter --- ## Method: help.getNearestDc [Back to methods index](index.md) +Get nearest datacenter + ### Return type: [NearestDc](../types/NearestDc.md) diff --git a/old_docs/API_docs_v23/methods/help_getSupport.md b/old_docs/API_docs_v23/methods/help_getSupport.md index 9b269f78..a5bab0f2 100644 --- a/old_docs/API_docs_v23/methods/help_getSupport.md +++ b/old_docs/API_docs_v23/methods/help_getSupport.md @@ -1,11 +1,13 @@ --- title: help.getSupport -description: help.getSupport parameters, return type and example +description: Get info of support user --- ## Method: help.getSupport [Back to methods index](index.md) +Get info of support user + ### Return type: [help\_Support](../types/help_Support.md) diff --git a/old_docs/API_docs_v23/methods/help_saveAppLog.md b/old_docs/API_docs_v23/methods/help_saveAppLog.md index af6e94e2..0165b6e3 100644 --- a/old_docs/API_docs_v23/methods/help_saveAppLog.md +++ b/old_docs/API_docs_v23/methods/help_saveAppLog.md @@ -1,16 +1,18 @@ --- title: help.saveAppLog -description: help.saveAppLog parameters, return type and example +description: Log data for developer of this app --- ## Method: help.saveAppLog [Back to methods index](index.md) +Log data for developer of this app + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|events|Array of [CLICK ME InputAppEvent](../types/InputAppEvent.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|events|Array of [CLICK ME InputAppEvent](../types/InputAppEvent.md) | Yes|Event list| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v23/methods/messages_deleteChatUser.md b/old_docs/API_docs_v23/methods/messages_deleteChatUser.md index d5f7f835..163a9250 100644 --- a/old_docs/API_docs_v23/methods/messages_deleteChatUser.md +++ b/old_docs/API_docs_v23/methods/messages_deleteChatUser.md @@ -12,7 +12,7 @@ Delete a user from a chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The MTProto ID of the chat| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to delete (pass @me to leave the chat)| diff --git a/old_docs/API_docs_v23/methods/messages_editChatPhoto.md b/old_docs/API_docs_v23/methods/messages_editChatPhoto.md index 4e5907aa..4decf9cd 100644 --- a/old_docs/API_docs_v23/methods/messages_editChatPhoto.md +++ b/old_docs/API_docs_v23/methods/messages_editChatPhoto.md @@ -12,7 +12,7 @@ Edit the photo of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The MTProto ID of the chat| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| |photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| diff --git a/old_docs/API_docs_v23/methods/messages_editChatTitle.md b/old_docs/API_docs_v23/methods/messages_editChatTitle.md index 5cfbea8b..cff2e5e6 100644 --- a/old_docs/API_docs_v23/methods/messages_editChatTitle.md +++ b/old_docs/API_docs_v23/methods/messages_editChatTitle.md @@ -12,7 +12,7 @@ Edit the title of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The MTProto ID of the chat| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| |title|[CLICK ME string](../types/string.md) | Yes|The new title| diff --git a/old_docs/API_docs_v23/methods/messages_getAllStickers.md b/old_docs/API_docs_v23/methods/messages_getAllStickers.md index 5e526f92..0708e15a 100644 --- a/old_docs/API_docs_v23/methods/messages_getAllStickers.md +++ b/old_docs/API_docs_v23/methods/messages_getAllStickers.md @@ -1,16 +1,18 @@ --- title: messages.getAllStickers -description: messages.getAllStickers parameters, return type and example +description: Get all stickerpacks --- ## Method: messages.getAllStickers [Back to methods index](index.md) +Get all stickerpacks + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME string](../types/string.md) | Yes|| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v23/methods/messages_getStickers.md b/old_docs/API_docs_v23/methods/messages_getStickers.md index 178b897c..4854696d 100644 --- a/old_docs/API_docs_v23/methods/messages_getStickers.md +++ b/old_docs/API_docs_v23/methods/messages_getStickers.md @@ -1,17 +1,19 @@ --- title: messages.getStickers -description: messages.getStickers parameters, return type and example +description: Get stickers --- ## Method: messages.getStickers [Back to methods index](index.md) +Get stickers + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|emoticon|[CLICK ME string](../types/string.md) | Yes| -|hash|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|emoticon|[CLICK ME string](../types/string.md) | Yes|Search by emoji| +|hash|[CLICK ME string](../types/string.md) | Yes|0 or $MadelineProto->gen_vector_hash(previously fetched sticker IDs)| ### Return type: [messages\_Stickers](../types/messages_Stickers.md) diff --git a/old_docs/API_docs_v23/methods/messages_readEncryptedHistory.md b/old_docs/API_docs_v23/methods/messages_readEncryptedHistory.md index 4d341809..39b110e3 100644 --- a/old_docs/API_docs_v23/methods/messages_readEncryptedHistory.md +++ b/old_docs/API_docs_v23/methods/messages_readEncryptedHistory.md @@ -1,17 +1,19 @@ --- title: messages.readEncryptedHistory -description: messages.readEncryptedHistory parameters, return type and example +description: Mark messages as read in secret chats --- ## Method: messages.readEncryptedHistory [Back to methods index](index.md) +Mark messages as read in secret chats + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|max\_date|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to mark messages as read| +|max\_date|[CLICK ME int](../types/int.md) | Yes|Maximum date of messages to mark| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v23/methods/messages_readMessageContents.md b/old_docs/API_docs_v23/methods/messages_readMessageContents.md index 3b22c4e0..286ec24a 100644 --- a/old_docs/API_docs_v23/methods/messages_readMessageContents.md +++ b/old_docs/API_docs_v23/methods/messages_readMessageContents.md @@ -1,16 +1,18 @@ --- title: messages.readMessageContents -description: messages.readMessageContents parameters, return type and example +description: Mark message as read --- ## Method: messages.readMessageContents [Back to methods index](index.md) +Mark message as read + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| ### Return type: [Vector\_of\_int](../types/int.md) diff --git a/old_docs/API_docs_v23/methods/messages_receivedQueue.md b/old_docs/API_docs_v23/methods/messages_receivedQueue.md index c91caa37..4ad78ba2 100644 --- a/old_docs/API_docs_v23/methods/messages_receivedQueue.md +++ b/old_docs/API_docs_v23/methods/messages_receivedQueue.md @@ -1,77 +1,13 @@ --- title: messages.receivedQueue -description: messages.receivedQueue parameters, return type and example +description: You cannot use this method directly --- ## Method: messages.receivedQueue [Back to methods index](index.md) -### Parameters: - -| Name | Type | Required | -|----------|---------------|----------| -|max\_qts|[CLICK ME int](../types/int.md) | Yes| - - -### 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| - - -### MadelineProto Example: - - -``` -if (!file_exists('madeline.php')) { - copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); -} -include 'madeline.php'; - -// !!! This API id/API hash combination will not work !!! -// !!! You must get your own @ my.telegram.org !!! -$api_id = 0; -$api_hash = ''; - -$MadelineProto = new \danog\MadelineProto\API('session.madeline', ['app_info' => ['api_id' => $api_id, 'api_hash' => $api_hash]]); -$MadelineProto->start(); - -$Vector_of_long = $MadelineProto->messages->receivedQueue(['max_qts' => int, ]); -``` - -### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): - -### As a bot: - -POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` - -Parameters: - -* method - messages.receivedQueue -* params - `{"max_qts": int, }` - - - -### As a user: - -POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.receivedQueue` - -Parameters: - -max_qts - Json encoded int +**You cannot use this method directly** -Or, if you're into Lua: - -``` -Vector_of_long = messages.receivedQueue({max_qts=int, }) -``` - diff --git a/old_docs/API_docs_v23/methods/messages_sendEncrypted.md b/old_docs/API_docs_v23/methods/messages_sendEncrypted.md index 23461760..d48f88d7 100644 --- a/old_docs/API_docs_v23/methods/messages_sendEncrypted.md +++ b/old_docs/API_docs_v23/methods/messages_sendEncrypted.md @@ -1,17 +1,19 @@ --- title: messages.sendEncrypted -description: messages.sendEncrypted parameters, return type and example +description: Send message to secret chat --- ## Method: messages.sendEncrypted [Back to methods index](index.md) +Send message to secret chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the message| +|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v23/methods/messages_sendEncryptedFile.md b/old_docs/API_docs_v23/methods/messages_sendEncryptedFile.md index 64919abe..4fd0648e 100644 --- a/old_docs/API_docs_v23/methods/messages_sendEncryptedFile.md +++ b/old_docs/API_docs_v23/methods/messages_sendEncryptedFile.md @@ -1,18 +1,20 @@ --- title: messages.sendEncryptedFile -description: messages.sendEncryptedFile parameters, return type and example +description: Send a file to a secret chat --- ## Method: messages.sendEncryptedFile [Back to methods index](index.md) +Send a file to a secret chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes| -|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the file| +|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| +|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional|The file (optional)| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v23/methods/messages_sendEncryptedService.md b/old_docs/API_docs_v23/methods/messages_sendEncryptedService.md index 0a0eea8a..d66894bf 100644 --- a/old_docs/API_docs_v23/methods/messages_sendEncryptedService.md +++ b/old_docs/API_docs_v23/methods/messages_sendEncryptedService.md @@ -1,17 +1,19 @@ --- title: messages.sendEncryptedService -description: messages.sendEncryptedService parameters, return type and example +description: Send a service message to a secret chat --- ## Method: messages.sendEncryptedService [Back to methods index](index.md) +Send a service message to a secret chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the service message| +|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v23/methods/messages_setEncryptedTyping.md b/old_docs/API_docs_v23/methods/messages_setEncryptedTyping.md index 3183fedf..e9afe99c 100644 --- a/old_docs/API_docs_v23/methods/messages_setEncryptedTyping.md +++ b/old_docs/API_docs_v23/methods/messages_setEncryptedTyping.md @@ -12,8 +12,8 @@ Send typing notification to secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|| -|typing|[CLICK ME Bool](../types/Bool.md) | Yes|| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to send the notification| +|typing|[CLICK ME Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v23/methods/photos_deletePhotos.md b/old_docs/API_docs_v23/methods/photos_deletePhotos.md index 104459b7..b9daca10 100644 --- a/old_docs/API_docs_v23/methods/photos_deletePhotos.md +++ b/old_docs/API_docs_v23/methods/photos_deletePhotos.md @@ -1,16 +1,18 @@ --- title: photos.deletePhotos -description: photos.deletePhotos parameters, return type and example +description: Delete profile photos --- ## Method: photos.deletePhotos [Back to methods index](index.md) +Delete profile photos + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Yes|The profile photos to delete| ### Return type: [Vector\_of\_long](../types/long.md) diff --git a/old_docs/API_docs_v23/methods/photos_getUserPhotos.md b/old_docs/API_docs_v23/methods/photos_getUserPhotos.md index 4b0db928..a5adfd7a 100644 --- a/old_docs/API_docs_v23/methods/photos_getUserPhotos.md +++ b/old_docs/API_docs_v23/methods/photos_getUserPhotos.md @@ -1,19 +1,21 @@ --- title: photos.getUserPhotos -description: photos.getUserPhotos parameters, return type and example +description: Get the profile photos of a user --- ## Method: photos.getUserPhotos [Back to methods index](index.md) +Get the profile photos of a user + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|offset|[CLICK ME int](../types/int.md) | Yes| -|max\_id|[CLICK ME int](../types/int.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| +|offset|[CLICK ME int](../types/int.md) | Yes|Offset| +|max\_id|[CLICK ME int](../types/int.md) | Yes|| +|limit|[CLICK ME int](../types/int.md) | Yes|Number of photos to return| ### Return type: [photos\_Photos](../types/photos_Photos.md) diff --git a/old_docs/API_docs_v23/methods/photos_updateProfilePhoto.md b/old_docs/API_docs_v23/methods/photos_updateProfilePhoto.md index 386970d5..dc6edd6b 100644 --- a/old_docs/API_docs_v23/methods/photos_updateProfilePhoto.md +++ b/old_docs/API_docs_v23/methods/photos_updateProfilePhoto.md @@ -1,17 +1,19 @@ --- title: photos.updateProfilePhoto -description: photos.updateProfilePhoto parameters, return type and example +description: Update the profile photo (use photos->uploadProfilePhoto to upload the photo) --- ## Method: photos.updateProfilePhoto [Back to methods index](index.md) +Update the profile photo (use photos->uploadProfilePhoto to upload the photo) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional| -|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional|The photo to use| +|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|| ### Return type: [UserProfilePhoto](../types/UserProfilePhoto.md) diff --git a/old_docs/API_docs_v23/methods/photos_uploadProfilePhoto.md b/old_docs/API_docs_v23/methods/photos_uploadProfilePhoto.md index 07b9936c..fb0bc534 100644 --- a/old_docs/API_docs_v23/methods/photos_uploadProfilePhoto.md +++ b/old_docs/API_docs_v23/methods/photos_uploadProfilePhoto.md @@ -1,19 +1,21 @@ --- title: photos.uploadProfilePhoto -description: photos.uploadProfilePhoto parameters, return type and example +description: Upload profile photo --- ## Method: photos.uploadProfilePhoto [Back to methods index](index.md) +Upload profile photo + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|file|[File path or InputFile](../types/InputFile.md) | Yes| -|caption|[CLICK ME string](../types/string.md) | Yes| -|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional| -|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|file|[File path or InputFile](../types/InputFile.md) | Yes|The photo| +|caption|[CLICK ME string](../types/string.md) | Yes|| +|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional|| +|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|| ### Return type: [photos\_Photo](../types/photos_Photo.md) diff --git a/old_docs/API_docs_v25/methods/account_registerDevice.md b/old_docs/API_docs_v25/methods/account_registerDevice.md index 1752afde..0a40f49c 100644 --- a/old_docs/API_docs_v25/methods/account_registerDevice.md +++ b/old_docs/API_docs_v25/methods/account_registerDevice.md @@ -12,8 +12,8 @@ Register device for push notifications | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and oTher, see source code of official apps for more info| +|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and oTher, see source code of official apps for more info| |device\_model|[CLICK ME string](../types/string.md) | Yes|| |system\_version|[CLICK ME string](../types/string.md) | Yes|| |app\_version|[CLICK ME string](../types/string.md) | Yes|| diff --git a/old_docs/API_docs_v25/methods/account_unregisterDevice.md b/old_docs/API_docs_v25/methods/account_unregisterDevice.md index 1d2b7670..32e44495 100644 --- a/old_docs/API_docs_v25/methods/account_unregisterDevice.md +++ b/old_docs/API_docs_v25/methods/account_unregisterDevice.md @@ -12,8 +12,8 @@ Stop sending PUSH notifications to app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and oTher, see source code of official apps for more info| +|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and oTher, see source code of official apps for more info| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v25/methods/contacts_getBlocked.md b/old_docs/API_docs_v25/methods/contacts_getBlocked.md index d7d8c5cc..300025af 100644 --- a/old_docs/API_docs_v25/methods/contacts_getBlocked.md +++ b/old_docs/API_docs_v25/methods/contacts_getBlocked.md @@ -12,7 +12,7 @@ Get blocked users | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, then set to the number of blocked contacts previously fetched| +|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, Then set to the number of blocked contacts previously fetched| |limit|[CLICK ME int](../types/int.md) | Yes|How many blocked contacts to fetch| diff --git a/old_docs/API_docs_v25/methods/help_getAppUpdate.md b/old_docs/API_docs_v25/methods/help_getAppUpdate.md index d13d6263..f3eacbd6 100644 --- a/old_docs/API_docs_v25/methods/help_getAppUpdate.md +++ b/old_docs/API_docs_v25/methods/help_getAppUpdate.md @@ -1,19 +1,21 @@ --- title: help.getAppUpdate -description: help.getAppUpdate parameters, return type and example +description: Get info about app updates --- ## Method: help.getAppUpdate [Back to methods index](index.md) +Get info about app updates + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|device\_model|[CLICK ME string](../types/string.md) | Yes| -|system\_version|[CLICK ME string](../types/string.md) | Yes| -|app\_version|[CLICK ME string](../types/string.md) | Yes| -|lang\_code|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|device\_model|[CLICK ME string](../types/string.md) | Yes|| +|system\_version|[CLICK ME string](../types/string.md) | Yes|| +|app\_version|[CLICK ME string](../types/string.md) | Yes|| +|lang\_code|[CLICK ME string](../types/string.md) | Yes|| ### Return type: [help\_AppUpdate](../types/help_AppUpdate.md) diff --git a/old_docs/API_docs_v25/methods/help_getConfig.md b/old_docs/API_docs_v25/methods/help_getConfig.md index 885ad5d3..16e25c68 100644 --- a/old_docs/API_docs_v25/methods/help_getConfig.md +++ b/old_docs/API_docs_v25/methods/help_getConfig.md @@ -1,11 +1,13 @@ --- title: help.getConfig -description: help.getConfig parameters, return type and example +description: Get server configuration --- ## Method: help.getConfig [Back to methods index](index.md) +Get server configuration + ### Return type: [Config](../types/Config.md) diff --git a/old_docs/API_docs_v25/methods/help_getInviteText.md b/old_docs/API_docs_v25/methods/help_getInviteText.md index aeebae28..d9ae8e0d 100644 --- a/old_docs/API_docs_v25/methods/help_getInviteText.md +++ b/old_docs/API_docs_v25/methods/help_getInviteText.md @@ -1,16 +1,18 @@ --- title: help.getInviteText -description: help.getInviteText parameters, return type and example +description: Get invitation text --- ## Method: help.getInviteText [Back to methods index](index.md) +Get invitation text + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|lang\_code|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|lang\_code|[CLICK ME string](../types/string.md) | Yes|| ### Return type: [help\_InviteText](../types/help_InviteText.md) diff --git a/old_docs/API_docs_v25/methods/help_getNearestDc.md b/old_docs/API_docs_v25/methods/help_getNearestDc.md index 6196890b..35a8bf91 100644 --- a/old_docs/API_docs_v25/methods/help_getNearestDc.md +++ b/old_docs/API_docs_v25/methods/help_getNearestDc.md @@ -1,11 +1,13 @@ --- title: help.getNearestDc -description: help.getNearestDc parameters, return type and example +description: Get nearest datacenter --- ## Method: help.getNearestDc [Back to methods index](index.md) +Get nearest datacenter + ### Return type: [NearestDc](../types/NearestDc.md) diff --git a/old_docs/API_docs_v25/methods/help_getSupport.md b/old_docs/API_docs_v25/methods/help_getSupport.md index 9b269f78..a5bab0f2 100644 --- a/old_docs/API_docs_v25/methods/help_getSupport.md +++ b/old_docs/API_docs_v25/methods/help_getSupport.md @@ -1,11 +1,13 @@ --- title: help.getSupport -description: help.getSupport parameters, return type and example +description: Get info of support user --- ## Method: help.getSupport [Back to methods index](index.md) +Get info of support user + ### Return type: [help\_Support](../types/help_Support.md) diff --git a/old_docs/API_docs_v25/methods/help_saveAppLog.md b/old_docs/API_docs_v25/methods/help_saveAppLog.md index af6e94e2..0165b6e3 100644 --- a/old_docs/API_docs_v25/methods/help_saveAppLog.md +++ b/old_docs/API_docs_v25/methods/help_saveAppLog.md @@ -1,16 +1,18 @@ --- title: help.saveAppLog -description: help.saveAppLog parameters, return type and example +description: Log data for developer of this app --- ## Method: help.saveAppLog [Back to methods index](index.md) +Log data for developer of this app + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|events|Array of [CLICK ME InputAppEvent](../types/InputAppEvent.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|events|Array of [CLICK ME InputAppEvent](../types/InputAppEvent.md) | Yes|Event list| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v25/methods/messages_deleteChatUser.md b/old_docs/API_docs_v25/methods/messages_deleteChatUser.md index d5f7f835..163a9250 100644 --- a/old_docs/API_docs_v25/methods/messages_deleteChatUser.md +++ b/old_docs/API_docs_v25/methods/messages_deleteChatUser.md @@ -12,7 +12,7 @@ Delete a user from a chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The MTProto ID of the chat| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to delete (pass @me to leave the chat)| diff --git a/old_docs/API_docs_v25/methods/messages_editChatPhoto.md b/old_docs/API_docs_v25/methods/messages_editChatPhoto.md index 4e5907aa..4decf9cd 100644 --- a/old_docs/API_docs_v25/methods/messages_editChatPhoto.md +++ b/old_docs/API_docs_v25/methods/messages_editChatPhoto.md @@ -12,7 +12,7 @@ Edit the photo of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The MTProto ID of the chat| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| |photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| diff --git a/old_docs/API_docs_v25/methods/messages_editChatTitle.md b/old_docs/API_docs_v25/methods/messages_editChatTitle.md index 5cfbea8b..cff2e5e6 100644 --- a/old_docs/API_docs_v25/methods/messages_editChatTitle.md +++ b/old_docs/API_docs_v25/methods/messages_editChatTitle.md @@ -12,7 +12,7 @@ Edit the title of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The MTProto ID of the chat| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| |title|[CLICK ME string](../types/string.md) | Yes|The new title| diff --git a/old_docs/API_docs_v25/methods/messages_getAllStickers.md b/old_docs/API_docs_v25/methods/messages_getAllStickers.md index 5e526f92..0708e15a 100644 --- a/old_docs/API_docs_v25/methods/messages_getAllStickers.md +++ b/old_docs/API_docs_v25/methods/messages_getAllStickers.md @@ -1,16 +1,18 @@ --- title: messages.getAllStickers -description: messages.getAllStickers parameters, return type and example +description: Get all stickerpacks --- ## Method: messages.getAllStickers [Back to methods index](index.md) +Get all stickerpacks + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME string](../types/string.md) | Yes|| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v25/methods/messages_getStickers.md b/old_docs/API_docs_v25/methods/messages_getStickers.md index 178b897c..4854696d 100644 --- a/old_docs/API_docs_v25/methods/messages_getStickers.md +++ b/old_docs/API_docs_v25/methods/messages_getStickers.md @@ -1,17 +1,19 @@ --- title: messages.getStickers -description: messages.getStickers parameters, return type and example +description: Get stickers --- ## Method: messages.getStickers [Back to methods index](index.md) +Get stickers + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|emoticon|[CLICK ME string](../types/string.md) | Yes| -|hash|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|emoticon|[CLICK ME string](../types/string.md) | Yes|Search by emoji| +|hash|[CLICK ME string](../types/string.md) | Yes|0 or $MadelineProto->gen_vector_hash(previously fetched sticker IDs)| ### Return type: [messages\_Stickers](../types/messages_Stickers.md) diff --git a/old_docs/API_docs_v25/methods/messages_readEncryptedHistory.md b/old_docs/API_docs_v25/methods/messages_readEncryptedHistory.md index 4d341809..39b110e3 100644 --- a/old_docs/API_docs_v25/methods/messages_readEncryptedHistory.md +++ b/old_docs/API_docs_v25/methods/messages_readEncryptedHistory.md @@ -1,17 +1,19 @@ --- title: messages.readEncryptedHistory -description: messages.readEncryptedHistory parameters, return type and example +description: Mark messages as read in secret chats --- ## Method: messages.readEncryptedHistory [Back to methods index](index.md) +Mark messages as read in secret chats + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|max\_date|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to mark messages as read| +|max\_date|[CLICK ME int](../types/int.md) | Yes|Maximum date of messages to mark| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v25/methods/messages_readMessageContents.md b/old_docs/API_docs_v25/methods/messages_readMessageContents.md index 0d27c209..9bb1bee8 100644 --- a/old_docs/API_docs_v25/methods/messages_readMessageContents.md +++ b/old_docs/API_docs_v25/methods/messages_readMessageContents.md @@ -1,16 +1,18 @@ --- title: messages.readMessageContents -description: messages.readMessageContents parameters, return type and example +description: Mark message as read --- ## Method: messages.readMessageContents [Back to methods index](index.md) +Mark message as read + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v25/methods/messages_receivedQueue.md b/old_docs/API_docs_v25/methods/messages_receivedQueue.md index c91caa37..4ad78ba2 100644 --- a/old_docs/API_docs_v25/methods/messages_receivedQueue.md +++ b/old_docs/API_docs_v25/methods/messages_receivedQueue.md @@ -1,77 +1,13 @@ --- title: messages.receivedQueue -description: messages.receivedQueue parameters, return type and example +description: You cannot use this method directly --- ## Method: messages.receivedQueue [Back to methods index](index.md) -### Parameters: - -| Name | Type | Required | -|----------|---------------|----------| -|max\_qts|[CLICK ME int](../types/int.md) | Yes| - - -### 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| - - -### MadelineProto Example: - - -``` -if (!file_exists('madeline.php')) { - copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); -} -include 'madeline.php'; - -// !!! This API id/API hash combination will not work !!! -// !!! You must get your own @ my.telegram.org !!! -$api_id = 0; -$api_hash = ''; - -$MadelineProto = new \danog\MadelineProto\API('session.madeline', ['app_info' => ['api_id' => $api_id, 'api_hash' => $api_hash]]); -$MadelineProto->start(); - -$Vector_of_long = $MadelineProto->messages->receivedQueue(['max_qts' => int, ]); -``` - -### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): - -### As a bot: - -POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` - -Parameters: - -* method - messages.receivedQueue -* params - `{"max_qts": int, }` - - - -### As a user: - -POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.receivedQueue` - -Parameters: - -max_qts - Json encoded int +**You cannot use this method directly** -Or, if you're into Lua: - -``` -Vector_of_long = messages.receivedQueue({max_qts=int, }) -``` - diff --git a/old_docs/API_docs_v25/methods/messages_sendEncrypted.md b/old_docs/API_docs_v25/methods/messages_sendEncrypted.md index 23461760..d48f88d7 100644 --- a/old_docs/API_docs_v25/methods/messages_sendEncrypted.md +++ b/old_docs/API_docs_v25/methods/messages_sendEncrypted.md @@ -1,17 +1,19 @@ --- title: messages.sendEncrypted -description: messages.sendEncrypted parameters, return type and example +description: Send message to secret chat --- ## Method: messages.sendEncrypted [Back to methods index](index.md) +Send message to secret chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the message| +|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v25/methods/messages_sendEncryptedFile.md b/old_docs/API_docs_v25/methods/messages_sendEncryptedFile.md index 64919abe..4fd0648e 100644 --- a/old_docs/API_docs_v25/methods/messages_sendEncryptedFile.md +++ b/old_docs/API_docs_v25/methods/messages_sendEncryptedFile.md @@ -1,18 +1,20 @@ --- title: messages.sendEncryptedFile -description: messages.sendEncryptedFile parameters, return type and example +description: Send a file to a secret chat --- ## Method: messages.sendEncryptedFile [Back to methods index](index.md) +Send a file to a secret chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes| -|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the file| +|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| +|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional|The file (optional)| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v25/methods/messages_sendEncryptedService.md b/old_docs/API_docs_v25/methods/messages_sendEncryptedService.md index 0a0eea8a..d66894bf 100644 --- a/old_docs/API_docs_v25/methods/messages_sendEncryptedService.md +++ b/old_docs/API_docs_v25/methods/messages_sendEncryptedService.md @@ -1,17 +1,19 @@ --- title: messages.sendEncryptedService -description: messages.sendEncryptedService parameters, return type and example +description: Send a service message to a secret chat --- ## Method: messages.sendEncryptedService [Back to methods index](index.md) +Send a service message to a secret chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the service message| +|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v25/methods/messages_setEncryptedTyping.md b/old_docs/API_docs_v25/methods/messages_setEncryptedTyping.md index 3183fedf..e9afe99c 100644 --- a/old_docs/API_docs_v25/methods/messages_setEncryptedTyping.md +++ b/old_docs/API_docs_v25/methods/messages_setEncryptedTyping.md @@ -12,8 +12,8 @@ Send typing notification to secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|| -|typing|[CLICK ME Bool](../types/Bool.md) | Yes|| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to send the notification| +|typing|[CLICK ME Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v25/methods/photos_deletePhotos.md b/old_docs/API_docs_v25/methods/photos_deletePhotos.md index 104459b7..b9daca10 100644 --- a/old_docs/API_docs_v25/methods/photos_deletePhotos.md +++ b/old_docs/API_docs_v25/methods/photos_deletePhotos.md @@ -1,16 +1,18 @@ --- title: photos.deletePhotos -description: photos.deletePhotos parameters, return type and example +description: Delete profile photos --- ## Method: photos.deletePhotos [Back to methods index](index.md) +Delete profile photos + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Yes|The profile photos to delete| ### Return type: [Vector\_of\_long](../types/long.md) diff --git a/old_docs/API_docs_v25/methods/photos_getUserPhotos.md b/old_docs/API_docs_v25/methods/photos_getUserPhotos.md index 4b0db928..a5adfd7a 100644 --- a/old_docs/API_docs_v25/methods/photos_getUserPhotos.md +++ b/old_docs/API_docs_v25/methods/photos_getUserPhotos.md @@ -1,19 +1,21 @@ --- title: photos.getUserPhotos -description: photos.getUserPhotos parameters, return type and example +description: Get the profile photos of a user --- ## Method: photos.getUserPhotos [Back to methods index](index.md) +Get the profile photos of a user + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|offset|[CLICK ME int](../types/int.md) | Yes| -|max\_id|[CLICK ME int](../types/int.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| +|offset|[CLICK ME int](../types/int.md) | Yes|Offset| +|max\_id|[CLICK ME int](../types/int.md) | Yes|| +|limit|[CLICK ME int](../types/int.md) | Yes|Number of photos to return| ### Return type: [photos\_Photos](../types/photos_Photos.md) diff --git a/old_docs/API_docs_v25/methods/photos_updateProfilePhoto.md b/old_docs/API_docs_v25/methods/photos_updateProfilePhoto.md index 386970d5..dc6edd6b 100644 --- a/old_docs/API_docs_v25/methods/photos_updateProfilePhoto.md +++ b/old_docs/API_docs_v25/methods/photos_updateProfilePhoto.md @@ -1,17 +1,19 @@ --- title: photos.updateProfilePhoto -description: photos.updateProfilePhoto parameters, return type and example +description: Update the profile photo (use photos->uploadProfilePhoto to upload the photo) --- ## Method: photos.updateProfilePhoto [Back to methods index](index.md) +Update the profile photo (use photos->uploadProfilePhoto to upload the photo) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional| -|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional|The photo to use| +|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|| ### Return type: [UserProfilePhoto](../types/UserProfilePhoto.md) diff --git a/old_docs/API_docs_v25/methods/photos_uploadProfilePhoto.md b/old_docs/API_docs_v25/methods/photos_uploadProfilePhoto.md index 07b9936c..fb0bc534 100644 --- a/old_docs/API_docs_v25/methods/photos_uploadProfilePhoto.md +++ b/old_docs/API_docs_v25/methods/photos_uploadProfilePhoto.md @@ -1,19 +1,21 @@ --- title: photos.uploadProfilePhoto -description: photos.uploadProfilePhoto parameters, return type and example +description: Upload profile photo --- ## Method: photos.uploadProfilePhoto [Back to methods index](index.md) +Upload profile photo + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|file|[File path or InputFile](../types/InputFile.md) | Yes| -|caption|[CLICK ME string](../types/string.md) | Yes| -|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional| -|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|file|[File path or InputFile](../types/InputFile.md) | Yes|The photo| +|caption|[CLICK ME string](../types/string.md) | Yes|| +|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional|| +|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|| ### Return type: [photos\_Photo](../types/photos_Photo.md) diff --git a/old_docs/API_docs_v27/methods/account_registerDevice.md b/old_docs/API_docs_v27/methods/account_registerDevice.md index 1752afde..0a40f49c 100644 --- a/old_docs/API_docs_v27/methods/account_registerDevice.md +++ b/old_docs/API_docs_v27/methods/account_registerDevice.md @@ -12,8 +12,8 @@ Register device for push notifications | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and oTher, see source code of official apps for more info| +|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and oTher, see source code of official apps for more info| |device\_model|[CLICK ME string](../types/string.md) | Yes|| |system\_version|[CLICK ME string](../types/string.md) | Yes|| |app\_version|[CLICK ME string](../types/string.md) | Yes|| diff --git a/old_docs/API_docs_v27/methods/account_unregisterDevice.md b/old_docs/API_docs_v27/methods/account_unregisterDevice.md index 1d2b7670..32e44495 100644 --- a/old_docs/API_docs_v27/methods/account_unregisterDevice.md +++ b/old_docs/API_docs_v27/methods/account_unregisterDevice.md @@ -12,8 +12,8 @@ Stop sending PUSH notifications to app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and oTher, see source code of official apps for more info| +|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and oTher, see source code of official apps for more info| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v27/methods/contacts_getBlocked.md b/old_docs/API_docs_v27/methods/contacts_getBlocked.md index d7d8c5cc..300025af 100644 --- a/old_docs/API_docs_v27/methods/contacts_getBlocked.md +++ b/old_docs/API_docs_v27/methods/contacts_getBlocked.md @@ -12,7 +12,7 @@ Get blocked users | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, then set to the number of blocked contacts previously fetched| +|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, Then set to the number of blocked contacts previously fetched| |limit|[CLICK ME int](../types/int.md) | Yes|How many blocked contacts to fetch| diff --git a/old_docs/API_docs_v27/methods/help_getAppUpdate.md b/old_docs/API_docs_v27/methods/help_getAppUpdate.md index d13d6263..f3eacbd6 100644 --- a/old_docs/API_docs_v27/methods/help_getAppUpdate.md +++ b/old_docs/API_docs_v27/methods/help_getAppUpdate.md @@ -1,19 +1,21 @@ --- title: help.getAppUpdate -description: help.getAppUpdate parameters, return type and example +description: Get info about app updates --- ## Method: help.getAppUpdate [Back to methods index](index.md) +Get info about app updates + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|device\_model|[CLICK ME string](../types/string.md) | Yes| -|system\_version|[CLICK ME string](../types/string.md) | Yes| -|app\_version|[CLICK ME string](../types/string.md) | Yes| -|lang\_code|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|device\_model|[CLICK ME string](../types/string.md) | Yes|| +|system\_version|[CLICK ME string](../types/string.md) | Yes|| +|app\_version|[CLICK ME string](../types/string.md) | Yes|| +|lang\_code|[CLICK ME string](../types/string.md) | Yes|| ### Return type: [help\_AppUpdate](../types/help_AppUpdate.md) diff --git a/old_docs/API_docs_v27/methods/help_getConfig.md b/old_docs/API_docs_v27/methods/help_getConfig.md index 885ad5d3..16e25c68 100644 --- a/old_docs/API_docs_v27/methods/help_getConfig.md +++ b/old_docs/API_docs_v27/methods/help_getConfig.md @@ -1,11 +1,13 @@ --- title: help.getConfig -description: help.getConfig parameters, return type and example +description: Get server configuration --- ## Method: help.getConfig [Back to methods index](index.md) +Get server configuration + ### Return type: [Config](../types/Config.md) diff --git a/old_docs/API_docs_v27/methods/help_getInviteText.md b/old_docs/API_docs_v27/methods/help_getInviteText.md index aeebae28..d9ae8e0d 100644 --- a/old_docs/API_docs_v27/methods/help_getInviteText.md +++ b/old_docs/API_docs_v27/methods/help_getInviteText.md @@ -1,16 +1,18 @@ --- title: help.getInviteText -description: help.getInviteText parameters, return type and example +description: Get invitation text --- ## Method: help.getInviteText [Back to methods index](index.md) +Get invitation text + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|lang\_code|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|lang\_code|[CLICK ME string](../types/string.md) | Yes|| ### Return type: [help\_InviteText](../types/help_InviteText.md) diff --git a/old_docs/API_docs_v27/methods/help_getNearestDc.md b/old_docs/API_docs_v27/methods/help_getNearestDc.md index 6196890b..35a8bf91 100644 --- a/old_docs/API_docs_v27/methods/help_getNearestDc.md +++ b/old_docs/API_docs_v27/methods/help_getNearestDc.md @@ -1,11 +1,13 @@ --- title: help.getNearestDc -description: help.getNearestDc parameters, return type and example +description: Get nearest datacenter --- ## Method: help.getNearestDc [Back to methods index](index.md) +Get nearest datacenter + ### Return type: [NearestDc](../types/NearestDc.md) diff --git a/old_docs/API_docs_v27/methods/help_getSupport.md b/old_docs/API_docs_v27/methods/help_getSupport.md index 9b269f78..a5bab0f2 100644 --- a/old_docs/API_docs_v27/methods/help_getSupport.md +++ b/old_docs/API_docs_v27/methods/help_getSupport.md @@ -1,11 +1,13 @@ --- title: help.getSupport -description: help.getSupport parameters, return type and example +description: Get info of support user --- ## Method: help.getSupport [Back to methods index](index.md) +Get info of support user + ### Return type: [help\_Support](../types/help_Support.md) diff --git a/old_docs/API_docs_v27/methods/help_saveAppLog.md b/old_docs/API_docs_v27/methods/help_saveAppLog.md index af6e94e2..0165b6e3 100644 --- a/old_docs/API_docs_v27/methods/help_saveAppLog.md +++ b/old_docs/API_docs_v27/methods/help_saveAppLog.md @@ -1,16 +1,18 @@ --- title: help.saveAppLog -description: help.saveAppLog parameters, return type and example +description: Log data for developer of this app --- ## Method: help.saveAppLog [Back to methods index](index.md) +Log data for developer of this app + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|events|Array of [CLICK ME InputAppEvent](../types/InputAppEvent.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|events|Array of [CLICK ME InputAppEvent](../types/InputAppEvent.md) | Yes|Event list| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v27/methods/messages_deleteChatUser.md b/old_docs/API_docs_v27/methods/messages_deleteChatUser.md index a71f4aaf..0a6830de 100644 --- a/old_docs/API_docs_v27/methods/messages_deleteChatUser.md +++ b/old_docs/API_docs_v27/methods/messages_deleteChatUser.md @@ -12,7 +12,7 @@ Delete a user from a chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The MTProto ID of the chat| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to delete (pass @me to leave the chat)| diff --git a/old_docs/API_docs_v27/methods/messages_editChatPhoto.md b/old_docs/API_docs_v27/methods/messages_editChatPhoto.md index 8848eca7..122913c4 100644 --- a/old_docs/API_docs_v27/methods/messages_editChatPhoto.md +++ b/old_docs/API_docs_v27/methods/messages_editChatPhoto.md @@ -12,7 +12,7 @@ Edit the photo of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The MTProto ID of the chat| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| |photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| diff --git a/old_docs/API_docs_v27/methods/messages_editChatTitle.md b/old_docs/API_docs_v27/methods/messages_editChatTitle.md index 1c1c7a16..3a1e974b 100644 --- a/old_docs/API_docs_v27/methods/messages_editChatTitle.md +++ b/old_docs/API_docs_v27/methods/messages_editChatTitle.md @@ -12,7 +12,7 @@ Edit the title of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The MTProto ID of the chat| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| |title|[CLICK ME string](../types/string.md) | Yes|The new title| diff --git a/old_docs/API_docs_v27/methods/messages_getAllStickers.md b/old_docs/API_docs_v27/methods/messages_getAllStickers.md index 5e526f92..0708e15a 100644 --- a/old_docs/API_docs_v27/methods/messages_getAllStickers.md +++ b/old_docs/API_docs_v27/methods/messages_getAllStickers.md @@ -1,16 +1,18 @@ --- title: messages.getAllStickers -description: messages.getAllStickers parameters, return type and example +description: Get all stickerpacks --- ## Method: messages.getAllStickers [Back to methods index](index.md) +Get all stickerpacks + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME string](../types/string.md) | Yes|| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v27/methods/messages_getStickers.md b/old_docs/API_docs_v27/methods/messages_getStickers.md index 178b897c..4854696d 100644 --- a/old_docs/API_docs_v27/methods/messages_getStickers.md +++ b/old_docs/API_docs_v27/methods/messages_getStickers.md @@ -1,17 +1,19 @@ --- title: messages.getStickers -description: messages.getStickers parameters, return type and example +description: Get stickers --- ## Method: messages.getStickers [Back to methods index](index.md) +Get stickers + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|emoticon|[CLICK ME string](../types/string.md) | Yes| -|hash|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|emoticon|[CLICK ME string](../types/string.md) | Yes|Search by emoji| +|hash|[CLICK ME string](../types/string.md) | Yes|0 or $MadelineProto->gen_vector_hash(previously fetched sticker IDs)| ### Return type: [messages\_Stickers](../types/messages_Stickers.md) diff --git a/old_docs/API_docs_v27/methods/messages_getWebPagePreview.md b/old_docs/API_docs_v27/methods/messages_getWebPagePreview.md index 35243c9f..d01bdd32 100644 --- a/old_docs/API_docs_v27/methods/messages_getWebPagePreview.md +++ b/old_docs/API_docs_v27/methods/messages_getWebPagePreview.md @@ -1,16 +1,18 @@ --- title: messages.getWebPagePreview -description: messages.getWebPagePreview parameters, return type and example +description: Get webpage preview --- ## Method: messages.getWebPagePreview [Back to methods index](index.md) +Get webpage preview + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|message|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|message|[CLICK ME string](../types/string.md) | Yes|Extract preview from this message| ### Return type: [MessageMedia](../types/MessageMedia.md) diff --git a/old_docs/API_docs_v27/methods/messages_readEncryptedHistory.md b/old_docs/API_docs_v27/methods/messages_readEncryptedHistory.md index 4d341809..39b110e3 100644 --- a/old_docs/API_docs_v27/methods/messages_readEncryptedHistory.md +++ b/old_docs/API_docs_v27/methods/messages_readEncryptedHistory.md @@ -1,17 +1,19 @@ --- title: messages.readEncryptedHistory -description: messages.readEncryptedHistory parameters, return type and example +description: Mark messages as read in secret chats --- ## Method: messages.readEncryptedHistory [Back to methods index](index.md) +Mark messages as read in secret chats + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|max\_date|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to mark messages as read| +|max\_date|[CLICK ME int](../types/int.md) | Yes|Maximum date of messages to mark| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v27/methods/messages_readMessageContents.md b/old_docs/API_docs_v27/methods/messages_readMessageContents.md index 0d27c209..9bb1bee8 100644 --- a/old_docs/API_docs_v27/methods/messages_readMessageContents.md +++ b/old_docs/API_docs_v27/methods/messages_readMessageContents.md @@ -1,16 +1,18 @@ --- title: messages.readMessageContents -description: messages.readMessageContents parameters, return type and example +description: Mark message as read --- ## Method: messages.readMessageContents [Back to methods index](index.md) +Mark message as read + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v27/methods/messages_receivedQueue.md b/old_docs/API_docs_v27/methods/messages_receivedQueue.md index c91caa37..4ad78ba2 100644 --- a/old_docs/API_docs_v27/methods/messages_receivedQueue.md +++ b/old_docs/API_docs_v27/methods/messages_receivedQueue.md @@ -1,77 +1,13 @@ --- title: messages.receivedQueue -description: messages.receivedQueue parameters, return type and example +description: You cannot use this method directly --- ## Method: messages.receivedQueue [Back to methods index](index.md) -### Parameters: - -| Name | Type | Required | -|----------|---------------|----------| -|max\_qts|[CLICK ME int](../types/int.md) | Yes| - - -### 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| - - -### MadelineProto Example: - - -``` -if (!file_exists('madeline.php')) { - copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); -} -include 'madeline.php'; - -// !!! This API id/API hash combination will not work !!! -// !!! You must get your own @ my.telegram.org !!! -$api_id = 0; -$api_hash = ''; - -$MadelineProto = new \danog\MadelineProto\API('session.madeline', ['app_info' => ['api_id' => $api_id, 'api_hash' => $api_hash]]); -$MadelineProto->start(); - -$Vector_of_long = $MadelineProto->messages->receivedQueue(['max_qts' => int, ]); -``` - -### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): - -### As a bot: - -POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` - -Parameters: - -* method - messages.receivedQueue -* params - `{"max_qts": int, }` - - - -### As a user: - -POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.receivedQueue` - -Parameters: - -max_qts - Json encoded int +**You cannot use this method directly** -Or, if you're into Lua: - -``` -Vector_of_long = messages.receivedQueue({max_qts=int, }) -``` - diff --git a/old_docs/API_docs_v27/methods/messages_sendEncrypted.md b/old_docs/API_docs_v27/methods/messages_sendEncrypted.md index 23461760..d48f88d7 100644 --- a/old_docs/API_docs_v27/methods/messages_sendEncrypted.md +++ b/old_docs/API_docs_v27/methods/messages_sendEncrypted.md @@ -1,17 +1,19 @@ --- title: messages.sendEncrypted -description: messages.sendEncrypted parameters, return type and example +description: Send message to secret chat --- ## Method: messages.sendEncrypted [Back to methods index](index.md) +Send message to secret chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the message| +|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v27/methods/messages_sendEncryptedFile.md b/old_docs/API_docs_v27/methods/messages_sendEncryptedFile.md index 64919abe..4fd0648e 100644 --- a/old_docs/API_docs_v27/methods/messages_sendEncryptedFile.md +++ b/old_docs/API_docs_v27/methods/messages_sendEncryptedFile.md @@ -1,18 +1,20 @@ --- title: messages.sendEncryptedFile -description: messages.sendEncryptedFile parameters, return type and example +description: Send a file to a secret chat --- ## Method: messages.sendEncryptedFile [Back to methods index](index.md) +Send a file to a secret chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes| -|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the file| +|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| +|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional|The file (optional)| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v27/methods/messages_sendEncryptedService.md b/old_docs/API_docs_v27/methods/messages_sendEncryptedService.md index 0a0eea8a..d66894bf 100644 --- a/old_docs/API_docs_v27/methods/messages_sendEncryptedService.md +++ b/old_docs/API_docs_v27/methods/messages_sendEncryptedService.md @@ -1,17 +1,19 @@ --- title: messages.sendEncryptedService -description: messages.sendEncryptedService parameters, return type and example +description: Send a service message to a secret chat --- ## Method: messages.sendEncryptedService [Back to methods index](index.md) +Send a service message to a secret chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the service message| +|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v27/methods/messages_setEncryptedTyping.md b/old_docs/API_docs_v27/methods/messages_setEncryptedTyping.md index 3183fedf..e9afe99c 100644 --- a/old_docs/API_docs_v27/methods/messages_setEncryptedTyping.md +++ b/old_docs/API_docs_v27/methods/messages_setEncryptedTyping.md @@ -12,8 +12,8 @@ Send typing notification to secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|| -|typing|[CLICK ME Bool](../types/Bool.md) | Yes|| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to send the notification| +|typing|[CLICK ME Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v27/methods/photos_deletePhotos.md b/old_docs/API_docs_v27/methods/photos_deletePhotos.md index 104459b7..b9daca10 100644 --- a/old_docs/API_docs_v27/methods/photos_deletePhotos.md +++ b/old_docs/API_docs_v27/methods/photos_deletePhotos.md @@ -1,16 +1,18 @@ --- title: photos.deletePhotos -description: photos.deletePhotos parameters, return type and example +description: Delete profile photos --- ## Method: photos.deletePhotos [Back to methods index](index.md) +Delete profile photos + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Yes|The profile photos to delete| ### Return type: [Vector\_of\_long](../types/long.md) diff --git a/old_docs/API_docs_v27/methods/photos_getUserPhotos.md b/old_docs/API_docs_v27/methods/photos_getUserPhotos.md index 4b0db928..a5adfd7a 100644 --- a/old_docs/API_docs_v27/methods/photos_getUserPhotos.md +++ b/old_docs/API_docs_v27/methods/photos_getUserPhotos.md @@ -1,19 +1,21 @@ --- title: photos.getUserPhotos -description: photos.getUserPhotos parameters, return type and example +description: Get the profile photos of a user --- ## Method: photos.getUserPhotos [Back to methods index](index.md) +Get the profile photos of a user + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|offset|[CLICK ME int](../types/int.md) | Yes| -|max\_id|[CLICK ME int](../types/int.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| +|offset|[CLICK ME int](../types/int.md) | Yes|Offset| +|max\_id|[CLICK ME int](../types/int.md) | Yes|| +|limit|[CLICK ME int](../types/int.md) | Yes|Number of photos to return| ### Return type: [photos\_Photos](../types/photos_Photos.md) diff --git a/old_docs/API_docs_v27/methods/photos_updateProfilePhoto.md b/old_docs/API_docs_v27/methods/photos_updateProfilePhoto.md index 386970d5..dc6edd6b 100644 --- a/old_docs/API_docs_v27/methods/photos_updateProfilePhoto.md +++ b/old_docs/API_docs_v27/methods/photos_updateProfilePhoto.md @@ -1,17 +1,19 @@ --- title: photos.updateProfilePhoto -description: photos.updateProfilePhoto parameters, return type and example +description: Update the profile photo (use photos->uploadProfilePhoto to upload the photo) --- ## Method: photos.updateProfilePhoto [Back to methods index](index.md) +Update the profile photo (use photos->uploadProfilePhoto to upload the photo) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional| -|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional|The photo to use| +|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|| ### Return type: [UserProfilePhoto](../types/UserProfilePhoto.md) diff --git a/old_docs/API_docs_v27/methods/photos_uploadProfilePhoto.md b/old_docs/API_docs_v27/methods/photos_uploadProfilePhoto.md index 07b9936c..fb0bc534 100644 --- a/old_docs/API_docs_v27/methods/photos_uploadProfilePhoto.md +++ b/old_docs/API_docs_v27/methods/photos_uploadProfilePhoto.md @@ -1,19 +1,21 @@ --- title: photos.uploadProfilePhoto -description: photos.uploadProfilePhoto parameters, return type and example +description: Upload profile photo --- ## Method: photos.uploadProfilePhoto [Back to methods index](index.md) +Upload profile photo + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|file|[File path or InputFile](../types/InputFile.md) | Yes| -|caption|[CLICK ME string](../types/string.md) | Yes| -|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional| -|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|file|[File path or InputFile](../types/InputFile.md) | Yes|The photo| +|caption|[CLICK ME string](../types/string.md) | Yes|| +|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional|| +|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|| ### Return type: [photos\_Photo](../types/photos_Photo.md) diff --git a/old_docs/API_docs_v33/methods/account_registerDevice.md b/old_docs/API_docs_v33/methods/account_registerDevice.md index 1752afde..0a40f49c 100644 --- a/old_docs/API_docs_v33/methods/account_registerDevice.md +++ b/old_docs/API_docs_v33/methods/account_registerDevice.md @@ -12,8 +12,8 @@ Register device for push notifications | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and oTher, see source code of official apps for more info| +|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and oTher, see source code of official apps for more info| |device\_model|[CLICK ME string](../types/string.md) | Yes|| |system\_version|[CLICK ME string](../types/string.md) | Yes|| |app\_version|[CLICK ME string](../types/string.md) | Yes|| diff --git a/old_docs/API_docs_v33/methods/account_unregisterDevice.md b/old_docs/API_docs_v33/methods/account_unregisterDevice.md index 1d2b7670..32e44495 100644 --- a/old_docs/API_docs_v33/methods/account_unregisterDevice.md +++ b/old_docs/API_docs_v33/methods/account_unregisterDevice.md @@ -12,8 +12,8 @@ Stop sending PUSH notifications to app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and oTher, see source code of official apps for more info| +|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and oTher, see source code of official apps for more info| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v33/methods/contacts_getBlocked.md b/old_docs/API_docs_v33/methods/contacts_getBlocked.md index d7d8c5cc..300025af 100644 --- a/old_docs/API_docs_v33/methods/contacts_getBlocked.md +++ b/old_docs/API_docs_v33/methods/contacts_getBlocked.md @@ -12,7 +12,7 @@ Get blocked users | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, then set to the number of blocked contacts previously fetched| +|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, Then set to the number of blocked contacts previously fetched| |limit|[CLICK ME int](../types/int.md) | Yes|How many blocked contacts to fetch| diff --git a/old_docs/API_docs_v33/methods/help_getAppChangelog.md b/old_docs/API_docs_v33/methods/help_getAppChangelog.md index ec71a905..c8c41f71 100644 --- a/old_docs/API_docs_v33/methods/help_getAppChangelog.md +++ b/old_docs/API_docs_v33/methods/help_getAppChangelog.md @@ -1,19 +1,21 @@ --- title: help.getAppChangelog -description: help.getAppChangelog parameters, return type and example +description: Get the changelog of this app --- ## Method: help.getAppChangelog [Back to methods index](index.md) +Get the changelog of this app + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|device\_model|[CLICK ME string](../types/string.md) | Yes| -|system\_version|[CLICK ME string](../types/string.md) | Yes| -|app\_version|[CLICK ME string](../types/string.md) | Yes| -|lang\_code|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|device\_model|[CLICK ME string](../types/string.md) | Yes|| +|system\_version|[CLICK ME string](../types/string.md) | Yes|| +|app\_version|[CLICK ME string](../types/string.md) | Yes|| +|lang\_code|[CLICK ME string](../types/string.md) | Yes|| ### Return type: [help\_AppChangelog](../types/help_AppChangelog.md) diff --git a/old_docs/API_docs_v33/methods/help_getAppUpdate.md b/old_docs/API_docs_v33/methods/help_getAppUpdate.md index d13d6263..f3eacbd6 100644 --- a/old_docs/API_docs_v33/methods/help_getAppUpdate.md +++ b/old_docs/API_docs_v33/methods/help_getAppUpdate.md @@ -1,19 +1,21 @@ --- title: help.getAppUpdate -description: help.getAppUpdate parameters, return type and example +description: Get info about app updates --- ## Method: help.getAppUpdate [Back to methods index](index.md) +Get info about app updates + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|device\_model|[CLICK ME string](../types/string.md) | Yes| -|system\_version|[CLICK ME string](../types/string.md) | Yes| -|app\_version|[CLICK ME string](../types/string.md) | Yes| -|lang\_code|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|device\_model|[CLICK ME string](../types/string.md) | Yes|| +|system\_version|[CLICK ME string](../types/string.md) | Yes|| +|app\_version|[CLICK ME string](../types/string.md) | Yes|| +|lang\_code|[CLICK ME string](../types/string.md) | Yes|| ### Return type: [help\_AppUpdate](../types/help_AppUpdate.md) diff --git a/old_docs/API_docs_v33/methods/help_getConfig.md b/old_docs/API_docs_v33/methods/help_getConfig.md index 885ad5d3..16e25c68 100644 --- a/old_docs/API_docs_v33/methods/help_getConfig.md +++ b/old_docs/API_docs_v33/methods/help_getConfig.md @@ -1,11 +1,13 @@ --- title: help.getConfig -description: help.getConfig parameters, return type and example +description: Get server configuration --- ## Method: help.getConfig [Back to methods index](index.md) +Get server configuration + ### Return type: [Config](../types/Config.md) diff --git a/old_docs/API_docs_v33/methods/help_getInviteText.md b/old_docs/API_docs_v33/methods/help_getInviteText.md index aeebae28..d9ae8e0d 100644 --- a/old_docs/API_docs_v33/methods/help_getInviteText.md +++ b/old_docs/API_docs_v33/methods/help_getInviteText.md @@ -1,16 +1,18 @@ --- title: help.getInviteText -description: help.getInviteText parameters, return type and example +description: Get invitation text --- ## Method: help.getInviteText [Back to methods index](index.md) +Get invitation text + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|lang\_code|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|lang\_code|[CLICK ME string](../types/string.md) | Yes|| ### Return type: [help\_InviteText](../types/help_InviteText.md) diff --git a/old_docs/API_docs_v33/methods/help_getNearestDc.md b/old_docs/API_docs_v33/methods/help_getNearestDc.md index 6196890b..35a8bf91 100644 --- a/old_docs/API_docs_v33/methods/help_getNearestDc.md +++ b/old_docs/API_docs_v33/methods/help_getNearestDc.md @@ -1,11 +1,13 @@ --- title: help.getNearestDc -description: help.getNearestDc parameters, return type and example +description: Get nearest datacenter --- ## Method: help.getNearestDc [Back to methods index](index.md) +Get nearest datacenter + ### Return type: [NearestDc](../types/NearestDc.md) diff --git a/old_docs/API_docs_v33/methods/help_getSupport.md b/old_docs/API_docs_v33/methods/help_getSupport.md index 9b269f78..a5bab0f2 100644 --- a/old_docs/API_docs_v33/methods/help_getSupport.md +++ b/old_docs/API_docs_v33/methods/help_getSupport.md @@ -1,11 +1,13 @@ --- title: help.getSupport -description: help.getSupport parameters, return type and example +description: Get info of support user --- ## Method: help.getSupport [Back to methods index](index.md) +Get info of support user + ### Return type: [help\_Support](../types/help_Support.md) diff --git a/old_docs/API_docs_v33/methods/help_saveAppLog.md b/old_docs/API_docs_v33/methods/help_saveAppLog.md index af6e94e2..0165b6e3 100644 --- a/old_docs/API_docs_v33/methods/help_saveAppLog.md +++ b/old_docs/API_docs_v33/methods/help_saveAppLog.md @@ -1,16 +1,18 @@ --- title: help.saveAppLog -description: help.saveAppLog parameters, return type and example +description: Log data for developer of this app --- ## Method: help.saveAppLog [Back to methods index](index.md) +Log data for developer of this app + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|events|Array of [CLICK ME InputAppEvent](../types/InputAppEvent.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|events|Array of [CLICK ME InputAppEvent](../types/InputAppEvent.md) | Yes|Event list| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v33/methods/messages_checkChatInvite.md b/old_docs/API_docs_v33/methods/messages_checkChatInvite.md index 4ddf5084..de1d9ff4 100644 --- a/old_docs/API_docs_v33/methods/messages_checkChatInvite.md +++ b/old_docs/API_docs_v33/methods/messages_checkChatInvite.md @@ -1,16 +1,18 @@ --- title: messages.checkChatInvite -description: messages.checkChatInvite parameters, return type and example +description: Check if an invitation link is valid --- ## Method: messages.checkChatInvite [Back to methods index](index.md) +Check if an invitation link is valid + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| ### Return type: [ChatInvite](../types/ChatInvite.md) diff --git a/old_docs/API_docs_v33/methods/messages_deleteChatUser.md b/old_docs/API_docs_v33/methods/messages_deleteChatUser.md index a71f4aaf..0a6830de 100644 --- a/old_docs/API_docs_v33/methods/messages_deleteChatUser.md +++ b/old_docs/API_docs_v33/methods/messages_deleteChatUser.md @@ -12,7 +12,7 @@ Delete a user from a chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The MTProto ID of the chat| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to delete (pass @me to leave the chat)| diff --git a/old_docs/API_docs_v33/methods/messages_editChatPhoto.md b/old_docs/API_docs_v33/methods/messages_editChatPhoto.md index 8848eca7..122913c4 100644 --- a/old_docs/API_docs_v33/methods/messages_editChatPhoto.md +++ b/old_docs/API_docs_v33/methods/messages_editChatPhoto.md @@ -12,7 +12,7 @@ Edit the photo of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The MTProto ID of the chat| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| |photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| diff --git a/old_docs/API_docs_v33/methods/messages_editChatTitle.md b/old_docs/API_docs_v33/methods/messages_editChatTitle.md index 1c1c7a16..3a1e974b 100644 --- a/old_docs/API_docs_v33/methods/messages_editChatTitle.md +++ b/old_docs/API_docs_v33/methods/messages_editChatTitle.md @@ -12,7 +12,7 @@ Edit the title of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The MTProto ID of the chat| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| |title|[CLICK ME string](../types/string.md) | Yes|The new title| diff --git a/old_docs/API_docs_v33/methods/messages_exportChatInvite.md b/old_docs/API_docs_v33/methods/messages_exportChatInvite.md index 74d70c21..98685d96 100644 --- a/old_docs/API_docs_v33/methods/messages_exportChatInvite.md +++ b/old_docs/API_docs_v33/methods/messages_exportChatInvite.md @@ -1,16 +1,18 @@ --- title: messages.exportChatInvite -description: messages.exportChatInvite parameters, return type and example +description: Export chat invite --- ## Method: messages.exportChatInvite [Back to methods index](index.md) +Export chat invite + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat id | ### Return type: [ExportedChatInvite](../types/ExportedChatInvite.md) diff --git a/old_docs/API_docs_v33/methods/messages_getAllStickers.md b/old_docs/API_docs_v33/methods/messages_getAllStickers.md index 5e526f92..0708e15a 100644 --- a/old_docs/API_docs_v33/methods/messages_getAllStickers.md +++ b/old_docs/API_docs_v33/methods/messages_getAllStickers.md @@ -1,16 +1,18 @@ --- title: messages.getAllStickers -description: messages.getAllStickers parameters, return type and example +description: Get all stickerpacks --- ## Method: messages.getAllStickers [Back to methods index](index.md) +Get all stickerpacks + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME string](../types/string.md) | Yes|| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v33/methods/messages_getStickerSet.md b/old_docs/API_docs_v33/methods/messages_getStickerSet.md index 70bdd9ba..c86807e4 100644 --- a/old_docs/API_docs_v33/methods/messages_getStickerSet.md +++ b/old_docs/API_docs_v33/methods/messages_getStickerSet.md @@ -1,16 +1,18 @@ --- title: messages.getStickerSet -description: messages.getStickerSet parameters, return type and example +description: Get a stickerset --- ## Method: messages.getStickerSet [Back to methods index](index.md) +Get a stickerset + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset to get| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/old_docs/API_docs_v33/methods/messages_getStickers.md b/old_docs/API_docs_v33/methods/messages_getStickers.md index 178b897c..4854696d 100644 --- a/old_docs/API_docs_v33/methods/messages_getStickers.md +++ b/old_docs/API_docs_v33/methods/messages_getStickers.md @@ -1,17 +1,19 @@ --- title: messages.getStickers -description: messages.getStickers parameters, return type and example +description: Get stickers --- ## Method: messages.getStickers [Back to methods index](index.md) +Get stickers + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|emoticon|[CLICK ME string](../types/string.md) | Yes| -|hash|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|emoticon|[CLICK ME string](../types/string.md) | Yes|Search by emoji| +|hash|[CLICK ME string](../types/string.md) | Yes|0 or $MadelineProto->gen_vector_hash(previously fetched sticker IDs)| ### Return type: [messages\_Stickers](../types/messages_Stickers.md) diff --git a/old_docs/API_docs_v33/methods/messages_getWebPagePreview.md b/old_docs/API_docs_v33/methods/messages_getWebPagePreview.md index 35243c9f..d01bdd32 100644 --- a/old_docs/API_docs_v33/methods/messages_getWebPagePreview.md +++ b/old_docs/API_docs_v33/methods/messages_getWebPagePreview.md @@ -1,16 +1,18 @@ --- title: messages.getWebPagePreview -description: messages.getWebPagePreview parameters, return type and example +description: Get webpage preview --- ## Method: messages.getWebPagePreview [Back to methods index](index.md) +Get webpage preview + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|message|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|message|[CLICK ME string](../types/string.md) | Yes|Extract preview from this message| ### Return type: [MessageMedia](../types/MessageMedia.md) diff --git a/old_docs/API_docs_v33/methods/messages_importChatInvite.md b/old_docs/API_docs_v33/methods/messages_importChatInvite.md index 2bea5247..0d6cd7c8 100644 --- a/old_docs/API_docs_v33/methods/messages_importChatInvite.md +++ b/old_docs/API_docs_v33/methods/messages_importChatInvite.md @@ -1,16 +1,18 @@ --- title: messages.importChatInvite -description: messages.importChatInvite parameters, return type and example +description: Import chat invite --- ## Method: messages.importChatInvite [Back to methods index](index.md) +Import chat invite + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v33/methods/messages_installStickerSet.md b/old_docs/API_docs_v33/methods/messages_installStickerSet.md index 857aa738..f620c96a 100644 --- a/old_docs/API_docs_v33/methods/messages_installStickerSet.md +++ b/old_docs/API_docs_v33/methods/messages_installStickerSet.md @@ -1,17 +1,19 @@ --- title: messages.installStickerSet -description: messages.installStickerSet parameters, return type and example +description: Add a sticker set --- ## Method: messages.installStickerSet [Back to methods index](index.md) +Add a sticker set + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional| -|disabled|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to add| +|disabled|[CLICK ME Bool](../types/Bool.md) | Yes|| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v33/methods/messages_readEncryptedHistory.md b/old_docs/API_docs_v33/methods/messages_readEncryptedHistory.md index 4d341809..39b110e3 100644 --- a/old_docs/API_docs_v33/methods/messages_readEncryptedHistory.md +++ b/old_docs/API_docs_v33/methods/messages_readEncryptedHistory.md @@ -1,17 +1,19 @@ --- title: messages.readEncryptedHistory -description: messages.readEncryptedHistory parameters, return type and example +description: Mark messages as read in secret chats --- ## Method: messages.readEncryptedHistory [Back to methods index](index.md) +Mark messages as read in secret chats + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|max\_date|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to mark messages as read| +|max\_date|[CLICK ME int](../types/int.md) | Yes|Maximum date of messages to mark| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v33/methods/messages_readMessageContents.md b/old_docs/API_docs_v33/methods/messages_readMessageContents.md index 0d27c209..9bb1bee8 100644 --- a/old_docs/API_docs_v33/methods/messages_readMessageContents.md +++ b/old_docs/API_docs_v33/methods/messages_readMessageContents.md @@ -1,16 +1,18 @@ --- title: messages.readMessageContents -description: messages.readMessageContents parameters, return type and example +description: Mark message as read --- ## Method: messages.readMessageContents [Back to methods index](index.md) +Mark message as read + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v33/methods/messages_receivedQueue.md b/old_docs/API_docs_v33/methods/messages_receivedQueue.md index c91caa37..4ad78ba2 100644 --- a/old_docs/API_docs_v33/methods/messages_receivedQueue.md +++ b/old_docs/API_docs_v33/methods/messages_receivedQueue.md @@ -1,77 +1,13 @@ --- title: messages.receivedQueue -description: messages.receivedQueue parameters, return type and example +description: You cannot use this method directly --- ## Method: messages.receivedQueue [Back to methods index](index.md) -### Parameters: - -| Name | Type | Required | -|----------|---------------|----------| -|max\_qts|[CLICK ME int](../types/int.md) | Yes| - - -### 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| - - -### MadelineProto Example: - - -``` -if (!file_exists('madeline.php')) { - copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); -} -include 'madeline.php'; - -// !!! This API id/API hash combination will not work !!! -// !!! You must get your own @ my.telegram.org !!! -$api_id = 0; -$api_hash = ''; - -$MadelineProto = new \danog\MadelineProto\API('session.madeline', ['app_info' => ['api_id' => $api_id, 'api_hash' => $api_hash]]); -$MadelineProto->start(); - -$Vector_of_long = $MadelineProto->messages->receivedQueue(['max_qts' => int, ]); -``` - -### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): - -### As a bot: - -POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` - -Parameters: - -* method - messages.receivedQueue -* params - `{"max_qts": int, }` - - - -### As a user: - -POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.receivedQueue` - -Parameters: - -max_qts - Json encoded int +**You cannot use this method directly** -Or, if you're into Lua: - -``` -Vector_of_long = messages.receivedQueue({max_qts=int, }) -``` - diff --git a/old_docs/API_docs_v33/methods/messages_sendEncrypted.md b/old_docs/API_docs_v33/methods/messages_sendEncrypted.md index 23461760..d48f88d7 100644 --- a/old_docs/API_docs_v33/methods/messages_sendEncrypted.md +++ b/old_docs/API_docs_v33/methods/messages_sendEncrypted.md @@ -1,17 +1,19 @@ --- title: messages.sendEncrypted -description: messages.sendEncrypted parameters, return type and example +description: Send message to secret chat --- ## Method: messages.sendEncrypted [Back to methods index](index.md) +Send message to secret chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the message| +|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v33/methods/messages_sendEncryptedFile.md b/old_docs/API_docs_v33/methods/messages_sendEncryptedFile.md index 64919abe..4fd0648e 100644 --- a/old_docs/API_docs_v33/methods/messages_sendEncryptedFile.md +++ b/old_docs/API_docs_v33/methods/messages_sendEncryptedFile.md @@ -1,18 +1,20 @@ --- title: messages.sendEncryptedFile -description: messages.sendEncryptedFile parameters, return type and example +description: Send a file to a secret chat --- ## Method: messages.sendEncryptedFile [Back to methods index](index.md) +Send a file to a secret chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes| -|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the file| +|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| +|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional|The file (optional)| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v33/methods/messages_sendEncryptedService.md b/old_docs/API_docs_v33/methods/messages_sendEncryptedService.md index 0a0eea8a..d66894bf 100644 --- a/old_docs/API_docs_v33/methods/messages_sendEncryptedService.md +++ b/old_docs/API_docs_v33/methods/messages_sendEncryptedService.md @@ -1,17 +1,19 @@ --- title: messages.sendEncryptedService -description: messages.sendEncryptedService parameters, return type and example +description: Send a service message to a secret chat --- ## Method: messages.sendEncryptedService [Back to methods index](index.md) +Send a service message to a secret chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the service message| +|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v33/methods/messages_setEncryptedTyping.md b/old_docs/API_docs_v33/methods/messages_setEncryptedTyping.md index 3183fedf..e9afe99c 100644 --- a/old_docs/API_docs_v33/methods/messages_setEncryptedTyping.md +++ b/old_docs/API_docs_v33/methods/messages_setEncryptedTyping.md @@ -12,8 +12,8 @@ Send typing notification to secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|| -|typing|[CLICK ME Bool](../types/Bool.md) | Yes|| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to send the notification| +|typing|[CLICK ME Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v33/methods/messages_startBot.md b/old_docs/API_docs_v33/methods/messages_startBot.md index 74f1019a..c52c66df 100644 --- a/old_docs/API_docs_v33/methods/messages_startBot.md +++ b/old_docs/API_docs_v33/methods/messages_startBot.md @@ -1,18 +1,20 @@ --- title: messages.startBot -description: messages.startBot parameters, return type and example +description: Start a bot --- ## Method: messages.startBot [Back to methods index](index.md) +Start a bot + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|start\_param|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot's ID or username| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|| +|start\_param|[CLICK ME string](../types/string.md) | Yes|The bot's start parameter| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v33/methods/messages_uninstallStickerSet.md b/old_docs/API_docs_v33/methods/messages_uninstallStickerSet.md index 60b0ca0c..6d04e847 100644 --- a/old_docs/API_docs_v33/methods/messages_uninstallStickerSet.md +++ b/old_docs/API_docs_v33/methods/messages_uninstallStickerSet.md @@ -1,16 +1,18 @@ --- title: messages.uninstallStickerSet -description: messages.uninstallStickerSet parameters, return type and example +description: Remove a sticker set --- ## Method: messages.uninstallStickerSet [Back to methods index](index.md) +Remove a sticker set + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to remove| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v33/methods/photos_deletePhotos.md b/old_docs/API_docs_v33/methods/photos_deletePhotos.md index 104459b7..b9daca10 100644 --- a/old_docs/API_docs_v33/methods/photos_deletePhotos.md +++ b/old_docs/API_docs_v33/methods/photos_deletePhotos.md @@ -1,16 +1,18 @@ --- title: photos.deletePhotos -description: photos.deletePhotos parameters, return type and example +description: Delete profile photos --- ## Method: photos.deletePhotos [Back to methods index](index.md) +Delete profile photos + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Yes|The profile photos to delete| ### Return type: [Vector\_of\_long](../types/long.md) diff --git a/old_docs/API_docs_v33/methods/photos_getUserPhotos.md b/old_docs/API_docs_v33/methods/photos_getUserPhotos.md index 1a7515ba..ea27a44f 100644 --- a/old_docs/API_docs_v33/methods/photos_getUserPhotos.md +++ b/old_docs/API_docs_v33/methods/photos_getUserPhotos.md @@ -1,19 +1,21 @@ --- title: photos.getUserPhotos -description: photos.getUserPhotos parameters, return type and example +description: Get the profile photos of a user --- ## Method: photos.getUserPhotos [Back to methods index](index.md) +Get the profile photos of a user + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|offset|[CLICK ME int](../types/int.md) | Yes| -|max\_id|[CLICK ME long](../types/long.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| +|offset|[CLICK ME int](../types/int.md) | Yes|Offset| +|max\_id|[CLICK ME long](../types/long.md) | Yes|Maximum ID of photo to return| +|limit|[CLICK ME int](../types/int.md) | Yes|Number of photos to return| ### Return type: [photos\_Photos](../types/photos_Photos.md) diff --git a/old_docs/API_docs_v33/methods/photos_updateProfilePhoto.md b/old_docs/API_docs_v33/methods/photos_updateProfilePhoto.md index 386970d5..dc6edd6b 100644 --- a/old_docs/API_docs_v33/methods/photos_updateProfilePhoto.md +++ b/old_docs/API_docs_v33/methods/photos_updateProfilePhoto.md @@ -1,17 +1,19 @@ --- title: photos.updateProfilePhoto -description: photos.updateProfilePhoto parameters, return type and example +description: Update the profile photo (use photos->uploadProfilePhoto to upload the photo) --- ## Method: photos.updateProfilePhoto [Back to methods index](index.md) +Update the profile photo (use photos->uploadProfilePhoto to upload the photo) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional| -|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional|The photo to use| +|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|| ### Return type: [UserProfilePhoto](../types/UserProfilePhoto.md) diff --git a/old_docs/API_docs_v33/methods/photos_uploadProfilePhoto.md b/old_docs/API_docs_v33/methods/photos_uploadProfilePhoto.md index 07b9936c..fb0bc534 100644 --- a/old_docs/API_docs_v33/methods/photos_uploadProfilePhoto.md +++ b/old_docs/API_docs_v33/methods/photos_uploadProfilePhoto.md @@ -1,19 +1,21 @@ --- title: photos.uploadProfilePhoto -description: photos.uploadProfilePhoto parameters, return type and example +description: Upload profile photo --- ## Method: photos.uploadProfilePhoto [Back to methods index](index.md) +Upload profile photo + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|file|[File path or InputFile](../types/InputFile.md) | Yes| -|caption|[CLICK ME string](../types/string.md) | Yes| -|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional| -|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|file|[File path or InputFile](../types/InputFile.md) | Yes|The photo| +|caption|[CLICK ME string](../types/string.md) | Yes|| +|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional|| +|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|| ### Return type: [photos\_Photo](../types/photos_Photo.md) diff --git a/old_docs/API_docs_v38/methods/account_registerDevice.md b/old_docs/API_docs_v38/methods/account_registerDevice.md index 1752afde..0a40f49c 100644 --- a/old_docs/API_docs_v38/methods/account_registerDevice.md +++ b/old_docs/API_docs_v38/methods/account_registerDevice.md @@ -12,8 +12,8 @@ Register device for push notifications | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and oTher, see source code of official apps for more info| +|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and oTher, see source code of official apps for more info| |device\_model|[CLICK ME string](../types/string.md) | Yes|| |system\_version|[CLICK ME string](../types/string.md) | Yes|| |app\_version|[CLICK ME string](../types/string.md) | Yes|| diff --git a/old_docs/API_docs_v38/methods/account_unregisterDevice.md b/old_docs/API_docs_v38/methods/account_unregisterDevice.md index 1d2b7670..32e44495 100644 --- a/old_docs/API_docs_v38/methods/account_unregisterDevice.md +++ b/old_docs/API_docs_v38/methods/account_unregisterDevice.md @@ -12,8 +12,8 @@ Stop sending PUSH notifications to app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and oTher, see source code of official apps for more info| +|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and oTher, see source code of official apps for more info| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v38/methods/channels_checkUsername.md b/old_docs/API_docs_v38/methods/channels_checkUsername.md index 371f4cd3..7bc7c245 100644 --- a/old_docs/API_docs_v38/methods/channels_checkUsername.md +++ b/old_docs/API_docs_v38/methods/channels_checkUsername.md @@ -1,17 +1,19 @@ --- title: channels.checkUsername -description: channels.checkUsername parameters, return type and example +description: Check if this username is free and can be assigned to a channel/supergroup --- ## Method: channels.checkUsername [Back to methods index](index.md) +Check if this username is free and can be assigned to a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|username|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|username|[CLICK ME string](../types/string.md) | Yes|The new username for this channel/supergroup| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v38/methods/channels_createChannel.md b/old_docs/API_docs_v38/methods/channels_createChannel.md index 0d476166..d4d97b26 100644 --- a/old_docs/API_docs_v38/methods/channels_createChannel.md +++ b/old_docs/API_docs_v38/methods/channels_createChannel.md @@ -1,18 +1,20 @@ --- title: channels.createChannel -description: channels.createChannel parameters, return type and example +description: Create channel/supergroup --- ## Method: channels.createChannel [Back to methods index](index.md) +Create channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|title|[CLICK ME string](../types/string.md) | Yes| -|about|[CLICK ME string](../types/string.md) | Yes| -|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|title|[CLICK ME string](../types/string.md) | Yes|Supergroup/channel title| +|about|[CLICK ME string](../types/string.md) | Yes|About text| +|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v38/methods/channels_deleteChannel.md b/old_docs/API_docs_v38/methods/channels_deleteChannel.md index 61b29eac..e660d25c 100644 --- a/old_docs/API_docs_v38/methods/channels_deleteChannel.md +++ b/old_docs/API_docs_v38/methods/channels_deleteChannel.md @@ -1,16 +1,18 @@ --- title: channels.deleteChannel -description: channels.deleteChannel parameters, return type and example +description: Delete a channel/supergroup --- ## Method: channels.deleteChannel [Back to methods index](index.md) +Delete a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup to delete| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v38/methods/channels_deleteMessages.md b/old_docs/API_docs_v38/methods/channels_deleteMessages.md index 87a968c5..fb9d3cc2 100644 --- a/old_docs/API_docs_v38/methods/channels_deleteMessages.md +++ b/old_docs/API_docs_v38/methods/channels_deleteMessages.md @@ -1,17 +1,19 @@ --- title: channels.deleteMessages -description: channels.deleteMessages parameters, return type and example +description: Delete channel/supergroup messages --- ## Method: channels.deleteMessages [Back to methods index](index.md) +Delete channel/supergroup messages + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|id|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to delete| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v38/methods/channels_deleteUserHistory.md b/old_docs/API_docs_v38/methods/channels_deleteUserHistory.md index ee828f45..fbe34341 100644 --- a/old_docs/API_docs_v38/methods/channels_deleteUserHistory.md +++ b/old_docs/API_docs_v38/methods/channels_deleteUserHistory.md @@ -1,17 +1,19 @@ --- title: channels.deleteUserHistory -description: channels.deleteUserHistory parameters, return type and example +description: Delete all messages of a user in a channel/supergroup --- ## Method: channels.deleteUserHistory [Back to methods index](index.md) +Delete all messages of a user in a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) diff --git a/old_docs/API_docs_v38/methods/channels_editAbout.md b/old_docs/API_docs_v38/methods/channels_editAbout.md index 94be2503..8908f29e 100644 --- a/old_docs/API_docs_v38/methods/channels_editAbout.md +++ b/old_docs/API_docs_v38/methods/channels_editAbout.md @@ -1,17 +1,19 @@ --- title: channels.editAbout -description: channels.editAbout parameters, return type and example +description: Edit the about text of a channel/supergroup --- ## Method: channels.editAbout [Back to methods index](index.md) +Edit the about text of a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|about|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|about|[CLICK ME string](../types/string.md) | Yes|The new about text| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v38/methods/channels_editAdmin.md b/old_docs/API_docs_v38/methods/channels_editAdmin.md index 1ebbbaf7..8546c4b6 100644 --- a/old_docs/API_docs_v38/methods/channels_editAdmin.md +++ b/old_docs/API_docs_v38/methods/channels_editAdmin.md @@ -1,18 +1,20 @@ --- title: channels.editAdmin -description: channels.editAdmin parameters, return type and example +description: Edit admin permissions of a user in a channel/supergroup --- ## Method: channels.editAdmin [Back to methods index](index.md) +Edit admin permissions of a user in a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|role|[CLICK ME ChannelParticipantRole](../types/ChannelParticipantRole.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| +|role|[CLICK ME ChannelParticipantRole](../types/ChannelParticipantRole.md) | Yes|| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v38/methods/channels_editPhoto.md b/old_docs/API_docs_v38/methods/channels_editPhoto.md index 3a2c794b..9ccd864f 100644 --- a/old_docs/API_docs_v38/methods/channels_editPhoto.md +++ b/old_docs/API_docs_v38/methods/channels_editPhoto.md @@ -1,17 +1,19 @@ --- title: channels.editPhoto -description: channels.editPhoto parameters, return type and example +description: Edit the photo of a supergroup/channel --- ## Method: channels.editPhoto [Back to methods index](index.md) +Edit the photo of a supergroup/channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new photo| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v38/methods/channels_editTitle.md b/old_docs/API_docs_v38/methods/channels_editTitle.md index ec60e10f..b1024faf 100644 --- a/old_docs/API_docs_v38/methods/channels_editTitle.md +++ b/old_docs/API_docs_v38/methods/channels_editTitle.md @@ -1,17 +1,19 @@ --- title: channels.editTitle -description: channels.editTitle parameters, return type and example +description: Edit the title of a supergroup/channel --- ## Method: channels.editTitle [Back to methods index](index.md) +Edit the title of a supergroup/channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|title|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|title|[CLICK ME string](../types/string.md) | Yes|The new channel/supergroup title| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v38/methods/channels_exportInvite.md b/old_docs/API_docs_v38/methods/channels_exportInvite.md index 3c10f832..f0c737d5 100644 --- a/old_docs/API_docs_v38/methods/channels_exportInvite.md +++ b/old_docs/API_docs_v38/methods/channels_exportInvite.md @@ -1,16 +1,18 @@ --- title: channels.exportInvite -description: channels.exportInvite parameters, return type and example +description: Export the invite link of a channel --- ## Method: channels.exportInvite [Back to methods index](index.md) +Export the invite link of a channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| ### Return type: [ExportedChatInvite](../types/ExportedChatInvite.md) diff --git a/old_docs/API_docs_v38/methods/channels_getChannels.md b/old_docs/API_docs_v38/methods/channels_getChannels.md index bd5958d6..9cd9e798 100644 --- a/old_docs/API_docs_v38/methods/channels_getChannels.md +++ b/old_docs/API_docs_v38/methods/channels_getChannels.md @@ -1,16 +1,18 @@ --- title: channels.getChannels -description: channels.getChannels parameters, return type and example +description: Get info about multiple channels/supergroups --- ## Method: channels.getChannels [Back to methods index](index.md) +Get info about multiple channels/supergroups + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|Array of [Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|Array of [Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Yes|The channel/supergroup MTProto IDs| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v38/methods/channels_getMessages.md b/old_docs/API_docs_v38/methods/channels_getMessages.md index 4440856c..cc944fe5 100644 --- a/old_docs/API_docs_v38/methods/channels_getMessages.md +++ b/old_docs/API_docs_v38/methods/channels_getMessages.md @@ -1,17 +1,19 @@ --- title: channels.getMessages -description: channels.getMessages parameters, return type and example +description: Get channel/supergroup messages --- ## Method: channels.getMessages [Back to methods index](index.md) +Get channel/supergroup messages + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|id|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The message IDs| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v38/methods/channels_getParticipant.md b/old_docs/API_docs_v38/methods/channels_getParticipant.md index c1819b6b..db9b1fc6 100644 --- a/old_docs/API_docs_v38/methods/channels_getParticipant.md +++ b/old_docs/API_docs_v38/methods/channels_getParticipant.md @@ -1,17 +1,19 @@ --- title: channels.getParticipant -description: channels.getParticipant parameters, return type and example +description: Get info about a certain channel/supergroup participant --- ## Method: channels.getParticipant [Back to methods index](index.md) +Get info about a certain channel/supergroup participant + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to fetch info about| ### Return type: [channels\_ChannelParticipant](../types/channels_ChannelParticipant.md) diff --git a/old_docs/API_docs_v38/methods/channels_getParticipants.md b/old_docs/API_docs_v38/methods/channels_getParticipants.md index 7ec8a980..96662466 100644 --- a/old_docs/API_docs_v38/methods/channels_getParticipants.md +++ b/old_docs/API_docs_v38/methods/channels_getParticipants.md @@ -1,19 +1,21 @@ --- title: channels.getParticipants -description: channels.getParticipants parameters, return type and example +description: Get channel/supergroup participants (you should use `$MadelineProto->get_pwr_chat($id)` instead) --- ## Method: channels.getParticipants [Back to methods index](index.md) +Get channel/supergroup participants (you should use `$MadelineProto->get_pwr_chat($id)` instead) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|filter|[CLICK ME ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) | Yes| -|offset|[CLICK ME int](../types/int.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|filter|[CLICK ME ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) | Yes|Member filter| +|offset|[CLICK ME int](../types/int.md) | Yes|Offset| +|limit|[CLICK ME int](../types/int.md) | Yes|Limit| ### Return type: [channels\_ChannelParticipants](../types/channels_ChannelParticipants.md) diff --git a/old_docs/API_docs_v38/methods/channels_inviteToChannel.md b/old_docs/API_docs_v38/methods/channels_inviteToChannel.md index 9bca2967..676f800c 100644 --- a/old_docs/API_docs_v38/methods/channels_inviteToChannel.md +++ b/old_docs/API_docs_v38/methods/channels_inviteToChannel.md @@ -1,17 +1,19 @@ --- title: channels.inviteToChannel -description: channels.inviteToChannel parameters, return type and example +description: Add users to channel/supergroup --- ## Method: channels.inviteToChannel [Back to methods index](index.md) +Add users to channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to add| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v38/methods/channels_joinChannel.md b/old_docs/API_docs_v38/methods/channels_joinChannel.md index 9ecdbe75..721f707c 100644 --- a/old_docs/API_docs_v38/methods/channels_joinChannel.md +++ b/old_docs/API_docs_v38/methods/channels_joinChannel.md @@ -1,16 +1,18 @@ --- title: channels.joinChannel -description: channels.joinChannel parameters, return type and example +description: Join a channel/supergroup --- ## Method: channels.joinChannel [Back to methods index](index.md) +Join a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup to join| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v38/methods/channels_leaveChannel.md b/old_docs/API_docs_v38/methods/channels_leaveChannel.md index 62c20a00..7f02e08c 100644 --- a/old_docs/API_docs_v38/methods/channels_leaveChannel.md +++ b/old_docs/API_docs_v38/methods/channels_leaveChannel.md @@ -1,16 +1,18 @@ --- title: channels.leaveChannel -description: channels.leaveChannel parameters, return type and example +description: Leave a channel/supergroup --- ## Method: channels.leaveChannel [Back to methods index](index.md) +Leave a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup to leave| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v38/methods/channels_readHistory.md b/old_docs/API_docs_v38/methods/channels_readHistory.md index 745893f6..cca891f0 100644 --- a/old_docs/API_docs_v38/methods/channels_readHistory.md +++ b/old_docs/API_docs_v38/methods/channels_readHistory.md @@ -1,17 +1,19 @@ --- title: channels.readHistory -description: channels.readHistory parameters, return type and example +description: Mark channel/supergroup history as read --- ## Method: channels.readHistory [Back to methods index](index.md) +Mark channel/supergroup history as read + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|max\_id|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to mark as read| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v38/methods/channels_reportSpam.md b/old_docs/API_docs_v38/methods/channels_reportSpam.md index 47dd7cff..09af14e0 100644 --- a/old_docs/API_docs_v38/methods/channels_reportSpam.md +++ b/old_docs/API_docs_v38/methods/channels_reportSpam.md @@ -1,18 +1,20 @@ --- title: channels.reportSpam -description: channels.reportSpam parameters, return type and example +description: Report a supergroup/channel for spam --- ## Method: channels.reportSpam [Back to methods index](index.md) +Report a supergroup/channel for spam + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|id|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that added you to this channel| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to report| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v38/methods/channels_updateUsername.md b/old_docs/API_docs_v38/methods/channels_updateUsername.md index 19647598..ad34490a 100644 --- a/old_docs/API_docs_v38/methods/channels_updateUsername.md +++ b/old_docs/API_docs_v38/methods/channels_updateUsername.md @@ -1,17 +1,19 @@ --- title: channels.updateUsername -description: channels.updateUsername parameters, return type and example +description: Update the username of a supergroup/channel --- ## Method: channels.updateUsername [Back to methods index](index.md) +Update the username of a supergroup/channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|username|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|username|[CLICK ME string](../types/string.md) | Yes|The new username| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v38/methods/contacts_getBlocked.md b/old_docs/API_docs_v38/methods/contacts_getBlocked.md index d7d8c5cc..300025af 100644 --- a/old_docs/API_docs_v38/methods/contacts_getBlocked.md +++ b/old_docs/API_docs_v38/methods/contacts_getBlocked.md @@ -12,7 +12,7 @@ Get blocked users | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, then set to the number of blocked contacts previously fetched| +|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, Then set to the number of blocked contacts previously fetched| |limit|[CLICK ME int](../types/int.md) | Yes|How many blocked contacts to fetch| diff --git a/old_docs/API_docs_v38/methods/help_getAppChangelog.md b/old_docs/API_docs_v38/methods/help_getAppChangelog.md index ec71a905..c8c41f71 100644 --- a/old_docs/API_docs_v38/methods/help_getAppChangelog.md +++ b/old_docs/API_docs_v38/methods/help_getAppChangelog.md @@ -1,19 +1,21 @@ --- title: help.getAppChangelog -description: help.getAppChangelog parameters, return type and example +description: Get the changelog of this app --- ## Method: help.getAppChangelog [Back to methods index](index.md) +Get the changelog of this app + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|device\_model|[CLICK ME string](../types/string.md) | Yes| -|system\_version|[CLICK ME string](../types/string.md) | Yes| -|app\_version|[CLICK ME string](../types/string.md) | Yes| -|lang\_code|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|device\_model|[CLICK ME string](../types/string.md) | Yes|| +|system\_version|[CLICK ME string](../types/string.md) | Yes|| +|app\_version|[CLICK ME string](../types/string.md) | Yes|| +|lang\_code|[CLICK ME string](../types/string.md) | Yes|| ### Return type: [help\_AppChangelog](../types/help_AppChangelog.md) diff --git a/old_docs/API_docs_v38/methods/help_getAppUpdate.md b/old_docs/API_docs_v38/methods/help_getAppUpdate.md index d13d6263..f3eacbd6 100644 --- a/old_docs/API_docs_v38/methods/help_getAppUpdate.md +++ b/old_docs/API_docs_v38/methods/help_getAppUpdate.md @@ -1,19 +1,21 @@ --- title: help.getAppUpdate -description: help.getAppUpdate parameters, return type and example +description: Get info about app updates --- ## Method: help.getAppUpdate [Back to methods index](index.md) +Get info about app updates + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|device\_model|[CLICK ME string](../types/string.md) | Yes| -|system\_version|[CLICK ME string](../types/string.md) | Yes| -|app\_version|[CLICK ME string](../types/string.md) | Yes| -|lang\_code|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|device\_model|[CLICK ME string](../types/string.md) | Yes|| +|system\_version|[CLICK ME string](../types/string.md) | Yes|| +|app\_version|[CLICK ME string](../types/string.md) | Yes|| +|lang\_code|[CLICK ME string](../types/string.md) | Yes|| ### Return type: [help\_AppUpdate](../types/help_AppUpdate.md) diff --git a/old_docs/API_docs_v38/methods/help_getConfig.md b/old_docs/API_docs_v38/methods/help_getConfig.md index 885ad5d3..16e25c68 100644 --- a/old_docs/API_docs_v38/methods/help_getConfig.md +++ b/old_docs/API_docs_v38/methods/help_getConfig.md @@ -1,11 +1,13 @@ --- title: help.getConfig -description: help.getConfig parameters, return type and example +description: Get server configuration --- ## Method: help.getConfig [Back to methods index](index.md) +Get server configuration + ### Return type: [Config](../types/Config.md) diff --git a/old_docs/API_docs_v38/methods/help_getInviteText.md b/old_docs/API_docs_v38/methods/help_getInviteText.md index aeebae28..d9ae8e0d 100644 --- a/old_docs/API_docs_v38/methods/help_getInviteText.md +++ b/old_docs/API_docs_v38/methods/help_getInviteText.md @@ -1,16 +1,18 @@ --- title: help.getInviteText -description: help.getInviteText parameters, return type and example +description: Get invitation text --- ## Method: help.getInviteText [Back to methods index](index.md) +Get invitation text + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|lang\_code|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|lang\_code|[CLICK ME string](../types/string.md) | Yes|| ### Return type: [help\_InviteText](../types/help_InviteText.md) diff --git a/old_docs/API_docs_v38/methods/help_getNearestDc.md b/old_docs/API_docs_v38/methods/help_getNearestDc.md index 6196890b..35a8bf91 100644 --- a/old_docs/API_docs_v38/methods/help_getNearestDc.md +++ b/old_docs/API_docs_v38/methods/help_getNearestDc.md @@ -1,11 +1,13 @@ --- title: help.getNearestDc -description: help.getNearestDc parameters, return type and example +description: Get nearest datacenter --- ## Method: help.getNearestDc [Back to methods index](index.md) +Get nearest datacenter + ### Return type: [NearestDc](../types/NearestDc.md) diff --git a/old_docs/API_docs_v38/methods/help_getSupport.md b/old_docs/API_docs_v38/methods/help_getSupport.md index 9b269f78..a5bab0f2 100644 --- a/old_docs/API_docs_v38/methods/help_getSupport.md +++ b/old_docs/API_docs_v38/methods/help_getSupport.md @@ -1,11 +1,13 @@ --- title: help.getSupport -description: help.getSupport parameters, return type and example +description: Get info of support user --- ## Method: help.getSupport [Back to methods index](index.md) +Get info of support user + ### Return type: [help\_Support](../types/help_Support.md) diff --git a/old_docs/API_docs_v38/methods/help_saveAppLog.md b/old_docs/API_docs_v38/methods/help_saveAppLog.md index af6e94e2..0165b6e3 100644 --- a/old_docs/API_docs_v38/methods/help_saveAppLog.md +++ b/old_docs/API_docs_v38/methods/help_saveAppLog.md @@ -1,16 +1,18 @@ --- title: help.saveAppLog -description: help.saveAppLog parameters, return type and example +description: Log data for developer of this app --- ## Method: help.saveAppLog [Back to methods index](index.md) +Log data for developer of this app + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|events|Array of [CLICK ME InputAppEvent](../types/InputAppEvent.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|events|Array of [CLICK ME InputAppEvent](../types/InputAppEvent.md) | Yes|Event list| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v38/methods/messages_checkChatInvite.md b/old_docs/API_docs_v38/methods/messages_checkChatInvite.md index 4ddf5084..de1d9ff4 100644 --- a/old_docs/API_docs_v38/methods/messages_checkChatInvite.md +++ b/old_docs/API_docs_v38/methods/messages_checkChatInvite.md @@ -1,16 +1,18 @@ --- title: messages.checkChatInvite -description: messages.checkChatInvite parameters, return type and example +description: Check if an invitation link is valid --- ## Method: messages.checkChatInvite [Back to methods index](index.md) +Check if an invitation link is valid + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| ### Return type: [ChatInvite](../types/ChatInvite.md) diff --git a/old_docs/API_docs_v38/methods/messages_deleteChatUser.md b/old_docs/API_docs_v38/methods/messages_deleteChatUser.md index a71f4aaf..0a6830de 100644 --- a/old_docs/API_docs_v38/methods/messages_deleteChatUser.md +++ b/old_docs/API_docs_v38/methods/messages_deleteChatUser.md @@ -12,7 +12,7 @@ Delete a user from a chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The MTProto ID of the chat| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to delete (pass @me to leave the chat)| diff --git a/old_docs/API_docs_v38/methods/messages_editChatPhoto.md b/old_docs/API_docs_v38/methods/messages_editChatPhoto.md index 8848eca7..122913c4 100644 --- a/old_docs/API_docs_v38/methods/messages_editChatPhoto.md +++ b/old_docs/API_docs_v38/methods/messages_editChatPhoto.md @@ -12,7 +12,7 @@ Edit the photo of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The MTProto ID of the chat| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| |photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| diff --git a/old_docs/API_docs_v38/methods/messages_editChatTitle.md b/old_docs/API_docs_v38/methods/messages_editChatTitle.md index 1c1c7a16..3a1e974b 100644 --- a/old_docs/API_docs_v38/methods/messages_editChatTitle.md +++ b/old_docs/API_docs_v38/methods/messages_editChatTitle.md @@ -12,7 +12,7 @@ Edit the title of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The MTProto ID of the chat| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| |title|[CLICK ME string](../types/string.md) | Yes|The new title| diff --git a/old_docs/API_docs_v38/methods/messages_exportChatInvite.md b/old_docs/API_docs_v38/methods/messages_exportChatInvite.md index 74d70c21..98685d96 100644 --- a/old_docs/API_docs_v38/methods/messages_exportChatInvite.md +++ b/old_docs/API_docs_v38/methods/messages_exportChatInvite.md @@ -1,16 +1,18 @@ --- title: messages.exportChatInvite -description: messages.exportChatInvite parameters, return type and example +description: Export chat invite --- ## Method: messages.exportChatInvite [Back to methods index](index.md) +Export chat invite + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat id | ### Return type: [ExportedChatInvite](../types/ExportedChatInvite.md) diff --git a/old_docs/API_docs_v38/methods/messages_getAllStickers.md b/old_docs/API_docs_v38/methods/messages_getAllStickers.md index 5e526f92..0708e15a 100644 --- a/old_docs/API_docs_v38/methods/messages_getAllStickers.md +++ b/old_docs/API_docs_v38/methods/messages_getAllStickers.md @@ -1,16 +1,18 @@ --- title: messages.getAllStickers -description: messages.getAllStickers parameters, return type and example +description: Get all stickerpacks --- ## Method: messages.getAllStickers [Back to methods index](index.md) +Get all stickerpacks + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME string](../types/string.md) | Yes|| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v38/methods/messages_getMessagesViews.md b/old_docs/API_docs_v38/methods/messages_getMessagesViews.md index e3f4e4ea..b8d78c85 100644 --- a/old_docs/API_docs_v38/methods/messages_getMessagesViews.md +++ b/old_docs/API_docs_v38/methods/messages_getMessagesViews.md @@ -1,18 +1,20 @@ --- title: messages.getMessagesViews -description: messages.getMessagesViews parameters, return type and example +description: Get and increase message views --- ## Method: messages.getMessagesViews [Back to methods index](index.md) +Get and increase message views + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|id|Array of [CLICK ME int](../types/int.md) | Yes| -|increment|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the message is located| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs messages to get| +|increment|[CLICK ME Bool](../types/Bool.md) | Yes|Increase message views?| ### Return type: [Vector\_of\_int](../types/int.md) diff --git a/old_docs/API_docs_v38/methods/messages_getStickerSet.md b/old_docs/API_docs_v38/methods/messages_getStickerSet.md index 70bdd9ba..c86807e4 100644 --- a/old_docs/API_docs_v38/methods/messages_getStickerSet.md +++ b/old_docs/API_docs_v38/methods/messages_getStickerSet.md @@ -1,16 +1,18 @@ --- title: messages.getStickerSet -description: messages.getStickerSet parameters, return type and example +description: Get a stickerset --- ## Method: messages.getStickerSet [Back to methods index](index.md) +Get a stickerset + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset to get| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/old_docs/API_docs_v38/methods/messages_getStickers.md b/old_docs/API_docs_v38/methods/messages_getStickers.md index 178b897c..4854696d 100644 --- a/old_docs/API_docs_v38/methods/messages_getStickers.md +++ b/old_docs/API_docs_v38/methods/messages_getStickers.md @@ -1,17 +1,19 @@ --- title: messages.getStickers -description: messages.getStickers parameters, return type and example +description: Get stickers --- ## Method: messages.getStickers [Back to methods index](index.md) +Get stickers + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|emoticon|[CLICK ME string](../types/string.md) | Yes| -|hash|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|emoticon|[CLICK ME string](../types/string.md) | Yes|Search by emoji| +|hash|[CLICK ME string](../types/string.md) | Yes|0 or $MadelineProto->gen_vector_hash(previously fetched sticker IDs)| ### Return type: [messages\_Stickers](../types/messages_Stickers.md) diff --git a/old_docs/API_docs_v38/methods/messages_getWebPagePreview.md b/old_docs/API_docs_v38/methods/messages_getWebPagePreview.md index 35243c9f..d01bdd32 100644 --- a/old_docs/API_docs_v38/methods/messages_getWebPagePreview.md +++ b/old_docs/API_docs_v38/methods/messages_getWebPagePreview.md @@ -1,16 +1,18 @@ --- title: messages.getWebPagePreview -description: messages.getWebPagePreview parameters, return type and example +description: Get webpage preview --- ## Method: messages.getWebPagePreview [Back to methods index](index.md) +Get webpage preview + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|message|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|message|[CLICK ME string](../types/string.md) | Yes|Extract preview from this message| ### Return type: [MessageMedia](../types/MessageMedia.md) diff --git a/old_docs/API_docs_v38/methods/messages_importChatInvite.md b/old_docs/API_docs_v38/methods/messages_importChatInvite.md index 2bea5247..0d6cd7c8 100644 --- a/old_docs/API_docs_v38/methods/messages_importChatInvite.md +++ b/old_docs/API_docs_v38/methods/messages_importChatInvite.md @@ -1,16 +1,18 @@ --- title: messages.importChatInvite -description: messages.importChatInvite parameters, return type and example +description: Import chat invite --- ## Method: messages.importChatInvite [Back to methods index](index.md) +Import chat invite + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v38/methods/messages_installStickerSet.md b/old_docs/API_docs_v38/methods/messages_installStickerSet.md index 857aa738..f620c96a 100644 --- a/old_docs/API_docs_v38/methods/messages_installStickerSet.md +++ b/old_docs/API_docs_v38/methods/messages_installStickerSet.md @@ -1,17 +1,19 @@ --- title: messages.installStickerSet -description: messages.installStickerSet parameters, return type and example +description: Add a sticker set --- ## Method: messages.installStickerSet [Back to methods index](index.md) +Add a sticker set + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional| -|disabled|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to add| +|disabled|[CLICK ME Bool](../types/Bool.md) | Yes|| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v38/methods/messages_readEncryptedHistory.md b/old_docs/API_docs_v38/methods/messages_readEncryptedHistory.md index 4d341809..39b110e3 100644 --- a/old_docs/API_docs_v38/methods/messages_readEncryptedHistory.md +++ b/old_docs/API_docs_v38/methods/messages_readEncryptedHistory.md @@ -1,17 +1,19 @@ --- title: messages.readEncryptedHistory -description: messages.readEncryptedHistory parameters, return type and example +description: Mark messages as read in secret chats --- ## Method: messages.readEncryptedHistory [Back to methods index](index.md) +Mark messages as read in secret chats + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|max\_date|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to mark messages as read| +|max\_date|[CLICK ME int](../types/int.md) | Yes|Maximum date of messages to mark| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v38/methods/messages_readMessageContents.md b/old_docs/API_docs_v38/methods/messages_readMessageContents.md index 0d27c209..9bb1bee8 100644 --- a/old_docs/API_docs_v38/methods/messages_readMessageContents.md +++ b/old_docs/API_docs_v38/methods/messages_readMessageContents.md @@ -1,16 +1,18 @@ --- title: messages.readMessageContents -description: messages.readMessageContents parameters, return type and example +description: Mark message as read --- ## Method: messages.readMessageContents [Back to methods index](index.md) +Mark message as read + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v38/methods/messages_receivedQueue.md b/old_docs/API_docs_v38/methods/messages_receivedQueue.md index c91caa37..4ad78ba2 100644 --- a/old_docs/API_docs_v38/methods/messages_receivedQueue.md +++ b/old_docs/API_docs_v38/methods/messages_receivedQueue.md @@ -1,77 +1,13 @@ --- title: messages.receivedQueue -description: messages.receivedQueue parameters, return type and example +description: You cannot use this method directly --- ## Method: messages.receivedQueue [Back to methods index](index.md) -### Parameters: - -| Name | Type | Required | -|----------|---------------|----------| -|max\_qts|[CLICK ME int](../types/int.md) | Yes| - - -### 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| - - -### MadelineProto Example: - - -``` -if (!file_exists('madeline.php')) { - copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); -} -include 'madeline.php'; - -// !!! This API id/API hash combination will not work !!! -// !!! You must get your own @ my.telegram.org !!! -$api_id = 0; -$api_hash = ''; - -$MadelineProto = new \danog\MadelineProto\API('session.madeline', ['app_info' => ['api_id' => $api_id, 'api_hash' => $api_hash]]); -$MadelineProto->start(); - -$Vector_of_long = $MadelineProto->messages->receivedQueue(['max_qts' => int, ]); -``` - -### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): - -### As a bot: - -POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` - -Parameters: - -* method - messages.receivedQueue -* params - `{"max_qts": int, }` - - - -### As a user: - -POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.receivedQueue` - -Parameters: - -max_qts - Json encoded int +**You cannot use this method directly** -Or, if you're into Lua: - -``` -Vector_of_long = messages.receivedQueue({max_qts=int, }) -``` - diff --git a/old_docs/API_docs_v38/methods/messages_sendEncrypted.md b/old_docs/API_docs_v38/methods/messages_sendEncrypted.md index 23461760..d48f88d7 100644 --- a/old_docs/API_docs_v38/methods/messages_sendEncrypted.md +++ b/old_docs/API_docs_v38/methods/messages_sendEncrypted.md @@ -1,17 +1,19 @@ --- title: messages.sendEncrypted -description: messages.sendEncrypted parameters, return type and example +description: Send message to secret chat --- ## Method: messages.sendEncrypted [Back to methods index](index.md) +Send message to secret chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the message| +|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v38/methods/messages_sendEncryptedFile.md b/old_docs/API_docs_v38/methods/messages_sendEncryptedFile.md index 64919abe..4fd0648e 100644 --- a/old_docs/API_docs_v38/methods/messages_sendEncryptedFile.md +++ b/old_docs/API_docs_v38/methods/messages_sendEncryptedFile.md @@ -1,18 +1,20 @@ --- title: messages.sendEncryptedFile -description: messages.sendEncryptedFile parameters, return type and example +description: Send a file to a secret chat --- ## Method: messages.sendEncryptedFile [Back to methods index](index.md) +Send a file to a secret chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes| -|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the file| +|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| +|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional|The file (optional)| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v38/methods/messages_sendEncryptedService.md b/old_docs/API_docs_v38/methods/messages_sendEncryptedService.md index 0a0eea8a..d66894bf 100644 --- a/old_docs/API_docs_v38/methods/messages_sendEncryptedService.md +++ b/old_docs/API_docs_v38/methods/messages_sendEncryptedService.md @@ -1,17 +1,19 @@ --- title: messages.sendEncryptedService -description: messages.sendEncryptedService parameters, return type and example +description: Send a service message to a secret chat --- ## Method: messages.sendEncryptedService [Back to methods index](index.md) +Send a service message to a secret chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the service message| +|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v38/methods/messages_setEncryptedTyping.md b/old_docs/API_docs_v38/methods/messages_setEncryptedTyping.md index 3183fedf..e9afe99c 100644 --- a/old_docs/API_docs_v38/methods/messages_setEncryptedTyping.md +++ b/old_docs/API_docs_v38/methods/messages_setEncryptedTyping.md @@ -12,8 +12,8 @@ Send typing notification to secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|| -|typing|[CLICK ME Bool](../types/Bool.md) | Yes|| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to send the notification| +|typing|[CLICK ME Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v38/methods/messages_startBot.md b/old_docs/API_docs_v38/methods/messages_startBot.md index 74f1019a..c52c66df 100644 --- a/old_docs/API_docs_v38/methods/messages_startBot.md +++ b/old_docs/API_docs_v38/methods/messages_startBot.md @@ -1,18 +1,20 @@ --- title: messages.startBot -description: messages.startBot parameters, return type and example +description: Start a bot --- ## Method: messages.startBot [Back to methods index](index.md) +Start a bot + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|start\_param|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot's ID or username| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|| +|start\_param|[CLICK ME string](../types/string.md) | Yes|The bot's start parameter| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v38/methods/messages_uninstallStickerSet.md b/old_docs/API_docs_v38/methods/messages_uninstallStickerSet.md index 60b0ca0c..6d04e847 100644 --- a/old_docs/API_docs_v38/methods/messages_uninstallStickerSet.md +++ b/old_docs/API_docs_v38/methods/messages_uninstallStickerSet.md @@ -1,16 +1,18 @@ --- title: messages.uninstallStickerSet -description: messages.uninstallStickerSet parameters, return type and example +description: Remove a sticker set --- ## Method: messages.uninstallStickerSet [Back to methods index](index.md) +Remove a sticker set + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to remove| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v38/methods/photos_deletePhotos.md b/old_docs/API_docs_v38/methods/photos_deletePhotos.md index 104459b7..b9daca10 100644 --- a/old_docs/API_docs_v38/methods/photos_deletePhotos.md +++ b/old_docs/API_docs_v38/methods/photos_deletePhotos.md @@ -1,16 +1,18 @@ --- title: photos.deletePhotos -description: photos.deletePhotos parameters, return type and example +description: Delete profile photos --- ## Method: photos.deletePhotos [Back to methods index](index.md) +Delete profile photos + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Yes|The profile photos to delete| ### Return type: [Vector\_of\_long](../types/long.md) diff --git a/old_docs/API_docs_v38/methods/photos_getUserPhotos.md b/old_docs/API_docs_v38/methods/photos_getUserPhotos.md index 1a7515ba..ea27a44f 100644 --- a/old_docs/API_docs_v38/methods/photos_getUserPhotos.md +++ b/old_docs/API_docs_v38/methods/photos_getUserPhotos.md @@ -1,19 +1,21 @@ --- title: photos.getUserPhotos -description: photos.getUserPhotos parameters, return type and example +description: Get the profile photos of a user --- ## Method: photos.getUserPhotos [Back to methods index](index.md) +Get the profile photos of a user + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|offset|[CLICK ME int](../types/int.md) | Yes| -|max\_id|[CLICK ME long](../types/long.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| +|offset|[CLICK ME int](../types/int.md) | Yes|Offset| +|max\_id|[CLICK ME long](../types/long.md) | Yes|Maximum ID of photo to return| +|limit|[CLICK ME int](../types/int.md) | Yes|Number of photos to return| ### Return type: [photos\_Photos](../types/photos_Photos.md) diff --git a/old_docs/API_docs_v38/methods/photos_updateProfilePhoto.md b/old_docs/API_docs_v38/methods/photos_updateProfilePhoto.md index 386970d5..dc6edd6b 100644 --- a/old_docs/API_docs_v38/methods/photos_updateProfilePhoto.md +++ b/old_docs/API_docs_v38/methods/photos_updateProfilePhoto.md @@ -1,17 +1,19 @@ --- title: photos.updateProfilePhoto -description: photos.updateProfilePhoto parameters, return type and example +description: Update the profile photo (use photos->uploadProfilePhoto to upload the photo) --- ## Method: photos.updateProfilePhoto [Back to methods index](index.md) +Update the profile photo (use photos->uploadProfilePhoto to upload the photo) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional| -|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional|The photo to use| +|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|| ### Return type: [UserProfilePhoto](../types/UserProfilePhoto.md) diff --git a/old_docs/API_docs_v38/methods/photos_uploadProfilePhoto.md b/old_docs/API_docs_v38/methods/photos_uploadProfilePhoto.md index 07b9936c..fb0bc534 100644 --- a/old_docs/API_docs_v38/methods/photos_uploadProfilePhoto.md +++ b/old_docs/API_docs_v38/methods/photos_uploadProfilePhoto.md @@ -1,19 +1,21 @@ --- title: photos.uploadProfilePhoto -description: photos.uploadProfilePhoto parameters, return type and example +description: Upload profile photo --- ## Method: photos.uploadProfilePhoto [Back to methods index](index.md) +Upload profile photo + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|file|[File path or InputFile](../types/InputFile.md) | Yes| -|caption|[CLICK ME string](../types/string.md) | Yes| -|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional| -|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|file|[File path or InputFile](../types/InputFile.md) | Yes|The photo| +|caption|[CLICK ME string](../types/string.md) | Yes|| +|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional|| +|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|| ### Return type: [photos\_Photo](../types/photos_Photo.md) diff --git a/old_docs/API_docs_v40/methods/account_registerDevice.md b/old_docs/API_docs_v40/methods/account_registerDevice.md index 1752afde..0a40f49c 100644 --- a/old_docs/API_docs_v40/methods/account_registerDevice.md +++ b/old_docs/API_docs_v40/methods/account_registerDevice.md @@ -12,8 +12,8 @@ Register device for push notifications | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and oTher, see source code of official apps for more info| +|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and oTher, see source code of official apps for more info| |device\_model|[CLICK ME string](../types/string.md) | Yes|| |system\_version|[CLICK ME string](../types/string.md) | Yes|| |app\_version|[CLICK ME string](../types/string.md) | Yes|| diff --git a/old_docs/API_docs_v40/methods/account_unregisterDevice.md b/old_docs/API_docs_v40/methods/account_unregisterDevice.md index 1d2b7670..32e44495 100644 --- a/old_docs/API_docs_v40/methods/account_unregisterDevice.md +++ b/old_docs/API_docs_v40/methods/account_unregisterDevice.md @@ -12,8 +12,8 @@ Stop sending PUSH notifications to app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and oTher, see source code of official apps for more info| +|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and oTher, see source code of official apps for more info| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v40/methods/contacts_getBlocked.md b/old_docs/API_docs_v40/methods/contacts_getBlocked.md index d7d8c5cc..300025af 100644 --- a/old_docs/API_docs_v40/methods/contacts_getBlocked.md +++ b/old_docs/API_docs_v40/methods/contacts_getBlocked.md @@ -12,7 +12,7 @@ Get blocked users | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, then set to the number of blocked contacts previously fetched| +|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, Then set to the number of blocked contacts previously fetched| |limit|[CLICK ME int](../types/int.md) | Yes|How many blocked contacts to fetch| diff --git a/old_docs/API_docs_v40/methods/help_getAppChangelog.md b/old_docs/API_docs_v40/methods/help_getAppChangelog.md index ec71a905..c8c41f71 100644 --- a/old_docs/API_docs_v40/methods/help_getAppChangelog.md +++ b/old_docs/API_docs_v40/methods/help_getAppChangelog.md @@ -1,19 +1,21 @@ --- title: help.getAppChangelog -description: help.getAppChangelog parameters, return type and example +description: Get the changelog of this app --- ## Method: help.getAppChangelog [Back to methods index](index.md) +Get the changelog of this app + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|device\_model|[CLICK ME string](../types/string.md) | Yes| -|system\_version|[CLICK ME string](../types/string.md) | Yes| -|app\_version|[CLICK ME string](../types/string.md) | Yes| -|lang\_code|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|device\_model|[CLICK ME string](../types/string.md) | Yes|| +|system\_version|[CLICK ME string](../types/string.md) | Yes|| +|app\_version|[CLICK ME string](../types/string.md) | Yes|| +|lang\_code|[CLICK ME string](../types/string.md) | Yes|| ### Return type: [help\_AppChangelog](../types/help_AppChangelog.md) diff --git a/old_docs/API_docs_v40/methods/help_getAppUpdate.md b/old_docs/API_docs_v40/methods/help_getAppUpdate.md index d13d6263..f3eacbd6 100644 --- a/old_docs/API_docs_v40/methods/help_getAppUpdate.md +++ b/old_docs/API_docs_v40/methods/help_getAppUpdate.md @@ -1,19 +1,21 @@ --- title: help.getAppUpdate -description: help.getAppUpdate parameters, return type and example +description: Get info about app updates --- ## Method: help.getAppUpdate [Back to methods index](index.md) +Get info about app updates + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|device\_model|[CLICK ME string](../types/string.md) | Yes| -|system\_version|[CLICK ME string](../types/string.md) | Yes| -|app\_version|[CLICK ME string](../types/string.md) | Yes| -|lang\_code|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|device\_model|[CLICK ME string](../types/string.md) | Yes|| +|system\_version|[CLICK ME string](../types/string.md) | Yes|| +|app\_version|[CLICK ME string](../types/string.md) | Yes|| +|lang\_code|[CLICK ME string](../types/string.md) | Yes|| ### Return type: [help\_AppUpdate](../types/help_AppUpdate.md) diff --git a/old_docs/API_docs_v40/methods/help_getConfig.md b/old_docs/API_docs_v40/methods/help_getConfig.md index 885ad5d3..16e25c68 100644 --- a/old_docs/API_docs_v40/methods/help_getConfig.md +++ b/old_docs/API_docs_v40/methods/help_getConfig.md @@ -1,11 +1,13 @@ --- title: help.getConfig -description: help.getConfig parameters, return type and example +description: Get server configuration --- ## Method: help.getConfig [Back to methods index](index.md) +Get server configuration + ### Return type: [Config](../types/Config.md) diff --git a/old_docs/API_docs_v40/methods/help_getInviteText.md b/old_docs/API_docs_v40/methods/help_getInviteText.md index aeebae28..d9ae8e0d 100644 --- a/old_docs/API_docs_v40/methods/help_getInviteText.md +++ b/old_docs/API_docs_v40/methods/help_getInviteText.md @@ -1,16 +1,18 @@ --- title: help.getInviteText -description: help.getInviteText parameters, return type and example +description: Get invitation text --- ## Method: help.getInviteText [Back to methods index](index.md) +Get invitation text + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|lang\_code|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|lang\_code|[CLICK ME string](../types/string.md) | Yes|| ### Return type: [help\_InviteText](../types/help_InviteText.md) diff --git a/old_docs/API_docs_v40/methods/help_getNearestDc.md b/old_docs/API_docs_v40/methods/help_getNearestDc.md index 6196890b..35a8bf91 100644 --- a/old_docs/API_docs_v40/methods/help_getNearestDc.md +++ b/old_docs/API_docs_v40/methods/help_getNearestDc.md @@ -1,11 +1,13 @@ --- title: help.getNearestDc -description: help.getNearestDc parameters, return type and example +description: Get nearest datacenter --- ## Method: help.getNearestDc [Back to methods index](index.md) +Get nearest datacenter + ### Return type: [NearestDc](../types/NearestDc.md) diff --git a/old_docs/API_docs_v40/methods/help_getSupport.md b/old_docs/API_docs_v40/methods/help_getSupport.md index 9b269f78..a5bab0f2 100644 --- a/old_docs/API_docs_v40/methods/help_getSupport.md +++ b/old_docs/API_docs_v40/methods/help_getSupport.md @@ -1,11 +1,13 @@ --- title: help.getSupport -description: help.getSupport parameters, return type and example +description: Get info of support user --- ## Method: help.getSupport [Back to methods index](index.md) +Get info of support user + ### Return type: [help\_Support](../types/help_Support.md) diff --git a/old_docs/API_docs_v40/methods/help_saveAppLog.md b/old_docs/API_docs_v40/methods/help_saveAppLog.md index af6e94e2..0165b6e3 100644 --- a/old_docs/API_docs_v40/methods/help_saveAppLog.md +++ b/old_docs/API_docs_v40/methods/help_saveAppLog.md @@ -1,16 +1,18 @@ --- title: help.saveAppLog -description: help.saveAppLog parameters, return type and example +description: Log data for developer of this app --- ## Method: help.saveAppLog [Back to methods index](index.md) +Log data for developer of this app + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|events|Array of [CLICK ME InputAppEvent](../types/InputAppEvent.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|events|Array of [CLICK ME InputAppEvent](../types/InputAppEvent.md) | Yes|Event list| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v40/methods/messages_checkChatInvite.md b/old_docs/API_docs_v40/methods/messages_checkChatInvite.md index 4ddf5084..de1d9ff4 100644 --- a/old_docs/API_docs_v40/methods/messages_checkChatInvite.md +++ b/old_docs/API_docs_v40/methods/messages_checkChatInvite.md @@ -1,16 +1,18 @@ --- title: messages.checkChatInvite -description: messages.checkChatInvite parameters, return type and example +description: Check if an invitation link is valid --- ## Method: messages.checkChatInvite [Back to methods index](index.md) +Check if an invitation link is valid + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| ### Return type: [ChatInvite](../types/ChatInvite.md) diff --git a/old_docs/API_docs_v40/methods/messages_deleteChatUser.md b/old_docs/API_docs_v40/methods/messages_deleteChatUser.md index a71f4aaf..0a6830de 100644 --- a/old_docs/API_docs_v40/methods/messages_deleteChatUser.md +++ b/old_docs/API_docs_v40/methods/messages_deleteChatUser.md @@ -12,7 +12,7 @@ Delete a user from a chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The MTProto ID of the chat| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to delete (pass @me to leave the chat)| diff --git a/old_docs/API_docs_v40/methods/messages_editChatPhoto.md b/old_docs/API_docs_v40/methods/messages_editChatPhoto.md index 8848eca7..122913c4 100644 --- a/old_docs/API_docs_v40/methods/messages_editChatPhoto.md +++ b/old_docs/API_docs_v40/methods/messages_editChatPhoto.md @@ -12,7 +12,7 @@ Edit the photo of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The MTProto ID of the chat| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| |photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| diff --git a/old_docs/API_docs_v40/methods/messages_editChatTitle.md b/old_docs/API_docs_v40/methods/messages_editChatTitle.md index 1c1c7a16..3a1e974b 100644 --- a/old_docs/API_docs_v40/methods/messages_editChatTitle.md +++ b/old_docs/API_docs_v40/methods/messages_editChatTitle.md @@ -12,7 +12,7 @@ Edit the title of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The MTProto ID of the chat| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| |title|[CLICK ME string](../types/string.md) | Yes|The new title| diff --git a/old_docs/API_docs_v40/methods/messages_exportChatInvite.md b/old_docs/API_docs_v40/methods/messages_exportChatInvite.md index 74d70c21..98685d96 100644 --- a/old_docs/API_docs_v40/methods/messages_exportChatInvite.md +++ b/old_docs/API_docs_v40/methods/messages_exportChatInvite.md @@ -1,16 +1,18 @@ --- title: messages.exportChatInvite -description: messages.exportChatInvite parameters, return type and example +description: Export chat invite --- ## Method: messages.exportChatInvite [Back to methods index](index.md) +Export chat invite + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat id | ### Return type: [ExportedChatInvite](../types/ExportedChatInvite.md) diff --git a/old_docs/API_docs_v40/methods/messages_getAllStickers.md b/old_docs/API_docs_v40/methods/messages_getAllStickers.md index 5e526f92..0708e15a 100644 --- a/old_docs/API_docs_v40/methods/messages_getAllStickers.md +++ b/old_docs/API_docs_v40/methods/messages_getAllStickers.md @@ -1,16 +1,18 @@ --- title: messages.getAllStickers -description: messages.getAllStickers parameters, return type and example +description: Get all stickerpacks --- ## Method: messages.getAllStickers [Back to methods index](index.md) +Get all stickerpacks + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME string](../types/string.md) | Yes|| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v40/methods/messages_getStickerSet.md b/old_docs/API_docs_v40/methods/messages_getStickerSet.md index 70bdd9ba..c86807e4 100644 --- a/old_docs/API_docs_v40/methods/messages_getStickerSet.md +++ b/old_docs/API_docs_v40/methods/messages_getStickerSet.md @@ -1,16 +1,18 @@ --- title: messages.getStickerSet -description: messages.getStickerSet parameters, return type and example +description: Get a stickerset --- ## Method: messages.getStickerSet [Back to methods index](index.md) +Get a stickerset + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset to get| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/old_docs/API_docs_v40/methods/messages_getStickers.md b/old_docs/API_docs_v40/methods/messages_getStickers.md index 178b897c..4854696d 100644 --- a/old_docs/API_docs_v40/methods/messages_getStickers.md +++ b/old_docs/API_docs_v40/methods/messages_getStickers.md @@ -1,17 +1,19 @@ --- title: messages.getStickers -description: messages.getStickers parameters, return type and example +description: Get stickers --- ## Method: messages.getStickers [Back to methods index](index.md) +Get stickers + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|emoticon|[CLICK ME string](../types/string.md) | Yes| -|hash|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|emoticon|[CLICK ME string](../types/string.md) | Yes|Search by emoji| +|hash|[CLICK ME string](../types/string.md) | Yes|0 or $MadelineProto->gen_vector_hash(previously fetched sticker IDs)| ### Return type: [messages\_Stickers](../types/messages_Stickers.md) diff --git a/old_docs/API_docs_v40/methods/messages_getWebPagePreview.md b/old_docs/API_docs_v40/methods/messages_getWebPagePreview.md index 35243c9f..d01bdd32 100644 --- a/old_docs/API_docs_v40/methods/messages_getWebPagePreview.md +++ b/old_docs/API_docs_v40/methods/messages_getWebPagePreview.md @@ -1,16 +1,18 @@ --- title: messages.getWebPagePreview -description: messages.getWebPagePreview parameters, return type and example +description: Get webpage preview --- ## Method: messages.getWebPagePreview [Back to methods index](index.md) +Get webpage preview + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|message|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|message|[CLICK ME string](../types/string.md) | Yes|Extract preview from this message| ### Return type: [MessageMedia](../types/MessageMedia.md) diff --git a/old_docs/API_docs_v40/methods/messages_importChatInvite.md b/old_docs/API_docs_v40/methods/messages_importChatInvite.md index 2bea5247..0d6cd7c8 100644 --- a/old_docs/API_docs_v40/methods/messages_importChatInvite.md +++ b/old_docs/API_docs_v40/methods/messages_importChatInvite.md @@ -1,16 +1,18 @@ --- title: messages.importChatInvite -description: messages.importChatInvite parameters, return type and example +description: Import chat invite --- ## Method: messages.importChatInvite [Back to methods index](index.md) +Import chat invite + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v40/methods/messages_installStickerSet.md b/old_docs/API_docs_v40/methods/messages_installStickerSet.md index 857aa738..f620c96a 100644 --- a/old_docs/API_docs_v40/methods/messages_installStickerSet.md +++ b/old_docs/API_docs_v40/methods/messages_installStickerSet.md @@ -1,17 +1,19 @@ --- title: messages.installStickerSet -description: messages.installStickerSet parameters, return type and example +description: Add a sticker set --- ## Method: messages.installStickerSet [Back to methods index](index.md) +Add a sticker set + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional| -|disabled|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to add| +|disabled|[CLICK ME Bool](../types/Bool.md) | Yes|| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v40/methods/messages_readEncryptedHistory.md b/old_docs/API_docs_v40/methods/messages_readEncryptedHistory.md index 4d341809..39b110e3 100644 --- a/old_docs/API_docs_v40/methods/messages_readEncryptedHistory.md +++ b/old_docs/API_docs_v40/methods/messages_readEncryptedHistory.md @@ -1,17 +1,19 @@ --- title: messages.readEncryptedHistory -description: messages.readEncryptedHistory parameters, return type and example +description: Mark messages as read in secret chats --- ## Method: messages.readEncryptedHistory [Back to methods index](index.md) +Mark messages as read in secret chats + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|max\_date|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to mark messages as read| +|max\_date|[CLICK ME int](../types/int.md) | Yes|Maximum date of messages to mark| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v40/methods/messages_readMessageContents.md b/old_docs/API_docs_v40/methods/messages_readMessageContents.md index 0d27c209..9bb1bee8 100644 --- a/old_docs/API_docs_v40/methods/messages_readMessageContents.md +++ b/old_docs/API_docs_v40/methods/messages_readMessageContents.md @@ -1,16 +1,18 @@ --- title: messages.readMessageContents -description: messages.readMessageContents parameters, return type and example +description: Mark message as read --- ## Method: messages.readMessageContents [Back to methods index](index.md) +Mark message as read + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v40/methods/messages_receivedQueue.md b/old_docs/API_docs_v40/methods/messages_receivedQueue.md index c91caa37..4ad78ba2 100644 --- a/old_docs/API_docs_v40/methods/messages_receivedQueue.md +++ b/old_docs/API_docs_v40/methods/messages_receivedQueue.md @@ -1,77 +1,13 @@ --- title: messages.receivedQueue -description: messages.receivedQueue parameters, return type and example +description: You cannot use this method directly --- ## Method: messages.receivedQueue [Back to methods index](index.md) -### Parameters: - -| Name | Type | Required | -|----------|---------------|----------| -|max\_qts|[CLICK ME int](../types/int.md) | Yes| - - -### 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| - - -### MadelineProto Example: - - -``` -if (!file_exists('madeline.php')) { - copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); -} -include 'madeline.php'; - -// !!! This API id/API hash combination will not work !!! -// !!! You must get your own @ my.telegram.org !!! -$api_id = 0; -$api_hash = ''; - -$MadelineProto = new \danog\MadelineProto\API('session.madeline', ['app_info' => ['api_id' => $api_id, 'api_hash' => $api_hash]]); -$MadelineProto->start(); - -$Vector_of_long = $MadelineProto->messages->receivedQueue(['max_qts' => int, ]); -``` - -### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): - -### As a bot: - -POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` - -Parameters: - -* method - messages.receivedQueue -* params - `{"max_qts": int, }` - - - -### As a user: - -POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.receivedQueue` - -Parameters: - -max_qts - Json encoded int +**You cannot use this method directly** -Or, if you're into Lua: - -``` -Vector_of_long = messages.receivedQueue({max_qts=int, }) -``` - diff --git a/old_docs/API_docs_v40/methods/messages_sendEncrypted.md b/old_docs/API_docs_v40/methods/messages_sendEncrypted.md index 23461760..d48f88d7 100644 --- a/old_docs/API_docs_v40/methods/messages_sendEncrypted.md +++ b/old_docs/API_docs_v40/methods/messages_sendEncrypted.md @@ -1,17 +1,19 @@ --- title: messages.sendEncrypted -description: messages.sendEncrypted parameters, return type and example +description: Send message to secret chat --- ## Method: messages.sendEncrypted [Back to methods index](index.md) +Send message to secret chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the message| +|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v40/methods/messages_sendEncryptedFile.md b/old_docs/API_docs_v40/methods/messages_sendEncryptedFile.md index 64919abe..4fd0648e 100644 --- a/old_docs/API_docs_v40/methods/messages_sendEncryptedFile.md +++ b/old_docs/API_docs_v40/methods/messages_sendEncryptedFile.md @@ -1,18 +1,20 @@ --- title: messages.sendEncryptedFile -description: messages.sendEncryptedFile parameters, return type and example +description: Send a file to a secret chat --- ## Method: messages.sendEncryptedFile [Back to methods index](index.md) +Send a file to a secret chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes| -|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the file| +|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| +|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional|The file (optional)| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v40/methods/messages_sendEncryptedService.md b/old_docs/API_docs_v40/methods/messages_sendEncryptedService.md index 0a0eea8a..d66894bf 100644 --- a/old_docs/API_docs_v40/methods/messages_sendEncryptedService.md +++ b/old_docs/API_docs_v40/methods/messages_sendEncryptedService.md @@ -1,17 +1,19 @@ --- title: messages.sendEncryptedService -description: messages.sendEncryptedService parameters, return type and example +description: Send a service message to a secret chat --- ## Method: messages.sendEncryptedService [Back to methods index](index.md) +Send a service message to a secret chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the service message| +|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v40/methods/messages_setEncryptedTyping.md b/old_docs/API_docs_v40/methods/messages_setEncryptedTyping.md index 3183fedf..e9afe99c 100644 --- a/old_docs/API_docs_v40/methods/messages_setEncryptedTyping.md +++ b/old_docs/API_docs_v40/methods/messages_setEncryptedTyping.md @@ -12,8 +12,8 @@ Send typing notification to secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|| -|typing|[CLICK ME Bool](../types/Bool.md) | Yes|| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to send the notification| +|typing|[CLICK ME Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v40/methods/messages_startBot.md b/old_docs/API_docs_v40/methods/messages_startBot.md index 74f1019a..c52c66df 100644 --- a/old_docs/API_docs_v40/methods/messages_startBot.md +++ b/old_docs/API_docs_v40/methods/messages_startBot.md @@ -1,18 +1,20 @@ --- title: messages.startBot -description: messages.startBot parameters, return type and example +description: Start a bot --- ## Method: messages.startBot [Back to methods index](index.md) +Start a bot + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|start\_param|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot's ID or username| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|| +|start\_param|[CLICK ME string](../types/string.md) | Yes|The bot's start parameter| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v40/methods/messages_uninstallStickerSet.md b/old_docs/API_docs_v40/methods/messages_uninstallStickerSet.md index 60b0ca0c..6d04e847 100644 --- a/old_docs/API_docs_v40/methods/messages_uninstallStickerSet.md +++ b/old_docs/API_docs_v40/methods/messages_uninstallStickerSet.md @@ -1,16 +1,18 @@ --- title: messages.uninstallStickerSet -description: messages.uninstallStickerSet parameters, return type and example +description: Remove a sticker set --- ## Method: messages.uninstallStickerSet [Back to methods index](index.md) +Remove a sticker set + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to remove| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v40/methods/photos_deletePhotos.md b/old_docs/API_docs_v40/methods/photos_deletePhotos.md index 104459b7..b9daca10 100644 --- a/old_docs/API_docs_v40/methods/photos_deletePhotos.md +++ b/old_docs/API_docs_v40/methods/photos_deletePhotos.md @@ -1,16 +1,18 @@ --- title: photos.deletePhotos -description: photos.deletePhotos parameters, return type and example +description: Delete profile photos --- ## Method: photos.deletePhotos [Back to methods index](index.md) +Delete profile photos + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Yes|The profile photos to delete| ### Return type: [Vector\_of\_long](../types/long.md) diff --git a/old_docs/API_docs_v40/methods/photos_getUserPhotos.md b/old_docs/API_docs_v40/methods/photos_getUserPhotos.md index 1a7515ba..ea27a44f 100644 --- a/old_docs/API_docs_v40/methods/photos_getUserPhotos.md +++ b/old_docs/API_docs_v40/methods/photos_getUserPhotos.md @@ -1,19 +1,21 @@ --- title: photos.getUserPhotos -description: photos.getUserPhotos parameters, return type and example +description: Get the profile photos of a user --- ## Method: photos.getUserPhotos [Back to methods index](index.md) +Get the profile photos of a user + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|offset|[CLICK ME int](../types/int.md) | Yes| -|max\_id|[CLICK ME long](../types/long.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| +|offset|[CLICK ME int](../types/int.md) | Yes|Offset| +|max\_id|[CLICK ME long](../types/long.md) | Yes|Maximum ID of photo to return| +|limit|[CLICK ME int](../types/int.md) | Yes|Number of photos to return| ### Return type: [photos\_Photos](../types/photos_Photos.md) diff --git a/old_docs/API_docs_v40/methods/photos_updateProfilePhoto.md b/old_docs/API_docs_v40/methods/photos_updateProfilePhoto.md index 386970d5..dc6edd6b 100644 --- a/old_docs/API_docs_v40/methods/photos_updateProfilePhoto.md +++ b/old_docs/API_docs_v40/methods/photos_updateProfilePhoto.md @@ -1,17 +1,19 @@ --- title: photos.updateProfilePhoto -description: photos.updateProfilePhoto parameters, return type and example +description: Update the profile photo (use photos->uploadProfilePhoto to upload the photo) --- ## Method: photos.updateProfilePhoto [Back to methods index](index.md) +Update the profile photo (use photos->uploadProfilePhoto to upload the photo) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional| -|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional|The photo to use| +|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|| ### Return type: [UserProfilePhoto](../types/UserProfilePhoto.md) diff --git a/old_docs/API_docs_v40/methods/photos_uploadProfilePhoto.md b/old_docs/API_docs_v40/methods/photos_uploadProfilePhoto.md index 07b9936c..fb0bc534 100644 --- a/old_docs/API_docs_v40/methods/photos_uploadProfilePhoto.md +++ b/old_docs/API_docs_v40/methods/photos_uploadProfilePhoto.md @@ -1,19 +1,21 @@ --- title: photos.uploadProfilePhoto -description: photos.uploadProfilePhoto parameters, return type and example +description: Upload profile photo --- ## Method: photos.uploadProfilePhoto [Back to methods index](index.md) +Upload profile photo + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|file|[File path or InputFile](../types/InputFile.md) | Yes| -|caption|[CLICK ME string](../types/string.md) | Yes| -|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional| -|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|file|[File path or InputFile](../types/InputFile.md) | Yes|The photo| +|caption|[CLICK ME string](../types/string.md) | Yes|| +|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional|| +|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|| ### Return type: [photos\_Photo](../types/photos_Photo.md) diff --git a/old_docs/API_docs_v41/methods/account_registerDevice.md b/old_docs/API_docs_v41/methods/account_registerDevice.md index 1752afde..0a40f49c 100644 --- a/old_docs/API_docs_v41/methods/account_registerDevice.md +++ b/old_docs/API_docs_v41/methods/account_registerDevice.md @@ -12,8 +12,8 @@ Register device for push notifications | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and oTher, see source code of official apps for more info| +|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and oTher, see source code of official apps for more info| |device\_model|[CLICK ME string](../types/string.md) | Yes|| |system\_version|[CLICK ME string](../types/string.md) | Yes|| |app\_version|[CLICK ME string](../types/string.md) | Yes|| diff --git a/old_docs/API_docs_v41/methods/account_unregisterDevice.md b/old_docs/API_docs_v41/methods/account_unregisterDevice.md index 1d2b7670..32e44495 100644 --- a/old_docs/API_docs_v41/methods/account_unregisterDevice.md +++ b/old_docs/API_docs_v41/methods/account_unregisterDevice.md @@ -12,8 +12,8 @@ Stop sending PUSH notifications to app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and oTher, see source code of official apps for more info| +|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and oTher, see source code of official apps for more info| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v41/methods/channels_checkUsername.md b/old_docs/API_docs_v41/methods/channels_checkUsername.md index 371f4cd3..7bc7c245 100644 --- a/old_docs/API_docs_v41/methods/channels_checkUsername.md +++ b/old_docs/API_docs_v41/methods/channels_checkUsername.md @@ -1,17 +1,19 @@ --- title: channels.checkUsername -description: channels.checkUsername parameters, return type and example +description: Check if this username is free and can be assigned to a channel/supergroup --- ## Method: channels.checkUsername [Back to methods index](index.md) +Check if this username is free and can be assigned to a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|username|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|username|[CLICK ME string](../types/string.md) | Yes|The new username for this channel/supergroup| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v41/methods/channels_createChannel.md b/old_docs/API_docs_v41/methods/channels_createChannel.md index c5d21585..1305e4fb 100644 --- a/old_docs/API_docs_v41/methods/channels_createChannel.md +++ b/old_docs/API_docs_v41/methods/channels_createChannel.md @@ -1,19 +1,21 @@ --- title: channels.createChannel -description: channels.createChannel parameters, return type and example +description: Create channel/supergroup --- ## Method: channels.createChannel [Back to methods index](index.md) +Create channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|broadcast|[CLICK ME Bool](../types/Bool.md) | Optional| -|megagroup|[CLICK ME Bool](../types/Bool.md) | Optional| -|title|[CLICK ME string](../types/string.md) | Yes| -|about|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|broadcast|[CLICK ME Bool](../types/Bool.md) | Optional|Set this to true to create a channel| +|megagroup|[CLICK ME Bool](../types/Bool.md) | Optional|Set this to true to create a supergroup| +|title|[CLICK ME string](../types/string.md) | Yes|Supergroup/channel title| +|about|[CLICK ME string](../types/string.md) | Yes|About text| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v41/methods/channels_deleteChannel.md b/old_docs/API_docs_v41/methods/channels_deleteChannel.md index 61b29eac..e660d25c 100644 --- a/old_docs/API_docs_v41/methods/channels_deleteChannel.md +++ b/old_docs/API_docs_v41/methods/channels_deleteChannel.md @@ -1,16 +1,18 @@ --- title: channels.deleteChannel -description: channels.deleteChannel parameters, return type and example +description: Delete a channel/supergroup --- ## Method: channels.deleteChannel [Back to methods index](index.md) +Delete a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup to delete| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v41/methods/channels_deleteMessages.md b/old_docs/API_docs_v41/methods/channels_deleteMessages.md index 87a968c5..fb9d3cc2 100644 --- a/old_docs/API_docs_v41/methods/channels_deleteMessages.md +++ b/old_docs/API_docs_v41/methods/channels_deleteMessages.md @@ -1,17 +1,19 @@ --- title: channels.deleteMessages -description: channels.deleteMessages parameters, return type and example +description: Delete channel/supergroup messages --- ## Method: channels.deleteMessages [Back to methods index](index.md) +Delete channel/supergroup messages + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|id|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to delete| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v41/methods/channels_deleteUserHistory.md b/old_docs/API_docs_v41/methods/channels_deleteUserHistory.md index ee828f45..fbe34341 100644 --- a/old_docs/API_docs_v41/methods/channels_deleteUserHistory.md +++ b/old_docs/API_docs_v41/methods/channels_deleteUserHistory.md @@ -1,17 +1,19 @@ --- title: channels.deleteUserHistory -description: channels.deleteUserHistory parameters, return type and example +description: Delete all messages of a user in a channel/supergroup --- ## Method: channels.deleteUserHistory [Back to methods index](index.md) +Delete all messages of a user in a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) diff --git a/old_docs/API_docs_v41/methods/channels_editAbout.md b/old_docs/API_docs_v41/methods/channels_editAbout.md index 94be2503..8908f29e 100644 --- a/old_docs/API_docs_v41/methods/channels_editAbout.md +++ b/old_docs/API_docs_v41/methods/channels_editAbout.md @@ -1,17 +1,19 @@ --- title: channels.editAbout -description: channels.editAbout parameters, return type and example +description: Edit the about text of a channel/supergroup --- ## Method: channels.editAbout [Back to methods index](index.md) +Edit the about text of a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|about|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|about|[CLICK ME string](../types/string.md) | Yes|The new about text| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v41/methods/channels_editAdmin.md b/old_docs/API_docs_v41/methods/channels_editAdmin.md index 1ebbbaf7..8546c4b6 100644 --- a/old_docs/API_docs_v41/methods/channels_editAdmin.md +++ b/old_docs/API_docs_v41/methods/channels_editAdmin.md @@ -1,18 +1,20 @@ --- title: channels.editAdmin -description: channels.editAdmin parameters, return type and example +description: Edit admin permissions of a user in a channel/supergroup --- ## Method: channels.editAdmin [Back to methods index](index.md) +Edit admin permissions of a user in a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|role|[CLICK ME ChannelParticipantRole](../types/ChannelParticipantRole.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| +|role|[CLICK ME ChannelParticipantRole](../types/ChannelParticipantRole.md) | Yes|| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v41/methods/channels_editPhoto.md b/old_docs/API_docs_v41/methods/channels_editPhoto.md index 3a2c794b..9ccd864f 100644 --- a/old_docs/API_docs_v41/methods/channels_editPhoto.md +++ b/old_docs/API_docs_v41/methods/channels_editPhoto.md @@ -1,17 +1,19 @@ --- title: channels.editPhoto -description: channels.editPhoto parameters, return type and example +description: Edit the photo of a supergroup/channel --- ## Method: channels.editPhoto [Back to methods index](index.md) +Edit the photo of a supergroup/channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new photo| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v41/methods/channels_editTitle.md b/old_docs/API_docs_v41/methods/channels_editTitle.md index ec60e10f..b1024faf 100644 --- a/old_docs/API_docs_v41/methods/channels_editTitle.md +++ b/old_docs/API_docs_v41/methods/channels_editTitle.md @@ -1,17 +1,19 @@ --- title: channels.editTitle -description: channels.editTitle parameters, return type and example +description: Edit the title of a supergroup/channel --- ## Method: channels.editTitle [Back to methods index](index.md) +Edit the title of a supergroup/channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|title|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|title|[CLICK ME string](../types/string.md) | Yes|The new channel/supergroup title| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v41/methods/channels_exportInvite.md b/old_docs/API_docs_v41/methods/channels_exportInvite.md index 3c10f832..f0c737d5 100644 --- a/old_docs/API_docs_v41/methods/channels_exportInvite.md +++ b/old_docs/API_docs_v41/methods/channels_exportInvite.md @@ -1,16 +1,18 @@ --- title: channels.exportInvite -description: channels.exportInvite parameters, return type and example +description: Export the invite link of a channel --- ## Method: channels.exportInvite [Back to methods index](index.md) +Export the invite link of a channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| ### Return type: [ExportedChatInvite](../types/ExportedChatInvite.md) diff --git a/old_docs/API_docs_v41/methods/channels_getChannels.md b/old_docs/API_docs_v41/methods/channels_getChannels.md index bd5958d6..9cd9e798 100644 --- a/old_docs/API_docs_v41/methods/channels_getChannels.md +++ b/old_docs/API_docs_v41/methods/channels_getChannels.md @@ -1,16 +1,18 @@ --- title: channels.getChannels -description: channels.getChannels parameters, return type and example +description: Get info about multiple channels/supergroups --- ## Method: channels.getChannels [Back to methods index](index.md) +Get info about multiple channels/supergroups + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|Array of [Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|Array of [Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Yes|The channel/supergroup MTProto IDs| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v41/methods/channels_getMessages.md b/old_docs/API_docs_v41/methods/channels_getMessages.md index 4440856c..cc944fe5 100644 --- a/old_docs/API_docs_v41/methods/channels_getMessages.md +++ b/old_docs/API_docs_v41/methods/channels_getMessages.md @@ -1,17 +1,19 @@ --- title: channels.getMessages -description: channels.getMessages parameters, return type and example +description: Get channel/supergroup messages --- ## Method: channels.getMessages [Back to methods index](index.md) +Get channel/supergroup messages + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|id|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The message IDs| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v41/methods/channels_getParticipant.md b/old_docs/API_docs_v41/methods/channels_getParticipant.md index c1819b6b..db9b1fc6 100644 --- a/old_docs/API_docs_v41/methods/channels_getParticipant.md +++ b/old_docs/API_docs_v41/methods/channels_getParticipant.md @@ -1,17 +1,19 @@ --- title: channels.getParticipant -description: channels.getParticipant parameters, return type and example +description: Get info about a certain channel/supergroup participant --- ## Method: channels.getParticipant [Back to methods index](index.md) +Get info about a certain channel/supergroup participant + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to fetch info about| ### Return type: [channels\_ChannelParticipant](../types/channels_ChannelParticipant.md) diff --git a/old_docs/API_docs_v41/methods/channels_getParticipants.md b/old_docs/API_docs_v41/methods/channels_getParticipants.md index 7ec8a980..96662466 100644 --- a/old_docs/API_docs_v41/methods/channels_getParticipants.md +++ b/old_docs/API_docs_v41/methods/channels_getParticipants.md @@ -1,19 +1,21 @@ --- title: channels.getParticipants -description: channels.getParticipants parameters, return type and example +description: Get channel/supergroup participants (you should use `$MadelineProto->get_pwr_chat($id)` instead) --- ## Method: channels.getParticipants [Back to methods index](index.md) +Get channel/supergroup participants (you should use `$MadelineProto->get_pwr_chat($id)` instead) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|filter|[CLICK ME ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) | Yes| -|offset|[CLICK ME int](../types/int.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|filter|[CLICK ME ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) | Yes|Member filter| +|offset|[CLICK ME int](../types/int.md) | Yes|Offset| +|limit|[CLICK ME int](../types/int.md) | Yes|Limit| ### Return type: [channels\_ChannelParticipants](../types/channels_ChannelParticipants.md) diff --git a/old_docs/API_docs_v41/methods/channels_inviteToChannel.md b/old_docs/API_docs_v41/methods/channels_inviteToChannel.md index 9bca2967..676f800c 100644 --- a/old_docs/API_docs_v41/methods/channels_inviteToChannel.md +++ b/old_docs/API_docs_v41/methods/channels_inviteToChannel.md @@ -1,17 +1,19 @@ --- title: channels.inviteToChannel -description: channels.inviteToChannel parameters, return type and example +description: Add users to channel/supergroup --- ## Method: channels.inviteToChannel [Back to methods index](index.md) +Add users to channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to add| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v41/methods/channels_joinChannel.md b/old_docs/API_docs_v41/methods/channels_joinChannel.md index 9ecdbe75..721f707c 100644 --- a/old_docs/API_docs_v41/methods/channels_joinChannel.md +++ b/old_docs/API_docs_v41/methods/channels_joinChannel.md @@ -1,16 +1,18 @@ --- title: channels.joinChannel -description: channels.joinChannel parameters, return type and example +description: Join a channel/supergroup --- ## Method: channels.joinChannel [Back to methods index](index.md) +Join a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup to join| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v41/methods/channels_leaveChannel.md b/old_docs/API_docs_v41/methods/channels_leaveChannel.md index 62c20a00..7f02e08c 100644 --- a/old_docs/API_docs_v41/methods/channels_leaveChannel.md +++ b/old_docs/API_docs_v41/methods/channels_leaveChannel.md @@ -1,16 +1,18 @@ --- title: channels.leaveChannel -description: channels.leaveChannel parameters, return type and example +description: Leave a channel/supergroup --- ## Method: channels.leaveChannel [Back to methods index](index.md) +Leave a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup to leave| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v41/methods/channels_readHistory.md b/old_docs/API_docs_v41/methods/channels_readHistory.md index 745893f6..cca891f0 100644 --- a/old_docs/API_docs_v41/methods/channels_readHistory.md +++ b/old_docs/API_docs_v41/methods/channels_readHistory.md @@ -1,17 +1,19 @@ --- title: channels.readHistory -description: channels.readHistory parameters, return type and example +description: Mark channel/supergroup history as read --- ## Method: channels.readHistory [Back to methods index](index.md) +Mark channel/supergroup history as read + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|max\_id|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to mark as read| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v41/methods/channels_reportSpam.md b/old_docs/API_docs_v41/methods/channels_reportSpam.md index 47dd7cff..09af14e0 100644 --- a/old_docs/API_docs_v41/methods/channels_reportSpam.md +++ b/old_docs/API_docs_v41/methods/channels_reportSpam.md @@ -1,18 +1,20 @@ --- title: channels.reportSpam -description: channels.reportSpam parameters, return type and example +description: Report a supergroup/channel for spam --- ## Method: channels.reportSpam [Back to methods index](index.md) +Report a supergroup/channel for spam + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|id|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that added you to this channel| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to report| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v41/methods/channels_updateUsername.md b/old_docs/API_docs_v41/methods/channels_updateUsername.md index 19647598..ad34490a 100644 --- a/old_docs/API_docs_v41/methods/channels_updateUsername.md +++ b/old_docs/API_docs_v41/methods/channels_updateUsername.md @@ -1,17 +1,19 @@ --- title: channels.updateUsername -description: channels.updateUsername parameters, return type and example +description: Update the username of a supergroup/channel --- ## Method: channels.updateUsername [Back to methods index](index.md) +Update the username of a supergroup/channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|username|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|username|[CLICK ME string](../types/string.md) | Yes|The new username| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v41/methods/contacts_getBlocked.md b/old_docs/API_docs_v41/methods/contacts_getBlocked.md index d7d8c5cc..300025af 100644 --- a/old_docs/API_docs_v41/methods/contacts_getBlocked.md +++ b/old_docs/API_docs_v41/methods/contacts_getBlocked.md @@ -12,7 +12,7 @@ Get blocked users | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, then set to the number of blocked contacts previously fetched| +|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, Then set to the number of blocked contacts previously fetched| |limit|[CLICK ME int](../types/int.md) | Yes|How many blocked contacts to fetch| diff --git a/old_docs/API_docs_v41/methods/help_getAppChangelog.md b/old_docs/API_docs_v41/methods/help_getAppChangelog.md index ec71a905..c8c41f71 100644 --- a/old_docs/API_docs_v41/methods/help_getAppChangelog.md +++ b/old_docs/API_docs_v41/methods/help_getAppChangelog.md @@ -1,19 +1,21 @@ --- title: help.getAppChangelog -description: help.getAppChangelog parameters, return type and example +description: Get the changelog of this app --- ## Method: help.getAppChangelog [Back to methods index](index.md) +Get the changelog of this app + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|device\_model|[CLICK ME string](../types/string.md) | Yes| -|system\_version|[CLICK ME string](../types/string.md) | Yes| -|app\_version|[CLICK ME string](../types/string.md) | Yes| -|lang\_code|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|device\_model|[CLICK ME string](../types/string.md) | Yes|| +|system\_version|[CLICK ME string](../types/string.md) | Yes|| +|app\_version|[CLICK ME string](../types/string.md) | Yes|| +|lang\_code|[CLICK ME string](../types/string.md) | Yes|| ### Return type: [help\_AppChangelog](../types/help_AppChangelog.md) diff --git a/old_docs/API_docs_v41/methods/help_getAppUpdate.md b/old_docs/API_docs_v41/methods/help_getAppUpdate.md index d13d6263..f3eacbd6 100644 --- a/old_docs/API_docs_v41/methods/help_getAppUpdate.md +++ b/old_docs/API_docs_v41/methods/help_getAppUpdate.md @@ -1,19 +1,21 @@ --- title: help.getAppUpdate -description: help.getAppUpdate parameters, return type and example +description: Get info about app updates --- ## Method: help.getAppUpdate [Back to methods index](index.md) +Get info about app updates + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|device\_model|[CLICK ME string](../types/string.md) | Yes| -|system\_version|[CLICK ME string](../types/string.md) | Yes| -|app\_version|[CLICK ME string](../types/string.md) | Yes| -|lang\_code|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|device\_model|[CLICK ME string](../types/string.md) | Yes|| +|system\_version|[CLICK ME string](../types/string.md) | Yes|| +|app\_version|[CLICK ME string](../types/string.md) | Yes|| +|lang\_code|[CLICK ME string](../types/string.md) | Yes|| ### Return type: [help\_AppUpdate](../types/help_AppUpdate.md) diff --git a/old_docs/API_docs_v41/methods/help_getConfig.md b/old_docs/API_docs_v41/methods/help_getConfig.md index 885ad5d3..16e25c68 100644 --- a/old_docs/API_docs_v41/methods/help_getConfig.md +++ b/old_docs/API_docs_v41/methods/help_getConfig.md @@ -1,11 +1,13 @@ --- title: help.getConfig -description: help.getConfig parameters, return type and example +description: Get server configuration --- ## Method: help.getConfig [Back to methods index](index.md) +Get server configuration + ### Return type: [Config](../types/Config.md) diff --git a/old_docs/API_docs_v41/methods/help_getInviteText.md b/old_docs/API_docs_v41/methods/help_getInviteText.md index aeebae28..d9ae8e0d 100644 --- a/old_docs/API_docs_v41/methods/help_getInviteText.md +++ b/old_docs/API_docs_v41/methods/help_getInviteText.md @@ -1,16 +1,18 @@ --- title: help.getInviteText -description: help.getInviteText parameters, return type and example +description: Get invitation text --- ## Method: help.getInviteText [Back to methods index](index.md) +Get invitation text + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|lang\_code|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|lang\_code|[CLICK ME string](../types/string.md) | Yes|| ### Return type: [help\_InviteText](../types/help_InviteText.md) diff --git a/old_docs/API_docs_v41/methods/help_getNearestDc.md b/old_docs/API_docs_v41/methods/help_getNearestDc.md index 6196890b..35a8bf91 100644 --- a/old_docs/API_docs_v41/methods/help_getNearestDc.md +++ b/old_docs/API_docs_v41/methods/help_getNearestDc.md @@ -1,11 +1,13 @@ --- title: help.getNearestDc -description: help.getNearestDc parameters, return type and example +description: Get nearest datacenter --- ## Method: help.getNearestDc [Back to methods index](index.md) +Get nearest datacenter + ### Return type: [NearestDc](../types/NearestDc.md) diff --git a/old_docs/API_docs_v41/methods/help_getSupport.md b/old_docs/API_docs_v41/methods/help_getSupport.md index 9b269f78..a5bab0f2 100644 --- a/old_docs/API_docs_v41/methods/help_getSupport.md +++ b/old_docs/API_docs_v41/methods/help_getSupport.md @@ -1,11 +1,13 @@ --- title: help.getSupport -description: help.getSupport parameters, return type and example +description: Get info of support user --- ## Method: help.getSupport [Back to methods index](index.md) +Get info of support user + ### Return type: [help\_Support](../types/help_Support.md) diff --git a/old_docs/API_docs_v41/methods/help_saveAppLog.md b/old_docs/API_docs_v41/methods/help_saveAppLog.md index af6e94e2..0165b6e3 100644 --- a/old_docs/API_docs_v41/methods/help_saveAppLog.md +++ b/old_docs/API_docs_v41/methods/help_saveAppLog.md @@ -1,16 +1,18 @@ --- title: help.saveAppLog -description: help.saveAppLog parameters, return type and example +description: Log data for developer of this app --- ## Method: help.saveAppLog [Back to methods index](index.md) +Log data for developer of this app + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|events|Array of [CLICK ME InputAppEvent](../types/InputAppEvent.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|events|Array of [CLICK ME InputAppEvent](../types/InputAppEvent.md) | Yes|Event list| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v41/methods/messages_checkChatInvite.md b/old_docs/API_docs_v41/methods/messages_checkChatInvite.md index 4ddf5084..de1d9ff4 100644 --- a/old_docs/API_docs_v41/methods/messages_checkChatInvite.md +++ b/old_docs/API_docs_v41/methods/messages_checkChatInvite.md @@ -1,16 +1,18 @@ --- title: messages.checkChatInvite -description: messages.checkChatInvite parameters, return type and example +description: Check if an invitation link is valid --- ## Method: messages.checkChatInvite [Back to methods index](index.md) +Check if an invitation link is valid + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| ### Return type: [ChatInvite](../types/ChatInvite.md) diff --git a/old_docs/API_docs_v41/methods/messages_deleteChatUser.md b/old_docs/API_docs_v41/methods/messages_deleteChatUser.md index a71f4aaf..0a6830de 100644 --- a/old_docs/API_docs_v41/methods/messages_deleteChatUser.md +++ b/old_docs/API_docs_v41/methods/messages_deleteChatUser.md @@ -12,7 +12,7 @@ Delete a user from a chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The MTProto ID of the chat| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to delete (pass @me to leave the chat)| diff --git a/old_docs/API_docs_v41/methods/messages_editChatAdmin.md b/old_docs/API_docs_v41/methods/messages_editChatAdmin.md index 6bc8f9ae..7916f8b1 100644 --- a/old_docs/API_docs_v41/methods/messages_editChatAdmin.md +++ b/old_docs/API_docs_v41/methods/messages_editChatAdmin.md @@ -1,18 +1,20 @@ --- title: messages.editChatAdmin -description: messages.editChatAdmin parameters, return type and example +description: Edit admin permissions --- ## Method: messages.editChatAdmin [Back to methods index](index.md) +Edit admin permissions + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|is\_admin|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat ID (no supergroups)| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user ID| +|is\_admin|[CLICK ME Bool](../types/Bool.md) | Yes|Should the user be admin?| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v41/methods/messages_editChatPhoto.md b/old_docs/API_docs_v41/methods/messages_editChatPhoto.md index 8848eca7..122913c4 100644 --- a/old_docs/API_docs_v41/methods/messages_editChatPhoto.md +++ b/old_docs/API_docs_v41/methods/messages_editChatPhoto.md @@ -12,7 +12,7 @@ Edit the photo of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The MTProto ID of the chat| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| |photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| diff --git a/old_docs/API_docs_v41/methods/messages_editChatTitle.md b/old_docs/API_docs_v41/methods/messages_editChatTitle.md index 1c1c7a16..3a1e974b 100644 --- a/old_docs/API_docs_v41/methods/messages_editChatTitle.md +++ b/old_docs/API_docs_v41/methods/messages_editChatTitle.md @@ -12,7 +12,7 @@ Edit the title of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The MTProto ID of the chat| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| |title|[CLICK ME string](../types/string.md) | Yes|The new title| diff --git a/old_docs/API_docs_v41/methods/messages_exportChatInvite.md b/old_docs/API_docs_v41/methods/messages_exportChatInvite.md index 74d70c21..98685d96 100644 --- a/old_docs/API_docs_v41/methods/messages_exportChatInvite.md +++ b/old_docs/API_docs_v41/methods/messages_exportChatInvite.md @@ -1,16 +1,18 @@ --- title: messages.exportChatInvite -description: messages.exportChatInvite parameters, return type and example +description: Export chat invite --- ## Method: messages.exportChatInvite [Back to methods index](index.md) +Export chat invite + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat id | ### Return type: [ExportedChatInvite](../types/ExportedChatInvite.md) diff --git a/old_docs/API_docs_v41/methods/messages_getAllStickers.md b/old_docs/API_docs_v41/methods/messages_getAllStickers.md index 5e526f92..0708e15a 100644 --- a/old_docs/API_docs_v41/methods/messages_getAllStickers.md +++ b/old_docs/API_docs_v41/methods/messages_getAllStickers.md @@ -1,16 +1,18 @@ --- title: messages.getAllStickers -description: messages.getAllStickers parameters, return type and example +description: Get all stickerpacks --- ## Method: messages.getAllStickers [Back to methods index](index.md) +Get all stickerpacks + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME string](../types/string.md) | Yes|| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v41/methods/messages_getMessagesViews.md b/old_docs/API_docs_v41/methods/messages_getMessagesViews.md index e3f4e4ea..b8d78c85 100644 --- a/old_docs/API_docs_v41/methods/messages_getMessagesViews.md +++ b/old_docs/API_docs_v41/methods/messages_getMessagesViews.md @@ -1,18 +1,20 @@ --- title: messages.getMessagesViews -description: messages.getMessagesViews parameters, return type and example +description: Get and increase message views --- ## Method: messages.getMessagesViews [Back to methods index](index.md) +Get and increase message views + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|id|Array of [CLICK ME int](../types/int.md) | Yes| -|increment|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the message is located| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs messages to get| +|increment|[CLICK ME Bool](../types/Bool.md) | Yes|Increase message views?| ### Return type: [Vector\_of\_int](../types/int.md) diff --git a/old_docs/API_docs_v41/methods/messages_getStickerSet.md b/old_docs/API_docs_v41/methods/messages_getStickerSet.md index 70bdd9ba..c86807e4 100644 --- a/old_docs/API_docs_v41/methods/messages_getStickerSet.md +++ b/old_docs/API_docs_v41/methods/messages_getStickerSet.md @@ -1,16 +1,18 @@ --- title: messages.getStickerSet -description: messages.getStickerSet parameters, return type and example +description: Get a stickerset --- ## Method: messages.getStickerSet [Back to methods index](index.md) +Get a stickerset + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset to get| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/old_docs/API_docs_v41/methods/messages_getStickers.md b/old_docs/API_docs_v41/methods/messages_getStickers.md index 178b897c..4854696d 100644 --- a/old_docs/API_docs_v41/methods/messages_getStickers.md +++ b/old_docs/API_docs_v41/methods/messages_getStickers.md @@ -1,17 +1,19 @@ --- title: messages.getStickers -description: messages.getStickers parameters, return type and example +description: Get stickers --- ## Method: messages.getStickers [Back to methods index](index.md) +Get stickers + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|emoticon|[CLICK ME string](../types/string.md) | Yes| -|hash|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|emoticon|[CLICK ME string](../types/string.md) | Yes|Search by emoji| +|hash|[CLICK ME string](../types/string.md) | Yes|0 or $MadelineProto->gen_vector_hash(previously fetched sticker IDs)| ### Return type: [messages\_Stickers](../types/messages_Stickers.md) diff --git a/old_docs/API_docs_v41/methods/messages_getWebPagePreview.md b/old_docs/API_docs_v41/methods/messages_getWebPagePreview.md index 35243c9f..d01bdd32 100644 --- a/old_docs/API_docs_v41/methods/messages_getWebPagePreview.md +++ b/old_docs/API_docs_v41/methods/messages_getWebPagePreview.md @@ -1,16 +1,18 @@ --- title: messages.getWebPagePreview -description: messages.getWebPagePreview parameters, return type and example +description: Get webpage preview --- ## Method: messages.getWebPagePreview [Back to methods index](index.md) +Get webpage preview + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|message|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|message|[CLICK ME string](../types/string.md) | Yes|Extract preview from this message| ### Return type: [MessageMedia](../types/MessageMedia.md) diff --git a/old_docs/API_docs_v41/methods/messages_importChatInvite.md b/old_docs/API_docs_v41/methods/messages_importChatInvite.md index 2bea5247..0d6cd7c8 100644 --- a/old_docs/API_docs_v41/methods/messages_importChatInvite.md +++ b/old_docs/API_docs_v41/methods/messages_importChatInvite.md @@ -1,16 +1,18 @@ --- title: messages.importChatInvite -description: messages.importChatInvite parameters, return type and example +description: Import chat invite --- ## Method: messages.importChatInvite [Back to methods index](index.md) +Import chat invite + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v41/methods/messages_installStickerSet.md b/old_docs/API_docs_v41/methods/messages_installStickerSet.md index 857aa738..f620c96a 100644 --- a/old_docs/API_docs_v41/methods/messages_installStickerSet.md +++ b/old_docs/API_docs_v41/methods/messages_installStickerSet.md @@ -1,17 +1,19 @@ --- title: messages.installStickerSet -description: messages.installStickerSet parameters, return type and example +description: Add a sticker set --- ## Method: messages.installStickerSet [Back to methods index](index.md) +Add a sticker set + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional| -|disabled|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to add| +|disabled|[CLICK ME Bool](../types/Bool.md) | Yes|| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v41/methods/messages_migrateChat.md b/old_docs/API_docs_v41/methods/messages_migrateChat.md index 5021ad45..db57adfa 100644 --- a/old_docs/API_docs_v41/methods/messages_migrateChat.md +++ b/old_docs/API_docs_v41/methods/messages_migrateChat.md @@ -1,16 +1,18 @@ --- title: messages.migrateChat -description: messages.migrateChat parameters, return type and example +description: Convert chat to supergroup --- ## Method: messages.migrateChat [Back to methods index](index.md) +Convert chat to supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat to convert| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v41/methods/messages_readEncryptedHistory.md b/old_docs/API_docs_v41/methods/messages_readEncryptedHistory.md index 4d341809..39b110e3 100644 --- a/old_docs/API_docs_v41/methods/messages_readEncryptedHistory.md +++ b/old_docs/API_docs_v41/methods/messages_readEncryptedHistory.md @@ -1,17 +1,19 @@ --- title: messages.readEncryptedHistory -description: messages.readEncryptedHistory parameters, return type and example +description: Mark messages as read in secret chats --- ## Method: messages.readEncryptedHistory [Back to methods index](index.md) +Mark messages as read in secret chats + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|max\_date|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to mark messages as read| +|max\_date|[CLICK ME int](../types/int.md) | Yes|Maximum date of messages to mark| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v41/methods/messages_readMessageContents.md b/old_docs/API_docs_v41/methods/messages_readMessageContents.md index 0d27c209..9bb1bee8 100644 --- a/old_docs/API_docs_v41/methods/messages_readMessageContents.md +++ b/old_docs/API_docs_v41/methods/messages_readMessageContents.md @@ -1,16 +1,18 @@ --- title: messages.readMessageContents -description: messages.readMessageContents parameters, return type and example +description: Mark message as read --- ## Method: messages.readMessageContents [Back to methods index](index.md) +Mark message as read + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v41/methods/messages_receivedQueue.md b/old_docs/API_docs_v41/methods/messages_receivedQueue.md index c91caa37..4ad78ba2 100644 --- a/old_docs/API_docs_v41/methods/messages_receivedQueue.md +++ b/old_docs/API_docs_v41/methods/messages_receivedQueue.md @@ -1,77 +1,13 @@ --- title: messages.receivedQueue -description: messages.receivedQueue parameters, return type and example +description: You cannot use this method directly --- ## Method: messages.receivedQueue [Back to methods index](index.md) -### Parameters: - -| Name | Type | Required | -|----------|---------------|----------| -|max\_qts|[CLICK ME int](../types/int.md) | Yes| - - -### 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| - - -### MadelineProto Example: - - -``` -if (!file_exists('madeline.php')) { - copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); -} -include 'madeline.php'; - -// !!! This API id/API hash combination will not work !!! -// !!! You must get your own @ my.telegram.org !!! -$api_id = 0; -$api_hash = ''; - -$MadelineProto = new \danog\MadelineProto\API('session.madeline', ['app_info' => ['api_id' => $api_id, 'api_hash' => $api_hash]]); -$MadelineProto->start(); - -$Vector_of_long = $MadelineProto->messages->receivedQueue(['max_qts' => int, ]); -``` - -### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): - -### As a bot: - -POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` - -Parameters: - -* method - messages.receivedQueue -* params - `{"max_qts": int, }` - - - -### As a user: - -POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.receivedQueue` - -Parameters: - -max_qts - Json encoded int +**You cannot use this method directly** -Or, if you're into Lua: - -``` -Vector_of_long = messages.receivedQueue({max_qts=int, }) -``` - diff --git a/old_docs/API_docs_v41/methods/messages_searchGlobal.md b/old_docs/API_docs_v41/methods/messages_searchGlobal.md index 32ddd175..0edd1e40 100644 --- a/old_docs/API_docs_v41/methods/messages_searchGlobal.md +++ b/old_docs/API_docs_v41/methods/messages_searchGlobal.md @@ -1,20 +1,22 @@ --- title: messages.searchGlobal -description: messages.searchGlobal parameters, return type and example +description: Global message search --- ## Method: messages.searchGlobal [Back to methods index](index.md) +Global message search + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|q|[CLICK ME string](../types/string.md) | Yes| -|offset\_date|[CLICK ME int](../types/int.md) | Yes| -|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|offset\_id|[CLICK ME int](../types/int.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|q|[CLICK ME string](../types/string.md) | Yes|The query| +|offset\_date|[CLICK ME int](../types/int.md) | Yes|0 or the date offset| +|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|0 or the peer offset| +|offset\_id|[CLICK ME int](../types/int.md) | Yes|0 or the message ID offset| +|limit|[CLICK ME int](../types/int.md) | Yes|The number of results to return| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v41/methods/messages_sendEncrypted.md b/old_docs/API_docs_v41/methods/messages_sendEncrypted.md index 23461760..d48f88d7 100644 --- a/old_docs/API_docs_v41/methods/messages_sendEncrypted.md +++ b/old_docs/API_docs_v41/methods/messages_sendEncrypted.md @@ -1,17 +1,19 @@ --- title: messages.sendEncrypted -description: messages.sendEncrypted parameters, return type and example +description: Send message to secret chat --- ## Method: messages.sendEncrypted [Back to methods index](index.md) +Send message to secret chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the message| +|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v41/methods/messages_sendEncryptedFile.md b/old_docs/API_docs_v41/methods/messages_sendEncryptedFile.md index 64919abe..4fd0648e 100644 --- a/old_docs/API_docs_v41/methods/messages_sendEncryptedFile.md +++ b/old_docs/API_docs_v41/methods/messages_sendEncryptedFile.md @@ -1,18 +1,20 @@ --- title: messages.sendEncryptedFile -description: messages.sendEncryptedFile parameters, return type and example +description: Send a file to a secret chat --- ## Method: messages.sendEncryptedFile [Back to methods index](index.md) +Send a file to a secret chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes| -|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the file| +|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| +|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional|The file (optional)| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v41/methods/messages_sendEncryptedService.md b/old_docs/API_docs_v41/methods/messages_sendEncryptedService.md index 0a0eea8a..d66894bf 100644 --- a/old_docs/API_docs_v41/methods/messages_sendEncryptedService.md +++ b/old_docs/API_docs_v41/methods/messages_sendEncryptedService.md @@ -1,17 +1,19 @@ --- title: messages.sendEncryptedService -description: messages.sendEncryptedService parameters, return type and example +description: Send a service message to a secret chat --- ## Method: messages.sendEncryptedService [Back to methods index](index.md) +Send a service message to a secret chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the service message| +|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v41/methods/messages_setEncryptedTyping.md b/old_docs/API_docs_v41/methods/messages_setEncryptedTyping.md index 3183fedf..e9afe99c 100644 --- a/old_docs/API_docs_v41/methods/messages_setEncryptedTyping.md +++ b/old_docs/API_docs_v41/methods/messages_setEncryptedTyping.md @@ -12,8 +12,8 @@ Send typing notification to secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|| -|typing|[CLICK ME Bool](../types/Bool.md) | Yes|| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to send the notification| +|typing|[CLICK ME Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v41/methods/messages_startBot.md b/old_docs/API_docs_v41/methods/messages_startBot.md index 0de0f1a5..94a4d86a 100644 --- a/old_docs/API_docs_v41/methods/messages_startBot.md +++ b/old_docs/API_docs_v41/methods/messages_startBot.md @@ -1,18 +1,20 @@ --- title: messages.startBot -description: messages.startBot parameters, return type and example +description: Start a bot --- ## Method: messages.startBot [Back to methods index](index.md) +Start a bot + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|start\_param|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot's ID or username| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to start the bot (@me or group ID/username)| +|start\_param|[CLICK ME string](../types/string.md) | Yes|The bot's start parameter| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v41/methods/messages_toggleChatAdmins.md b/old_docs/API_docs_v41/methods/messages_toggleChatAdmins.md index d56e5753..ab591fd9 100644 --- a/old_docs/API_docs_v41/methods/messages_toggleChatAdmins.md +++ b/old_docs/API_docs_v41/methods/messages_toggleChatAdmins.md @@ -1,17 +1,19 @@ --- title: messages.toggleChatAdmins -description: messages.toggleChatAdmins parameters, return type and example +description: Enable all users are admins in normal groups (not supergroups) --- ## Method: messages.toggleChatAdmins [Back to methods index](index.md) +Enable all users are admins in normal groups (not supergroups) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Group ID| +|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Enable all users are admins| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v41/methods/messages_uninstallStickerSet.md b/old_docs/API_docs_v41/methods/messages_uninstallStickerSet.md index 60b0ca0c..6d04e847 100644 --- a/old_docs/API_docs_v41/methods/messages_uninstallStickerSet.md +++ b/old_docs/API_docs_v41/methods/messages_uninstallStickerSet.md @@ -1,16 +1,18 @@ --- title: messages.uninstallStickerSet -description: messages.uninstallStickerSet parameters, return type and example +description: Remove a sticker set --- ## Method: messages.uninstallStickerSet [Back to methods index](index.md) +Remove a sticker set + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to remove| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v41/methods/photos_deletePhotos.md b/old_docs/API_docs_v41/methods/photos_deletePhotos.md index 104459b7..b9daca10 100644 --- a/old_docs/API_docs_v41/methods/photos_deletePhotos.md +++ b/old_docs/API_docs_v41/methods/photos_deletePhotos.md @@ -1,16 +1,18 @@ --- title: photos.deletePhotos -description: photos.deletePhotos parameters, return type and example +description: Delete profile photos --- ## Method: photos.deletePhotos [Back to methods index](index.md) +Delete profile photos + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Yes|The profile photos to delete| ### Return type: [Vector\_of\_long](../types/long.md) diff --git a/old_docs/API_docs_v41/methods/photos_getUserPhotos.md b/old_docs/API_docs_v41/methods/photos_getUserPhotos.md index 1a7515ba..ea27a44f 100644 --- a/old_docs/API_docs_v41/methods/photos_getUserPhotos.md +++ b/old_docs/API_docs_v41/methods/photos_getUserPhotos.md @@ -1,19 +1,21 @@ --- title: photos.getUserPhotos -description: photos.getUserPhotos parameters, return type and example +description: Get the profile photos of a user --- ## Method: photos.getUserPhotos [Back to methods index](index.md) +Get the profile photos of a user + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|offset|[CLICK ME int](../types/int.md) | Yes| -|max\_id|[CLICK ME long](../types/long.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| +|offset|[CLICK ME int](../types/int.md) | Yes|Offset| +|max\_id|[CLICK ME long](../types/long.md) | Yes|Maximum ID of photo to return| +|limit|[CLICK ME int](../types/int.md) | Yes|Number of photos to return| ### Return type: [photos\_Photos](../types/photos_Photos.md) diff --git a/old_docs/API_docs_v41/methods/photos_updateProfilePhoto.md b/old_docs/API_docs_v41/methods/photos_updateProfilePhoto.md index 386970d5..dc6edd6b 100644 --- a/old_docs/API_docs_v41/methods/photos_updateProfilePhoto.md +++ b/old_docs/API_docs_v41/methods/photos_updateProfilePhoto.md @@ -1,17 +1,19 @@ --- title: photos.updateProfilePhoto -description: photos.updateProfilePhoto parameters, return type and example +description: Update the profile photo (use photos->uploadProfilePhoto to upload the photo) --- ## Method: photos.updateProfilePhoto [Back to methods index](index.md) +Update the profile photo (use photos->uploadProfilePhoto to upload the photo) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional| -|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional|The photo to use| +|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|| ### Return type: [UserProfilePhoto](../types/UserProfilePhoto.md) diff --git a/old_docs/API_docs_v41/methods/photos_uploadProfilePhoto.md b/old_docs/API_docs_v41/methods/photos_uploadProfilePhoto.md index 07b9936c..fb0bc534 100644 --- a/old_docs/API_docs_v41/methods/photos_uploadProfilePhoto.md +++ b/old_docs/API_docs_v41/methods/photos_uploadProfilePhoto.md @@ -1,19 +1,21 @@ --- title: photos.uploadProfilePhoto -description: photos.uploadProfilePhoto parameters, return type and example +description: Upload profile photo --- ## Method: photos.uploadProfilePhoto [Back to methods index](index.md) +Upload profile photo + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|file|[File path or InputFile](../types/InputFile.md) | Yes| -|caption|[CLICK ME string](../types/string.md) | Yes| -|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional| -|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|file|[File path or InputFile](../types/InputFile.md) | Yes|The photo| +|caption|[CLICK ME string](../types/string.md) | Yes|| +|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional|| +|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|| ### Return type: [photos\_Photo](../types/photos_Photo.md) diff --git a/old_docs/API_docs_v42/methods/account_registerDevice.md b/old_docs/API_docs_v42/methods/account_registerDevice.md index 1752afde..0a40f49c 100644 --- a/old_docs/API_docs_v42/methods/account_registerDevice.md +++ b/old_docs/API_docs_v42/methods/account_registerDevice.md @@ -12,8 +12,8 @@ Register device for push notifications | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and oTher, see source code of official apps for more info| +|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and oTher, see source code of official apps for more info| |device\_model|[CLICK ME string](../types/string.md) | Yes|| |system\_version|[CLICK ME string](../types/string.md) | Yes|| |app\_version|[CLICK ME string](../types/string.md) | Yes|| diff --git a/old_docs/API_docs_v42/methods/account_unregisterDevice.md b/old_docs/API_docs_v42/methods/account_unregisterDevice.md index 1d2b7670..32e44495 100644 --- a/old_docs/API_docs_v42/methods/account_unregisterDevice.md +++ b/old_docs/API_docs_v42/methods/account_unregisterDevice.md @@ -12,8 +12,8 @@ Stop sending PUSH notifications to app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and oTher, see source code of official apps for more info| +|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and oTher, see source code of official apps for more info| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v42/methods/channels_checkUsername.md b/old_docs/API_docs_v42/methods/channels_checkUsername.md index 371f4cd3..7bc7c245 100644 --- a/old_docs/API_docs_v42/methods/channels_checkUsername.md +++ b/old_docs/API_docs_v42/methods/channels_checkUsername.md @@ -1,17 +1,19 @@ --- title: channels.checkUsername -description: channels.checkUsername parameters, return type and example +description: Check if this username is free and can be assigned to a channel/supergroup --- ## Method: channels.checkUsername [Back to methods index](index.md) +Check if this username is free and can be assigned to a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|username|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|username|[CLICK ME string](../types/string.md) | Yes|The new username for this channel/supergroup| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v42/methods/channels_createChannel.md b/old_docs/API_docs_v42/methods/channels_createChannel.md index c5d21585..1305e4fb 100644 --- a/old_docs/API_docs_v42/methods/channels_createChannel.md +++ b/old_docs/API_docs_v42/methods/channels_createChannel.md @@ -1,19 +1,21 @@ --- title: channels.createChannel -description: channels.createChannel parameters, return type and example +description: Create channel/supergroup --- ## Method: channels.createChannel [Back to methods index](index.md) +Create channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|broadcast|[CLICK ME Bool](../types/Bool.md) | Optional| -|megagroup|[CLICK ME Bool](../types/Bool.md) | Optional| -|title|[CLICK ME string](../types/string.md) | Yes| -|about|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|broadcast|[CLICK ME Bool](../types/Bool.md) | Optional|Set this to true to create a channel| +|megagroup|[CLICK ME Bool](../types/Bool.md) | Optional|Set this to true to create a supergroup| +|title|[CLICK ME string](../types/string.md) | Yes|Supergroup/channel title| +|about|[CLICK ME string](../types/string.md) | Yes|About text| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v42/methods/channels_deleteChannel.md b/old_docs/API_docs_v42/methods/channels_deleteChannel.md index 61b29eac..e660d25c 100644 --- a/old_docs/API_docs_v42/methods/channels_deleteChannel.md +++ b/old_docs/API_docs_v42/methods/channels_deleteChannel.md @@ -1,16 +1,18 @@ --- title: channels.deleteChannel -description: channels.deleteChannel parameters, return type and example +description: Delete a channel/supergroup --- ## Method: channels.deleteChannel [Back to methods index](index.md) +Delete a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup to delete| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v42/methods/channels_deleteMessages.md b/old_docs/API_docs_v42/methods/channels_deleteMessages.md index 87a968c5..fb9d3cc2 100644 --- a/old_docs/API_docs_v42/methods/channels_deleteMessages.md +++ b/old_docs/API_docs_v42/methods/channels_deleteMessages.md @@ -1,17 +1,19 @@ --- title: channels.deleteMessages -description: channels.deleteMessages parameters, return type and example +description: Delete channel/supergroup messages --- ## Method: channels.deleteMessages [Back to methods index](index.md) +Delete channel/supergroup messages + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|id|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to delete| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v42/methods/channels_deleteUserHistory.md b/old_docs/API_docs_v42/methods/channels_deleteUserHistory.md index ee828f45..fbe34341 100644 --- a/old_docs/API_docs_v42/methods/channels_deleteUserHistory.md +++ b/old_docs/API_docs_v42/methods/channels_deleteUserHistory.md @@ -1,17 +1,19 @@ --- title: channels.deleteUserHistory -description: channels.deleteUserHistory parameters, return type and example +description: Delete all messages of a user in a channel/supergroup --- ## Method: channels.deleteUserHistory [Back to methods index](index.md) +Delete all messages of a user in a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) diff --git a/old_docs/API_docs_v42/methods/channels_editAbout.md b/old_docs/API_docs_v42/methods/channels_editAbout.md index 94be2503..8908f29e 100644 --- a/old_docs/API_docs_v42/methods/channels_editAbout.md +++ b/old_docs/API_docs_v42/methods/channels_editAbout.md @@ -1,17 +1,19 @@ --- title: channels.editAbout -description: channels.editAbout parameters, return type and example +description: Edit the about text of a channel/supergroup --- ## Method: channels.editAbout [Back to methods index](index.md) +Edit the about text of a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|about|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|about|[CLICK ME string](../types/string.md) | Yes|The new about text| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v42/methods/channels_editAdmin.md b/old_docs/API_docs_v42/methods/channels_editAdmin.md index e1917c89..695c5294 100644 --- a/old_docs/API_docs_v42/methods/channels_editAdmin.md +++ b/old_docs/API_docs_v42/methods/channels_editAdmin.md @@ -1,18 +1,20 @@ --- title: channels.editAdmin -description: channels.editAdmin parameters, return type and example +description: Edit admin permissions of a user in a channel/supergroup --- ## Method: channels.editAdmin [Back to methods index](index.md) +Edit admin permissions of a user in a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|role|[CLICK ME ChannelParticipantRole](../types/ChannelParticipantRole.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| +|role|[CLICK ME ChannelParticipantRole](../types/ChannelParticipantRole.md) | Yes|| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v42/methods/channels_editPhoto.md b/old_docs/API_docs_v42/methods/channels_editPhoto.md index 3a2c794b..9ccd864f 100644 --- a/old_docs/API_docs_v42/methods/channels_editPhoto.md +++ b/old_docs/API_docs_v42/methods/channels_editPhoto.md @@ -1,17 +1,19 @@ --- title: channels.editPhoto -description: channels.editPhoto parameters, return type and example +description: Edit the photo of a supergroup/channel --- ## Method: channels.editPhoto [Back to methods index](index.md) +Edit the photo of a supergroup/channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new photo| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v42/methods/channels_editTitle.md b/old_docs/API_docs_v42/methods/channels_editTitle.md index ec60e10f..b1024faf 100644 --- a/old_docs/API_docs_v42/methods/channels_editTitle.md +++ b/old_docs/API_docs_v42/methods/channels_editTitle.md @@ -1,17 +1,19 @@ --- title: channels.editTitle -description: channels.editTitle parameters, return type and example +description: Edit the title of a supergroup/channel --- ## Method: channels.editTitle [Back to methods index](index.md) +Edit the title of a supergroup/channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|title|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|title|[CLICK ME string](../types/string.md) | Yes|The new channel/supergroup title| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v42/methods/channels_exportInvite.md b/old_docs/API_docs_v42/methods/channels_exportInvite.md index 3c10f832..f0c737d5 100644 --- a/old_docs/API_docs_v42/methods/channels_exportInvite.md +++ b/old_docs/API_docs_v42/methods/channels_exportInvite.md @@ -1,16 +1,18 @@ --- title: channels.exportInvite -description: channels.exportInvite parameters, return type and example +description: Export the invite link of a channel --- ## Method: channels.exportInvite [Back to methods index](index.md) +Export the invite link of a channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| ### Return type: [ExportedChatInvite](../types/ExportedChatInvite.md) diff --git a/old_docs/API_docs_v42/methods/channels_getChannels.md b/old_docs/API_docs_v42/methods/channels_getChannels.md index bd5958d6..9cd9e798 100644 --- a/old_docs/API_docs_v42/methods/channels_getChannels.md +++ b/old_docs/API_docs_v42/methods/channels_getChannels.md @@ -1,16 +1,18 @@ --- title: channels.getChannels -description: channels.getChannels parameters, return type and example +description: Get info about multiple channels/supergroups --- ## Method: channels.getChannels [Back to methods index](index.md) +Get info about multiple channels/supergroups + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|Array of [Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|Array of [Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Yes|The channel/supergroup MTProto IDs| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v42/methods/channels_getMessages.md b/old_docs/API_docs_v42/methods/channels_getMessages.md index 4440856c..cc944fe5 100644 --- a/old_docs/API_docs_v42/methods/channels_getMessages.md +++ b/old_docs/API_docs_v42/methods/channels_getMessages.md @@ -1,17 +1,19 @@ --- title: channels.getMessages -description: channels.getMessages parameters, return type and example +description: Get channel/supergroup messages --- ## Method: channels.getMessages [Back to methods index](index.md) +Get channel/supergroup messages + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|id|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The message IDs| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v42/methods/channels_getParticipant.md b/old_docs/API_docs_v42/methods/channels_getParticipant.md index c1819b6b..db9b1fc6 100644 --- a/old_docs/API_docs_v42/methods/channels_getParticipant.md +++ b/old_docs/API_docs_v42/methods/channels_getParticipant.md @@ -1,17 +1,19 @@ --- title: channels.getParticipant -description: channels.getParticipant parameters, return type and example +description: Get info about a certain channel/supergroup participant --- ## Method: channels.getParticipant [Back to methods index](index.md) +Get info about a certain channel/supergroup participant + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to fetch info about| ### Return type: [channels\_ChannelParticipant](../types/channels_ChannelParticipant.md) diff --git a/old_docs/API_docs_v42/methods/channels_getParticipants.md b/old_docs/API_docs_v42/methods/channels_getParticipants.md index 7ec8a980..96662466 100644 --- a/old_docs/API_docs_v42/methods/channels_getParticipants.md +++ b/old_docs/API_docs_v42/methods/channels_getParticipants.md @@ -1,19 +1,21 @@ --- title: channels.getParticipants -description: channels.getParticipants parameters, return type and example +description: Get channel/supergroup participants (you should use `$MadelineProto->get_pwr_chat($id)` instead) --- ## Method: channels.getParticipants [Back to methods index](index.md) +Get channel/supergroup participants (you should use `$MadelineProto->get_pwr_chat($id)` instead) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|filter|[CLICK ME ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) | Yes| -|offset|[CLICK ME int](../types/int.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|filter|[CLICK ME ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) | Yes|Member filter| +|offset|[CLICK ME int](../types/int.md) | Yes|Offset| +|limit|[CLICK ME int](../types/int.md) | Yes|Limit| ### Return type: [channels\_ChannelParticipants](../types/channels_ChannelParticipants.md) diff --git a/old_docs/API_docs_v42/methods/channels_inviteToChannel.md b/old_docs/API_docs_v42/methods/channels_inviteToChannel.md index 9bca2967..676f800c 100644 --- a/old_docs/API_docs_v42/methods/channels_inviteToChannel.md +++ b/old_docs/API_docs_v42/methods/channels_inviteToChannel.md @@ -1,17 +1,19 @@ --- title: channels.inviteToChannel -description: channels.inviteToChannel parameters, return type and example +description: Add users to channel/supergroup --- ## Method: channels.inviteToChannel [Back to methods index](index.md) +Add users to channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to add| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v42/methods/channels_joinChannel.md b/old_docs/API_docs_v42/methods/channels_joinChannel.md index 9ecdbe75..721f707c 100644 --- a/old_docs/API_docs_v42/methods/channels_joinChannel.md +++ b/old_docs/API_docs_v42/methods/channels_joinChannel.md @@ -1,16 +1,18 @@ --- title: channels.joinChannel -description: channels.joinChannel parameters, return type and example +description: Join a channel/supergroup --- ## Method: channels.joinChannel [Back to methods index](index.md) +Join a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup to join| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v42/methods/channels_leaveChannel.md b/old_docs/API_docs_v42/methods/channels_leaveChannel.md index 62c20a00..7f02e08c 100644 --- a/old_docs/API_docs_v42/methods/channels_leaveChannel.md +++ b/old_docs/API_docs_v42/methods/channels_leaveChannel.md @@ -1,16 +1,18 @@ --- title: channels.leaveChannel -description: channels.leaveChannel parameters, return type and example +description: Leave a channel/supergroup --- ## Method: channels.leaveChannel [Back to methods index](index.md) +Leave a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup to leave| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v42/methods/channels_readHistory.md b/old_docs/API_docs_v42/methods/channels_readHistory.md index 745893f6..cca891f0 100644 --- a/old_docs/API_docs_v42/methods/channels_readHistory.md +++ b/old_docs/API_docs_v42/methods/channels_readHistory.md @@ -1,17 +1,19 @@ --- title: channels.readHistory -description: channels.readHistory parameters, return type and example +description: Mark channel/supergroup history as read --- ## Method: channels.readHistory [Back to methods index](index.md) +Mark channel/supergroup history as read + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|max\_id|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to mark as read| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v42/methods/channels_reportSpam.md b/old_docs/API_docs_v42/methods/channels_reportSpam.md index 47dd7cff..09af14e0 100644 --- a/old_docs/API_docs_v42/methods/channels_reportSpam.md +++ b/old_docs/API_docs_v42/methods/channels_reportSpam.md @@ -1,18 +1,20 @@ --- title: channels.reportSpam -description: channels.reportSpam parameters, return type and example +description: Report a supergroup/channel for spam --- ## Method: channels.reportSpam [Back to methods index](index.md) +Report a supergroup/channel for spam + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|id|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that added you to this channel| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to report| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v42/methods/channels_updateUsername.md b/old_docs/API_docs_v42/methods/channels_updateUsername.md index 19647598..ad34490a 100644 --- a/old_docs/API_docs_v42/methods/channels_updateUsername.md +++ b/old_docs/API_docs_v42/methods/channels_updateUsername.md @@ -1,17 +1,19 @@ --- title: channels.updateUsername -description: channels.updateUsername parameters, return type and example +description: Update the username of a supergroup/channel --- ## Method: channels.updateUsername [Back to methods index](index.md) +Update the username of a supergroup/channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|username|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|username|[CLICK ME string](../types/string.md) | Yes|The new username| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v42/methods/contacts_getBlocked.md b/old_docs/API_docs_v42/methods/contacts_getBlocked.md index d7d8c5cc..300025af 100644 --- a/old_docs/API_docs_v42/methods/contacts_getBlocked.md +++ b/old_docs/API_docs_v42/methods/contacts_getBlocked.md @@ -12,7 +12,7 @@ Get blocked users | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, then set to the number of blocked contacts previously fetched| +|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, Then set to the number of blocked contacts previously fetched| |limit|[CLICK ME int](../types/int.md) | Yes|How many blocked contacts to fetch| diff --git a/old_docs/API_docs_v42/methods/help_getAppChangelog.md b/old_docs/API_docs_v42/methods/help_getAppChangelog.md index ec71a905..c8c41f71 100644 --- a/old_docs/API_docs_v42/methods/help_getAppChangelog.md +++ b/old_docs/API_docs_v42/methods/help_getAppChangelog.md @@ -1,19 +1,21 @@ --- title: help.getAppChangelog -description: help.getAppChangelog parameters, return type and example +description: Get the changelog of this app --- ## Method: help.getAppChangelog [Back to methods index](index.md) +Get the changelog of this app + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|device\_model|[CLICK ME string](../types/string.md) | Yes| -|system\_version|[CLICK ME string](../types/string.md) | Yes| -|app\_version|[CLICK ME string](../types/string.md) | Yes| -|lang\_code|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|device\_model|[CLICK ME string](../types/string.md) | Yes|| +|system\_version|[CLICK ME string](../types/string.md) | Yes|| +|app\_version|[CLICK ME string](../types/string.md) | Yes|| +|lang\_code|[CLICK ME string](../types/string.md) | Yes|| ### Return type: [help\_AppChangelog](../types/help_AppChangelog.md) diff --git a/old_docs/API_docs_v42/methods/help_getAppUpdate.md b/old_docs/API_docs_v42/methods/help_getAppUpdate.md index d13d6263..f3eacbd6 100644 --- a/old_docs/API_docs_v42/methods/help_getAppUpdate.md +++ b/old_docs/API_docs_v42/methods/help_getAppUpdate.md @@ -1,19 +1,21 @@ --- title: help.getAppUpdate -description: help.getAppUpdate parameters, return type and example +description: Get info about app updates --- ## Method: help.getAppUpdate [Back to methods index](index.md) +Get info about app updates + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|device\_model|[CLICK ME string](../types/string.md) | Yes| -|system\_version|[CLICK ME string](../types/string.md) | Yes| -|app\_version|[CLICK ME string](../types/string.md) | Yes| -|lang\_code|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|device\_model|[CLICK ME string](../types/string.md) | Yes|| +|system\_version|[CLICK ME string](../types/string.md) | Yes|| +|app\_version|[CLICK ME string](../types/string.md) | Yes|| +|lang\_code|[CLICK ME string](../types/string.md) | Yes|| ### Return type: [help\_AppUpdate](../types/help_AppUpdate.md) diff --git a/old_docs/API_docs_v42/methods/help_getConfig.md b/old_docs/API_docs_v42/methods/help_getConfig.md index 885ad5d3..16e25c68 100644 --- a/old_docs/API_docs_v42/methods/help_getConfig.md +++ b/old_docs/API_docs_v42/methods/help_getConfig.md @@ -1,11 +1,13 @@ --- title: help.getConfig -description: help.getConfig parameters, return type and example +description: Get server configuration --- ## Method: help.getConfig [Back to methods index](index.md) +Get server configuration + ### Return type: [Config](../types/Config.md) diff --git a/old_docs/API_docs_v42/methods/help_getInviteText.md b/old_docs/API_docs_v42/methods/help_getInviteText.md index aeebae28..d9ae8e0d 100644 --- a/old_docs/API_docs_v42/methods/help_getInviteText.md +++ b/old_docs/API_docs_v42/methods/help_getInviteText.md @@ -1,16 +1,18 @@ --- title: help.getInviteText -description: help.getInviteText parameters, return type and example +description: Get invitation text --- ## Method: help.getInviteText [Back to methods index](index.md) +Get invitation text + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|lang\_code|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|lang\_code|[CLICK ME string](../types/string.md) | Yes|| ### Return type: [help\_InviteText](../types/help_InviteText.md) diff --git a/old_docs/API_docs_v42/methods/help_getNearestDc.md b/old_docs/API_docs_v42/methods/help_getNearestDc.md index 6196890b..35a8bf91 100644 --- a/old_docs/API_docs_v42/methods/help_getNearestDc.md +++ b/old_docs/API_docs_v42/methods/help_getNearestDc.md @@ -1,11 +1,13 @@ --- title: help.getNearestDc -description: help.getNearestDc parameters, return type and example +description: Get nearest datacenter --- ## Method: help.getNearestDc [Back to methods index](index.md) +Get nearest datacenter + ### Return type: [NearestDc](../types/NearestDc.md) diff --git a/old_docs/API_docs_v42/methods/help_getSupport.md b/old_docs/API_docs_v42/methods/help_getSupport.md index 9b269f78..a5bab0f2 100644 --- a/old_docs/API_docs_v42/methods/help_getSupport.md +++ b/old_docs/API_docs_v42/methods/help_getSupport.md @@ -1,11 +1,13 @@ --- title: help.getSupport -description: help.getSupport parameters, return type and example +description: Get info of support user --- ## Method: help.getSupport [Back to methods index](index.md) +Get info of support user + ### Return type: [help\_Support](../types/help_Support.md) diff --git a/old_docs/API_docs_v42/methods/help_saveAppLog.md b/old_docs/API_docs_v42/methods/help_saveAppLog.md index af6e94e2..0165b6e3 100644 --- a/old_docs/API_docs_v42/methods/help_saveAppLog.md +++ b/old_docs/API_docs_v42/methods/help_saveAppLog.md @@ -1,16 +1,18 @@ --- title: help.saveAppLog -description: help.saveAppLog parameters, return type and example +description: Log data for developer of this app --- ## Method: help.saveAppLog [Back to methods index](index.md) +Log data for developer of this app + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|events|Array of [CLICK ME InputAppEvent](../types/InputAppEvent.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|events|Array of [CLICK ME InputAppEvent](../types/InputAppEvent.md) | Yes|Event list| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v42/methods/messages_checkChatInvite.md b/old_docs/API_docs_v42/methods/messages_checkChatInvite.md index 4ddf5084..de1d9ff4 100644 --- a/old_docs/API_docs_v42/methods/messages_checkChatInvite.md +++ b/old_docs/API_docs_v42/methods/messages_checkChatInvite.md @@ -1,16 +1,18 @@ --- title: messages.checkChatInvite -description: messages.checkChatInvite parameters, return type and example +description: Check if an invitation link is valid --- ## Method: messages.checkChatInvite [Back to methods index](index.md) +Check if an invitation link is valid + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| ### Return type: [ChatInvite](../types/ChatInvite.md) diff --git a/old_docs/API_docs_v42/methods/messages_deleteChatUser.md b/old_docs/API_docs_v42/methods/messages_deleteChatUser.md index a71f4aaf..0a6830de 100644 --- a/old_docs/API_docs_v42/methods/messages_deleteChatUser.md +++ b/old_docs/API_docs_v42/methods/messages_deleteChatUser.md @@ -12,7 +12,7 @@ Delete a user from a chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The MTProto ID of the chat| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to delete (pass @me to leave the chat)| diff --git a/old_docs/API_docs_v42/methods/messages_editChatAdmin.md b/old_docs/API_docs_v42/methods/messages_editChatAdmin.md index 6bc8f9ae..7916f8b1 100644 --- a/old_docs/API_docs_v42/methods/messages_editChatAdmin.md +++ b/old_docs/API_docs_v42/methods/messages_editChatAdmin.md @@ -1,18 +1,20 @@ --- title: messages.editChatAdmin -description: messages.editChatAdmin parameters, return type and example +description: Edit admin permissions --- ## Method: messages.editChatAdmin [Back to methods index](index.md) +Edit admin permissions + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|is\_admin|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat ID (no supergroups)| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user ID| +|is\_admin|[CLICK ME Bool](../types/Bool.md) | Yes|Should the user be admin?| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v42/methods/messages_editChatPhoto.md b/old_docs/API_docs_v42/methods/messages_editChatPhoto.md index 8848eca7..122913c4 100644 --- a/old_docs/API_docs_v42/methods/messages_editChatPhoto.md +++ b/old_docs/API_docs_v42/methods/messages_editChatPhoto.md @@ -12,7 +12,7 @@ Edit the photo of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The MTProto ID of the chat| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| |photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| diff --git a/old_docs/API_docs_v42/methods/messages_editChatTitle.md b/old_docs/API_docs_v42/methods/messages_editChatTitle.md index 1c1c7a16..3a1e974b 100644 --- a/old_docs/API_docs_v42/methods/messages_editChatTitle.md +++ b/old_docs/API_docs_v42/methods/messages_editChatTitle.md @@ -12,7 +12,7 @@ Edit the title of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The MTProto ID of the chat| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| |title|[CLICK ME string](../types/string.md) | Yes|The new title| diff --git a/old_docs/API_docs_v42/methods/messages_exportChatInvite.md b/old_docs/API_docs_v42/methods/messages_exportChatInvite.md index 74d70c21..98685d96 100644 --- a/old_docs/API_docs_v42/methods/messages_exportChatInvite.md +++ b/old_docs/API_docs_v42/methods/messages_exportChatInvite.md @@ -1,16 +1,18 @@ --- title: messages.exportChatInvite -description: messages.exportChatInvite parameters, return type and example +description: Export chat invite --- ## Method: messages.exportChatInvite [Back to methods index](index.md) +Export chat invite + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat id | ### Return type: [ExportedChatInvite](../types/ExportedChatInvite.md) diff --git a/old_docs/API_docs_v42/methods/messages_getAllStickers.md b/old_docs/API_docs_v42/methods/messages_getAllStickers.md index 5e526f92..0708e15a 100644 --- a/old_docs/API_docs_v42/methods/messages_getAllStickers.md +++ b/old_docs/API_docs_v42/methods/messages_getAllStickers.md @@ -1,16 +1,18 @@ --- title: messages.getAllStickers -description: messages.getAllStickers parameters, return type and example +description: Get all stickerpacks --- ## Method: messages.getAllStickers [Back to methods index](index.md) +Get all stickerpacks + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME string](../types/string.md) | Yes|| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v42/methods/messages_getMessagesViews.md b/old_docs/API_docs_v42/methods/messages_getMessagesViews.md index e3f4e4ea..b8d78c85 100644 --- a/old_docs/API_docs_v42/methods/messages_getMessagesViews.md +++ b/old_docs/API_docs_v42/methods/messages_getMessagesViews.md @@ -1,18 +1,20 @@ --- title: messages.getMessagesViews -description: messages.getMessagesViews parameters, return type and example +description: Get and increase message views --- ## Method: messages.getMessagesViews [Back to methods index](index.md) +Get and increase message views + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|id|Array of [CLICK ME int](../types/int.md) | Yes| -|increment|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the message is located| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs messages to get| +|increment|[CLICK ME Bool](../types/Bool.md) | Yes|Increase message views?| ### Return type: [Vector\_of\_int](../types/int.md) diff --git a/old_docs/API_docs_v42/methods/messages_getStickerSet.md b/old_docs/API_docs_v42/methods/messages_getStickerSet.md index 70bdd9ba..c86807e4 100644 --- a/old_docs/API_docs_v42/methods/messages_getStickerSet.md +++ b/old_docs/API_docs_v42/methods/messages_getStickerSet.md @@ -1,16 +1,18 @@ --- title: messages.getStickerSet -description: messages.getStickerSet parameters, return type and example +description: Get a stickerset --- ## Method: messages.getStickerSet [Back to methods index](index.md) +Get a stickerset + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset to get| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/old_docs/API_docs_v42/methods/messages_getStickers.md b/old_docs/API_docs_v42/methods/messages_getStickers.md index 178b897c..4854696d 100644 --- a/old_docs/API_docs_v42/methods/messages_getStickers.md +++ b/old_docs/API_docs_v42/methods/messages_getStickers.md @@ -1,17 +1,19 @@ --- title: messages.getStickers -description: messages.getStickers parameters, return type and example +description: Get stickers --- ## Method: messages.getStickers [Back to methods index](index.md) +Get stickers + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|emoticon|[CLICK ME string](../types/string.md) | Yes| -|hash|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|emoticon|[CLICK ME string](../types/string.md) | Yes|Search by emoji| +|hash|[CLICK ME string](../types/string.md) | Yes|0 or $MadelineProto->gen_vector_hash(previously fetched sticker IDs)| ### Return type: [messages\_Stickers](../types/messages_Stickers.md) diff --git a/old_docs/API_docs_v42/methods/messages_getWebPagePreview.md b/old_docs/API_docs_v42/methods/messages_getWebPagePreview.md index 35243c9f..d01bdd32 100644 --- a/old_docs/API_docs_v42/methods/messages_getWebPagePreview.md +++ b/old_docs/API_docs_v42/methods/messages_getWebPagePreview.md @@ -1,16 +1,18 @@ --- title: messages.getWebPagePreview -description: messages.getWebPagePreview parameters, return type and example +description: Get webpage preview --- ## Method: messages.getWebPagePreview [Back to methods index](index.md) +Get webpage preview + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|message|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|message|[CLICK ME string](../types/string.md) | Yes|Extract preview from this message| ### Return type: [MessageMedia](../types/MessageMedia.md) diff --git a/old_docs/API_docs_v42/methods/messages_importChatInvite.md b/old_docs/API_docs_v42/methods/messages_importChatInvite.md index 2bea5247..0d6cd7c8 100644 --- a/old_docs/API_docs_v42/methods/messages_importChatInvite.md +++ b/old_docs/API_docs_v42/methods/messages_importChatInvite.md @@ -1,16 +1,18 @@ --- title: messages.importChatInvite -description: messages.importChatInvite parameters, return type and example +description: Import chat invite --- ## Method: messages.importChatInvite [Back to methods index](index.md) +Import chat invite + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v42/methods/messages_installStickerSet.md b/old_docs/API_docs_v42/methods/messages_installStickerSet.md index 857aa738..f620c96a 100644 --- a/old_docs/API_docs_v42/methods/messages_installStickerSet.md +++ b/old_docs/API_docs_v42/methods/messages_installStickerSet.md @@ -1,17 +1,19 @@ --- title: messages.installStickerSet -description: messages.installStickerSet parameters, return type and example +description: Add a sticker set --- ## Method: messages.installStickerSet [Back to methods index](index.md) +Add a sticker set + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional| -|disabled|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to add| +|disabled|[CLICK ME Bool](../types/Bool.md) | Yes|| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v42/methods/messages_migrateChat.md b/old_docs/API_docs_v42/methods/messages_migrateChat.md index 5021ad45..db57adfa 100644 --- a/old_docs/API_docs_v42/methods/messages_migrateChat.md +++ b/old_docs/API_docs_v42/methods/messages_migrateChat.md @@ -1,16 +1,18 @@ --- title: messages.migrateChat -description: messages.migrateChat parameters, return type and example +description: Convert chat to supergroup --- ## Method: messages.migrateChat [Back to methods index](index.md) +Convert chat to supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat to convert| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v42/methods/messages_readEncryptedHistory.md b/old_docs/API_docs_v42/methods/messages_readEncryptedHistory.md index 4d341809..39b110e3 100644 --- a/old_docs/API_docs_v42/methods/messages_readEncryptedHistory.md +++ b/old_docs/API_docs_v42/methods/messages_readEncryptedHistory.md @@ -1,17 +1,19 @@ --- title: messages.readEncryptedHistory -description: messages.readEncryptedHistory parameters, return type and example +description: Mark messages as read in secret chats --- ## Method: messages.readEncryptedHistory [Back to methods index](index.md) +Mark messages as read in secret chats + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|max\_date|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to mark messages as read| +|max\_date|[CLICK ME int](../types/int.md) | Yes|Maximum date of messages to mark| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v42/methods/messages_readMessageContents.md b/old_docs/API_docs_v42/methods/messages_readMessageContents.md index 0d27c209..9bb1bee8 100644 --- a/old_docs/API_docs_v42/methods/messages_readMessageContents.md +++ b/old_docs/API_docs_v42/methods/messages_readMessageContents.md @@ -1,16 +1,18 @@ --- title: messages.readMessageContents -description: messages.readMessageContents parameters, return type and example +description: Mark message as read --- ## Method: messages.readMessageContents [Back to methods index](index.md) +Mark message as read + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v42/methods/messages_receivedQueue.md b/old_docs/API_docs_v42/methods/messages_receivedQueue.md index c91caa37..4ad78ba2 100644 --- a/old_docs/API_docs_v42/methods/messages_receivedQueue.md +++ b/old_docs/API_docs_v42/methods/messages_receivedQueue.md @@ -1,77 +1,13 @@ --- title: messages.receivedQueue -description: messages.receivedQueue parameters, return type and example +description: You cannot use this method directly --- ## Method: messages.receivedQueue [Back to methods index](index.md) -### Parameters: - -| Name | Type | Required | -|----------|---------------|----------| -|max\_qts|[CLICK ME int](../types/int.md) | Yes| - - -### 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| - - -### MadelineProto Example: - - -``` -if (!file_exists('madeline.php')) { - copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); -} -include 'madeline.php'; - -// !!! This API id/API hash combination will not work !!! -// !!! You must get your own @ my.telegram.org !!! -$api_id = 0; -$api_hash = ''; - -$MadelineProto = new \danog\MadelineProto\API('session.madeline', ['app_info' => ['api_id' => $api_id, 'api_hash' => $api_hash]]); -$MadelineProto->start(); - -$Vector_of_long = $MadelineProto->messages->receivedQueue(['max_qts' => int, ]); -``` - -### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): - -### As a bot: - -POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` - -Parameters: - -* method - messages.receivedQueue -* params - `{"max_qts": int, }` - - - -### As a user: - -POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.receivedQueue` - -Parameters: - -max_qts - Json encoded int +**You cannot use this method directly** -Or, if you're into Lua: - -``` -Vector_of_long = messages.receivedQueue({max_qts=int, }) -``` - diff --git a/old_docs/API_docs_v42/methods/messages_searchGlobal.md b/old_docs/API_docs_v42/methods/messages_searchGlobal.md index 32ddd175..0edd1e40 100644 --- a/old_docs/API_docs_v42/methods/messages_searchGlobal.md +++ b/old_docs/API_docs_v42/methods/messages_searchGlobal.md @@ -1,20 +1,22 @@ --- title: messages.searchGlobal -description: messages.searchGlobal parameters, return type and example +description: Global message search --- ## Method: messages.searchGlobal [Back to methods index](index.md) +Global message search + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|q|[CLICK ME string](../types/string.md) | Yes| -|offset\_date|[CLICK ME int](../types/int.md) | Yes| -|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|offset\_id|[CLICK ME int](../types/int.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|q|[CLICK ME string](../types/string.md) | Yes|The query| +|offset\_date|[CLICK ME int](../types/int.md) | Yes|0 or the date offset| +|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|0 or the peer offset| +|offset\_id|[CLICK ME int](../types/int.md) | Yes|0 or the message ID offset| +|limit|[CLICK ME int](../types/int.md) | Yes|The number of results to return| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v42/methods/messages_sendEncrypted.md b/old_docs/API_docs_v42/methods/messages_sendEncrypted.md index 23461760..d48f88d7 100644 --- a/old_docs/API_docs_v42/methods/messages_sendEncrypted.md +++ b/old_docs/API_docs_v42/methods/messages_sendEncrypted.md @@ -1,17 +1,19 @@ --- title: messages.sendEncrypted -description: messages.sendEncrypted parameters, return type and example +description: Send message to secret chat --- ## Method: messages.sendEncrypted [Back to methods index](index.md) +Send message to secret chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the message| +|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v42/methods/messages_sendEncryptedFile.md b/old_docs/API_docs_v42/methods/messages_sendEncryptedFile.md index 64919abe..4fd0648e 100644 --- a/old_docs/API_docs_v42/methods/messages_sendEncryptedFile.md +++ b/old_docs/API_docs_v42/methods/messages_sendEncryptedFile.md @@ -1,18 +1,20 @@ --- title: messages.sendEncryptedFile -description: messages.sendEncryptedFile parameters, return type and example +description: Send a file to a secret chat --- ## Method: messages.sendEncryptedFile [Back to methods index](index.md) +Send a file to a secret chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes| -|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the file| +|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| +|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional|The file (optional)| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v42/methods/messages_sendEncryptedService.md b/old_docs/API_docs_v42/methods/messages_sendEncryptedService.md index 0a0eea8a..d66894bf 100644 --- a/old_docs/API_docs_v42/methods/messages_sendEncryptedService.md +++ b/old_docs/API_docs_v42/methods/messages_sendEncryptedService.md @@ -1,17 +1,19 @@ --- title: messages.sendEncryptedService -description: messages.sendEncryptedService parameters, return type and example +description: Send a service message to a secret chat --- ## Method: messages.sendEncryptedService [Back to methods index](index.md) +Send a service message to a secret chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the service message| +|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v42/methods/messages_setEncryptedTyping.md b/old_docs/API_docs_v42/methods/messages_setEncryptedTyping.md index 3183fedf..e9afe99c 100644 --- a/old_docs/API_docs_v42/methods/messages_setEncryptedTyping.md +++ b/old_docs/API_docs_v42/methods/messages_setEncryptedTyping.md @@ -12,8 +12,8 @@ Send typing notification to secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|| -|typing|[CLICK ME Bool](../types/Bool.md) | Yes|| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to send the notification| +|typing|[CLICK ME Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v42/methods/messages_startBot.md b/old_docs/API_docs_v42/methods/messages_startBot.md index 0de0f1a5..94a4d86a 100644 --- a/old_docs/API_docs_v42/methods/messages_startBot.md +++ b/old_docs/API_docs_v42/methods/messages_startBot.md @@ -1,18 +1,20 @@ --- title: messages.startBot -description: messages.startBot parameters, return type and example +description: Start a bot --- ## Method: messages.startBot [Back to methods index](index.md) +Start a bot + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|start\_param|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot's ID or username| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to start the bot (@me or group ID/username)| +|start\_param|[CLICK ME string](../types/string.md) | Yes|The bot's start parameter| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v42/methods/messages_toggleChatAdmins.md b/old_docs/API_docs_v42/methods/messages_toggleChatAdmins.md index d56e5753..ab591fd9 100644 --- a/old_docs/API_docs_v42/methods/messages_toggleChatAdmins.md +++ b/old_docs/API_docs_v42/methods/messages_toggleChatAdmins.md @@ -1,17 +1,19 @@ --- title: messages.toggleChatAdmins -description: messages.toggleChatAdmins parameters, return type and example +description: Enable all users are admins in normal groups (not supergroups) --- ## Method: messages.toggleChatAdmins [Back to methods index](index.md) +Enable all users are admins in normal groups (not supergroups) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Group ID| +|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Enable all users are admins| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v42/methods/messages_uninstallStickerSet.md b/old_docs/API_docs_v42/methods/messages_uninstallStickerSet.md index 60b0ca0c..6d04e847 100644 --- a/old_docs/API_docs_v42/methods/messages_uninstallStickerSet.md +++ b/old_docs/API_docs_v42/methods/messages_uninstallStickerSet.md @@ -1,16 +1,18 @@ --- title: messages.uninstallStickerSet -description: messages.uninstallStickerSet parameters, return type and example +description: Remove a sticker set --- ## Method: messages.uninstallStickerSet [Back to methods index](index.md) +Remove a sticker set + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to remove| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v42/methods/photos_deletePhotos.md b/old_docs/API_docs_v42/methods/photos_deletePhotos.md index 104459b7..b9daca10 100644 --- a/old_docs/API_docs_v42/methods/photos_deletePhotos.md +++ b/old_docs/API_docs_v42/methods/photos_deletePhotos.md @@ -1,16 +1,18 @@ --- title: photos.deletePhotos -description: photos.deletePhotos parameters, return type and example +description: Delete profile photos --- ## Method: photos.deletePhotos [Back to methods index](index.md) +Delete profile photos + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Yes|The profile photos to delete| ### Return type: [Vector\_of\_long](../types/long.md) diff --git a/old_docs/API_docs_v42/methods/photos_getUserPhotos.md b/old_docs/API_docs_v42/methods/photos_getUserPhotos.md index 1a7515ba..ea27a44f 100644 --- a/old_docs/API_docs_v42/methods/photos_getUserPhotos.md +++ b/old_docs/API_docs_v42/methods/photos_getUserPhotos.md @@ -1,19 +1,21 @@ --- title: photos.getUserPhotos -description: photos.getUserPhotos parameters, return type and example +description: Get the profile photos of a user --- ## Method: photos.getUserPhotos [Back to methods index](index.md) +Get the profile photos of a user + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|offset|[CLICK ME int](../types/int.md) | Yes| -|max\_id|[CLICK ME long](../types/long.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| +|offset|[CLICK ME int](../types/int.md) | Yes|Offset| +|max\_id|[CLICK ME long](../types/long.md) | Yes|Maximum ID of photo to return| +|limit|[CLICK ME int](../types/int.md) | Yes|Number of photos to return| ### Return type: [photos\_Photos](../types/photos_Photos.md) diff --git a/old_docs/API_docs_v42/methods/photos_updateProfilePhoto.md b/old_docs/API_docs_v42/methods/photos_updateProfilePhoto.md index 386970d5..dc6edd6b 100644 --- a/old_docs/API_docs_v42/methods/photos_updateProfilePhoto.md +++ b/old_docs/API_docs_v42/methods/photos_updateProfilePhoto.md @@ -1,17 +1,19 @@ --- title: photos.updateProfilePhoto -description: photos.updateProfilePhoto parameters, return type and example +description: Update the profile photo (use photos->uploadProfilePhoto to upload the photo) --- ## Method: photos.updateProfilePhoto [Back to methods index](index.md) +Update the profile photo (use photos->uploadProfilePhoto to upload the photo) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional| -|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional|The photo to use| +|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|| ### Return type: [UserProfilePhoto](../types/UserProfilePhoto.md) diff --git a/old_docs/API_docs_v42/methods/photos_uploadProfilePhoto.md b/old_docs/API_docs_v42/methods/photos_uploadProfilePhoto.md index 07b9936c..fb0bc534 100644 --- a/old_docs/API_docs_v42/methods/photos_uploadProfilePhoto.md +++ b/old_docs/API_docs_v42/methods/photos_uploadProfilePhoto.md @@ -1,19 +1,21 @@ --- title: photos.uploadProfilePhoto -description: photos.uploadProfilePhoto parameters, return type and example +description: Upload profile photo --- ## Method: photos.uploadProfilePhoto [Back to methods index](index.md) +Upload profile photo + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|file|[File path or InputFile](../types/InputFile.md) | Yes| -|caption|[CLICK ME string](../types/string.md) | Yes| -|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional| -|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|file|[File path or InputFile](../types/InputFile.md) | Yes|The photo| +|caption|[CLICK ME string](../types/string.md) | Yes|| +|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional|| +|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|| ### Return type: [photos\_Photo](../types/photos_Photo.md) diff --git a/old_docs/API_docs_v44/methods/account_registerDevice.md b/old_docs/API_docs_v44/methods/account_registerDevice.md index 1752afde..0a40f49c 100644 --- a/old_docs/API_docs_v44/methods/account_registerDevice.md +++ b/old_docs/API_docs_v44/methods/account_registerDevice.md @@ -12,8 +12,8 @@ Register device for push notifications | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and oTher, see source code of official apps for more info| +|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and oTher, see source code of official apps for more info| |device\_model|[CLICK ME string](../types/string.md) | Yes|| |system\_version|[CLICK ME string](../types/string.md) | Yes|| |app\_version|[CLICK ME string](../types/string.md) | Yes|| diff --git a/old_docs/API_docs_v44/methods/account_unregisterDevice.md b/old_docs/API_docs_v44/methods/account_unregisterDevice.md index 1d2b7670..32e44495 100644 --- a/old_docs/API_docs_v44/methods/account_unregisterDevice.md +++ b/old_docs/API_docs_v44/methods/account_unregisterDevice.md @@ -12,8 +12,8 @@ Stop sending PUSH notifications to app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and oTher, see source code of official apps for more info| +|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and oTher, see source code of official apps for more info| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v44/methods/channels_checkUsername.md b/old_docs/API_docs_v44/methods/channels_checkUsername.md index 371f4cd3..7bc7c245 100644 --- a/old_docs/API_docs_v44/methods/channels_checkUsername.md +++ b/old_docs/API_docs_v44/methods/channels_checkUsername.md @@ -1,17 +1,19 @@ --- title: channels.checkUsername -description: channels.checkUsername parameters, return type and example +description: Check if this username is free and can be assigned to a channel/supergroup --- ## Method: channels.checkUsername [Back to methods index](index.md) +Check if this username is free and can be assigned to a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|username|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|username|[CLICK ME string](../types/string.md) | Yes|The new username for this channel/supergroup| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v44/methods/channels_createChannel.md b/old_docs/API_docs_v44/methods/channels_createChannel.md index c5d21585..1305e4fb 100644 --- a/old_docs/API_docs_v44/methods/channels_createChannel.md +++ b/old_docs/API_docs_v44/methods/channels_createChannel.md @@ -1,19 +1,21 @@ --- title: channels.createChannel -description: channels.createChannel parameters, return type and example +description: Create channel/supergroup --- ## Method: channels.createChannel [Back to methods index](index.md) +Create channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|broadcast|[CLICK ME Bool](../types/Bool.md) | Optional| -|megagroup|[CLICK ME Bool](../types/Bool.md) | Optional| -|title|[CLICK ME string](../types/string.md) | Yes| -|about|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|broadcast|[CLICK ME Bool](../types/Bool.md) | Optional|Set this to true to create a channel| +|megagroup|[CLICK ME Bool](../types/Bool.md) | Optional|Set this to true to create a supergroup| +|title|[CLICK ME string](../types/string.md) | Yes|Supergroup/channel title| +|about|[CLICK ME string](../types/string.md) | Yes|About text| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v44/methods/channels_deleteChannel.md b/old_docs/API_docs_v44/methods/channels_deleteChannel.md index 61b29eac..e660d25c 100644 --- a/old_docs/API_docs_v44/methods/channels_deleteChannel.md +++ b/old_docs/API_docs_v44/methods/channels_deleteChannel.md @@ -1,16 +1,18 @@ --- title: channels.deleteChannel -description: channels.deleteChannel parameters, return type and example +description: Delete a channel/supergroup --- ## Method: channels.deleteChannel [Back to methods index](index.md) +Delete a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup to delete| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v44/methods/channels_deleteMessages.md b/old_docs/API_docs_v44/methods/channels_deleteMessages.md index 87a968c5..fb9d3cc2 100644 --- a/old_docs/API_docs_v44/methods/channels_deleteMessages.md +++ b/old_docs/API_docs_v44/methods/channels_deleteMessages.md @@ -1,17 +1,19 @@ --- title: channels.deleteMessages -description: channels.deleteMessages parameters, return type and example +description: Delete channel/supergroup messages --- ## Method: channels.deleteMessages [Back to methods index](index.md) +Delete channel/supergroup messages + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|id|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to delete| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v44/methods/channels_deleteUserHistory.md b/old_docs/API_docs_v44/methods/channels_deleteUserHistory.md index ee828f45..fbe34341 100644 --- a/old_docs/API_docs_v44/methods/channels_deleteUserHistory.md +++ b/old_docs/API_docs_v44/methods/channels_deleteUserHistory.md @@ -1,17 +1,19 @@ --- title: channels.deleteUserHistory -description: channels.deleteUserHistory parameters, return type and example +description: Delete all messages of a user in a channel/supergroup --- ## Method: channels.deleteUserHistory [Back to methods index](index.md) +Delete all messages of a user in a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) diff --git a/old_docs/API_docs_v44/methods/channels_editAbout.md b/old_docs/API_docs_v44/methods/channels_editAbout.md index 94be2503..8908f29e 100644 --- a/old_docs/API_docs_v44/methods/channels_editAbout.md +++ b/old_docs/API_docs_v44/methods/channels_editAbout.md @@ -1,17 +1,19 @@ --- title: channels.editAbout -description: channels.editAbout parameters, return type and example +description: Edit the about text of a channel/supergroup --- ## Method: channels.editAbout [Back to methods index](index.md) +Edit the about text of a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|about|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|about|[CLICK ME string](../types/string.md) | Yes|The new about text| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v44/methods/channels_editAdmin.md b/old_docs/API_docs_v44/methods/channels_editAdmin.md index e1917c89..695c5294 100644 --- a/old_docs/API_docs_v44/methods/channels_editAdmin.md +++ b/old_docs/API_docs_v44/methods/channels_editAdmin.md @@ -1,18 +1,20 @@ --- title: channels.editAdmin -description: channels.editAdmin parameters, return type and example +description: Edit admin permissions of a user in a channel/supergroup --- ## Method: channels.editAdmin [Back to methods index](index.md) +Edit admin permissions of a user in a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|role|[CLICK ME ChannelParticipantRole](../types/ChannelParticipantRole.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| +|role|[CLICK ME ChannelParticipantRole](../types/ChannelParticipantRole.md) | Yes|| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v44/methods/channels_editPhoto.md b/old_docs/API_docs_v44/methods/channels_editPhoto.md index 3a2c794b..9ccd864f 100644 --- a/old_docs/API_docs_v44/methods/channels_editPhoto.md +++ b/old_docs/API_docs_v44/methods/channels_editPhoto.md @@ -1,17 +1,19 @@ --- title: channels.editPhoto -description: channels.editPhoto parameters, return type and example +description: Edit the photo of a supergroup/channel --- ## Method: channels.editPhoto [Back to methods index](index.md) +Edit the photo of a supergroup/channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new photo| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v44/methods/channels_editTitle.md b/old_docs/API_docs_v44/methods/channels_editTitle.md index ec60e10f..b1024faf 100644 --- a/old_docs/API_docs_v44/methods/channels_editTitle.md +++ b/old_docs/API_docs_v44/methods/channels_editTitle.md @@ -1,17 +1,19 @@ --- title: channels.editTitle -description: channels.editTitle parameters, return type and example +description: Edit the title of a supergroup/channel --- ## Method: channels.editTitle [Back to methods index](index.md) +Edit the title of a supergroup/channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|title|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|title|[CLICK ME string](../types/string.md) | Yes|The new channel/supergroup title| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v44/methods/channels_exportInvite.md b/old_docs/API_docs_v44/methods/channels_exportInvite.md index 3c10f832..f0c737d5 100644 --- a/old_docs/API_docs_v44/methods/channels_exportInvite.md +++ b/old_docs/API_docs_v44/methods/channels_exportInvite.md @@ -1,16 +1,18 @@ --- title: channels.exportInvite -description: channels.exportInvite parameters, return type and example +description: Export the invite link of a channel --- ## Method: channels.exportInvite [Back to methods index](index.md) +Export the invite link of a channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| ### Return type: [ExportedChatInvite](../types/ExportedChatInvite.md) diff --git a/old_docs/API_docs_v44/methods/channels_getChannels.md b/old_docs/API_docs_v44/methods/channels_getChannels.md index bd5958d6..9cd9e798 100644 --- a/old_docs/API_docs_v44/methods/channels_getChannels.md +++ b/old_docs/API_docs_v44/methods/channels_getChannels.md @@ -1,16 +1,18 @@ --- title: channels.getChannels -description: channels.getChannels parameters, return type and example +description: Get info about multiple channels/supergroups --- ## Method: channels.getChannels [Back to methods index](index.md) +Get info about multiple channels/supergroups + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|Array of [Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|Array of [Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Yes|The channel/supergroup MTProto IDs| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v44/methods/channels_getMessages.md b/old_docs/API_docs_v44/methods/channels_getMessages.md index 4440856c..cc944fe5 100644 --- a/old_docs/API_docs_v44/methods/channels_getMessages.md +++ b/old_docs/API_docs_v44/methods/channels_getMessages.md @@ -1,17 +1,19 @@ --- title: channels.getMessages -description: channels.getMessages parameters, return type and example +description: Get channel/supergroup messages --- ## Method: channels.getMessages [Back to methods index](index.md) +Get channel/supergroup messages + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|id|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The message IDs| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v44/methods/channels_getParticipant.md b/old_docs/API_docs_v44/methods/channels_getParticipant.md index c1819b6b..db9b1fc6 100644 --- a/old_docs/API_docs_v44/methods/channels_getParticipant.md +++ b/old_docs/API_docs_v44/methods/channels_getParticipant.md @@ -1,17 +1,19 @@ --- title: channels.getParticipant -description: channels.getParticipant parameters, return type and example +description: Get info about a certain channel/supergroup participant --- ## Method: channels.getParticipant [Back to methods index](index.md) +Get info about a certain channel/supergroup participant + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to fetch info about| ### Return type: [channels\_ChannelParticipant](../types/channels_ChannelParticipant.md) diff --git a/old_docs/API_docs_v44/methods/channels_getParticipants.md b/old_docs/API_docs_v44/methods/channels_getParticipants.md index 7ec8a980..96662466 100644 --- a/old_docs/API_docs_v44/methods/channels_getParticipants.md +++ b/old_docs/API_docs_v44/methods/channels_getParticipants.md @@ -1,19 +1,21 @@ --- title: channels.getParticipants -description: channels.getParticipants parameters, return type and example +description: Get channel/supergroup participants (you should use `$MadelineProto->get_pwr_chat($id)` instead) --- ## Method: channels.getParticipants [Back to methods index](index.md) +Get channel/supergroup participants (you should use `$MadelineProto->get_pwr_chat($id)` instead) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|filter|[CLICK ME ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) | Yes| -|offset|[CLICK ME int](../types/int.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|filter|[CLICK ME ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) | Yes|Member filter| +|offset|[CLICK ME int](../types/int.md) | Yes|Offset| +|limit|[CLICK ME int](../types/int.md) | Yes|Limit| ### Return type: [channels\_ChannelParticipants](../types/channels_ChannelParticipants.md) diff --git a/old_docs/API_docs_v44/methods/channels_inviteToChannel.md b/old_docs/API_docs_v44/methods/channels_inviteToChannel.md index 9bca2967..676f800c 100644 --- a/old_docs/API_docs_v44/methods/channels_inviteToChannel.md +++ b/old_docs/API_docs_v44/methods/channels_inviteToChannel.md @@ -1,17 +1,19 @@ --- title: channels.inviteToChannel -description: channels.inviteToChannel parameters, return type and example +description: Add users to channel/supergroup --- ## Method: channels.inviteToChannel [Back to methods index](index.md) +Add users to channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to add| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v44/methods/channels_joinChannel.md b/old_docs/API_docs_v44/methods/channels_joinChannel.md index 9ecdbe75..721f707c 100644 --- a/old_docs/API_docs_v44/methods/channels_joinChannel.md +++ b/old_docs/API_docs_v44/methods/channels_joinChannel.md @@ -1,16 +1,18 @@ --- title: channels.joinChannel -description: channels.joinChannel parameters, return type and example +description: Join a channel/supergroup --- ## Method: channels.joinChannel [Back to methods index](index.md) +Join a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup to join| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v44/methods/channels_leaveChannel.md b/old_docs/API_docs_v44/methods/channels_leaveChannel.md index 62c20a00..7f02e08c 100644 --- a/old_docs/API_docs_v44/methods/channels_leaveChannel.md +++ b/old_docs/API_docs_v44/methods/channels_leaveChannel.md @@ -1,16 +1,18 @@ --- title: channels.leaveChannel -description: channels.leaveChannel parameters, return type and example +description: Leave a channel/supergroup --- ## Method: channels.leaveChannel [Back to methods index](index.md) +Leave a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup to leave| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v44/methods/channels_readHistory.md b/old_docs/API_docs_v44/methods/channels_readHistory.md index 745893f6..cca891f0 100644 --- a/old_docs/API_docs_v44/methods/channels_readHistory.md +++ b/old_docs/API_docs_v44/methods/channels_readHistory.md @@ -1,17 +1,19 @@ --- title: channels.readHistory -description: channels.readHistory parameters, return type and example +description: Mark channel/supergroup history as read --- ## Method: channels.readHistory [Back to methods index](index.md) +Mark channel/supergroup history as read + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|max\_id|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to mark as read| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v44/methods/channels_reportSpam.md b/old_docs/API_docs_v44/methods/channels_reportSpam.md index 47dd7cff..09af14e0 100644 --- a/old_docs/API_docs_v44/methods/channels_reportSpam.md +++ b/old_docs/API_docs_v44/methods/channels_reportSpam.md @@ -1,18 +1,20 @@ --- title: channels.reportSpam -description: channels.reportSpam parameters, return type and example +description: Report a supergroup/channel for spam --- ## Method: channels.reportSpam [Back to methods index](index.md) +Report a supergroup/channel for spam + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|id|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that added you to this channel| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to report| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v44/methods/channels_updateUsername.md b/old_docs/API_docs_v44/methods/channels_updateUsername.md index 19647598..ad34490a 100644 --- a/old_docs/API_docs_v44/methods/channels_updateUsername.md +++ b/old_docs/API_docs_v44/methods/channels_updateUsername.md @@ -1,17 +1,19 @@ --- title: channels.updateUsername -description: channels.updateUsername parameters, return type and example +description: Update the username of a supergroup/channel --- ## Method: channels.updateUsername [Back to methods index](index.md) +Update the username of a supergroup/channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|username|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|username|[CLICK ME string](../types/string.md) | Yes|The new username| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v44/methods/contacts_getBlocked.md b/old_docs/API_docs_v44/methods/contacts_getBlocked.md index d7d8c5cc..300025af 100644 --- a/old_docs/API_docs_v44/methods/contacts_getBlocked.md +++ b/old_docs/API_docs_v44/methods/contacts_getBlocked.md @@ -12,7 +12,7 @@ Get blocked users | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, then set to the number of blocked contacts previously fetched| +|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, Then set to the number of blocked contacts previously fetched| |limit|[CLICK ME int](../types/int.md) | Yes|How many blocked contacts to fetch| diff --git a/old_docs/API_docs_v44/methods/help_getAppChangelog.md b/old_docs/API_docs_v44/methods/help_getAppChangelog.md index ec71a905..c8c41f71 100644 --- a/old_docs/API_docs_v44/methods/help_getAppChangelog.md +++ b/old_docs/API_docs_v44/methods/help_getAppChangelog.md @@ -1,19 +1,21 @@ --- title: help.getAppChangelog -description: help.getAppChangelog parameters, return type and example +description: Get the changelog of this app --- ## Method: help.getAppChangelog [Back to methods index](index.md) +Get the changelog of this app + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|device\_model|[CLICK ME string](../types/string.md) | Yes| -|system\_version|[CLICK ME string](../types/string.md) | Yes| -|app\_version|[CLICK ME string](../types/string.md) | Yes| -|lang\_code|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|device\_model|[CLICK ME string](../types/string.md) | Yes|| +|system\_version|[CLICK ME string](../types/string.md) | Yes|| +|app\_version|[CLICK ME string](../types/string.md) | Yes|| +|lang\_code|[CLICK ME string](../types/string.md) | Yes|| ### Return type: [help\_AppChangelog](../types/help_AppChangelog.md) diff --git a/old_docs/API_docs_v44/methods/help_getAppUpdate.md b/old_docs/API_docs_v44/methods/help_getAppUpdate.md index d13d6263..f3eacbd6 100644 --- a/old_docs/API_docs_v44/methods/help_getAppUpdate.md +++ b/old_docs/API_docs_v44/methods/help_getAppUpdate.md @@ -1,19 +1,21 @@ --- title: help.getAppUpdate -description: help.getAppUpdate parameters, return type and example +description: Get info about app updates --- ## Method: help.getAppUpdate [Back to methods index](index.md) +Get info about app updates + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|device\_model|[CLICK ME string](../types/string.md) | Yes| -|system\_version|[CLICK ME string](../types/string.md) | Yes| -|app\_version|[CLICK ME string](../types/string.md) | Yes| -|lang\_code|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|device\_model|[CLICK ME string](../types/string.md) | Yes|| +|system\_version|[CLICK ME string](../types/string.md) | Yes|| +|app\_version|[CLICK ME string](../types/string.md) | Yes|| +|lang\_code|[CLICK ME string](../types/string.md) | Yes|| ### Return type: [help\_AppUpdate](../types/help_AppUpdate.md) diff --git a/old_docs/API_docs_v44/methods/help_getConfig.md b/old_docs/API_docs_v44/methods/help_getConfig.md index 885ad5d3..16e25c68 100644 --- a/old_docs/API_docs_v44/methods/help_getConfig.md +++ b/old_docs/API_docs_v44/methods/help_getConfig.md @@ -1,11 +1,13 @@ --- title: help.getConfig -description: help.getConfig parameters, return type and example +description: Get server configuration --- ## Method: help.getConfig [Back to methods index](index.md) +Get server configuration + ### Return type: [Config](../types/Config.md) diff --git a/old_docs/API_docs_v44/methods/help_getInviteText.md b/old_docs/API_docs_v44/methods/help_getInviteText.md index aeebae28..d9ae8e0d 100644 --- a/old_docs/API_docs_v44/methods/help_getInviteText.md +++ b/old_docs/API_docs_v44/methods/help_getInviteText.md @@ -1,16 +1,18 @@ --- title: help.getInviteText -description: help.getInviteText parameters, return type and example +description: Get invitation text --- ## Method: help.getInviteText [Back to methods index](index.md) +Get invitation text + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|lang\_code|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|lang\_code|[CLICK ME string](../types/string.md) | Yes|| ### Return type: [help\_InviteText](../types/help_InviteText.md) diff --git a/old_docs/API_docs_v44/methods/help_getNearestDc.md b/old_docs/API_docs_v44/methods/help_getNearestDc.md index 6196890b..35a8bf91 100644 --- a/old_docs/API_docs_v44/methods/help_getNearestDc.md +++ b/old_docs/API_docs_v44/methods/help_getNearestDc.md @@ -1,11 +1,13 @@ --- title: help.getNearestDc -description: help.getNearestDc parameters, return type and example +description: Get nearest datacenter --- ## Method: help.getNearestDc [Back to methods index](index.md) +Get nearest datacenter + ### Return type: [NearestDc](../types/NearestDc.md) diff --git a/old_docs/API_docs_v44/methods/help_getSupport.md b/old_docs/API_docs_v44/methods/help_getSupport.md index 9b269f78..a5bab0f2 100644 --- a/old_docs/API_docs_v44/methods/help_getSupport.md +++ b/old_docs/API_docs_v44/methods/help_getSupport.md @@ -1,11 +1,13 @@ --- title: help.getSupport -description: help.getSupport parameters, return type and example +description: Get info of support user --- ## Method: help.getSupport [Back to methods index](index.md) +Get info of support user + ### Return type: [help\_Support](../types/help_Support.md) diff --git a/old_docs/API_docs_v44/methods/help_getTermsOfService.md b/old_docs/API_docs_v44/methods/help_getTermsOfService.md index 3a1b355d..e9b1cae4 100644 --- a/old_docs/API_docs_v44/methods/help_getTermsOfService.md +++ b/old_docs/API_docs_v44/methods/help_getTermsOfService.md @@ -1,16 +1,18 @@ --- title: help.getTermsOfService -description: help.getTermsOfService parameters, return type and example +description: Get terms of service --- ## Method: help.getTermsOfService [Back to methods index](index.md) +Get terms of service + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|lang\_code|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|lang\_code|[CLICK ME string](../types/string.md) | Yes|| ### Return type: [help\_TermsOfService](../types/help_TermsOfService.md) diff --git a/old_docs/API_docs_v44/methods/help_saveAppLog.md b/old_docs/API_docs_v44/methods/help_saveAppLog.md index af6e94e2..0165b6e3 100644 --- a/old_docs/API_docs_v44/methods/help_saveAppLog.md +++ b/old_docs/API_docs_v44/methods/help_saveAppLog.md @@ -1,16 +1,18 @@ --- title: help.saveAppLog -description: help.saveAppLog parameters, return type and example +description: Log data for developer of this app --- ## Method: help.saveAppLog [Back to methods index](index.md) +Log data for developer of this app + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|events|Array of [CLICK ME InputAppEvent](../types/InputAppEvent.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|events|Array of [CLICK ME InputAppEvent](../types/InputAppEvent.md) | Yes|Event list| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v44/methods/messages_checkChatInvite.md b/old_docs/API_docs_v44/methods/messages_checkChatInvite.md index 4ddf5084..de1d9ff4 100644 --- a/old_docs/API_docs_v44/methods/messages_checkChatInvite.md +++ b/old_docs/API_docs_v44/methods/messages_checkChatInvite.md @@ -1,16 +1,18 @@ --- title: messages.checkChatInvite -description: messages.checkChatInvite parameters, return type and example +description: Check if an invitation link is valid --- ## Method: messages.checkChatInvite [Back to methods index](index.md) +Check if an invitation link is valid + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| ### Return type: [ChatInvite](../types/ChatInvite.md) diff --git a/old_docs/API_docs_v44/methods/messages_deleteChatUser.md b/old_docs/API_docs_v44/methods/messages_deleteChatUser.md index a71f4aaf..0a6830de 100644 --- a/old_docs/API_docs_v44/methods/messages_deleteChatUser.md +++ b/old_docs/API_docs_v44/methods/messages_deleteChatUser.md @@ -12,7 +12,7 @@ Delete a user from a chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The MTProto ID of the chat| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to delete (pass @me to leave the chat)| diff --git a/old_docs/API_docs_v44/methods/messages_editChatAdmin.md b/old_docs/API_docs_v44/methods/messages_editChatAdmin.md index 6bc8f9ae..7916f8b1 100644 --- a/old_docs/API_docs_v44/methods/messages_editChatAdmin.md +++ b/old_docs/API_docs_v44/methods/messages_editChatAdmin.md @@ -1,18 +1,20 @@ --- title: messages.editChatAdmin -description: messages.editChatAdmin parameters, return type and example +description: Edit admin permissions --- ## Method: messages.editChatAdmin [Back to methods index](index.md) +Edit admin permissions + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|is\_admin|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat ID (no supergroups)| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user ID| +|is\_admin|[CLICK ME Bool](../types/Bool.md) | Yes|Should the user be admin?| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v44/methods/messages_editChatPhoto.md b/old_docs/API_docs_v44/methods/messages_editChatPhoto.md index 8848eca7..122913c4 100644 --- a/old_docs/API_docs_v44/methods/messages_editChatPhoto.md +++ b/old_docs/API_docs_v44/methods/messages_editChatPhoto.md @@ -12,7 +12,7 @@ Edit the photo of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The MTProto ID of the chat| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| |photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| diff --git a/old_docs/API_docs_v44/methods/messages_editChatTitle.md b/old_docs/API_docs_v44/methods/messages_editChatTitle.md index 1c1c7a16..3a1e974b 100644 --- a/old_docs/API_docs_v44/methods/messages_editChatTitle.md +++ b/old_docs/API_docs_v44/methods/messages_editChatTitle.md @@ -12,7 +12,7 @@ Edit the title of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The MTProto ID of the chat| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| |title|[CLICK ME string](../types/string.md) | Yes|The new title| diff --git a/old_docs/API_docs_v44/methods/messages_exportChatInvite.md b/old_docs/API_docs_v44/methods/messages_exportChatInvite.md index 74d70c21..98685d96 100644 --- a/old_docs/API_docs_v44/methods/messages_exportChatInvite.md +++ b/old_docs/API_docs_v44/methods/messages_exportChatInvite.md @@ -1,16 +1,18 @@ --- title: messages.exportChatInvite -description: messages.exportChatInvite parameters, return type and example +description: Export chat invite --- ## Method: messages.exportChatInvite [Back to methods index](index.md) +Export chat invite + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat id | ### Return type: [ExportedChatInvite](../types/ExportedChatInvite.md) diff --git a/old_docs/API_docs_v44/methods/messages_getAllStickers.md b/old_docs/API_docs_v44/methods/messages_getAllStickers.md index 575fcd49..16fdba6c 100644 --- a/old_docs/API_docs_v44/methods/messages_getAllStickers.md +++ b/old_docs/API_docs_v44/methods/messages_getAllStickers.md @@ -1,16 +1,18 @@ --- title: messages.getAllStickers -description: messages.getAllStickers parameters, return type and example +description: Get all stickerpacks --- ## Method: messages.getAllStickers [Back to methods index](index.md) +Get all stickerpacks + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v44/methods/messages_getDocumentByHash.md b/old_docs/API_docs_v44/methods/messages_getDocumentByHash.md index b7c45398..1af5bad4 100644 --- a/old_docs/API_docs_v44/methods/messages_getDocumentByHash.md +++ b/old_docs/API_docs_v44/methods/messages_getDocumentByHash.md @@ -1,18 +1,20 @@ --- title: messages.getDocumentByHash -description: messages.getDocumentByHash parameters, return type and example +description: Get document by SHA256 hash --- ## Method: messages.getDocumentByHash [Back to methods index](index.md) +Get document by SHA256 hash + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|sha256|[CLICK ME bytes](../types/bytes.md) | Yes| -|size|[CLICK ME int](../types/int.md) | Yes| -|mime\_type|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|sha256|[CLICK ME bytes](../types/bytes.md) | Yes|`hash('sha256', $filename, true);`| +|size|[CLICK ME int](../types/int.md) | Yes|The file size| +|mime\_type|[CLICK ME string](../types/string.md) | Yes|The mime type of the file| ### Return type: [Document](../types/Document.md) diff --git a/old_docs/API_docs_v44/methods/messages_getMessagesViews.md b/old_docs/API_docs_v44/methods/messages_getMessagesViews.md index e3f4e4ea..b8d78c85 100644 --- a/old_docs/API_docs_v44/methods/messages_getMessagesViews.md +++ b/old_docs/API_docs_v44/methods/messages_getMessagesViews.md @@ -1,18 +1,20 @@ --- title: messages.getMessagesViews -description: messages.getMessagesViews parameters, return type and example +description: Get and increase message views --- ## Method: messages.getMessagesViews [Back to methods index](index.md) +Get and increase message views + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|id|Array of [CLICK ME int](../types/int.md) | Yes| -|increment|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the message is located| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs messages to get| +|increment|[CLICK ME Bool](../types/Bool.md) | Yes|Increase message views?| ### Return type: [Vector\_of\_int](../types/int.md) diff --git a/old_docs/API_docs_v44/methods/messages_getStickerSet.md b/old_docs/API_docs_v44/methods/messages_getStickerSet.md index 70bdd9ba..c86807e4 100644 --- a/old_docs/API_docs_v44/methods/messages_getStickerSet.md +++ b/old_docs/API_docs_v44/methods/messages_getStickerSet.md @@ -1,16 +1,18 @@ --- title: messages.getStickerSet -description: messages.getStickerSet parameters, return type and example +description: Get a stickerset --- ## Method: messages.getStickerSet [Back to methods index](index.md) +Get a stickerset + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset to get| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/old_docs/API_docs_v44/methods/messages_getStickers.md b/old_docs/API_docs_v44/methods/messages_getStickers.md index 178b897c..4854696d 100644 --- a/old_docs/API_docs_v44/methods/messages_getStickers.md +++ b/old_docs/API_docs_v44/methods/messages_getStickers.md @@ -1,17 +1,19 @@ --- title: messages.getStickers -description: messages.getStickers parameters, return type and example +description: Get stickers --- ## Method: messages.getStickers [Back to methods index](index.md) +Get stickers + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|emoticon|[CLICK ME string](../types/string.md) | Yes| -|hash|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|emoticon|[CLICK ME string](../types/string.md) | Yes|Search by emoji| +|hash|[CLICK ME string](../types/string.md) | Yes|0 or $MadelineProto->gen_vector_hash(previously fetched sticker IDs)| ### Return type: [messages\_Stickers](../types/messages_Stickers.md) diff --git a/old_docs/API_docs_v44/methods/messages_getWebPagePreview.md b/old_docs/API_docs_v44/methods/messages_getWebPagePreview.md index 35243c9f..d01bdd32 100644 --- a/old_docs/API_docs_v44/methods/messages_getWebPagePreview.md +++ b/old_docs/API_docs_v44/methods/messages_getWebPagePreview.md @@ -1,16 +1,18 @@ --- title: messages.getWebPagePreview -description: messages.getWebPagePreview parameters, return type and example +description: Get webpage preview --- ## Method: messages.getWebPagePreview [Back to methods index](index.md) +Get webpage preview + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|message|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|message|[CLICK ME string](../types/string.md) | Yes|Extract preview from this message| ### Return type: [MessageMedia](../types/MessageMedia.md) diff --git a/old_docs/API_docs_v44/methods/messages_importChatInvite.md b/old_docs/API_docs_v44/methods/messages_importChatInvite.md index 2bea5247..0d6cd7c8 100644 --- a/old_docs/API_docs_v44/methods/messages_importChatInvite.md +++ b/old_docs/API_docs_v44/methods/messages_importChatInvite.md @@ -1,16 +1,18 @@ --- title: messages.importChatInvite -description: messages.importChatInvite parameters, return type and example +description: Import chat invite --- ## Method: messages.importChatInvite [Back to methods index](index.md) +Import chat invite + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v44/methods/messages_installStickerSet.md b/old_docs/API_docs_v44/methods/messages_installStickerSet.md index 857aa738..f620c96a 100644 --- a/old_docs/API_docs_v44/methods/messages_installStickerSet.md +++ b/old_docs/API_docs_v44/methods/messages_installStickerSet.md @@ -1,17 +1,19 @@ --- title: messages.installStickerSet -description: messages.installStickerSet parameters, return type and example +description: Add a sticker set --- ## Method: messages.installStickerSet [Back to methods index](index.md) +Add a sticker set + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional| -|disabled|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to add| +|disabled|[CLICK ME Bool](../types/Bool.md) | Yes|| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v44/methods/messages_migrateChat.md b/old_docs/API_docs_v44/methods/messages_migrateChat.md index 5021ad45..db57adfa 100644 --- a/old_docs/API_docs_v44/methods/messages_migrateChat.md +++ b/old_docs/API_docs_v44/methods/messages_migrateChat.md @@ -1,16 +1,18 @@ --- title: messages.migrateChat -description: messages.migrateChat parameters, return type and example +description: Convert chat to supergroup --- ## Method: messages.migrateChat [Back to methods index](index.md) +Convert chat to supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat to convert| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v44/methods/messages_readEncryptedHistory.md b/old_docs/API_docs_v44/methods/messages_readEncryptedHistory.md index 4d341809..39b110e3 100644 --- a/old_docs/API_docs_v44/methods/messages_readEncryptedHistory.md +++ b/old_docs/API_docs_v44/methods/messages_readEncryptedHistory.md @@ -1,17 +1,19 @@ --- title: messages.readEncryptedHistory -description: messages.readEncryptedHistory parameters, return type and example +description: Mark messages as read in secret chats --- ## Method: messages.readEncryptedHistory [Back to methods index](index.md) +Mark messages as read in secret chats + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|max\_date|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to mark messages as read| +|max\_date|[CLICK ME int](../types/int.md) | Yes|Maximum date of messages to mark| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v44/methods/messages_readMessageContents.md b/old_docs/API_docs_v44/methods/messages_readMessageContents.md index 0d27c209..9bb1bee8 100644 --- a/old_docs/API_docs_v44/methods/messages_readMessageContents.md +++ b/old_docs/API_docs_v44/methods/messages_readMessageContents.md @@ -1,16 +1,18 @@ --- title: messages.readMessageContents -description: messages.readMessageContents parameters, return type and example +description: Mark message as read --- ## Method: messages.readMessageContents [Back to methods index](index.md) +Mark message as read + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v44/methods/messages_receivedQueue.md b/old_docs/API_docs_v44/methods/messages_receivedQueue.md index c91caa37..4ad78ba2 100644 --- a/old_docs/API_docs_v44/methods/messages_receivedQueue.md +++ b/old_docs/API_docs_v44/methods/messages_receivedQueue.md @@ -1,77 +1,13 @@ --- title: messages.receivedQueue -description: messages.receivedQueue parameters, return type and example +description: You cannot use this method directly --- ## Method: messages.receivedQueue [Back to methods index](index.md) -### Parameters: - -| Name | Type | Required | -|----------|---------------|----------| -|max\_qts|[CLICK ME int](../types/int.md) | Yes| - - -### 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| - - -### MadelineProto Example: - - -``` -if (!file_exists('madeline.php')) { - copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); -} -include 'madeline.php'; - -// !!! This API id/API hash combination will not work !!! -// !!! You must get your own @ my.telegram.org !!! -$api_id = 0; -$api_hash = ''; - -$MadelineProto = new \danog\MadelineProto\API('session.madeline', ['app_info' => ['api_id' => $api_id, 'api_hash' => $api_hash]]); -$MadelineProto->start(); - -$Vector_of_long = $MadelineProto->messages->receivedQueue(['max_qts' => int, ]); -``` - -### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): - -### As a bot: - -POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` - -Parameters: - -* method - messages.receivedQueue -* params - `{"max_qts": int, }` - - - -### As a user: - -POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.receivedQueue` - -Parameters: - -max_qts - Json encoded int +**You cannot use this method directly** -Or, if you're into Lua: - -``` -Vector_of_long = messages.receivedQueue({max_qts=int, }) -``` - diff --git a/old_docs/API_docs_v44/methods/messages_reorderStickerSets.md b/old_docs/API_docs_v44/methods/messages_reorderStickerSets.md index ad5df9fa..b2cbe4c1 100644 --- a/old_docs/API_docs_v44/methods/messages_reorderStickerSets.md +++ b/old_docs/API_docs_v44/methods/messages_reorderStickerSets.md @@ -1,16 +1,18 @@ --- title: messages.reorderStickerSets -description: messages.reorderStickerSets parameters, return type and example +description: Reorder sticker sets --- ## Method: messages.reorderStickerSets [Back to methods index](index.md) +Reorder sticker sets + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|order|Array of [CLICK ME long](../types/long.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|order|Array of [CLICK ME long](../types/long.md) | Yes|The order| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v44/methods/messages_searchGifs.md b/old_docs/API_docs_v44/methods/messages_searchGifs.md index fefef1d7..103ebfeb 100644 --- a/old_docs/API_docs_v44/methods/messages_searchGifs.md +++ b/old_docs/API_docs_v44/methods/messages_searchGifs.md @@ -1,17 +1,19 @@ --- title: messages.searchGifs -description: messages.searchGifs parameters, return type and example +description: Search gifs --- ## Method: messages.searchGifs [Back to methods index](index.md) +Search gifs + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|q|[CLICK ME string](../types/string.md) | Yes| -|offset|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|q|[CLICK ME string](../types/string.md) | Yes|The search query| +|offset|[CLICK ME int](../types/int.md) | Yes|The offset | ### Return type: [messages\_FoundGifs](../types/messages_FoundGifs.md) diff --git a/old_docs/API_docs_v44/methods/messages_searchGlobal.md b/old_docs/API_docs_v44/methods/messages_searchGlobal.md index 32ddd175..0edd1e40 100644 --- a/old_docs/API_docs_v44/methods/messages_searchGlobal.md +++ b/old_docs/API_docs_v44/methods/messages_searchGlobal.md @@ -1,20 +1,22 @@ --- title: messages.searchGlobal -description: messages.searchGlobal parameters, return type and example +description: Global message search --- ## Method: messages.searchGlobal [Back to methods index](index.md) +Global message search + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|q|[CLICK ME string](../types/string.md) | Yes| -|offset\_date|[CLICK ME int](../types/int.md) | Yes| -|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|offset\_id|[CLICK ME int](../types/int.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|q|[CLICK ME string](../types/string.md) | Yes|The query| +|offset\_date|[CLICK ME int](../types/int.md) | Yes|0 or the date offset| +|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|0 or the peer offset| +|offset\_id|[CLICK ME int](../types/int.md) | Yes|0 or the message ID offset| +|limit|[CLICK ME int](../types/int.md) | Yes|The number of results to return| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v44/methods/messages_sendEncrypted.md b/old_docs/API_docs_v44/methods/messages_sendEncrypted.md index 23461760..d48f88d7 100644 --- a/old_docs/API_docs_v44/methods/messages_sendEncrypted.md +++ b/old_docs/API_docs_v44/methods/messages_sendEncrypted.md @@ -1,17 +1,19 @@ --- title: messages.sendEncrypted -description: messages.sendEncrypted parameters, return type and example +description: Send message to secret chat --- ## Method: messages.sendEncrypted [Back to methods index](index.md) +Send message to secret chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the message| +|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v44/methods/messages_sendEncryptedFile.md b/old_docs/API_docs_v44/methods/messages_sendEncryptedFile.md index 64919abe..4fd0648e 100644 --- a/old_docs/API_docs_v44/methods/messages_sendEncryptedFile.md +++ b/old_docs/API_docs_v44/methods/messages_sendEncryptedFile.md @@ -1,18 +1,20 @@ --- title: messages.sendEncryptedFile -description: messages.sendEncryptedFile parameters, return type and example +description: Send a file to a secret chat --- ## Method: messages.sendEncryptedFile [Back to methods index](index.md) +Send a file to a secret chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes| -|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the file| +|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| +|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional|The file (optional)| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v44/methods/messages_sendEncryptedService.md b/old_docs/API_docs_v44/methods/messages_sendEncryptedService.md index 0a0eea8a..d66894bf 100644 --- a/old_docs/API_docs_v44/methods/messages_sendEncryptedService.md +++ b/old_docs/API_docs_v44/methods/messages_sendEncryptedService.md @@ -1,17 +1,19 @@ --- title: messages.sendEncryptedService -description: messages.sendEncryptedService parameters, return type and example +description: Send a service message to a secret chat --- ## Method: messages.sendEncryptedService [Back to methods index](index.md) +Send a service message to a secret chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the service message| +|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v44/methods/messages_setEncryptedTyping.md b/old_docs/API_docs_v44/methods/messages_setEncryptedTyping.md index 3183fedf..e9afe99c 100644 --- a/old_docs/API_docs_v44/methods/messages_setEncryptedTyping.md +++ b/old_docs/API_docs_v44/methods/messages_setEncryptedTyping.md @@ -12,8 +12,8 @@ Send typing notification to secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|| -|typing|[CLICK ME Bool](../types/Bool.md) | Yes|| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to send the notification| +|typing|[CLICK ME Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v44/methods/messages_startBot.md b/old_docs/API_docs_v44/methods/messages_startBot.md index 0de0f1a5..94a4d86a 100644 --- a/old_docs/API_docs_v44/methods/messages_startBot.md +++ b/old_docs/API_docs_v44/methods/messages_startBot.md @@ -1,18 +1,20 @@ --- title: messages.startBot -description: messages.startBot parameters, return type and example +description: Start a bot --- ## Method: messages.startBot [Back to methods index](index.md) +Start a bot + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|start\_param|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot's ID or username| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to start the bot (@me or group ID/username)| +|start\_param|[CLICK ME string](../types/string.md) | Yes|The bot's start parameter| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v44/methods/messages_toggleChatAdmins.md b/old_docs/API_docs_v44/methods/messages_toggleChatAdmins.md index d56e5753..ab591fd9 100644 --- a/old_docs/API_docs_v44/methods/messages_toggleChatAdmins.md +++ b/old_docs/API_docs_v44/methods/messages_toggleChatAdmins.md @@ -1,17 +1,19 @@ --- title: messages.toggleChatAdmins -description: messages.toggleChatAdmins parameters, return type and example +description: Enable all users are admins in normal groups (not supergroups) --- ## Method: messages.toggleChatAdmins [Back to methods index](index.md) +Enable all users are admins in normal groups (not supergroups) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Group ID| +|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Enable all users are admins| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v44/methods/messages_uninstallStickerSet.md b/old_docs/API_docs_v44/methods/messages_uninstallStickerSet.md index 60b0ca0c..6d04e847 100644 --- a/old_docs/API_docs_v44/methods/messages_uninstallStickerSet.md +++ b/old_docs/API_docs_v44/methods/messages_uninstallStickerSet.md @@ -1,16 +1,18 @@ --- title: messages.uninstallStickerSet -description: messages.uninstallStickerSet parameters, return type and example +description: Remove a sticker set --- ## Method: messages.uninstallStickerSet [Back to methods index](index.md) +Remove a sticker set + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to remove| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v44/methods/photos_deletePhotos.md b/old_docs/API_docs_v44/methods/photos_deletePhotos.md index 104459b7..b9daca10 100644 --- a/old_docs/API_docs_v44/methods/photos_deletePhotos.md +++ b/old_docs/API_docs_v44/methods/photos_deletePhotos.md @@ -1,16 +1,18 @@ --- title: photos.deletePhotos -description: photos.deletePhotos parameters, return type and example +description: Delete profile photos --- ## Method: photos.deletePhotos [Back to methods index](index.md) +Delete profile photos + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Yes|The profile photos to delete| ### Return type: [Vector\_of\_long](../types/long.md) diff --git a/old_docs/API_docs_v44/methods/photos_getUserPhotos.md b/old_docs/API_docs_v44/methods/photos_getUserPhotos.md index 1a7515ba..ea27a44f 100644 --- a/old_docs/API_docs_v44/methods/photos_getUserPhotos.md +++ b/old_docs/API_docs_v44/methods/photos_getUserPhotos.md @@ -1,19 +1,21 @@ --- title: photos.getUserPhotos -description: photos.getUserPhotos parameters, return type and example +description: Get the profile photos of a user --- ## Method: photos.getUserPhotos [Back to methods index](index.md) +Get the profile photos of a user + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|offset|[CLICK ME int](../types/int.md) | Yes| -|max\_id|[CLICK ME long](../types/long.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| +|offset|[CLICK ME int](../types/int.md) | Yes|Offset| +|max\_id|[CLICK ME long](../types/long.md) | Yes|Maximum ID of photo to return| +|limit|[CLICK ME int](../types/int.md) | Yes|Number of photos to return| ### Return type: [photos\_Photos](../types/photos_Photos.md) diff --git a/old_docs/API_docs_v44/methods/photos_updateProfilePhoto.md b/old_docs/API_docs_v44/methods/photos_updateProfilePhoto.md index 386970d5..dc6edd6b 100644 --- a/old_docs/API_docs_v44/methods/photos_updateProfilePhoto.md +++ b/old_docs/API_docs_v44/methods/photos_updateProfilePhoto.md @@ -1,17 +1,19 @@ --- title: photos.updateProfilePhoto -description: photos.updateProfilePhoto parameters, return type and example +description: Update the profile photo (use photos->uploadProfilePhoto to upload the photo) --- ## Method: photos.updateProfilePhoto [Back to methods index](index.md) +Update the profile photo (use photos->uploadProfilePhoto to upload the photo) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional| -|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional|The photo to use| +|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|| ### Return type: [UserProfilePhoto](../types/UserProfilePhoto.md) diff --git a/old_docs/API_docs_v44/methods/photos_uploadProfilePhoto.md b/old_docs/API_docs_v44/methods/photos_uploadProfilePhoto.md index 07b9936c..fb0bc534 100644 --- a/old_docs/API_docs_v44/methods/photos_uploadProfilePhoto.md +++ b/old_docs/API_docs_v44/methods/photos_uploadProfilePhoto.md @@ -1,19 +1,21 @@ --- title: photos.uploadProfilePhoto -description: photos.uploadProfilePhoto parameters, return type and example +description: Upload profile photo --- ## Method: photos.uploadProfilePhoto [Back to methods index](index.md) +Upload profile photo + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|file|[File path or InputFile](../types/InputFile.md) | Yes| -|caption|[CLICK ME string](../types/string.md) | Yes| -|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional| -|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|file|[File path or InputFile](../types/InputFile.md) | Yes|The photo| +|caption|[CLICK ME string](../types/string.md) | Yes|| +|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional|| +|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|| ### Return type: [photos\_Photo](../types/photos_Photo.md) diff --git a/old_docs/API_docs_v45/methods/account_registerDevice.md b/old_docs/API_docs_v45/methods/account_registerDevice.md index 1752afde..0a40f49c 100644 --- a/old_docs/API_docs_v45/methods/account_registerDevice.md +++ b/old_docs/API_docs_v45/methods/account_registerDevice.md @@ -12,8 +12,8 @@ Register device for push notifications | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and oTher, see source code of official apps for more info| +|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and oTher, see source code of official apps for more info| |device\_model|[CLICK ME string](../types/string.md) | Yes|| |system\_version|[CLICK ME string](../types/string.md) | Yes|| |app\_version|[CLICK ME string](../types/string.md) | Yes|| diff --git a/old_docs/API_docs_v45/methods/account_unregisterDevice.md b/old_docs/API_docs_v45/methods/account_unregisterDevice.md index 1d2b7670..32e44495 100644 --- a/old_docs/API_docs_v45/methods/account_unregisterDevice.md +++ b/old_docs/API_docs_v45/methods/account_unregisterDevice.md @@ -12,8 +12,8 @@ Stop sending PUSH notifications to app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and oTher, see source code of official apps for more info| +|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and oTher, see source code of official apps for more info| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v45/methods/channels_checkUsername.md b/old_docs/API_docs_v45/methods/channels_checkUsername.md index 371f4cd3..7bc7c245 100644 --- a/old_docs/API_docs_v45/methods/channels_checkUsername.md +++ b/old_docs/API_docs_v45/methods/channels_checkUsername.md @@ -1,17 +1,19 @@ --- title: channels.checkUsername -description: channels.checkUsername parameters, return type and example +description: Check if this username is free and can be assigned to a channel/supergroup --- ## Method: channels.checkUsername [Back to methods index](index.md) +Check if this username is free and can be assigned to a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|username|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|username|[CLICK ME string](../types/string.md) | Yes|The new username for this channel/supergroup| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v45/methods/channels_createChannel.md b/old_docs/API_docs_v45/methods/channels_createChannel.md index c5d21585..1305e4fb 100644 --- a/old_docs/API_docs_v45/methods/channels_createChannel.md +++ b/old_docs/API_docs_v45/methods/channels_createChannel.md @@ -1,19 +1,21 @@ --- title: channels.createChannel -description: channels.createChannel parameters, return type and example +description: Create channel/supergroup --- ## Method: channels.createChannel [Back to methods index](index.md) +Create channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|broadcast|[CLICK ME Bool](../types/Bool.md) | Optional| -|megagroup|[CLICK ME Bool](../types/Bool.md) | Optional| -|title|[CLICK ME string](../types/string.md) | Yes| -|about|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|broadcast|[CLICK ME Bool](../types/Bool.md) | Optional|Set this to true to create a channel| +|megagroup|[CLICK ME Bool](../types/Bool.md) | Optional|Set this to true to create a supergroup| +|title|[CLICK ME string](../types/string.md) | Yes|Supergroup/channel title| +|about|[CLICK ME string](../types/string.md) | Yes|About text| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v45/methods/channels_deleteChannel.md b/old_docs/API_docs_v45/methods/channels_deleteChannel.md index 61b29eac..e660d25c 100644 --- a/old_docs/API_docs_v45/methods/channels_deleteChannel.md +++ b/old_docs/API_docs_v45/methods/channels_deleteChannel.md @@ -1,16 +1,18 @@ --- title: channels.deleteChannel -description: channels.deleteChannel parameters, return type and example +description: Delete a channel/supergroup --- ## Method: channels.deleteChannel [Back to methods index](index.md) +Delete a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup to delete| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v45/methods/channels_deleteMessages.md b/old_docs/API_docs_v45/methods/channels_deleteMessages.md index 87a968c5..fb9d3cc2 100644 --- a/old_docs/API_docs_v45/methods/channels_deleteMessages.md +++ b/old_docs/API_docs_v45/methods/channels_deleteMessages.md @@ -1,17 +1,19 @@ --- title: channels.deleteMessages -description: channels.deleteMessages parameters, return type and example +description: Delete channel/supergroup messages --- ## Method: channels.deleteMessages [Back to methods index](index.md) +Delete channel/supergroup messages + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|id|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to delete| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v45/methods/channels_deleteUserHistory.md b/old_docs/API_docs_v45/methods/channels_deleteUserHistory.md index ee828f45..fbe34341 100644 --- a/old_docs/API_docs_v45/methods/channels_deleteUserHistory.md +++ b/old_docs/API_docs_v45/methods/channels_deleteUserHistory.md @@ -1,17 +1,19 @@ --- title: channels.deleteUserHistory -description: channels.deleteUserHistory parameters, return type and example +description: Delete all messages of a user in a channel/supergroup --- ## Method: channels.deleteUserHistory [Back to methods index](index.md) +Delete all messages of a user in a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) diff --git a/old_docs/API_docs_v45/methods/channels_editAbout.md b/old_docs/API_docs_v45/methods/channels_editAbout.md index 94be2503..8908f29e 100644 --- a/old_docs/API_docs_v45/methods/channels_editAbout.md +++ b/old_docs/API_docs_v45/methods/channels_editAbout.md @@ -1,17 +1,19 @@ --- title: channels.editAbout -description: channels.editAbout parameters, return type and example +description: Edit the about text of a channel/supergroup --- ## Method: channels.editAbout [Back to methods index](index.md) +Edit the about text of a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|about|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|about|[CLICK ME string](../types/string.md) | Yes|The new about text| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v45/methods/channels_editAdmin.md b/old_docs/API_docs_v45/methods/channels_editAdmin.md index e1917c89..695c5294 100644 --- a/old_docs/API_docs_v45/methods/channels_editAdmin.md +++ b/old_docs/API_docs_v45/methods/channels_editAdmin.md @@ -1,18 +1,20 @@ --- title: channels.editAdmin -description: channels.editAdmin parameters, return type and example +description: Edit admin permissions of a user in a channel/supergroup --- ## Method: channels.editAdmin [Back to methods index](index.md) +Edit admin permissions of a user in a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|role|[CLICK ME ChannelParticipantRole](../types/ChannelParticipantRole.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| +|role|[CLICK ME ChannelParticipantRole](../types/ChannelParticipantRole.md) | Yes|| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v45/methods/channels_editPhoto.md b/old_docs/API_docs_v45/methods/channels_editPhoto.md index 3a2c794b..9ccd864f 100644 --- a/old_docs/API_docs_v45/methods/channels_editPhoto.md +++ b/old_docs/API_docs_v45/methods/channels_editPhoto.md @@ -1,17 +1,19 @@ --- title: channels.editPhoto -description: channels.editPhoto parameters, return type and example +description: Edit the photo of a supergroup/channel --- ## Method: channels.editPhoto [Back to methods index](index.md) +Edit the photo of a supergroup/channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new photo| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v45/methods/channels_editTitle.md b/old_docs/API_docs_v45/methods/channels_editTitle.md index ec60e10f..b1024faf 100644 --- a/old_docs/API_docs_v45/methods/channels_editTitle.md +++ b/old_docs/API_docs_v45/methods/channels_editTitle.md @@ -1,17 +1,19 @@ --- title: channels.editTitle -description: channels.editTitle parameters, return type and example +description: Edit the title of a supergroup/channel --- ## Method: channels.editTitle [Back to methods index](index.md) +Edit the title of a supergroup/channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|title|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|title|[CLICK ME string](../types/string.md) | Yes|The new channel/supergroup title| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v45/methods/channels_exportInvite.md b/old_docs/API_docs_v45/methods/channels_exportInvite.md index 3c10f832..f0c737d5 100644 --- a/old_docs/API_docs_v45/methods/channels_exportInvite.md +++ b/old_docs/API_docs_v45/methods/channels_exportInvite.md @@ -1,16 +1,18 @@ --- title: channels.exportInvite -description: channels.exportInvite parameters, return type and example +description: Export the invite link of a channel --- ## Method: channels.exportInvite [Back to methods index](index.md) +Export the invite link of a channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| ### Return type: [ExportedChatInvite](../types/ExportedChatInvite.md) diff --git a/old_docs/API_docs_v45/methods/channels_getChannels.md b/old_docs/API_docs_v45/methods/channels_getChannels.md index bd5958d6..9cd9e798 100644 --- a/old_docs/API_docs_v45/methods/channels_getChannels.md +++ b/old_docs/API_docs_v45/methods/channels_getChannels.md @@ -1,16 +1,18 @@ --- title: channels.getChannels -description: channels.getChannels parameters, return type and example +description: Get info about multiple channels/supergroups --- ## Method: channels.getChannels [Back to methods index](index.md) +Get info about multiple channels/supergroups + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|Array of [Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|Array of [Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Yes|The channel/supergroup MTProto IDs| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v45/methods/channels_getMessages.md b/old_docs/API_docs_v45/methods/channels_getMessages.md index 4440856c..cc944fe5 100644 --- a/old_docs/API_docs_v45/methods/channels_getMessages.md +++ b/old_docs/API_docs_v45/methods/channels_getMessages.md @@ -1,17 +1,19 @@ --- title: channels.getMessages -description: channels.getMessages parameters, return type and example +description: Get channel/supergroup messages --- ## Method: channels.getMessages [Back to methods index](index.md) +Get channel/supergroup messages + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|id|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The message IDs| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v45/methods/channels_getParticipant.md b/old_docs/API_docs_v45/methods/channels_getParticipant.md index c1819b6b..db9b1fc6 100644 --- a/old_docs/API_docs_v45/methods/channels_getParticipant.md +++ b/old_docs/API_docs_v45/methods/channels_getParticipant.md @@ -1,17 +1,19 @@ --- title: channels.getParticipant -description: channels.getParticipant parameters, return type and example +description: Get info about a certain channel/supergroup participant --- ## Method: channels.getParticipant [Back to methods index](index.md) +Get info about a certain channel/supergroup participant + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to fetch info about| ### Return type: [channels\_ChannelParticipant](../types/channels_ChannelParticipant.md) diff --git a/old_docs/API_docs_v45/methods/channels_getParticipants.md b/old_docs/API_docs_v45/methods/channels_getParticipants.md index 7ec8a980..96662466 100644 --- a/old_docs/API_docs_v45/methods/channels_getParticipants.md +++ b/old_docs/API_docs_v45/methods/channels_getParticipants.md @@ -1,19 +1,21 @@ --- title: channels.getParticipants -description: channels.getParticipants parameters, return type and example +description: Get channel/supergroup participants (you should use `$MadelineProto->get_pwr_chat($id)` instead) --- ## Method: channels.getParticipants [Back to methods index](index.md) +Get channel/supergroup participants (you should use `$MadelineProto->get_pwr_chat($id)` instead) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|filter|[CLICK ME ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) | Yes| -|offset|[CLICK ME int](../types/int.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|filter|[CLICK ME ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) | Yes|Member filter| +|offset|[CLICK ME int](../types/int.md) | Yes|Offset| +|limit|[CLICK ME int](../types/int.md) | Yes|Limit| ### Return type: [channels\_ChannelParticipants](../types/channels_ChannelParticipants.md) diff --git a/old_docs/API_docs_v45/methods/channels_inviteToChannel.md b/old_docs/API_docs_v45/methods/channels_inviteToChannel.md index 9bca2967..676f800c 100644 --- a/old_docs/API_docs_v45/methods/channels_inviteToChannel.md +++ b/old_docs/API_docs_v45/methods/channels_inviteToChannel.md @@ -1,17 +1,19 @@ --- title: channels.inviteToChannel -description: channels.inviteToChannel parameters, return type and example +description: Add users to channel/supergroup --- ## Method: channels.inviteToChannel [Back to methods index](index.md) +Add users to channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to add| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v45/methods/channels_joinChannel.md b/old_docs/API_docs_v45/methods/channels_joinChannel.md index 9ecdbe75..721f707c 100644 --- a/old_docs/API_docs_v45/methods/channels_joinChannel.md +++ b/old_docs/API_docs_v45/methods/channels_joinChannel.md @@ -1,16 +1,18 @@ --- title: channels.joinChannel -description: channels.joinChannel parameters, return type and example +description: Join a channel/supergroup --- ## Method: channels.joinChannel [Back to methods index](index.md) +Join a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup to join| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v45/methods/channels_leaveChannel.md b/old_docs/API_docs_v45/methods/channels_leaveChannel.md index 62c20a00..7f02e08c 100644 --- a/old_docs/API_docs_v45/methods/channels_leaveChannel.md +++ b/old_docs/API_docs_v45/methods/channels_leaveChannel.md @@ -1,16 +1,18 @@ --- title: channels.leaveChannel -description: channels.leaveChannel parameters, return type and example +description: Leave a channel/supergroup --- ## Method: channels.leaveChannel [Back to methods index](index.md) +Leave a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup to leave| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v45/methods/channels_readHistory.md b/old_docs/API_docs_v45/methods/channels_readHistory.md index 745893f6..cca891f0 100644 --- a/old_docs/API_docs_v45/methods/channels_readHistory.md +++ b/old_docs/API_docs_v45/methods/channels_readHistory.md @@ -1,17 +1,19 @@ --- title: channels.readHistory -description: channels.readHistory parameters, return type and example +description: Mark channel/supergroup history as read --- ## Method: channels.readHistory [Back to methods index](index.md) +Mark channel/supergroup history as read + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|max\_id|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to mark as read| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v45/methods/channels_reportSpam.md b/old_docs/API_docs_v45/methods/channels_reportSpam.md index 47dd7cff..09af14e0 100644 --- a/old_docs/API_docs_v45/methods/channels_reportSpam.md +++ b/old_docs/API_docs_v45/methods/channels_reportSpam.md @@ -1,18 +1,20 @@ --- title: channels.reportSpam -description: channels.reportSpam parameters, return type and example +description: Report a supergroup/channel for spam --- ## Method: channels.reportSpam [Back to methods index](index.md) +Report a supergroup/channel for spam + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|id|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that added you to this channel| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to report| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v45/methods/channels_updateUsername.md b/old_docs/API_docs_v45/methods/channels_updateUsername.md index 19647598..ad34490a 100644 --- a/old_docs/API_docs_v45/methods/channels_updateUsername.md +++ b/old_docs/API_docs_v45/methods/channels_updateUsername.md @@ -1,17 +1,19 @@ --- title: channels.updateUsername -description: channels.updateUsername parameters, return type and example +description: Update the username of a supergroup/channel --- ## Method: channels.updateUsername [Back to methods index](index.md) +Update the username of a supergroup/channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|username|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|username|[CLICK ME string](../types/string.md) | Yes|The new username| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v45/methods/contacts_getBlocked.md b/old_docs/API_docs_v45/methods/contacts_getBlocked.md index d7d8c5cc..300025af 100644 --- a/old_docs/API_docs_v45/methods/contacts_getBlocked.md +++ b/old_docs/API_docs_v45/methods/contacts_getBlocked.md @@ -12,7 +12,7 @@ Get blocked users | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, then set to the number of blocked contacts previously fetched| +|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, Then set to the number of blocked contacts previously fetched| |limit|[CLICK ME int](../types/int.md) | Yes|How many blocked contacts to fetch| diff --git a/old_docs/API_docs_v45/methods/help_getAppChangelog.md b/old_docs/API_docs_v45/methods/help_getAppChangelog.md index ec71a905..c8c41f71 100644 --- a/old_docs/API_docs_v45/methods/help_getAppChangelog.md +++ b/old_docs/API_docs_v45/methods/help_getAppChangelog.md @@ -1,19 +1,21 @@ --- title: help.getAppChangelog -description: help.getAppChangelog parameters, return type and example +description: Get the changelog of this app --- ## Method: help.getAppChangelog [Back to methods index](index.md) +Get the changelog of this app + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|device\_model|[CLICK ME string](../types/string.md) | Yes| -|system\_version|[CLICK ME string](../types/string.md) | Yes| -|app\_version|[CLICK ME string](../types/string.md) | Yes| -|lang\_code|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|device\_model|[CLICK ME string](../types/string.md) | Yes|| +|system\_version|[CLICK ME string](../types/string.md) | Yes|| +|app\_version|[CLICK ME string](../types/string.md) | Yes|| +|lang\_code|[CLICK ME string](../types/string.md) | Yes|| ### Return type: [help\_AppChangelog](../types/help_AppChangelog.md) diff --git a/old_docs/API_docs_v45/methods/help_getAppUpdate.md b/old_docs/API_docs_v45/methods/help_getAppUpdate.md index d13d6263..f3eacbd6 100644 --- a/old_docs/API_docs_v45/methods/help_getAppUpdate.md +++ b/old_docs/API_docs_v45/methods/help_getAppUpdate.md @@ -1,19 +1,21 @@ --- title: help.getAppUpdate -description: help.getAppUpdate parameters, return type and example +description: Get info about app updates --- ## Method: help.getAppUpdate [Back to methods index](index.md) +Get info about app updates + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|device\_model|[CLICK ME string](../types/string.md) | Yes| -|system\_version|[CLICK ME string](../types/string.md) | Yes| -|app\_version|[CLICK ME string](../types/string.md) | Yes| -|lang\_code|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|device\_model|[CLICK ME string](../types/string.md) | Yes|| +|system\_version|[CLICK ME string](../types/string.md) | Yes|| +|app\_version|[CLICK ME string](../types/string.md) | Yes|| +|lang\_code|[CLICK ME string](../types/string.md) | Yes|| ### Return type: [help\_AppUpdate](../types/help_AppUpdate.md) diff --git a/old_docs/API_docs_v45/methods/help_getConfig.md b/old_docs/API_docs_v45/methods/help_getConfig.md index 885ad5d3..16e25c68 100644 --- a/old_docs/API_docs_v45/methods/help_getConfig.md +++ b/old_docs/API_docs_v45/methods/help_getConfig.md @@ -1,11 +1,13 @@ --- title: help.getConfig -description: help.getConfig parameters, return type and example +description: Get server configuration --- ## Method: help.getConfig [Back to methods index](index.md) +Get server configuration + ### Return type: [Config](../types/Config.md) diff --git a/old_docs/API_docs_v45/methods/help_getInviteText.md b/old_docs/API_docs_v45/methods/help_getInviteText.md index aeebae28..d9ae8e0d 100644 --- a/old_docs/API_docs_v45/methods/help_getInviteText.md +++ b/old_docs/API_docs_v45/methods/help_getInviteText.md @@ -1,16 +1,18 @@ --- title: help.getInviteText -description: help.getInviteText parameters, return type and example +description: Get invitation text --- ## Method: help.getInviteText [Back to methods index](index.md) +Get invitation text + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|lang\_code|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|lang\_code|[CLICK ME string](../types/string.md) | Yes|| ### Return type: [help\_InviteText](../types/help_InviteText.md) diff --git a/old_docs/API_docs_v45/methods/help_getNearestDc.md b/old_docs/API_docs_v45/methods/help_getNearestDc.md index 6196890b..35a8bf91 100644 --- a/old_docs/API_docs_v45/methods/help_getNearestDc.md +++ b/old_docs/API_docs_v45/methods/help_getNearestDc.md @@ -1,11 +1,13 @@ --- title: help.getNearestDc -description: help.getNearestDc parameters, return type and example +description: Get nearest datacenter --- ## Method: help.getNearestDc [Back to methods index](index.md) +Get nearest datacenter + ### Return type: [NearestDc](../types/NearestDc.md) diff --git a/old_docs/API_docs_v45/methods/help_getSupport.md b/old_docs/API_docs_v45/methods/help_getSupport.md index 9b269f78..a5bab0f2 100644 --- a/old_docs/API_docs_v45/methods/help_getSupport.md +++ b/old_docs/API_docs_v45/methods/help_getSupport.md @@ -1,11 +1,13 @@ --- title: help.getSupport -description: help.getSupport parameters, return type and example +description: Get info of support user --- ## Method: help.getSupport [Back to methods index](index.md) +Get info of support user + ### Return type: [help\_Support](../types/help_Support.md) diff --git a/old_docs/API_docs_v45/methods/help_getTermsOfService.md b/old_docs/API_docs_v45/methods/help_getTermsOfService.md index 3a1b355d..e9b1cae4 100644 --- a/old_docs/API_docs_v45/methods/help_getTermsOfService.md +++ b/old_docs/API_docs_v45/methods/help_getTermsOfService.md @@ -1,16 +1,18 @@ --- title: help.getTermsOfService -description: help.getTermsOfService parameters, return type and example +description: Get terms of service --- ## Method: help.getTermsOfService [Back to methods index](index.md) +Get terms of service + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|lang\_code|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|lang\_code|[CLICK ME string](../types/string.md) | Yes|| ### Return type: [help\_TermsOfService](../types/help_TermsOfService.md) diff --git a/old_docs/API_docs_v45/methods/help_saveAppLog.md b/old_docs/API_docs_v45/methods/help_saveAppLog.md index af6e94e2..0165b6e3 100644 --- a/old_docs/API_docs_v45/methods/help_saveAppLog.md +++ b/old_docs/API_docs_v45/methods/help_saveAppLog.md @@ -1,16 +1,18 @@ --- title: help.saveAppLog -description: help.saveAppLog parameters, return type and example +description: Log data for developer of this app --- ## Method: help.saveAppLog [Back to methods index](index.md) +Log data for developer of this app + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|events|Array of [CLICK ME InputAppEvent](../types/InputAppEvent.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|events|Array of [CLICK ME InputAppEvent](../types/InputAppEvent.md) | Yes|Event list| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v45/methods/messages_checkChatInvite.md b/old_docs/API_docs_v45/methods/messages_checkChatInvite.md index 4ddf5084..de1d9ff4 100644 --- a/old_docs/API_docs_v45/methods/messages_checkChatInvite.md +++ b/old_docs/API_docs_v45/methods/messages_checkChatInvite.md @@ -1,16 +1,18 @@ --- title: messages.checkChatInvite -description: messages.checkChatInvite parameters, return type and example +description: Check if an invitation link is valid --- ## Method: messages.checkChatInvite [Back to methods index](index.md) +Check if an invitation link is valid + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| ### Return type: [ChatInvite](../types/ChatInvite.md) diff --git a/old_docs/API_docs_v45/methods/messages_deleteChatUser.md b/old_docs/API_docs_v45/methods/messages_deleteChatUser.md index a71f4aaf..0a6830de 100644 --- a/old_docs/API_docs_v45/methods/messages_deleteChatUser.md +++ b/old_docs/API_docs_v45/methods/messages_deleteChatUser.md @@ -12,7 +12,7 @@ Delete a user from a chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The MTProto ID of the chat| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to delete (pass @me to leave the chat)| diff --git a/old_docs/API_docs_v45/methods/messages_editChatAdmin.md b/old_docs/API_docs_v45/methods/messages_editChatAdmin.md index 6bc8f9ae..7916f8b1 100644 --- a/old_docs/API_docs_v45/methods/messages_editChatAdmin.md +++ b/old_docs/API_docs_v45/methods/messages_editChatAdmin.md @@ -1,18 +1,20 @@ --- title: messages.editChatAdmin -description: messages.editChatAdmin parameters, return type and example +description: Edit admin permissions --- ## Method: messages.editChatAdmin [Back to methods index](index.md) +Edit admin permissions + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|is\_admin|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat ID (no supergroups)| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user ID| +|is\_admin|[CLICK ME Bool](../types/Bool.md) | Yes|Should the user be admin?| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v45/methods/messages_editChatPhoto.md b/old_docs/API_docs_v45/methods/messages_editChatPhoto.md index 8848eca7..122913c4 100644 --- a/old_docs/API_docs_v45/methods/messages_editChatPhoto.md +++ b/old_docs/API_docs_v45/methods/messages_editChatPhoto.md @@ -12,7 +12,7 @@ Edit the photo of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The MTProto ID of the chat| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| |photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| diff --git a/old_docs/API_docs_v45/methods/messages_editChatTitle.md b/old_docs/API_docs_v45/methods/messages_editChatTitle.md index 1c1c7a16..3a1e974b 100644 --- a/old_docs/API_docs_v45/methods/messages_editChatTitle.md +++ b/old_docs/API_docs_v45/methods/messages_editChatTitle.md @@ -12,7 +12,7 @@ Edit the title of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The MTProto ID of the chat| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| |title|[CLICK ME string](../types/string.md) | Yes|The new title| diff --git a/old_docs/API_docs_v45/methods/messages_exportChatInvite.md b/old_docs/API_docs_v45/methods/messages_exportChatInvite.md index 74d70c21..98685d96 100644 --- a/old_docs/API_docs_v45/methods/messages_exportChatInvite.md +++ b/old_docs/API_docs_v45/methods/messages_exportChatInvite.md @@ -1,16 +1,18 @@ --- title: messages.exportChatInvite -description: messages.exportChatInvite parameters, return type and example +description: Export chat invite --- ## Method: messages.exportChatInvite [Back to methods index](index.md) +Export chat invite + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat id | ### Return type: [ExportedChatInvite](../types/ExportedChatInvite.md) diff --git a/old_docs/API_docs_v45/methods/messages_getAllStickers.md b/old_docs/API_docs_v45/methods/messages_getAllStickers.md index 575fcd49..16fdba6c 100644 --- a/old_docs/API_docs_v45/methods/messages_getAllStickers.md +++ b/old_docs/API_docs_v45/methods/messages_getAllStickers.md @@ -1,16 +1,18 @@ --- title: messages.getAllStickers -description: messages.getAllStickers parameters, return type and example +description: Get all stickerpacks --- ## Method: messages.getAllStickers [Back to methods index](index.md) +Get all stickerpacks + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v45/methods/messages_getDocumentByHash.md b/old_docs/API_docs_v45/methods/messages_getDocumentByHash.md index b7c45398..1af5bad4 100644 --- a/old_docs/API_docs_v45/methods/messages_getDocumentByHash.md +++ b/old_docs/API_docs_v45/methods/messages_getDocumentByHash.md @@ -1,18 +1,20 @@ --- title: messages.getDocumentByHash -description: messages.getDocumentByHash parameters, return type and example +description: Get document by SHA256 hash --- ## Method: messages.getDocumentByHash [Back to methods index](index.md) +Get document by SHA256 hash + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|sha256|[CLICK ME bytes](../types/bytes.md) | Yes| -|size|[CLICK ME int](../types/int.md) | Yes| -|mime\_type|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|sha256|[CLICK ME bytes](../types/bytes.md) | Yes|`hash('sha256', $filename, true);`| +|size|[CLICK ME int](../types/int.md) | Yes|The file size| +|mime\_type|[CLICK ME string](../types/string.md) | Yes|The mime type of the file| ### Return type: [Document](../types/Document.md) diff --git a/old_docs/API_docs_v45/methods/messages_getInlineBotResults.md b/old_docs/API_docs_v45/methods/messages_getInlineBotResults.md index 8a6608c0..fc80c5e8 100644 --- a/old_docs/API_docs_v45/methods/messages_getInlineBotResults.md +++ b/old_docs/API_docs_v45/methods/messages_getInlineBotResults.md @@ -1,18 +1,20 @@ --- title: messages.getInlineBotResults -description: messages.getInlineBotResults parameters, return type and example +description: Call inline bot --- ## Method: messages.getInlineBotResults [Back to methods index](index.md) +Call inline bot + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|query|[CLICK ME string](../types/string.md) | Yes| -|offset|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot to call| +|query|[CLICK ME string](../types/string.md) | Yes|The query to send to the bot| +|offset|[CLICK ME string](../types/string.md) | Yes|The offset to send to the bot| ### Return type: [messages\_BotResults](../types/messages_BotResults.md) diff --git a/old_docs/API_docs_v45/methods/messages_getMessagesViews.md b/old_docs/API_docs_v45/methods/messages_getMessagesViews.md index e3f4e4ea..b8d78c85 100644 --- a/old_docs/API_docs_v45/methods/messages_getMessagesViews.md +++ b/old_docs/API_docs_v45/methods/messages_getMessagesViews.md @@ -1,18 +1,20 @@ --- title: messages.getMessagesViews -description: messages.getMessagesViews parameters, return type and example +description: Get and increase message views --- ## Method: messages.getMessagesViews [Back to methods index](index.md) +Get and increase message views + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|id|Array of [CLICK ME int](../types/int.md) | Yes| -|increment|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the message is located| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs messages to get| +|increment|[CLICK ME Bool](../types/Bool.md) | Yes|Increase message views?| ### Return type: [Vector\_of\_int](../types/int.md) diff --git a/old_docs/API_docs_v45/methods/messages_getSavedGifs.md b/old_docs/API_docs_v45/methods/messages_getSavedGifs.md index 08dc4be6..f61348ce 100644 --- a/old_docs/API_docs_v45/methods/messages_getSavedGifs.md +++ b/old_docs/API_docs_v45/methods/messages_getSavedGifs.md @@ -1,16 +1,18 @@ --- title: messages.getSavedGifs -description: messages.getSavedGifs parameters, return type and example +description: Get saved gifs --- ## Method: messages.getSavedGifs [Back to methods index](index.md) +Get saved gifs + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_SavedGifs](../types/messages_SavedGifs.md) diff --git a/old_docs/API_docs_v45/methods/messages_getStickerSet.md b/old_docs/API_docs_v45/methods/messages_getStickerSet.md index 70bdd9ba..c86807e4 100644 --- a/old_docs/API_docs_v45/methods/messages_getStickerSet.md +++ b/old_docs/API_docs_v45/methods/messages_getStickerSet.md @@ -1,16 +1,18 @@ --- title: messages.getStickerSet -description: messages.getStickerSet parameters, return type and example +description: Get a stickerset --- ## Method: messages.getStickerSet [Back to methods index](index.md) +Get a stickerset + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset to get| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/old_docs/API_docs_v45/methods/messages_getStickers.md b/old_docs/API_docs_v45/methods/messages_getStickers.md index 178b897c..4854696d 100644 --- a/old_docs/API_docs_v45/methods/messages_getStickers.md +++ b/old_docs/API_docs_v45/methods/messages_getStickers.md @@ -1,17 +1,19 @@ --- title: messages.getStickers -description: messages.getStickers parameters, return type and example +description: Get stickers --- ## Method: messages.getStickers [Back to methods index](index.md) +Get stickers + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|emoticon|[CLICK ME string](../types/string.md) | Yes| -|hash|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|emoticon|[CLICK ME string](../types/string.md) | Yes|Search by emoji| +|hash|[CLICK ME string](../types/string.md) | Yes|0 or $MadelineProto->gen_vector_hash(previously fetched sticker IDs)| ### Return type: [messages\_Stickers](../types/messages_Stickers.md) diff --git a/old_docs/API_docs_v45/methods/messages_getWebPagePreview.md b/old_docs/API_docs_v45/methods/messages_getWebPagePreview.md index 35243c9f..d01bdd32 100644 --- a/old_docs/API_docs_v45/methods/messages_getWebPagePreview.md +++ b/old_docs/API_docs_v45/methods/messages_getWebPagePreview.md @@ -1,16 +1,18 @@ --- title: messages.getWebPagePreview -description: messages.getWebPagePreview parameters, return type and example +description: Get webpage preview --- ## Method: messages.getWebPagePreview [Back to methods index](index.md) +Get webpage preview + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|message|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|message|[CLICK ME string](../types/string.md) | Yes|Extract preview from this message| ### Return type: [MessageMedia](../types/MessageMedia.md) diff --git a/old_docs/API_docs_v45/methods/messages_importChatInvite.md b/old_docs/API_docs_v45/methods/messages_importChatInvite.md index 2bea5247..0d6cd7c8 100644 --- a/old_docs/API_docs_v45/methods/messages_importChatInvite.md +++ b/old_docs/API_docs_v45/methods/messages_importChatInvite.md @@ -1,16 +1,18 @@ --- title: messages.importChatInvite -description: messages.importChatInvite parameters, return type and example +description: Import chat invite --- ## Method: messages.importChatInvite [Back to methods index](index.md) +Import chat invite + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v45/methods/messages_installStickerSet.md b/old_docs/API_docs_v45/methods/messages_installStickerSet.md index 857aa738..f620c96a 100644 --- a/old_docs/API_docs_v45/methods/messages_installStickerSet.md +++ b/old_docs/API_docs_v45/methods/messages_installStickerSet.md @@ -1,17 +1,19 @@ --- title: messages.installStickerSet -description: messages.installStickerSet parameters, return type and example +description: Add a sticker set --- ## Method: messages.installStickerSet [Back to methods index](index.md) +Add a sticker set + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional| -|disabled|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to add| +|disabled|[CLICK ME Bool](../types/Bool.md) | Yes|| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v45/methods/messages_migrateChat.md b/old_docs/API_docs_v45/methods/messages_migrateChat.md index 5021ad45..db57adfa 100644 --- a/old_docs/API_docs_v45/methods/messages_migrateChat.md +++ b/old_docs/API_docs_v45/methods/messages_migrateChat.md @@ -1,16 +1,18 @@ --- title: messages.migrateChat -description: messages.migrateChat parameters, return type and example +description: Convert chat to supergroup --- ## Method: messages.migrateChat [Back to methods index](index.md) +Convert chat to supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat to convert| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v45/methods/messages_readEncryptedHistory.md b/old_docs/API_docs_v45/methods/messages_readEncryptedHistory.md index 4d341809..39b110e3 100644 --- a/old_docs/API_docs_v45/methods/messages_readEncryptedHistory.md +++ b/old_docs/API_docs_v45/methods/messages_readEncryptedHistory.md @@ -1,17 +1,19 @@ --- title: messages.readEncryptedHistory -description: messages.readEncryptedHistory parameters, return type and example +description: Mark messages as read in secret chats --- ## Method: messages.readEncryptedHistory [Back to methods index](index.md) +Mark messages as read in secret chats + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|max\_date|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to mark messages as read| +|max\_date|[CLICK ME int](../types/int.md) | Yes|Maximum date of messages to mark| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v45/methods/messages_readMessageContents.md b/old_docs/API_docs_v45/methods/messages_readMessageContents.md index 0d27c209..9bb1bee8 100644 --- a/old_docs/API_docs_v45/methods/messages_readMessageContents.md +++ b/old_docs/API_docs_v45/methods/messages_readMessageContents.md @@ -1,16 +1,18 @@ --- title: messages.readMessageContents -description: messages.readMessageContents parameters, return type and example +description: Mark message as read --- ## Method: messages.readMessageContents [Back to methods index](index.md) +Mark message as read + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v45/methods/messages_receivedQueue.md b/old_docs/API_docs_v45/methods/messages_receivedQueue.md index c91caa37..4ad78ba2 100644 --- a/old_docs/API_docs_v45/methods/messages_receivedQueue.md +++ b/old_docs/API_docs_v45/methods/messages_receivedQueue.md @@ -1,77 +1,13 @@ --- title: messages.receivedQueue -description: messages.receivedQueue parameters, return type and example +description: You cannot use this method directly --- ## Method: messages.receivedQueue [Back to methods index](index.md) -### Parameters: - -| Name | Type | Required | -|----------|---------------|----------| -|max\_qts|[CLICK ME int](../types/int.md) | Yes| - - -### 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| - - -### MadelineProto Example: - - -``` -if (!file_exists('madeline.php')) { - copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); -} -include 'madeline.php'; - -// !!! This API id/API hash combination will not work !!! -// !!! You must get your own @ my.telegram.org !!! -$api_id = 0; -$api_hash = ''; - -$MadelineProto = new \danog\MadelineProto\API('session.madeline', ['app_info' => ['api_id' => $api_id, 'api_hash' => $api_hash]]); -$MadelineProto->start(); - -$Vector_of_long = $MadelineProto->messages->receivedQueue(['max_qts' => int, ]); -``` - -### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): - -### As a bot: - -POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` - -Parameters: - -* method - messages.receivedQueue -* params - `{"max_qts": int, }` - - - -### As a user: - -POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.receivedQueue` - -Parameters: - -max_qts - Json encoded int +**You cannot use this method directly** -Or, if you're into Lua: - -``` -Vector_of_long = messages.receivedQueue({max_qts=int, }) -``` - diff --git a/old_docs/API_docs_v45/methods/messages_reorderStickerSets.md b/old_docs/API_docs_v45/methods/messages_reorderStickerSets.md index ad5df9fa..b2cbe4c1 100644 --- a/old_docs/API_docs_v45/methods/messages_reorderStickerSets.md +++ b/old_docs/API_docs_v45/methods/messages_reorderStickerSets.md @@ -1,16 +1,18 @@ --- title: messages.reorderStickerSets -description: messages.reorderStickerSets parameters, return type and example +description: Reorder sticker sets --- ## Method: messages.reorderStickerSets [Back to methods index](index.md) +Reorder sticker sets + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|order|Array of [CLICK ME long](../types/long.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|order|Array of [CLICK ME long](../types/long.md) | Yes|The order| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v45/methods/messages_saveGif.md b/old_docs/API_docs_v45/methods/messages_saveGif.md index 4a3b6166..6f608c4c 100644 --- a/old_docs/API_docs_v45/methods/messages_saveGif.md +++ b/old_docs/API_docs_v45/methods/messages_saveGif.md @@ -1,17 +1,19 @@ --- title: messages.saveGif -description: messages.saveGif parameters, return type and example +description: Save a GIF --- ## Method: messages.saveGif [Back to methods index](index.md) +Save a GIF + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional| -|unsave|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The GIF to save| +|unsave|[CLICK ME Bool](../types/Bool.md) | Yes|Remove the gif?| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v45/methods/messages_searchGifs.md b/old_docs/API_docs_v45/methods/messages_searchGifs.md index fefef1d7..103ebfeb 100644 --- a/old_docs/API_docs_v45/methods/messages_searchGifs.md +++ b/old_docs/API_docs_v45/methods/messages_searchGifs.md @@ -1,17 +1,19 @@ --- title: messages.searchGifs -description: messages.searchGifs parameters, return type and example +description: Search gifs --- ## Method: messages.searchGifs [Back to methods index](index.md) +Search gifs + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|q|[CLICK ME string](../types/string.md) | Yes| -|offset|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|q|[CLICK ME string](../types/string.md) | Yes|The search query| +|offset|[CLICK ME int](../types/int.md) | Yes|The offset | ### Return type: [messages\_FoundGifs](../types/messages_FoundGifs.md) diff --git a/old_docs/API_docs_v45/methods/messages_searchGlobal.md b/old_docs/API_docs_v45/methods/messages_searchGlobal.md index 32ddd175..0edd1e40 100644 --- a/old_docs/API_docs_v45/methods/messages_searchGlobal.md +++ b/old_docs/API_docs_v45/methods/messages_searchGlobal.md @@ -1,20 +1,22 @@ --- title: messages.searchGlobal -description: messages.searchGlobal parameters, return type and example +description: Global message search --- ## Method: messages.searchGlobal [Back to methods index](index.md) +Global message search + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|q|[CLICK ME string](../types/string.md) | Yes| -|offset\_date|[CLICK ME int](../types/int.md) | Yes| -|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|offset\_id|[CLICK ME int](../types/int.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|q|[CLICK ME string](../types/string.md) | Yes|The query| +|offset\_date|[CLICK ME int](../types/int.md) | Yes|0 or the date offset| +|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|0 or the peer offset| +|offset\_id|[CLICK ME int](../types/int.md) | Yes|0 or the message ID offset| +|limit|[CLICK ME int](../types/int.md) | Yes|The number of results to return| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v45/methods/messages_sendEncrypted.md b/old_docs/API_docs_v45/methods/messages_sendEncrypted.md index 23461760..d48f88d7 100644 --- a/old_docs/API_docs_v45/methods/messages_sendEncrypted.md +++ b/old_docs/API_docs_v45/methods/messages_sendEncrypted.md @@ -1,17 +1,19 @@ --- title: messages.sendEncrypted -description: messages.sendEncrypted parameters, return type and example +description: Send message to secret chat --- ## Method: messages.sendEncrypted [Back to methods index](index.md) +Send message to secret chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the message| +|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v45/methods/messages_sendEncryptedFile.md b/old_docs/API_docs_v45/methods/messages_sendEncryptedFile.md index 64919abe..4fd0648e 100644 --- a/old_docs/API_docs_v45/methods/messages_sendEncryptedFile.md +++ b/old_docs/API_docs_v45/methods/messages_sendEncryptedFile.md @@ -1,18 +1,20 @@ --- title: messages.sendEncryptedFile -description: messages.sendEncryptedFile parameters, return type and example +description: Send a file to a secret chat --- ## Method: messages.sendEncryptedFile [Back to methods index](index.md) +Send a file to a secret chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes| -|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the file| +|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| +|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional|The file (optional)| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v45/methods/messages_sendEncryptedService.md b/old_docs/API_docs_v45/methods/messages_sendEncryptedService.md index 0a0eea8a..d66894bf 100644 --- a/old_docs/API_docs_v45/methods/messages_sendEncryptedService.md +++ b/old_docs/API_docs_v45/methods/messages_sendEncryptedService.md @@ -1,17 +1,19 @@ --- title: messages.sendEncryptedService -description: messages.sendEncryptedService parameters, return type and example +description: Send a service message to a secret chat --- ## Method: messages.sendEncryptedService [Back to methods index](index.md) +Send a service message to a secret chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the service message| +|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v45/methods/messages_sendInlineBotResult.md b/old_docs/API_docs_v45/methods/messages_sendInlineBotResult.md index 31437347..3f8a554b 100644 --- a/old_docs/API_docs_v45/methods/messages_sendInlineBotResult.md +++ b/old_docs/API_docs_v45/methods/messages_sendInlineBotResult.md @@ -1,20 +1,22 @@ --- title: messages.sendInlineBotResult -description: messages.sendInlineBotResult parameters, return type and example +description: Send a received bot result to the chat --- ## Method: messages.sendInlineBotResult [Back to methods index](index.md) +Send a received bot result to the chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|broadcast|[CLICK ME Bool](../types/Bool.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional| -|query\_id|[CLICK ME long](../types/long.md) | Yes| -|id|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|broadcast|[CLICK ME Bool](../types/Bool.md) | Optional|| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the message| +|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| +|query\_id|[CLICK ME long](../types/long.md) | Yes|The inline query ID| +|id|[CLICK ME string](../types/string.md) | Yes|The result ID| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v45/methods/messages_setEncryptedTyping.md b/old_docs/API_docs_v45/methods/messages_setEncryptedTyping.md index 3183fedf..e9afe99c 100644 --- a/old_docs/API_docs_v45/methods/messages_setEncryptedTyping.md +++ b/old_docs/API_docs_v45/methods/messages_setEncryptedTyping.md @@ -12,8 +12,8 @@ Send typing notification to secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|| -|typing|[CLICK ME Bool](../types/Bool.md) | Yes|| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to send the notification| +|typing|[CLICK ME Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v45/methods/messages_setInlineBotResults.md b/old_docs/API_docs_v45/methods/messages_setInlineBotResults.md index cbcb63cc..28a67893 100644 --- a/old_docs/API_docs_v45/methods/messages_setInlineBotResults.md +++ b/old_docs/API_docs_v45/methods/messages_setInlineBotResults.md @@ -1,21 +1,23 @@ --- title: messages.setInlineBotResults -description: messages.setInlineBotResults parameters, return type and example +description: Bots only: set the results of an inline query --- ## Method: messages.setInlineBotResults [Back to methods index](index.md) +Bots only: set the results of an inline query + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|gallery|[CLICK ME Bool](../types/Bool.md) | Optional| -|private|[CLICK ME Bool](../types/Bool.md) | Optional| -|query\_id|[CLICK ME long](../types/long.md) | Yes| -|results|Array of [CLICK ME InputBotInlineResult](../types/InputBotInlineResult.md) | Yes| -|cache\_time|[CLICK ME int](../types/int.md) | Yes| -|next\_offset|[CLICK ME string](../types/string.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|gallery|[CLICK ME Bool](../types/Bool.md) | Optional|Is this a gallery?| +|private|[CLICK ME Bool](../types/Bool.md) | Optional|Is this result private (not cached)?| +|query\_id|[CLICK ME long](../types/long.md) | Yes|Query ID| +|results|Array of [CLICK ME InputBotInlineResult](../types/InputBotInlineResult.md) | Yes|Results| +|cache\_time|[CLICK ME int](../types/int.md) | Yes|Cache time| +|next\_offset|[CLICK ME string](../types/string.md) | Optional|The next offset| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v45/methods/messages_startBot.md b/old_docs/API_docs_v45/methods/messages_startBot.md index 0de0f1a5..94a4d86a 100644 --- a/old_docs/API_docs_v45/methods/messages_startBot.md +++ b/old_docs/API_docs_v45/methods/messages_startBot.md @@ -1,18 +1,20 @@ --- title: messages.startBot -description: messages.startBot parameters, return type and example +description: Start a bot --- ## Method: messages.startBot [Back to methods index](index.md) +Start a bot + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|start\_param|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot's ID or username| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to start the bot (@me or group ID/username)| +|start\_param|[CLICK ME string](../types/string.md) | Yes|The bot's start parameter| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v45/methods/messages_toggleChatAdmins.md b/old_docs/API_docs_v45/methods/messages_toggleChatAdmins.md index d56e5753..ab591fd9 100644 --- a/old_docs/API_docs_v45/methods/messages_toggleChatAdmins.md +++ b/old_docs/API_docs_v45/methods/messages_toggleChatAdmins.md @@ -1,17 +1,19 @@ --- title: messages.toggleChatAdmins -description: messages.toggleChatAdmins parameters, return type and example +description: Enable all users are admins in normal groups (not supergroups) --- ## Method: messages.toggleChatAdmins [Back to methods index](index.md) +Enable all users are admins in normal groups (not supergroups) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Group ID| +|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Enable all users are admins| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v45/methods/messages_uninstallStickerSet.md b/old_docs/API_docs_v45/methods/messages_uninstallStickerSet.md index 60b0ca0c..6d04e847 100644 --- a/old_docs/API_docs_v45/methods/messages_uninstallStickerSet.md +++ b/old_docs/API_docs_v45/methods/messages_uninstallStickerSet.md @@ -1,16 +1,18 @@ --- title: messages.uninstallStickerSet -description: messages.uninstallStickerSet parameters, return type and example +description: Remove a sticker set --- ## Method: messages.uninstallStickerSet [Back to methods index](index.md) +Remove a sticker set + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to remove| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v45/methods/photos_deletePhotos.md b/old_docs/API_docs_v45/methods/photos_deletePhotos.md index 104459b7..b9daca10 100644 --- a/old_docs/API_docs_v45/methods/photos_deletePhotos.md +++ b/old_docs/API_docs_v45/methods/photos_deletePhotos.md @@ -1,16 +1,18 @@ --- title: photos.deletePhotos -description: photos.deletePhotos parameters, return type and example +description: Delete profile photos --- ## Method: photos.deletePhotos [Back to methods index](index.md) +Delete profile photos + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Yes|The profile photos to delete| ### Return type: [Vector\_of\_long](../types/long.md) diff --git a/old_docs/API_docs_v45/methods/photos_getUserPhotos.md b/old_docs/API_docs_v45/methods/photos_getUserPhotos.md index 1a7515ba..ea27a44f 100644 --- a/old_docs/API_docs_v45/methods/photos_getUserPhotos.md +++ b/old_docs/API_docs_v45/methods/photos_getUserPhotos.md @@ -1,19 +1,21 @@ --- title: photos.getUserPhotos -description: photos.getUserPhotos parameters, return type and example +description: Get the profile photos of a user --- ## Method: photos.getUserPhotos [Back to methods index](index.md) +Get the profile photos of a user + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|offset|[CLICK ME int](../types/int.md) | Yes| -|max\_id|[CLICK ME long](../types/long.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| +|offset|[CLICK ME int](../types/int.md) | Yes|Offset| +|max\_id|[CLICK ME long](../types/long.md) | Yes|Maximum ID of photo to return| +|limit|[CLICK ME int](../types/int.md) | Yes|Number of photos to return| ### Return type: [photos\_Photos](../types/photos_Photos.md) diff --git a/old_docs/API_docs_v45/methods/photos_updateProfilePhoto.md b/old_docs/API_docs_v45/methods/photos_updateProfilePhoto.md index 386970d5..dc6edd6b 100644 --- a/old_docs/API_docs_v45/methods/photos_updateProfilePhoto.md +++ b/old_docs/API_docs_v45/methods/photos_updateProfilePhoto.md @@ -1,17 +1,19 @@ --- title: photos.updateProfilePhoto -description: photos.updateProfilePhoto parameters, return type and example +description: Update the profile photo (use photos->uploadProfilePhoto to upload the photo) --- ## Method: photos.updateProfilePhoto [Back to methods index](index.md) +Update the profile photo (use photos->uploadProfilePhoto to upload the photo) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional| -|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional|The photo to use| +|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|| ### Return type: [UserProfilePhoto](../types/UserProfilePhoto.md) diff --git a/old_docs/API_docs_v45/methods/photos_uploadProfilePhoto.md b/old_docs/API_docs_v45/methods/photos_uploadProfilePhoto.md index 07b9936c..fb0bc534 100644 --- a/old_docs/API_docs_v45/methods/photos_uploadProfilePhoto.md +++ b/old_docs/API_docs_v45/methods/photos_uploadProfilePhoto.md @@ -1,19 +1,21 @@ --- title: photos.uploadProfilePhoto -description: photos.uploadProfilePhoto parameters, return type and example +description: Upload profile photo --- ## Method: photos.uploadProfilePhoto [Back to methods index](index.md) +Upload profile photo + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|file|[File path or InputFile](../types/InputFile.md) | Yes| -|caption|[CLICK ME string](../types/string.md) | Yes| -|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional| -|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|file|[File path or InputFile](../types/InputFile.md) | Yes|The photo| +|caption|[CLICK ME string](../types/string.md) | Yes|| +|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional|| +|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|| ### Return type: [photos\_Photo](../types/photos_Photo.md) diff --git a/old_docs/API_docs_v46/methods/account_registerDevice.md b/old_docs/API_docs_v46/methods/account_registerDevice.md index 1752afde..0a40f49c 100644 --- a/old_docs/API_docs_v46/methods/account_registerDevice.md +++ b/old_docs/API_docs_v46/methods/account_registerDevice.md @@ -12,8 +12,8 @@ Register device for push notifications | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and oTher, see source code of official apps for more info| +|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and oTher, see source code of official apps for more info| |device\_model|[CLICK ME string](../types/string.md) | Yes|| |system\_version|[CLICK ME string](../types/string.md) | Yes|| |app\_version|[CLICK ME string](../types/string.md) | Yes|| diff --git a/old_docs/API_docs_v46/methods/account_unregisterDevice.md b/old_docs/API_docs_v46/methods/account_unregisterDevice.md index 1d2b7670..32e44495 100644 --- a/old_docs/API_docs_v46/methods/account_unregisterDevice.md +++ b/old_docs/API_docs_v46/methods/account_unregisterDevice.md @@ -12,8 +12,8 @@ Stop sending PUSH notifications to app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and oTher, see source code of official apps for more info| +|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and oTher, see source code of official apps for more info| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v46/methods/channels_checkUsername.md b/old_docs/API_docs_v46/methods/channels_checkUsername.md index 371f4cd3..7bc7c245 100644 --- a/old_docs/API_docs_v46/methods/channels_checkUsername.md +++ b/old_docs/API_docs_v46/methods/channels_checkUsername.md @@ -1,17 +1,19 @@ --- title: channels.checkUsername -description: channels.checkUsername parameters, return type and example +description: Check if this username is free and can be assigned to a channel/supergroup --- ## Method: channels.checkUsername [Back to methods index](index.md) +Check if this username is free and can be assigned to a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|username|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|username|[CLICK ME string](../types/string.md) | Yes|The new username for this channel/supergroup| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v46/methods/channels_createChannel.md b/old_docs/API_docs_v46/methods/channels_createChannel.md index c5d21585..1305e4fb 100644 --- a/old_docs/API_docs_v46/methods/channels_createChannel.md +++ b/old_docs/API_docs_v46/methods/channels_createChannel.md @@ -1,19 +1,21 @@ --- title: channels.createChannel -description: channels.createChannel parameters, return type and example +description: Create channel/supergroup --- ## Method: channels.createChannel [Back to methods index](index.md) +Create channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|broadcast|[CLICK ME Bool](../types/Bool.md) | Optional| -|megagroup|[CLICK ME Bool](../types/Bool.md) | Optional| -|title|[CLICK ME string](../types/string.md) | Yes| -|about|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|broadcast|[CLICK ME Bool](../types/Bool.md) | Optional|Set this to true to create a channel| +|megagroup|[CLICK ME Bool](../types/Bool.md) | Optional|Set this to true to create a supergroup| +|title|[CLICK ME string](../types/string.md) | Yes|Supergroup/channel title| +|about|[CLICK ME string](../types/string.md) | Yes|About text| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v46/methods/channels_deleteChannel.md b/old_docs/API_docs_v46/methods/channels_deleteChannel.md index 61b29eac..e660d25c 100644 --- a/old_docs/API_docs_v46/methods/channels_deleteChannel.md +++ b/old_docs/API_docs_v46/methods/channels_deleteChannel.md @@ -1,16 +1,18 @@ --- title: channels.deleteChannel -description: channels.deleteChannel parameters, return type and example +description: Delete a channel/supergroup --- ## Method: channels.deleteChannel [Back to methods index](index.md) +Delete a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup to delete| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v46/methods/channels_deleteMessages.md b/old_docs/API_docs_v46/methods/channels_deleteMessages.md index 87a968c5..fb9d3cc2 100644 --- a/old_docs/API_docs_v46/methods/channels_deleteMessages.md +++ b/old_docs/API_docs_v46/methods/channels_deleteMessages.md @@ -1,17 +1,19 @@ --- title: channels.deleteMessages -description: channels.deleteMessages parameters, return type and example +description: Delete channel/supergroup messages --- ## Method: channels.deleteMessages [Back to methods index](index.md) +Delete channel/supergroup messages + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|id|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to delete| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v46/methods/channels_deleteUserHistory.md b/old_docs/API_docs_v46/methods/channels_deleteUserHistory.md index ee828f45..fbe34341 100644 --- a/old_docs/API_docs_v46/methods/channels_deleteUserHistory.md +++ b/old_docs/API_docs_v46/methods/channels_deleteUserHistory.md @@ -1,17 +1,19 @@ --- title: channels.deleteUserHistory -description: channels.deleteUserHistory parameters, return type and example +description: Delete all messages of a user in a channel/supergroup --- ## Method: channels.deleteUserHistory [Back to methods index](index.md) +Delete all messages of a user in a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) diff --git a/old_docs/API_docs_v46/methods/channels_editAbout.md b/old_docs/API_docs_v46/methods/channels_editAbout.md index 94be2503..8908f29e 100644 --- a/old_docs/API_docs_v46/methods/channels_editAbout.md +++ b/old_docs/API_docs_v46/methods/channels_editAbout.md @@ -1,17 +1,19 @@ --- title: channels.editAbout -description: channels.editAbout parameters, return type and example +description: Edit the about text of a channel/supergroup --- ## Method: channels.editAbout [Back to methods index](index.md) +Edit the about text of a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|about|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|about|[CLICK ME string](../types/string.md) | Yes|The new about text| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v46/methods/channels_editAdmin.md b/old_docs/API_docs_v46/methods/channels_editAdmin.md index e1917c89..695c5294 100644 --- a/old_docs/API_docs_v46/methods/channels_editAdmin.md +++ b/old_docs/API_docs_v46/methods/channels_editAdmin.md @@ -1,18 +1,20 @@ --- title: channels.editAdmin -description: channels.editAdmin parameters, return type and example +description: Edit admin permissions of a user in a channel/supergroup --- ## Method: channels.editAdmin [Back to methods index](index.md) +Edit admin permissions of a user in a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|role|[CLICK ME ChannelParticipantRole](../types/ChannelParticipantRole.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| +|role|[CLICK ME ChannelParticipantRole](../types/ChannelParticipantRole.md) | Yes|| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v46/methods/channels_editPhoto.md b/old_docs/API_docs_v46/methods/channels_editPhoto.md index 3a2c794b..9ccd864f 100644 --- a/old_docs/API_docs_v46/methods/channels_editPhoto.md +++ b/old_docs/API_docs_v46/methods/channels_editPhoto.md @@ -1,17 +1,19 @@ --- title: channels.editPhoto -description: channels.editPhoto parameters, return type and example +description: Edit the photo of a supergroup/channel --- ## Method: channels.editPhoto [Back to methods index](index.md) +Edit the photo of a supergroup/channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new photo| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v46/methods/channels_editTitle.md b/old_docs/API_docs_v46/methods/channels_editTitle.md index ec60e10f..b1024faf 100644 --- a/old_docs/API_docs_v46/methods/channels_editTitle.md +++ b/old_docs/API_docs_v46/methods/channels_editTitle.md @@ -1,17 +1,19 @@ --- title: channels.editTitle -description: channels.editTitle parameters, return type and example +description: Edit the title of a supergroup/channel --- ## Method: channels.editTitle [Back to methods index](index.md) +Edit the title of a supergroup/channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|title|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|title|[CLICK ME string](../types/string.md) | Yes|The new channel/supergroup title| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v46/methods/channels_exportInvite.md b/old_docs/API_docs_v46/methods/channels_exportInvite.md index 3c10f832..f0c737d5 100644 --- a/old_docs/API_docs_v46/methods/channels_exportInvite.md +++ b/old_docs/API_docs_v46/methods/channels_exportInvite.md @@ -1,16 +1,18 @@ --- title: channels.exportInvite -description: channels.exportInvite parameters, return type and example +description: Export the invite link of a channel --- ## Method: channels.exportInvite [Back to methods index](index.md) +Export the invite link of a channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| ### Return type: [ExportedChatInvite](../types/ExportedChatInvite.md) diff --git a/old_docs/API_docs_v46/methods/channels_getChannels.md b/old_docs/API_docs_v46/methods/channels_getChannels.md index bd5958d6..9cd9e798 100644 --- a/old_docs/API_docs_v46/methods/channels_getChannels.md +++ b/old_docs/API_docs_v46/methods/channels_getChannels.md @@ -1,16 +1,18 @@ --- title: channels.getChannels -description: channels.getChannels parameters, return type and example +description: Get info about multiple channels/supergroups --- ## Method: channels.getChannels [Back to methods index](index.md) +Get info about multiple channels/supergroups + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|Array of [Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|Array of [Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Yes|The channel/supergroup MTProto IDs| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v46/methods/channels_getMessages.md b/old_docs/API_docs_v46/methods/channels_getMessages.md index 4440856c..cc944fe5 100644 --- a/old_docs/API_docs_v46/methods/channels_getMessages.md +++ b/old_docs/API_docs_v46/methods/channels_getMessages.md @@ -1,17 +1,19 @@ --- title: channels.getMessages -description: channels.getMessages parameters, return type and example +description: Get channel/supergroup messages --- ## Method: channels.getMessages [Back to methods index](index.md) +Get channel/supergroup messages + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|id|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The message IDs| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v46/methods/channels_getParticipant.md b/old_docs/API_docs_v46/methods/channels_getParticipant.md index c1819b6b..db9b1fc6 100644 --- a/old_docs/API_docs_v46/methods/channels_getParticipant.md +++ b/old_docs/API_docs_v46/methods/channels_getParticipant.md @@ -1,17 +1,19 @@ --- title: channels.getParticipant -description: channels.getParticipant parameters, return type and example +description: Get info about a certain channel/supergroup participant --- ## Method: channels.getParticipant [Back to methods index](index.md) +Get info about a certain channel/supergroup participant + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to fetch info about| ### Return type: [channels\_ChannelParticipant](../types/channels_ChannelParticipant.md) diff --git a/old_docs/API_docs_v46/methods/channels_getParticipants.md b/old_docs/API_docs_v46/methods/channels_getParticipants.md index 7ec8a980..96662466 100644 --- a/old_docs/API_docs_v46/methods/channels_getParticipants.md +++ b/old_docs/API_docs_v46/methods/channels_getParticipants.md @@ -1,19 +1,21 @@ --- title: channels.getParticipants -description: channels.getParticipants parameters, return type and example +description: Get channel/supergroup participants (you should use `$MadelineProto->get_pwr_chat($id)` instead) --- ## Method: channels.getParticipants [Back to methods index](index.md) +Get channel/supergroup participants (you should use `$MadelineProto->get_pwr_chat($id)` instead) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|filter|[CLICK ME ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) | Yes| -|offset|[CLICK ME int](../types/int.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|filter|[CLICK ME ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) | Yes|Member filter| +|offset|[CLICK ME int](../types/int.md) | Yes|Offset| +|limit|[CLICK ME int](../types/int.md) | Yes|Limit| ### Return type: [channels\_ChannelParticipants](../types/channels_ChannelParticipants.md) diff --git a/old_docs/API_docs_v46/methods/channels_inviteToChannel.md b/old_docs/API_docs_v46/methods/channels_inviteToChannel.md index 9bca2967..676f800c 100644 --- a/old_docs/API_docs_v46/methods/channels_inviteToChannel.md +++ b/old_docs/API_docs_v46/methods/channels_inviteToChannel.md @@ -1,17 +1,19 @@ --- title: channels.inviteToChannel -description: channels.inviteToChannel parameters, return type and example +description: Add users to channel/supergroup --- ## Method: channels.inviteToChannel [Back to methods index](index.md) +Add users to channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to add| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v46/methods/channels_joinChannel.md b/old_docs/API_docs_v46/methods/channels_joinChannel.md index 9ecdbe75..721f707c 100644 --- a/old_docs/API_docs_v46/methods/channels_joinChannel.md +++ b/old_docs/API_docs_v46/methods/channels_joinChannel.md @@ -1,16 +1,18 @@ --- title: channels.joinChannel -description: channels.joinChannel parameters, return type and example +description: Join a channel/supergroup --- ## Method: channels.joinChannel [Back to methods index](index.md) +Join a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup to join| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v46/methods/channels_leaveChannel.md b/old_docs/API_docs_v46/methods/channels_leaveChannel.md index 62c20a00..7f02e08c 100644 --- a/old_docs/API_docs_v46/methods/channels_leaveChannel.md +++ b/old_docs/API_docs_v46/methods/channels_leaveChannel.md @@ -1,16 +1,18 @@ --- title: channels.leaveChannel -description: channels.leaveChannel parameters, return type and example +description: Leave a channel/supergroup --- ## Method: channels.leaveChannel [Back to methods index](index.md) +Leave a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup to leave| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v46/methods/channels_readHistory.md b/old_docs/API_docs_v46/methods/channels_readHistory.md index 745893f6..cca891f0 100644 --- a/old_docs/API_docs_v46/methods/channels_readHistory.md +++ b/old_docs/API_docs_v46/methods/channels_readHistory.md @@ -1,17 +1,19 @@ --- title: channels.readHistory -description: channels.readHistory parameters, return type and example +description: Mark channel/supergroup history as read --- ## Method: channels.readHistory [Back to methods index](index.md) +Mark channel/supergroup history as read + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|max\_id|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to mark as read| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v46/methods/channels_reportSpam.md b/old_docs/API_docs_v46/methods/channels_reportSpam.md index 47dd7cff..09af14e0 100644 --- a/old_docs/API_docs_v46/methods/channels_reportSpam.md +++ b/old_docs/API_docs_v46/methods/channels_reportSpam.md @@ -1,18 +1,20 @@ --- title: channels.reportSpam -description: channels.reportSpam parameters, return type and example +description: Report a supergroup/channel for spam --- ## Method: channels.reportSpam [Back to methods index](index.md) +Report a supergroup/channel for spam + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|id|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that added you to this channel| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to report| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v46/methods/channels_updateUsername.md b/old_docs/API_docs_v46/methods/channels_updateUsername.md index 19647598..ad34490a 100644 --- a/old_docs/API_docs_v46/methods/channels_updateUsername.md +++ b/old_docs/API_docs_v46/methods/channels_updateUsername.md @@ -1,17 +1,19 @@ --- title: channels.updateUsername -description: channels.updateUsername parameters, return type and example +description: Update the username of a supergroup/channel --- ## Method: channels.updateUsername [Back to methods index](index.md) +Update the username of a supergroup/channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|username|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|username|[CLICK ME string](../types/string.md) | Yes|The new username| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v46/methods/contacts_getBlocked.md b/old_docs/API_docs_v46/methods/contacts_getBlocked.md index d7d8c5cc..300025af 100644 --- a/old_docs/API_docs_v46/methods/contacts_getBlocked.md +++ b/old_docs/API_docs_v46/methods/contacts_getBlocked.md @@ -12,7 +12,7 @@ Get blocked users | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, then set to the number of blocked contacts previously fetched| +|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, Then set to the number of blocked contacts previously fetched| |limit|[CLICK ME int](../types/int.md) | Yes|How many blocked contacts to fetch| diff --git a/old_docs/API_docs_v46/methods/help_getAppChangelog.md b/old_docs/API_docs_v46/methods/help_getAppChangelog.md index ec71a905..c8c41f71 100644 --- a/old_docs/API_docs_v46/methods/help_getAppChangelog.md +++ b/old_docs/API_docs_v46/methods/help_getAppChangelog.md @@ -1,19 +1,21 @@ --- title: help.getAppChangelog -description: help.getAppChangelog parameters, return type and example +description: Get the changelog of this app --- ## Method: help.getAppChangelog [Back to methods index](index.md) +Get the changelog of this app + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|device\_model|[CLICK ME string](../types/string.md) | Yes| -|system\_version|[CLICK ME string](../types/string.md) | Yes| -|app\_version|[CLICK ME string](../types/string.md) | Yes| -|lang\_code|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|device\_model|[CLICK ME string](../types/string.md) | Yes|| +|system\_version|[CLICK ME string](../types/string.md) | Yes|| +|app\_version|[CLICK ME string](../types/string.md) | Yes|| +|lang\_code|[CLICK ME string](../types/string.md) | Yes|| ### Return type: [help\_AppChangelog](../types/help_AppChangelog.md) diff --git a/old_docs/API_docs_v46/methods/help_getAppUpdate.md b/old_docs/API_docs_v46/methods/help_getAppUpdate.md index d13d6263..f3eacbd6 100644 --- a/old_docs/API_docs_v46/methods/help_getAppUpdate.md +++ b/old_docs/API_docs_v46/methods/help_getAppUpdate.md @@ -1,19 +1,21 @@ --- title: help.getAppUpdate -description: help.getAppUpdate parameters, return type and example +description: Get info about app updates --- ## Method: help.getAppUpdate [Back to methods index](index.md) +Get info about app updates + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|device\_model|[CLICK ME string](../types/string.md) | Yes| -|system\_version|[CLICK ME string](../types/string.md) | Yes| -|app\_version|[CLICK ME string](../types/string.md) | Yes| -|lang\_code|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|device\_model|[CLICK ME string](../types/string.md) | Yes|| +|system\_version|[CLICK ME string](../types/string.md) | Yes|| +|app\_version|[CLICK ME string](../types/string.md) | Yes|| +|lang\_code|[CLICK ME string](../types/string.md) | Yes|| ### Return type: [help\_AppUpdate](../types/help_AppUpdate.md) diff --git a/old_docs/API_docs_v46/methods/help_getConfig.md b/old_docs/API_docs_v46/methods/help_getConfig.md index 885ad5d3..16e25c68 100644 --- a/old_docs/API_docs_v46/methods/help_getConfig.md +++ b/old_docs/API_docs_v46/methods/help_getConfig.md @@ -1,11 +1,13 @@ --- title: help.getConfig -description: help.getConfig parameters, return type and example +description: Get server configuration --- ## Method: help.getConfig [Back to methods index](index.md) +Get server configuration + ### Return type: [Config](../types/Config.md) diff --git a/old_docs/API_docs_v46/methods/help_getInviteText.md b/old_docs/API_docs_v46/methods/help_getInviteText.md index aeebae28..d9ae8e0d 100644 --- a/old_docs/API_docs_v46/methods/help_getInviteText.md +++ b/old_docs/API_docs_v46/methods/help_getInviteText.md @@ -1,16 +1,18 @@ --- title: help.getInviteText -description: help.getInviteText parameters, return type and example +description: Get invitation text --- ## Method: help.getInviteText [Back to methods index](index.md) +Get invitation text + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|lang\_code|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|lang\_code|[CLICK ME string](../types/string.md) | Yes|| ### Return type: [help\_InviteText](../types/help_InviteText.md) diff --git a/old_docs/API_docs_v46/methods/help_getNearestDc.md b/old_docs/API_docs_v46/methods/help_getNearestDc.md index 6196890b..35a8bf91 100644 --- a/old_docs/API_docs_v46/methods/help_getNearestDc.md +++ b/old_docs/API_docs_v46/methods/help_getNearestDc.md @@ -1,11 +1,13 @@ --- title: help.getNearestDc -description: help.getNearestDc parameters, return type and example +description: Get nearest datacenter --- ## Method: help.getNearestDc [Back to methods index](index.md) +Get nearest datacenter + ### Return type: [NearestDc](../types/NearestDc.md) diff --git a/old_docs/API_docs_v46/methods/help_getSupport.md b/old_docs/API_docs_v46/methods/help_getSupport.md index 9b269f78..a5bab0f2 100644 --- a/old_docs/API_docs_v46/methods/help_getSupport.md +++ b/old_docs/API_docs_v46/methods/help_getSupport.md @@ -1,11 +1,13 @@ --- title: help.getSupport -description: help.getSupport parameters, return type and example +description: Get info of support user --- ## Method: help.getSupport [Back to methods index](index.md) +Get info of support user + ### Return type: [help\_Support](../types/help_Support.md) diff --git a/old_docs/API_docs_v46/methods/help_getTermsOfService.md b/old_docs/API_docs_v46/methods/help_getTermsOfService.md index 3a1b355d..e9b1cae4 100644 --- a/old_docs/API_docs_v46/methods/help_getTermsOfService.md +++ b/old_docs/API_docs_v46/methods/help_getTermsOfService.md @@ -1,16 +1,18 @@ --- title: help.getTermsOfService -description: help.getTermsOfService parameters, return type and example +description: Get terms of service --- ## Method: help.getTermsOfService [Back to methods index](index.md) +Get terms of service + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|lang\_code|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|lang\_code|[CLICK ME string](../types/string.md) | Yes|| ### Return type: [help\_TermsOfService](../types/help_TermsOfService.md) diff --git a/old_docs/API_docs_v46/methods/help_saveAppLog.md b/old_docs/API_docs_v46/methods/help_saveAppLog.md index af6e94e2..0165b6e3 100644 --- a/old_docs/API_docs_v46/methods/help_saveAppLog.md +++ b/old_docs/API_docs_v46/methods/help_saveAppLog.md @@ -1,16 +1,18 @@ --- title: help.saveAppLog -description: help.saveAppLog parameters, return type and example +description: Log data for developer of this app --- ## Method: help.saveAppLog [Back to methods index](index.md) +Log data for developer of this app + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|events|Array of [CLICK ME InputAppEvent](../types/InputAppEvent.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|events|Array of [CLICK ME InputAppEvent](../types/InputAppEvent.md) | Yes|Event list| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v46/methods/messages_checkChatInvite.md b/old_docs/API_docs_v46/methods/messages_checkChatInvite.md index 4ddf5084..de1d9ff4 100644 --- a/old_docs/API_docs_v46/methods/messages_checkChatInvite.md +++ b/old_docs/API_docs_v46/methods/messages_checkChatInvite.md @@ -1,16 +1,18 @@ --- title: messages.checkChatInvite -description: messages.checkChatInvite parameters, return type and example +description: Check if an invitation link is valid --- ## Method: messages.checkChatInvite [Back to methods index](index.md) +Check if an invitation link is valid + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| ### Return type: [ChatInvite](../types/ChatInvite.md) diff --git a/old_docs/API_docs_v46/methods/messages_deleteChatUser.md b/old_docs/API_docs_v46/methods/messages_deleteChatUser.md index a71f4aaf..0a6830de 100644 --- a/old_docs/API_docs_v46/methods/messages_deleteChatUser.md +++ b/old_docs/API_docs_v46/methods/messages_deleteChatUser.md @@ -12,7 +12,7 @@ Delete a user from a chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The MTProto ID of the chat| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to delete (pass @me to leave the chat)| diff --git a/old_docs/API_docs_v46/methods/messages_editChatAdmin.md b/old_docs/API_docs_v46/methods/messages_editChatAdmin.md index 6bc8f9ae..7916f8b1 100644 --- a/old_docs/API_docs_v46/methods/messages_editChatAdmin.md +++ b/old_docs/API_docs_v46/methods/messages_editChatAdmin.md @@ -1,18 +1,20 @@ --- title: messages.editChatAdmin -description: messages.editChatAdmin parameters, return type and example +description: Edit admin permissions --- ## Method: messages.editChatAdmin [Back to methods index](index.md) +Edit admin permissions + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|is\_admin|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat ID (no supergroups)| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user ID| +|is\_admin|[CLICK ME Bool](../types/Bool.md) | Yes|Should the user be admin?| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v46/methods/messages_editChatPhoto.md b/old_docs/API_docs_v46/methods/messages_editChatPhoto.md index 8848eca7..122913c4 100644 --- a/old_docs/API_docs_v46/methods/messages_editChatPhoto.md +++ b/old_docs/API_docs_v46/methods/messages_editChatPhoto.md @@ -12,7 +12,7 @@ Edit the photo of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The MTProto ID of the chat| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| |photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| diff --git a/old_docs/API_docs_v46/methods/messages_editChatTitle.md b/old_docs/API_docs_v46/methods/messages_editChatTitle.md index 1c1c7a16..3a1e974b 100644 --- a/old_docs/API_docs_v46/methods/messages_editChatTitle.md +++ b/old_docs/API_docs_v46/methods/messages_editChatTitle.md @@ -12,7 +12,7 @@ Edit the title of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The MTProto ID of the chat| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| |title|[CLICK ME string](../types/string.md) | Yes|The new title| diff --git a/old_docs/API_docs_v46/methods/messages_exportChatInvite.md b/old_docs/API_docs_v46/methods/messages_exportChatInvite.md index 74d70c21..98685d96 100644 --- a/old_docs/API_docs_v46/methods/messages_exportChatInvite.md +++ b/old_docs/API_docs_v46/methods/messages_exportChatInvite.md @@ -1,16 +1,18 @@ --- title: messages.exportChatInvite -description: messages.exportChatInvite parameters, return type and example +description: Export chat invite --- ## Method: messages.exportChatInvite [Back to methods index](index.md) +Export chat invite + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat id | ### Return type: [ExportedChatInvite](../types/ExportedChatInvite.md) diff --git a/old_docs/API_docs_v46/methods/messages_getAllStickers.md b/old_docs/API_docs_v46/methods/messages_getAllStickers.md index 575fcd49..16fdba6c 100644 --- a/old_docs/API_docs_v46/methods/messages_getAllStickers.md +++ b/old_docs/API_docs_v46/methods/messages_getAllStickers.md @@ -1,16 +1,18 @@ --- title: messages.getAllStickers -description: messages.getAllStickers parameters, return type and example +description: Get all stickerpacks --- ## Method: messages.getAllStickers [Back to methods index](index.md) +Get all stickerpacks + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v46/methods/messages_getDocumentByHash.md b/old_docs/API_docs_v46/methods/messages_getDocumentByHash.md index b7c45398..1af5bad4 100644 --- a/old_docs/API_docs_v46/methods/messages_getDocumentByHash.md +++ b/old_docs/API_docs_v46/methods/messages_getDocumentByHash.md @@ -1,18 +1,20 @@ --- title: messages.getDocumentByHash -description: messages.getDocumentByHash parameters, return type and example +description: Get document by SHA256 hash --- ## Method: messages.getDocumentByHash [Back to methods index](index.md) +Get document by SHA256 hash + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|sha256|[CLICK ME bytes](../types/bytes.md) | Yes| -|size|[CLICK ME int](../types/int.md) | Yes| -|mime\_type|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|sha256|[CLICK ME bytes](../types/bytes.md) | Yes|`hash('sha256', $filename, true);`| +|size|[CLICK ME int](../types/int.md) | Yes|The file size| +|mime\_type|[CLICK ME string](../types/string.md) | Yes|The mime type of the file| ### Return type: [Document](../types/Document.md) diff --git a/old_docs/API_docs_v46/methods/messages_getInlineBotResults.md b/old_docs/API_docs_v46/methods/messages_getInlineBotResults.md index 8a6608c0..fc80c5e8 100644 --- a/old_docs/API_docs_v46/methods/messages_getInlineBotResults.md +++ b/old_docs/API_docs_v46/methods/messages_getInlineBotResults.md @@ -1,18 +1,20 @@ --- title: messages.getInlineBotResults -description: messages.getInlineBotResults parameters, return type and example +description: Call inline bot --- ## Method: messages.getInlineBotResults [Back to methods index](index.md) +Call inline bot + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|query|[CLICK ME string](../types/string.md) | Yes| -|offset|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot to call| +|query|[CLICK ME string](../types/string.md) | Yes|The query to send to the bot| +|offset|[CLICK ME string](../types/string.md) | Yes|The offset to send to the bot| ### Return type: [messages\_BotResults](../types/messages_BotResults.md) diff --git a/old_docs/API_docs_v46/methods/messages_getMessagesViews.md b/old_docs/API_docs_v46/methods/messages_getMessagesViews.md index e3f4e4ea..b8d78c85 100644 --- a/old_docs/API_docs_v46/methods/messages_getMessagesViews.md +++ b/old_docs/API_docs_v46/methods/messages_getMessagesViews.md @@ -1,18 +1,20 @@ --- title: messages.getMessagesViews -description: messages.getMessagesViews parameters, return type and example +description: Get and increase message views --- ## Method: messages.getMessagesViews [Back to methods index](index.md) +Get and increase message views + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|id|Array of [CLICK ME int](../types/int.md) | Yes| -|increment|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the message is located| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs messages to get| +|increment|[CLICK ME Bool](../types/Bool.md) | Yes|Increase message views?| ### Return type: [Vector\_of\_int](../types/int.md) diff --git a/old_docs/API_docs_v46/methods/messages_getSavedGifs.md b/old_docs/API_docs_v46/methods/messages_getSavedGifs.md index 08dc4be6..f61348ce 100644 --- a/old_docs/API_docs_v46/methods/messages_getSavedGifs.md +++ b/old_docs/API_docs_v46/methods/messages_getSavedGifs.md @@ -1,16 +1,18 @@ --- title: messages.getSavedGifs -description: messages.getSavedGifs parameters, return type and example +description: Get saved gifs --- ## Method: messages.getSavedGifs [Back to methods index](index.md) +Get saved gifs + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_SavedGifs](../types/messages_SavedGifs.md) diff --git a/old_docs/API_docs_v46/methods/messages_getStickerSet.md b/old_docs/API_docs_v46/methods/messages_getStickerSet.md index 70bdd9ba..c86807e4 100644 --- a/old_docs/API_docs_v46/methods/messages_getStickerSet.md +++ b/old_docs/API_docs_v46/methods/messages_getStickerSet.md @@ -1,16 +1,18 @@ --- title: messages.getStickerSet -description: messages.getStickerSet parameters, return type and example +description: Get a stickerset --- ## Method: messages.getStickerSet [Back to methods index](index.md) +Get a stickerset + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset to get| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/old_docs/API_docs_v46/methods/messages_getStickers.md b/old_docs/API_docs_v46/methods/messages_getStickers.md index 178b897c..4854696d 100644 --- a/old_docs/API_docs_v46/methods/messages_getStickers.md +++ b/old_docs/API_docs_v46/methods/messages_getStickers.md @@ -1,17 +1,19 @@ --- title: messages.getStickers -description: messages.getStickers parameters, return type and example +description: Get stickers --- ## Method: messages.getStickers [Back to methods index](index.md) +Get stickers + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|emoticon|[CLICK ME string](../types/string.md) | Yes| -|hash|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|emoticon|[CLICK ME string](../types/string.md) | Yes|Search by emoji| +|hash|[CLICK ME string](../types/string.md) | Yes|0 or $MadelineProto->gen_vector_hash(previously fetched sticker IDs)| ### Return type: [messages\_Stickers](../types/messages_Stickers.md) diff --git a/old_docs/API_docs_v46/methods/messages_getWebPagePreview.md b/old_docs/API_docs_v46/methods/messages_getWebPagePreview.md index 35243c9f..d01bdd32 100644 --- a/old_docs/API_docs_v46/methods/messages_getWebPagePreview.md +++ b/old_docs/API_docs_v46/methods/messages_getWebPagePreview.md @@ -1,16 +1,18 @@ --- title: messages.getWebPagePreview -description: messages.getWebPagePreview parameters, return type and example +description: Get webpage preview --- ## Method: messages.getWebPagePreview [Back to methods index](index.md) +Get webpage preview + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|message|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|message|[CLICK ME string](../types/string.md) | Yes|Extract preview from this message| ### Return type: [MessageMedia](../types/MessageMedia.md) diff --git a/old_docs/API_docs_v46/methods/messages_importChatInvite.md b/old_docs/API_docs_v46/methods/messages_importChatInvite.md index 2bea5247..0d6cd7c8 100644 --- a/old_docs/API_docs_v46/methods/messages_importChatInvite.md +++ b/old_docs/API_docs_v46/methods/messages_importChatInvite.md @@ -1,16 +1,18 @@ --- title: messages.importChatInvite -description: messages.importChatInvite parameters, return type and example +description: Import chat invite --- ## Method: messages.importChatInvite [Back to methods index](index.md) +Import chat invite + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v46/methods/messages_installStickerSet.md b/old_docs/API_docs_v46/methods/messages_installStickerSet.md index 857aa738..f620c96a 100644 --- a/old_docs/API_docs_v46/methods/messages_installStickerSet.md +++ b/old_docs/API_docs_v46/methods/messages_installStickerSet.md @@ -1,17 +1,19 @@ --- title: messages.installStickerSet -description: messages.installStickerSet parameters, return type and example +description: Add a sticker set --- ## Method: messages.installStickerSet [Back to methods index](index.md) +Add a sticker set + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional| -|disabled|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to add| +|disabled|[CLICK ME Bool](../types/Bool.md) | Yes|| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v46/methods/messages_migrateChat.md b/old_docs/API_docs_v46/methods/messages_migrateChat.md index 5021ad45..db57adfa 100644 --- a/old_docs/API_docs_v46/methods/messages_migrateChat.md +++ b/old_docs/API_docs_v46/methods/messages_migrateChat.md @@ -1,16 +1,18 @@ --- title: messages.migrateChat -description: messages.migrateChat parameters, return type and example +description: Convert chat to supergroup --- ## Method: messages.migrateChat [Back to methods index](index.md) +Convert chat to supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat to convert| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v46/methods/messages_readEncryptedHistory.md b/old_docs/API_docs_v46/methods/messages_readEncryptedHistory.md index 4d341809..39b110e3 100644 --- a/old_docs/API_docs_v46/methods/messages_readEncryptedHistory.md +++ b/old_docs/API_docs_v46/methods/messages_readEncryptedHistory.md @@ -1,17 +1,19 @@ --- title: messages.readEncryptedHistory -description: messages.readEncryptedHistory parameters, return type and example +description: Mark messages as read in secret chats --- ## Method: messages.readEncryptedHistory [Back to methods index](index.md) +Mark messages as read in secret chats + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|max\_date|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to mark messages as read| +|max\_date|[CLICK ME int](../types/int.md) | Yes|Maximum date of messages to mark| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v46/methods/messages_readMessageContents.md b/old_docs/API_docs_v46/methods/messages_readMessageContents.md index 0d27c209..9bb1bee8 100644 --- a/old_docs/API_docs_v46/methods/messages_readMessageContents.md +++ b/old_docs/API_docs_v46/methods/messages_readMessageContents.md @@ -1,16 +1,18 @@ --- title: messages.readMessageContents -description: messages.readMessageContents parameters, return type and example +description: Mark message as read --- ## Method: messages.readMessageContents [Back to methods index](index.md) +Mark message as read + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v46/methods/messages_receivedQueue.md b/old_docs/API_docs_v46/methods/messages_receivedQueue.md index c91caa37..4ad78ba2 100644 --- a/old_docs/API_docs_v46/methods/messages_receivedQueue.md +++ b/old_docs/API_docs_v46/methods/messages_receivedQueue.md @@ -1,77 +1,13 @@ --- title: messages.receivedQueue -description: messages.receivedQueue parameters, return type and example +description: You cannot use this method directly --- ## Method: messages.receivedQueue [Back to methods index](index.md) -### Parameters: - -| Name | Type | Required | -|----------|---------------|----------| -|max\_qts|[CLICK ME int](../types/int.md) | Yes| - - -### 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| - - -### MadelineProto Example: - - -``` -if (!file_exists('madeline.php')) { - copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); -} -include 'madeline.php'; - -// !!! This API id/API hash combination will not work !!! -// !!! You must get your own @ my.telegram.org !!! -$api_id = 0; -$api_hash = ''; - -$MadelineProto = new \danog\MadelineProto\API('session.madeline', ['app_info' => ['api_id' => $api_id, 'api_hash' => $api_hash]]); -$MadelineProto->start(); - -$Vector_of_long = $MadelineProto->messages->receivedQueue(['max_qts' => int, ]); -``` - -### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): - -### As a bot: - -POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` - -Parameters: - -* method - messages.receivedQueue -* params - `{"max_qts": int, }` - - - -### As a user: - -POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.receivedQueue` - -Parameters: - -max_qts - Json encoded int +**You cannot use this method directly** -Or, if you're into Lua: - -``` -Vector_of_long = messages.receivedQueue({max_qts=int, }) -``` - diff --git a/old_docs/API_docs_v46/methods/messages_reorderStickerSets.md b/old_docs/API_docs_v46/methods/messages_reorderStickerSets.md index ad5df9fa..b2cbe4c1 100644 --- a/old_docs/API_docs_v46/methods/messages_reorderStickerSets.md +++ b/old_docs/API_docs_v46/methods/messages_reorderStickerSets.md @@ -1,16 +1,18 @@ --- title: messages.reorderStickerSets -description: messages.reorderStickerSets parameters, return type and example +description: Reorder sticker sets --- ## Method: messages.reorderStickerSets [Back to methods index](index.md) +Reorder sticker sets + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|order|Array of [CLICK ME long](../types/long.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|order|Array of [CLICK ME long](../types/long.md) | Yes|The order| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v46/methods/messages_saveGif.md b/old_docs/API_docs_v46/methods/messages_saveGif.md index 4a3b6166..6f608c4c 100644 --- a/old_docs/API_docs_v46/methods/messages_saveGif.md +++ b/old_docs/API_docs_v46/methods/messages_saveGif.md @@ -1,17 +1,19 @@ --- title: messages.saveGif -description: messages.saveGif parameters, return type and example +description: Save a GIF --- ## Method: messages.saveGif [Back to methods index](index.md) +Save a GIF + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional| -|unsave|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The GIF to save| +|unsave|[CLICK ME Bool](../types/Bool.md) | Yes|Remove the gif?| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v46/methods/messages_searchGifs.md b/old_docs/API_docs_v46/methods/messages_searchGifs.md index fefef1d7..103ebfeb 100644 --- a/old_docs/API_docs_v46/methods/messages_searchGifs.md +++ b/old_docs/API_docs_v46/methods/messages_searchGifs.md @@ -1,17 +1,19 @@ --- title: messages.searchGifs -description: messages.searchGifs parameters, return type and example +description: Search gifs --- ## Method: messages.searchGifs [Back to methods index](index.md) +Search gifs + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|q|[CLICK ME string](../types/string.md) | Yes| -|offset|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|q|[CLICK ME string](../types/string.md) | Yes|The search query| +|offset|[CLICK ME int](../types/int.md) | Yes|The offset | ### Return type: [messages\_FoundGifs](../types/messages_FoundGifs.md) diff --git a/old_docs/API_docs_v46/methods/messages_searchGlobal.md b/old_docs/API_docs_v46/methods/messages_searchGlobal.md index 32ddd175..0edd1e40 100644 --- a/old_docs/API_docs_v46/methods/messages_searchGlobal.md +++ b/old_docs/API_docs_v46/methods/messages_searchGlobal.md @@ -1,20 +1,22 @@ --- title: messages.searchGlobal -description: messages.searchGlobal parameters, return type and example +description: Global message search --- ## Method: messages.searchGlobal [Back to methods index](index.md) +Global message search + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|q|[CLICK ME string](../types/string.md) | Yes| -|offset\_date|[CLICK ME int](../types/int.md) | Yes| -|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|offset\_id|[CLICK ME int](../types/int.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|q|[CLICK ME string](../types/string.md) | Yes|The query| +|offset\_date|[CLICK ME int](../types/int.md) | Yes|0 or the date offset| +|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|0 or the peer offset| +|offset\_id|[CLICK ME int](../types/int.md) | Yes|0 or the message ID offset| +|limit|[CLICK ME int](../types/int.md) | Yes|The number of results to return| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v46/methods/messages_sendEncrypted.md b/old_docs/API_docs_v46/methods/messages_sendEncrypted.md index 23461760..d48f88d7 100644 --- a/old_docs/API_docs_v46/methods/messages_sendEncrypted.md +++ b/old_docs/API_docs_v46/methods/messages_sendEncrypted.md @@ -1,17 +1,19 @@ --- title: messages.sendEncrypted -description: messages.sendEncrypted parameters, return type and example +description: Send message to secret chat --- ## Method: messages.sendEncrypted [Back to methods index](index.md) +Send message to secret chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the message| +|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v46/methods/messages_sendEncryptedFile.md b/old_docs/API_docs_v46/methods/messages_sendEncryptedFile.md index 64919abe..4fd0648e 100644 --- a/old_docs/API_docs_v46/methods/messages_sendEncryptedFile.md +++ b/old_docs/API_docs_v46/methods/messages_sendEncryptedFile.md @@ -1,18 +1,20 @@ --- title: messages.sendEncryptedFile -description: messages.sendEncryptedFile parameters, return type and example +description: Send a file to a secret chat --- ## Method: messages.sendEncryptedFile [Back to methods index](index.md) +Send a file to a secret chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes| -|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the file| +|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| +|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional|The file (optional)| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v46/methods/messages_sendEncryptedService.md b/old_docs/API_docs_v46/methods/messages_sendEncryptedService.md index 0a0eea8a..d66894bf 100644 --- a/old_docs/API_docs_v46/methods/messages_sendEncryptedService.md +++ b/old_docs/API_docs_v46/methods/messages_sendEncryptedService.md @@ -1,17 +1,19 @@ --- title: messages.sendEncryptedService -description: messages.sendEncryptedService parameters, return type and example +description: Send a service message to a secret chat --- ## Method: messages.sendEncryptedService [Back to methods index](index.md) +Send a service message to a secret chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the service message| +|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v46/methods/messages_sendInlineBotResult.md b/old_docs/API_docs_v46/methods/messages_sendInlineBotResult.md index 31437347..3f8a554b 100644 --- a/old_docs/API_docs_v46/methods/messages_sendInlineBotResult.md +++ b/old_docs/API_docs_v46/methods/messages_sendInlineBotResult.md @@ -1,20 +1,22 @@ --- title: messages.sendInlineBotResult -description: messages.sendInlineBotResult parameters, return type and example +description: Send a received bot result to the chat --- ## Method: messages.sendInlineBotResult [Back to methods index](index.md) +Send a received bot result to the chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|broadcast|[CLICK ME Bool](../types/Bool.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional| -|query\_id|[CLICK ME long](../types/long.md) | Yes| -|id|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|broadcast|[CLICK ME Bool](../types/Bool.md) | Optional|| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the message| +|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| +|query\_id|[CLICK ME long](../types/long.md) | Yes|The inline query ID| +|id|[CLICK ME string](../types/string.md) | Yes|The result ID| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v46/methods/messages_setEncryptedTyping.md b/old_docs/API_docs_v46/methods/messages_setEncryptedTyping.md index 3183fedf..e9afe99c 100644 --- a/old_docs/API_docs_v46/methods/messages_setEncryptedTyping.md +++ b/old_docs/API_docs_v46/methods/messages_setEncryptedTyping.md @@ -12,8 +12,8 @@ Send typing notification to secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|| -|typing|[CLICK ME Bool](../types/Bool.md) | Yes|| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to send the notification| +|typing|[CLICK ME Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v46/methods/messages_setInlineBotResults.md b/old_docs/API_docs_v46/methods/messages_setInlineBotResults.md index cbcb63cc..28a67893 100644 --- a/old_docs/API_docs_v46/methods/messages_setInlineBotResults.md +++ b/old_docs/API_docs_v46/methods/messages_setInlineBotResults.md @@ -1,21 +1,23 @@ --- title: messages.setInlineBotResults -description: messages.setInlineBotResults parameters, return type and example +description: Bots only: set the results of an inline query --- ## Method: messages.setInlineBotResults [Back to methods index](index.md) +Bots only: set the results of an inline query + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|gallery|[CLICK ME Bool](../types/Bool.md) | Optional| -|private|[CLICK ME Bool](../types/Bool.md) | Optional| -|query\_id|[CLICK ME long](../types/long.md) | Yes| -|results|Array of [CLICK ME InputBotInlineResult](../types/InputBotInlineResult.md) | Yes| -|cache\_time|[CLICK ME int](../types/int.md) | Yes| -|next\_offset|[CLICK ME string](../types/string.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|gallery|[CLICK ME Bool](../types/Bool.md) | Optional|Is this a gallery?| +|private|[CLICK ME Bool](../types/Bool.md) | Optional|Is this result private (not cached)?| +|query\_id|[CLICK ME long](../types/long.md) | Yes|Query ID| +|results|Array of [CLICK ME InputBotInlineResult](../types/InputBotInlineResult.md) | Yes|Results| +|cache\_time|[CLICK ME int](../types/int.md) | Yes|Cache time| +|next\_offset|[CLICK ME string](../types/string.md) | Optional|The next offset| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v46/methods/messages_startBot.md b/old_docs/API_docs_v46/methods/messages_startBot.md index 0de0f1a5..94a4d86a 100644 --- a/old_docs/API_docs_v46/methods/messages_startBot.md +++ b/old_docs/API_docs_v46/methods/messages_startBot.md @@ -1,18 +1,20 @@ --- title: messages.startBot -description: messages.startBot parameters, return type and example +description: Start a bot --- ## Method: messages.startBot [Back to methods index](index.md) +Start a bot + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|start\_param|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot's ID or username| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to start the bot (@me or group ID/username)| +|start\_param|[CLICK ME string](../types/string.md) | Yes|The bot's start parameter| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v46/methods/messages_toggleChatAdmins.md b/old_docs/API_docs_v46/methods/messages_toggleChatAdmins.md index d56e5753..ab591fd9 100644 --- a/old_docs/API_docs_v46/methods/messages_toggleChatAdmins.md +++ b/old_docs/API_docs_v46/methods/messages_toggleChatAdmins.md @@ -1,17 +1,19 @@ --- title: messages.toggleChatAdmins -description: messages.toggleChatAdmins parameters, return type and example +description: Enable all users are admins in normal groups (not supergroups) --- ## Method: messages.toggleChatAdmins [Back to methods index](index.md) +Enable all users are admins in normal groups (not supergroups) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Group ID| +|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Enable all users are admins| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v46/methods/messages_uninstallStickerSet.md b/old_docs/API_docs_v46/methods/messages_uninstallStickerSet.md index 60b0ca0c..6d04e847 100644 --- a/old_docs/API_docs_v46/methods/messages_uninstallStickerSet.md +++ b/old_docs/API_docs_v46/methods/messages_uninstallStickerSet.md @@ -1,16 +1,18 @@ --- title: messages.uninstallStickerSet -description: messages.uninstallStickerSet parameters, return type and example +description: Remove a sticker set --- ## Method: messages.uninstallStickerSet [Back to methods index](index.md) +Remove a sticker set + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to remove| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v46/methods/photos_deletePhotos.md b/old_docs/API_docs_v46/methods/photos_deletePhotos.md index 104459b7..b9daca10 100644 --- a/old_docs/API_docs_v46/methods/photos_deletePhotos.md +++ b/old_docs/API_docs_v46/methods/photos_deletePhotos.md @@ -1,16 +1,18 @@ --- title: photos.deletePhotos -description: photos.deletePhotos parameters, return type and example +description: Delete profile photos --- ## Method: photos.deletePhotos [Back to methods index](index.md) +Delete profile photos + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Yes|The profile photos to delete| ### Return type: [Vector\_of\_long](../types/long.md) diff --git a/old_docs/API_docs_v46/methods/photos_getUserPhotos.md b/old_docs/API_docs_v46/methods/photos_getUserPhotos.md index 1a7515ba..ea27a44f 100644 --- a/old_docs/API_docs_v46/methods/photos_getUserPhotos.md +++ b/old_docs/API_docs_v46/methods/photos_getUserPhotos.md @@ -1,19 +1,21 @@ --- title: photos.getUserPhotos -description: photos.getUserPhotos parameters, return type and example +description: Get the profile photos of a user --- ## Method: photos.getUserPhotos [Back to methods index](index.md) +Get the profile photos of a user + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|offset|[CLICK ME int](../types/int.md) | Yes| -|max\_id|[CLICK ME long](../types/long.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| +|offset|[CLICK ME int](../types/int.md) | Yes|Offset| +|max\_id|[CLICK ME long](../types/long.md) | Yes|Maximum ID of photo to return| +|limit|[CLICK ME int](../types/int.md) | Yes|Number of photos to return| ### Return type: [photos\_Photos](../types/photos_Photos.md) diff --git a/old_docs/API_docs_v46/methods/photos_updateProfilePhoto.md b/old_docs/API_docs_v46/methods/photos_updateProfilePhoto.md index 386970d5..dc6edd6b 100644 --- a/old_docs/API_docs_v46/methods/photos_updateProfilePhoto.md +++ b/old_docs/API_docs_v46/methods/photos_updateProfilePhoto.md @@ -1,17 +1,19 @@ --- title: photos.updateProfilePhoto -description: photos.updateProfilePhoto parameters, return type and example +description: Update the profile photo (use photos->uploadProfilePhoto to upload the photo) --- ## Method: photos.updateProfilePhoto [Back to methods index](index.md) +Update the profile photo (use photos->uploadProfilePhoto to upload the photo) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional| -|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional|The photo to use| +|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|| ### Return type: [UserProfilePhoto](../types/UserProfilePhoto.md) diff --git a/old_docs/API_docs_v46/methods/photos_uploadProfilePhoto.md b/old_docs/API_docs_v46/methods/photos_uploadProfilePhoto.md index 07b9936c..fb0bc534 100644 --- a/old_docs/API_docs_v46/methods/photos_uploadProfilePhoto.md +++ b/old_docs/API_docs_v46/methods/photos_uploadProfilePhoto.md @@ -1,19 +1,21 @@ --- title: photos.uploadProfilePhoto -description: photos.uploadProfilePhoto parameters, return type and example +description: Upload profile photo --- ## Method: photos.uploadProfilePhoto [Back to methods index](index.md) +Upload profile photo + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|file|[File path or InputFile](../types/InputFile.md) | Yes| -|caption|[CLICK ME string](../types/string.md) | Yes| -|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional| -|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|file|[File path or InputFile](../types/InputFile.md) | Yes|The photo| +|caption|[CLICK ME string](../types/string.md) | Yes|| +|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional|| +|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|| ### Return type: [photos\_Photo](../types/photos_Photo.md) diff --git a/old_docs/API_docs_v51/methods/account_registerDevice.md b/old_docs/API_docs_v51/methods/account_registerDevice.md index 1752afde..0a40f49c 100644 --- a/old_docs/API_docs_v51/methods/account_registerDevice.md +++ b/old_docs/API_docs_v51/methods/account_registerDevice.md @@ -12,8 +12,8 @@ Register device for push notifications | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and oTher, see source code of official apps for more info| +|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and oTher, see source code of official apps for more info| |device\_model|[CLICK ME string](../types/string.md) | Yes|| |system\_version|[CLICK ME string](../types/string.md) | Yes|| |app\_version|[CLICK ME string](../types/string.md) | Yes|| diff --git a/old_docs/API_docs_v51/methods/account_unregisterDevice.md b/old_docs/API_docs_v51/methods/account_unregisterDevice.md index 1d2b7670..32e44495 100644 --- a/old_docs/API_docs_v51/methods/account_unregisterDevice.md +++ b/old_docs/API_docs_v51/methods/account_unregisterDevice.md @@ -12,8 +12,8 @@ Stop sending PUSH notifications to app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and oTher, see source code of official apps for more info| +|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and oTher, see source code of official apps for more info| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v51/methods/channels_checkUsername.md b/old_docs/API_docs_v51/methods/channels_checkUsername.md index 371f4cd3..7bc7c245 100644 --- a/old_docs/API_docs_v51/methods/channels_checkUsername.md +++ b/old_docs/API_docs_v51/methods/channels_checkUsername.md @@ -1,17 +1,19 @@ --- title: channels.checkUsername -description: channels.checkUsername parameters, return type and example +description: Check if this username is free and can be assigned to a channel/supergroup --- ## Method: channels.checkUsername [Back to methods index](index.md) +Check if this username is free and can be assigned to a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|username|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|username|[CLICK ME string](../types/string.md) | Yes|The new username for this channel/supergroup| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v51/methods/channels_createChannel.md b/old_docs/API_docs_v51/methods/channels_createChannel.md index c5d21585..1305e4fb 100644 --- a/old_docs/API_docs_v51/methods/channels_createChannel.md +++ b/old_docs/API_docs_v51/methods/channels_createChannel.md @@ -1,19 +1,21 @@ --- title: channels.createChannel -description: channels.createChannel parameters, return type and example +description: Create channel/supergroup --- ## Method: channels.createChannel [Back to methods index](index.md) +Create channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|broadcast|[CLICK ME Bool](../types/Bool.md) | Optional| -|megagroup|[CLICK ME Bool](../types/Bool.md) | Optional| -|title|[CLICK ME string](../types/string.md) | Yes| -|about|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|broadcast|[CLICK ME Bool](../types/Bool.md) | Optional|Set this to true to create a channel| +|megagroup|[CLICK ME Bool](../types/Bool.md) | Optional|Set this to true to create a supergroup| +|title|[CLICK ME string](../types/string.md) | Yes|Supergroup/channel title| +|about|[CLICK ME string](../types/string.md) | Yes|About text| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v51/methods/channels_deleteChannel.md b/old_docs/API_docs_v51/methods/channels_deleteChannel.md index 61b29eac..e660d25c 100644 --- a/old_docs/API_docs_v51/methods/channels_deleteChannel.md +++ b/old_docs/API_docs_v51/methods/channels_deleteChannel.md @@ -1,16 +1,18 @@ --- title: channels.deleteChannel -description: channels.deleteChannel parameters, return type and example +description: Delete a channel/supergroup --- ## Method: channels.deleteChannel [Back to methods index](index.md) +Delete a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup to delete| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v51/methods/channels_deleteMessages.md b/old_docs/API_docs_v51/methods/channels_deleteMessages.md index 87a968c5..fb9d3cc2 100644 --- a/old_docs/API_docs_v51/methods/channels_deleteMessages.md +++ b/old_docs/API_docs_v51/methods/channels_deleteMessages.md @@ -1,17 +1,19 @@ --- title: channels.deleteMessages -description: channels.deleteMessages parameters, return type and example +description: Delete channel/supergroup messages --- ## Method: channels.deleteMessages [Back to methods index](index.md) +Delete channel/supergroup messages + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|id|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to delete| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v51/methods/channels_deleteUserHistory.md b/old_docs/API_docs_v51/methods/channels_deleteUserHistory.md index ee828f45..fbe34341 100644 --- a/old_docs/API_docs_v51/methods/channels_deleteUserHistory.md +++ b/old_docs/API_docs_v51/methods/channels_deleteUserHistory.md @@ -1,17 +1,19 @@ --- title: channels.deleteUserHistory -description: channels.deleteUserHistory parameters, return type and example +description: Delete all messages of a user in a channel/supergroup --- ## Method: channels.deleteUserHistory [Back to methods index](index.md) +Delete all messages of a user in a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) diff --git a/old_docs/API_docs_v51/methods/channels_editAbout.md b/old_docs/API_docs_v51/methods/channels_editAbout.md index 94be2503..8908f29e 100644 --- a/old_docs/API_docs_v51/methods/channels_editAbout.md +++ b/old_docs/API_docs_v51/methods/channels_editAbout.md @@ -1,17 +1,19 @@ --- title: channels.editAbout -description: channels.editAbout parameters, return type and example +description: Edit the about text of a channel/supergroup --- ## Method: channels.editAbout [Back to methods index](index.md) +Edit the about text of a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|about|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|about|[CLICK ME string](../types/string.md) | Yes|The new about text| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v51/methods/channels_editAdmin.md b/old_docs/API_docs_v51/methods/channels_editAdmin.md index e1917c89..695c5294 100644 --- a/old_docs/API_docs_v51/methods/channels_editAdmin.md +++ b/old_docs/API_docs_v51/methods/channels_editAdmin.md @@ -1,18 +1,20 @@ --- title: channels.editAdmin -description: channels.editAdmin parameters, return type and example +description: Edit admin permissions of a user in a channel/supergroup --- ## Method: channels.editAdmin [Back to methods index](index.md) +Edit admin permissions of a user in a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|role|[CLICK ME ChannelParticipantRole](../types/ChannelParticipantRole.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| +|role|[CLICK ME ChannelParticipantRole](../types/ChannelParticipantRole.md) | Yes|| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v51/methods/channels_editPhoto.md b/old_docs/API_docs_v51/methods/channels_editPhoto.md index 3a2c794b..9ccd864f 100644 --- a/old_docs/API_docs_v51/methods/channels_editPhoto.md +++ b/old_docs/API_docs_v51/methods/channels_editPhoto.md @@ -1,17 +1,19 @@ --- title: channels.editPhoto -description: channels.editPhoto parameters, return type and example +description: Edit the photo of a supergroup/channel --- ## Method: channels.editPhoto [Back to methods index](index.md) +Edit the photo of a supergroup/channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new photo| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v51/methods/channels_editTitle.md b/old_docs/API_docs_v51/methods/channels_editTitle.md index ec60e10f..b1024faf 100644 --- a/old_docs/API_docs_v51/methods/channels_editTitle.md +++ b/old_docs/API_docs_v51/methods/channels_editTitle.md @@ -1,17 +1,19 @@ --- title: channels.editTitle -description: channels.editTitle parameters, return type and example +description: Edit the title of a supergroup/channel --- ## Method: channels.editTitle [Back to methods index](index.md) +Edit the title of a supergroup/channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|title|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|title|[CLICK ME string](../types/string.md) | Yes|The new channel/supergroup title| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v51/methods/channels_exportInvite.md b/old_docs/API_docs_v51/methods/channels_exportInvite.md index 3c10f832..f0c737d5 100644 --- a/old_docs/API_docs_v51/methods/channels_exportInvite.md +++ b/old_docs/API_docs_v51/methods/channels_exportInvite.md @@ -1,16 +1,18 @@ --- title: channels.exportInvite -description: channels.exportInvite parameters, return type and example +description: Export the invite link of a channel --- ## Method: channels.exportInvite [Back to methods index](index.md) +Export the invite link of a channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| ### Return type: [ExportedChatInvite](../types/ExportedChatInvite.md) diff --git a/old_docs/API_docs_v51/methods/channels_exportMessageLink.md b/old_docs/API_docs_v51/methods/channels_exportMessageLink.md index 924dc0d5..f910b594 100644 --- a/old_docs/API_docs_v51/methods/channels_exportMessageLink.md +++ b/old_docs/API_docs_v51/methods/channels_exportMessageLink.md @@ -1,17 +1,19 @@ --- title: channels.exportMessageLink -description: channels.exportMessageLink parameters, return type and example +description: Get the link of a message in a channel --- ## Method: channels.exportMessageLink [Back to methods index](index.md) +Get the link of a message in a channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|id|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|id|[CLICK ME int](../types/int.md) | Yes|The ID of the message| ### Return type: [ExportedMessageLink](../types/ExportedMessageLink.md) diff --git a/old_docs/API_docs_v51/methods/channels_getChannels.md b/old_docs/API_docs_v51/methods/channels_getChannels.md index bd5958d6..9cd9e798 100644 --- a/old_docs/API_docs_v51/methods/channels_getChannels.md +++ b/old_docs/API_docs_v51/methods/channels_getChannels.md @@ -1,16 +1,18 @@ --- title: channels.getChannels -description: channels.getChannels parameters, return type and example +description: Get info about multiple channels/supergroups --- ## Method: channels.getChannels [Back to methods index](index.md) +Get info about multiple channels/supergroups + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|Array of [Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|Array of [Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Yes|The channel/supergroup MTProto IDs| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v51/methods/channels_getMessages.md b/old_docs/API_docs_v51/methods/channels_getMessages.md index 4440856c..cc944fe5 100644 --- a/old_docs/API_docs_v51/methods/channels_getMessages.md +++ b/old_docs/API_docs_v51/methods/channels_getMessages.md @@ -1,17 +1,19 @@ --- title: channels.getMessages -description: channels.getMessages parameters, return type and example +description: Get channel/supergroup messages --- ## Method: channels.getMessages [Back to methods index](index.md) +Get channel/supergroup messages + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|id|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The message IDs| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v51/methods/channels_getParticipant.md b/old_docs/API_docs_v51/methods/channels_getParticipant.md index c1819b6b..db9b1fc6 100644 --- a/old_docs/API_docs_v51/methods/channels_getParticipant.md +++ b/old_docs/API_docs_v51/methods/channels_getParticipant.md @@ -1,17 +1,19 @@ --- title: channels.getParticipant -description: channels.getParticipant parameters, return type and example +description: Get info about a certain channel/supergroup participant --- ## Method: channels.getParticipant [Back to methods index](index.md) +Get info about a certain channel/supergroup participant + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to fetch info about| ### Return type: [channels\_ChannelParticipant](../types/channels_ChannelParticipant.md) diff --git a/old_docs/API_docs_v51/methods/channels_getParticipants.md b/old_docs/API_docs_v51/methods/channels_getParticipants.md index 7ec8a980..96662466 100644 --- a/old_docs/API_docs_v51/methods/channels_getParticipants.md +++ b/old_docs/API_docs_v51/methods/channels_getParticipants.md @@ -1,19 +1,21 @@ --- title: channels.getParticipants -description: channels.getParticipants parameters, return type and example +description: Get channel/supergroup participants (you should use `$MadelineProto->get_pwr_chat($id)` instead) --- ## Method: channels.getParticipants [Back to methods index](index.md) +Get channel/supergroup participants (you should use `$MadelineProto->get_pwr_chat($id)` instead) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|filter|[CLICK ME ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) | Yes| -|offset|[CLICK ME int](../types/int.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|filter|[CLICK ME ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) | Yes|Member filter| +|offset|[CLICK ME int](../types/int.md) | Yes|Offset| +|limit|[CLICK ME int](../types/int.md) | Yes|Limit| ### Return type: [channels\_ChannelParticipants](../types/channels_ChannelParticipants.md) diff --git a/old_docs/API_docs_v51/methods/channels_inviteToChannel.md b/old_docs/API_docs_v51/methods/channels_inviteToChannel.md index 9bca2967..676f800c 100644 --- a/old_docs/API_docs_v51/methods/channels_inviteToChannel.md +++ b/old_docs/API_docs_v51/methods/channels_inviteToChannel.md @@ -1,17 +1,19 @@ --- title: channels.inviteToChannel -description: channels.inviteToChannel parameters, return type and example +description: Add users to channel/supergroup --- ## Method: channels.inviteToChannel [Back to methods index](index.md) +Add users to channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to add| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v51/methods/channels_joinChannel.md b/old_docs/API_docs_v51/methods/channels_joinChannel.md index 9ecdbe75..721f707c 100644 --- a/old_docs/API_docs_v51/methods/channels_joinChannel.md +++ b/old_docs/API_docs_v51/methods/channels_joinChannel.md @@ -1,16 +1,18 @@ --- title: channels.joinChannel -description: channels.joinChannel parameters, return type and example +description: Join a channel/supergroup --- ## Method: channels.joinChannel [Back to methods index](index.md) +Join a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup to join| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v51/methods/channels_leaveChannel.md b/old_docs/API_docs_v51/methods/channels_leaveChannel.md index 62c20a00..7f02e08c 100644 --- a/old_docs/API_docs_v51/methods/channels_leaveChannel.md +++ b/old_docs/API_docs_v51/methods/channels_leaveChannel.md @@ -1,16 +1,18 @@ --- title: channels.leaveChannel -description: channels.leaveChannel parameters, return type and example +description: Leave a channel/supergroup --- ## Method: channels.leaveChannel [Back to methods index](index.md) +Leave a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup to leave| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v51/methods/channels_readHistory.md b/old_docs/API_docs_v51/methods/channels_readHistory.md index 745893f6..cca891f0 100644 --- a/old_docs/API_docs_v51/methods/channels_readHistory.md +++ b/old_docs/API_docs_v51/methods/channels_readHistory.md @@ -1,17 +1,19 @@ --- title: channels.readHistory -description: channels.readHistory parameters, return type and example +description: Mark channel/supergroup history as read --- ## Method: channels.readHistory [Back to methods index](index.md) +Mark channel/supergroup history as read + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|max\_id|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to mark as read| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v51/methods/channels_reportSpam.md b/old_docs/API_docs_v51/methods/channels_reportSpam.md index 47dd7cff..09af14e0 100644 --- a/old_docs/API_docs_v51/methods/channels_reportSpam.md +++ b/old_docs/API_docs_v51/methods/channels_reportSpam.md @@ -1,18 +1,20 @@ --- title: channels.reportSpam -description: channels.reportSpam parameters, return type and example +description: Report a supergroup/channel for spam --- ## Method: channels.reportSpam [Back to methods index](index.md) +Report a supergroup/channel for spam + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|id|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that added you to this channel| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to report| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v51/methods/channels_toggleInvites.md b/old_docs/API_docs_v51/methods/channels_toggleInvites.md index b6771ed3..5b541f67 100644 --- a/old_docs/API_docs_v51/methods/channels_toggleInvites.md +++ b/old_docs/API_docs_v51/methods/channels_toggleInvites.md @@ -1,17 +1,19 @@ --- title: channels.toggleInvites -description: channels.toggleInvites parameters, return type and example +description: Allow or disallow any user to invite users to this channel/supergroup --- ## Method: channels.toggleInvites [Back to methods index](index.md) +Allow or disallow any user to invite users to this channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Allow or disallow| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v51/methods/channels_toggleSignatures.md b/old_docs/API_docs_v51/methods/channels_toggleSignatures.md index e8ff70a8..f233a8e1 100644 --- a/old_docs/API_docs_v51/methods/channels_toggleSignatures.md +++ b/old_docs/API_docs_v51/methods/channels_toggleSignatures.md @@ -1,17 +1,19 @@ --- title: channels.toggleSignatures -description: channels.toggleSignatures parameters, return type and example +description: Toggle channel signatures --- ## Method: channels.toggleSignatures [Back to methods index](index.md) +Toggle channel signatures + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Enable or disable channel signatures?| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v51/methods/channels_updatePinnedMessage.md b/old_docs/API_docs_v51/methods/channels_updatePinnedMessage.md index 7a14b68b..f06d1f0f 100644 --- a/old_docs/API_docs_v51/methods/channels_updatePinnedMessage.md +++ b/old_docs/API_docs_v51/methods/channels_updatePinnedMessage.md @@ -1,18 +1,20 @@ --- title: channels.updatePinnedMessage -description: channels.updatePinnedMessage parameters, return type and example +description: Set the pinned message of a channel/supergroup --- ## Method: channels.updatePinnedMessage [Back to methods index](index.md) +Set the pinned message of a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|id|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Pin silently| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|id|[CLICK ME int](../types/int.md) | Yes|The ID of the message to pin| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v51/methods/channels_updateUsername.md b/old_docs/API_docs_v51/methods/channels_updateUsername.md index 19647598..ad34490a 100644 --- a/old_docs/API_docs_v51/methods/channels_updateUsername.md +++ b/old_docs/API_docs_v51/methods/channels_updateUsername.md @@ -1,17 +1,19 @@ --- title: channels.updateUsername -description: channels.updateUsername parameters, return type and example +description: Update the username of a supergroup/channel --- ## Method: channels.updateUsername [Back to methods index](index.md) +Update the username of a supergroup/channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|username|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|username|[CLICK ME string](../types/string.md) | Yes|The new username| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v51/methods/contacts_getBlocked.md b/old_docs/API_docs_v51/methods/contacts_getBlocked.md index d7d8c5cc..300025af 100644 --- a/old_docs/API_docs_v51/methods/contacts_getBlocked.md +++ b/old_docs/API_docs_v51/methods/contacts_getBlocked.md @@ -12,7 +12,7 @@ Get blocked users | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, then set to the number of blocked contacts previously fetched| +|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, Then set to the number of blocked contacts previously fetched| |limit|[CLICK ME int](../types/int.md) | Yes|How many blocked contacts to fetch| diff --git a/old_docs/API_docs_v51/methods/help_getAppChangelog.md b/old_docs/API_docs_v51/methods/help_getAppChangelog.md index ec71a905..c8c41f71 100644 --- a/old_docs/API_docs_v51/methods/help_getAppChangelog.md +++ b/old_docs/API_docs_v51/methods/help_getAppChangelog.md @@ -1,19 +1,21 @@ --- title: help.getAppChangelog -description: help.getAppChangelog parameters, return type and example +description: Get the changelog of this app --- ## Method: help.getAppChangelog [Back to methods index](index.md) +Get the changelog of this app + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|device\_model|[CLICK ME string](../types/string.md) | Yes| -|system\_version|[CLICK ME string](../types/string.md) | Yes| -|app\_version|[CLICK ME string](../types/string.md) | Yes| -|lang\_code|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|device\_model|[CLICK ME string](../types/string.md) | Yes|| +|system\_version|[CLICK ME string](../types/string.md) | Yes|| +|app\_version|[CLICK ME string](../types/string.md) | Yes|| +|lang\_code|[CLICK ME string](../types/string.md) | Yes|| ### Return type: [help\_AppChangelog](../types/help_AppChangelog.md) diff --git a/old_docs/API_docs_v51/methods/help_getAppUpdate.md b/old_docs/API_docs_v51/methods/help_getAppUpdate.md index d13d6263..f3eacbd6 100644 --- a/old_docs/API_docs_v51/methods/help_getAppUpdate.md +++ b/old_docs/API_docs_v51/methods/help_getAppUpdate.md @@ -1,19 +1,21 @@ --- title: help.getAppUpdate -description: help.getAppUpdate parameters, return type and example +description: Get info about app updates --- ## Method: help.getAppUpdate [Back to methods index](index.md) +Get info about app updates + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|device\_model|[CLICK ME string](../types/string.md) | Yes| -|system\_version|[CLICK ME string](../types/string.md) | Yes| -|app\_version|[CLICK ME string](../types/string.md) | Yes| -|lang\_code|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|device\_model|[CLICK ME string](../types/string.md) | Yes|| +|system\_version|[CLICK ME string](../types/string.md) | Yes|| +|app\_version|[CLICK ME string](../types/string.md) | Yes|| +|lang\_code|[CLICK ME string](../types/string.md) | Yes|| ### Return type: [help\_AppUpdate](../types/help_AppUpdate.md) diff --git a/old_docs/API_docs_v51/methods/help_getConfig.md b/old_docs/API_docs_v51/methods/help_getConfig.md index 885ad5d3..16e25c68 100644 --- a/old_docs/API_docs_v51/methods/help_getConfig.md +++ b/old_docs/API_docs_v51/methods/help_getConfig.md @@ -1,11 +1,13 @@ --- title: help.getConfig -description: help.getConfig parameters, return type and example +description: Get server configuration --- ## Method: help.getConfig [Back to methods index](index.md) +Get server configuration + ### Return type: [Config](../types/Config.md) diff --git a/old_docs/API_docs_v51/methods/help_getInviteText.md b/old_docs/API_docs_v51/methods/help_getInviteText.md index aeebae28..d9ae8e0d 100644 --- a/old_docs/API_docs_v51/methods/help_getInviteText.md +++ b/old_docs/API_docs_v51/methods/help_getInviteText.md @@ -1,16 +1,18 @@ --- title: help.getInviteText -description: help.getInviteText parameters, return type and example +description: Get invitation text --- ## Method: help.getInviteText [Back to methods index](index.md) +Get invitation text + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|lang\_code|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|lang\_code|[CLICK ME string](../types/string.md) | Yes|| ### Return type: [help\_InviteText](../types/help_InviteText.md) diff --git a/old_docs/API_docs_v51/methods/help_getNearestDc.md b/old_docs/API_docs_v51/methods/help_getNearestDc.md index 6196890b..35a8bf91 100644 --- a/old_docs/API_docs_v51/methods/help_getNearestDc.md +++ b/old_docs/API_docs_v51/methods/help_getNearestDc.md @@ -1,11 +1,13 @@ --- title: help.getNearestDc -description: help.getNearestDc parameters, return type and example +description: Get nearest datacenter --- ## Method: help.getNearestDc [Back to methods index](index.md) +Get nearest datacenter + ### Return type: [NearestDc](../types/NearestDc.md) diff --git a/old_docs/API_docs_v51/methods/help_getSupport.md b/old_docs/API_docs_v51/methods/help_getSupport.md index 9b269f78..a5bab0f2 100644 --- a/old_docs/API_docs_v51/methods/help_getSupport.md +++ b/old_docs/API_docs_v51/methods/help_getSupport.md @@ -1,11 +1,13 @@ --- title: help.getSupport -description: help.getSupport parameters, return type and example +description: Get info of support user --- ## Method: help.getSupport [Back to methods index](index.md) +Get info of support user + ### Return type: [help\_Support](../types/help_Support.md) diff --git a/old_docs/API_docs_v51/methods/help_getTermsOfService.md b/old_docs/API_docs_v51/methods/help_getTermsOfService.md index 3a1b355d..e9b1cae4 100644 --- a/old_docs/API_docs_v51/methods/help_getTermsOfService.md +++ b/old_docs/API_docs_v51/methods/help_getTermsOfService.md @@ -1,16 +1,18 @@ --- title: help.getTermsOfService -description: help.getTermsOfService parameters, return type and example +description: Get terms of service --- ## Method: help.getTermsOfService [Back to methods index](index.md) +Get terms of service + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|lang\_code|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|lang\_code|[CLICK ME string](../types/string.md) | Yes|| ### Return type: [help\_TermsOfService](../types/help_TermsOfService.md) diff --git a/old_docs/API_docs_v51/methods/help_saveAppLog.md b/old_docs/API_docs_v51/methods/help_saveAppLog.md index af6e94e2..0165b6e3 100644 --- a/old_docs/API_docs_v51/methods/help_saveAppLog.md +++ b/old_docs/API_docs_v51/methods/help_saveAppLog.md @@ -1,16 +1,18 @@ --- title: help.saveAppLog -description: help.saveAppLog parameters, return type and example +description: Log data for developer of this app --- ## Method: help.saveAppLog [Back to methods index](index.md) +Log data for developer of this app + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|events|Array of [CLICK ME InputAppEvent](../types/InputAppEvent.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|events|Array of [CLICK ME InputAppEvent](../types/InputAppEvent.md) | Yes|Event list| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v51/methods/messages_checkChatInvite.md b/old_docs/API_docs_v51/methods/messages_checkChatInvite.md index 4ddf5084..de1d9ff4 100644 --- a/old_docs/API_docs_v51/methods/messages_checkChatInvite.md +++ b/old_docs/API_docs_v51/methods/messages_checkChatInvite.md @@ -1,16 +1,18 @@ --- title: messages.checkChatInvite -description: messages.checkChatInvite parameters, return type and example +description: Check if an invitation link is valid --- ## Method: messages.checkChatInvite [Back to methods index](index.md) +Check if an invitation link is valid + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| ### Return type: [ChatInvite](../types/ChatInvite.md) diff --git a/old_docs/API_docs_v51/methods/messages_deleteChatUser.md b/old_docs/API_docs_v51/methods/messages_deleteChatUser.md index a71f4aaf..0a6830de 100644 --- a/old_docs/API_docs_v51/methods/messages_deleteChatUser.md +++ b/old_docs/API_docs_v51/methods/messages_deleteChatUser.md @@ -12,7 +12,7 @@ Delete a user from a chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The MTProto ID of the chat| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to delete (pass @me to leave the chat)| diff --git a/old_docs/API_docs_v51/methods/messages_editChatAdmin.md b/old_docs/API_docs_v51/methods/messages_editChatAdmin.md index 6bc8f9ae..7916f8b1 100644 --- a/old_docs/API_docs_v51/methods/messages_editChatAdmin.md +++ b/old_docs/API_docs_v51/methods/messages_editChatAdmin.md @@ -1,18 +1,20 @@ --- title: messages.editChatAdmin -description: messages.editChatAdmin parameters, return type and example +description: Edit admin permissions --- ## Method: messages.editChatAdmin [Back to methods index](index.md) +Edit admin permissions + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|is\_admin|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat ID (no supergroups)| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user ID| +|is\_admin|[CLICK ME Bool](../types/Bool.md) | Yes|Should the user be admin?| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v51/methods/messages_editChatPhoto.md b/old_docs/API_docs_v51/methods/messages_editChatPhoto.md index 8848eca7..122913c4 100644 --- a/old_docs/API_docs_v51/methods/messages_editChatPhoto.md +++ b/old_docs/API_docs_v51/methods/messages_editChatPhoto.md @@ -12,7 +12,7 @@ Edit the photo of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The MTProto ID of the chat| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| |photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| diff --git a/old_docs/API_docs_v51/methods/messages_editChatTitle.md b/old_docs/API_docs_v51/methods/messages_editChatTitle.md index 1c1c7a16..3a1e974b 100644 --- a/old_docs/API_docs_v51/methods/messages_editChatTitle.md +++ b/old_docs/API_docs_v51/methods/messages_editChatTitle.md @@ -12,7 +12,7 @@ Edit the title of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The MTProto ID of the chat| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| |title|[CLICK ME string](../types/string.md) | Yes|The new title| diff --git a/old_docs/API_docs_v51/methods/messages_editInlineBotMessage.md b/old_docs/API_docs_v51/methods/messages_editInlineBotMessage.md index c0d06614..2237fb20 100644 --- a/old_docs/API_docs_v51/methods/messages_editInlineBotMessage.md +++ b/old_docs/API_docs_v51/methods/messages_editInlineBotMessage.md @@ -1,20 +1,22 @@ --- title: messages.editInlineBotMessage -description: messages.editInlineBotMessage parameters, return type and example +description: Edit a sent inline message --- ## Method: messages.editInlineBotMessage [Back to methods index](index.md) +Edit a sent inline message + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional| -|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes| -|message|[CLICK ME string](../types/string.md) | Optional| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview| +|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The message ID| +|message|[CLICK ME string](../types/string.md) | Optional|The new message| +|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| +|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/old_docs/API_docs_v51/methods/messages_editMessage.md b/old_docs/API_docs_v51/methods/messages_editMessage.md index 2e98318d..177438a5 100644 --- a/old_docs/API_docs_v51/methods/messages_editMessage.md +++ b/old_docs/API_docs_v51/methods/messages_editMessage.md @@ -1,21 +1,23 @@ --- title: messages.editMessage -description: messages.editMessage parameters, return type and example +description: Edit a message --- ## Method: messages.editMessage [Back to methods index](index.md) +Edit a message + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|id|[CLICK ME int](../types/int.md) | Yes| -|message|[CLICK ME string](../types/string.md) | Optional| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| +|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|message|[CLICK ME string](../types/string.md) | Optional|The new message| +|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| +|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/old_docs/API_docs_v51/methods/messages_exportChatInvite.md b/old_docs/API_docs_v51/methods/messages_exportChatInvite.md index 74d70c21..98685d96 100644 --- a/old_docs/API_docs_v51/methods/messages_exportChatInvite.md +++ b/old_docs/API_docs_v51/methods/messages_exportChatInvite.md @@ -1,16 +1,18 @@ --- title: messages.exportChatInvite -description: messages.exportChatInvite parameters, return type and example +description: Export chat invite --- ## Method: messages.exportChatInvite [Back to methods index](index.md) +Export chat invite + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat id | ### Return type: [ExportedChatInvite](../types/ExportedChatInvite.md) diff --git a/old_docs/API_docs_v51/methods/messages_getAllStickers.md b/old_docs/API_docs_v51/methods/messages_getAllStickers.md index 575fcd49..16fdba6c 100644 --- a/old_docs/API_docs_v51/methods/messages_getAllStickers.md +++ b/old_docs/API_docs_v51/methods/messages_getAllStickers.md @@ -1,16 +1,18 @@ --- title: messages.getAllStickers -description: messages.getAllStickers parameters, return type and example +description: Get all stickerpacks --- ## Method: messages.getAllStickers [Back to methods index](index.md) +Get all stickerpacks + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v51/methods/messages_getBotCallbackAnswer.md b/old_docs/API_docs_v51/methods/messages_getBotCallbackAnswer.md index eb3094e6..bd83feb0 100644 --- a/old_docs/API_docs_v51/methods/messages_getBotCallbackAnswer.md +++ b/old_docs/API_docs_v51/methods/messages_getBotCallbackAnswer.md @@ -1,18 +1,20 @@ --- title: messages.getBotCallbackAnswer -description: messages.getBotCallbackAnswer parameters, return type and example +description: Get the callback answer of a bot (after clicking a button) --- ## Method: messages.getBotCallbackAnswer [Back to methods index](index.md) +Get the callback answer of a bot (after clicking a button) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|msg\_id|[CLICK ME int](../types/int.md) | Yes| -|data|[CLICK ME bytes](../types/bytes.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| +|msg\_id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|data|[CLICK ME bytes](../types/bytes.md) | Yes|The data to send to the bot| ### Return type: [messages\_BotCallbackAnswer](../types/messages_BotCallbackAnswer.md) diff --git a/old_docs/API_docs_v51/methods/messages_getDocumentByHash.md b/old_docs/API_docs_v51/methods/messages_getDocumentByHash.md index b7c45398..1af5bad4 100644 --- a/old_docs/API_docs_v51/methods/messages_getDocumentByHash.md +++ b/old_docs/API_docs_v51/methods/messages_getDocumentByHash.md @@ -1,18 +1,20 @@ --- title: messages.getDocumentByHash -description: messages.getDocumentByHash parameters, return type and example +description: Get document by SHA256 hash --- ## Method: messages.getDocumentByHash [Back to methods index](index.md) +Get document by SHA256 hash + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|sha256|[CLICK ME bytes](../types/bytes.md) | Yes| -|size|[CLICK ME int](../types/int.md) | Yes| -|mime\_type|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|sha256|[CLICK ME bytes](../types/bytes.md) | Yes|`hash('sha256', $filename, true);`| +|size|[CLICK ME int](../types/int.md) | Yes|The file size| +|mime\_type|[CLICK ME string](../types/string.md) | Yes|The mime type of the file| ### Return type: [Document](../types/Document.md) diff --git a/old_docs/API_docs_v51/methods/messages_getInlineBotResults.md b/old_docs/API_docs_v51/methods/messages_getInlineBotResults.md index 5b2bb254..8ab5bf78 100644 --- a/old_docs/API_docs_v51/methods/messages_getInlineBotResults.md +++ b/old_docs/API_docs_v51/methods/messages_getInlineBotResults.md @@ -1,20 +1,22 @@ --- title: messages.getInlineBotResults -description: messages.getInlineBotResults parameters, return type and example +description: Call inline bot --- ## Method: messages.getInlineBotResults [Back to methods index](index.md) +Call inline bot + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional| -|query|[CLICK ME string](../types/string.md) | Yes| -|offset|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot to call| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to call the bot| +|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional|The current location| +|query|[CLICK ME string](../types/string.md) | Yes|The query to send to the bot| +|offset|[CLICK ME string](../types/string.md) | Yes|The offset to send to the bot| ### Return type: [messages\_BotResults](../types/messages_BotResults.md) diff --git a/old_docs/API_docs_v51/methods/messages_getMessageEditData.md b/old_docs/API_docs_v51/methods/messages_getMessageEditData.md index 339678bd..12e71bee 100644 --- a/old_docs/API_docs_v51/methods/messages_getMessageEditData.md +++ b/old_docs/API_docs_v51/methods/messages_getMessageEditData.md @@ -1,17 +1,19 @@ --- title: messages.getMessageEditData -description: messages.getMessageEditData parameters, return type and example +description: Check if about to edit a message or a media caption --- ## Method: messages.getMessageEditData [Back to methods index](index.md) +Check if about to edit a message or a media caption + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|id|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| +|id|[CLICK ME int](../types/int.md) | Yes|The message ID| ### Return type: [messages\_MessageEditData](../types/messages_MessageEditData.md) diff --git a/old_docs/API_docs_v51/methods/messages_getMessagesViews.md b/old_docs/API_docs_v51/methods/messages_getMessagesViews.md index e3f4e4ea..b8d78c85 100644 --- a/old_docs/API_docs_v51/methods/messages_getMessagesViews.md +++ b/old_docs/API_docs_v51/methods/messages_getMessagesViews.md @@ -1,18 +1,20 @@ --- title: messages.getMessagesViews -description: messages.getMessagesViews parameters, return type and example +description: Get and increase message views --- ## Method: messages.getMessagesViews [Back to methods index](index.md) +Get and increase message views + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|id|Array of [CLICK ME int](../types/int.md) | Yes| -|increment|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the message is located| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs messages to get| +|increment|[CLICK ME Bool](../types/Bool.md) | Yes|Increase message views?| ### Return type: [Vector\_of\_int](../types/int.md) diff --git a/old_docs/API_docs_v51/methods/messages_getSavedGifs.md b/old_docs/API_docs_v51/methods/messages_getSavedGifs.md index 08dc4be6..f61348ce 100644 --- a/old_docs/API_docs_v51/methods/messages_getSavedGifs.md +++ b/old_docs/API_docs_v51/methods/messages_getSavedGifs.md @@ -1,16 +1,18 @@ --- title: messages.getSavedGifs -description: messages.getSavedGifs parameters, return type and example +description: Get saved gifs --- ## Method: messages.getSavedGifs [Back to methods index](index.md) +Get saved gifs + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_SavedGifs](../types/messages_SavedGifs.md) diff --git a/old_docs/API_docs_v51/methods/messages_getStickerSet.md b/old_docs/API_docs_v51/methods/messages_getStickerSet.md index 70bdd9ba..c86807e4 100644 --- a/old_docs/API_docs_v51/methods/messages_getStickerSet.md +++ b/old_docs/API_docs_v51/methods/messages_getStickerSet.md @@ -1,16 +1,18 @@ --- title: messages.getStickerSet -description: messages.getStickerSet parameters, return type and example +description: Get a stickerset --- ## Method: messages.getStickerSet [Back to methods index](index.md) +Get a stickerset + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset to get| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/old_docs/API_docs_v51/methods/messages_getStickers.md b/old_docs/API_docs_v51/methods/messages_getStickers.md index 178b897c..4854696d 100644 --- a/old_docs/API_docs_v51/methods/messages_getStickers.md +++ b/old_docs/API_docs_v51/methods/messages_getStickers.md @@ -1,17 +1,19 @@ --- title: messages.getStickers -description: messages.getStickers parameters, return type and example +description: Get stickers --- ## Method: messages.getStickers [Back to methods index](index.md) +Get stickers + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|emoticon|[CLICK ME string](../types/string.md) | Yes| -|hash|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|emoticon|[CLICK ME string](../types/string.md) | Yes|Search by emoji| +|hash|[CLICK ME string](../types/string.md) | Yes|0 or $MadelineProto->gen_vector_hash(previously fetched sticker IDs)| ### Return type: [messages\_Stickers](../types/messages_Stickers.md) diff --git a/old_docs/API_docs_v51/methods/messages_getWebPagePreview.md b/old_docs/API_docs_v51/methods/messages_getWebPagePreview.md index 35243c9f..d01bdd32 100644 --- a/old_docs/API_docs_v51/methods/messages_getWebPagePreview.md +++ b/old_docs/API_docs_v51/methods/messages_getWebPagePreview.md @@ -1,16 +1,18 @@ --- title: messages.getWebPagePreview -description: messages.getWebPagePreview parameters, return type and example +description: Get webpage preview --- ## Method: messages.getWebPagePreview [Back to methods index](index.md) +Get webpage preview + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|message|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|message|[CLICK ME string](../types/string.md) | Yes|Extract preview from this message| ### Return type: [MessageMedia](../types/MessageMedia.md) diff --git a/old_docs/API_docs_v51/methods/messages_importChatInvite.md b/old_docs/API_docs_v51/methods/messages_importChatInvite.md index 2bea5247..0d6cd7c8 100644 --- a/old_docs/API_docs_v51/methods/messages_importChatInvite.md +++ b/old_docs/API_docs_v51/methods/messages_importChatInvite.md @@ -1,16 +1,18 @@ --- title: messages.importChatInvite -description: messages.importChatInvite parameters, return type and example +description: Import chat invite --- ## Method: messages.importChatInvite [Back to methods index](index.md) +Import chat invite + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v51/methods/messages_installStickerSet.md b/old_docs/API_docs_v51/methods/messages_installStickerSet.md index 857aa738..f620c96a 100644 --- a/old_docs/API_docs_v51/methods/messages_installStickerSet.md +++ b/old_docs/API_docs_v51/methods/messages_installStickerSet.md @@ -1,17 +1,19 @@ --- title: messages.installStickerSet -description: messages.installStickerSet parameters, return type and example +description: Add a sticker set --- ## Method: messages.installStickerSet [Back to methods index](index.md) +Add a sticker set + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional| -|disabled|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to add| +|disabled|[CLICK ME Bool](../types/Bool.md) | Yes|| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v51/methods/messages_migrateChat.md b/old_docs/API_docs_v51/methods/messages_migrateChat.md index 5021ad45..db57adfa 100644 --- a/old_docs/API_docs_v51/methods/messages_migrateChat.md +++ b/old_docs/API_docs_v51/methods/messages_migrateChat.md @@ -1,16 +1,18 @@ --- title: messages.migrateChat -description: messages.migrateChat parameters, return type and example +description: Convert chat to supergroup --- ## Method: messages.migrateChat [Back to methods index](index.md) +Convert chat to supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat to convert| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v51/methods/messages_readEncryptedHistory.md b/old_docs/API_docs_v51/methods/messages_readEncryptedHistory.md index 4d341809..39b110e3 100644 --- a/old_docs/API_docs_v51/methods/messages_readEncryptedHistory.md +++ b/old_docs/API_docs_v51/methods/messages_readEncryptedHistory.md @@ -1,17 +1,19 @@ --- title: messages.readEncryptedHistory -description: messages.readEncryptedHistory parameters, return type and example +description: Mark messages as read in secret chats --- ## Method: messages.readEncryptedHistory [Back to methods index](index.md) +Mark messages as read in secret chats + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|max\_date|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to mark messages as read| +|max\_date|[CLICK ME int](../types/int.md) | Yes|Maximum date of messages to mark| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v51/methods/messages_readMessageContents.md b/old_docs/API_docs_v51/methods/messages_readMessageContents.md index 0d27c209..9bb1bee8 100644 --- a/old_docs/API_docs_v51/methods/messages_readMessageContents.md +++ b/old_docs/API_docs_v51/methods/messages_readMessageContents.md @@ -1,16 +1,18 @@ --- title: messages.readMessageContents -description: messages.readMessageContents parameters, return type and example +description: Mark message as read --- ## Method: messages.readMessageContents [Back to methods index](index.md) +Mark message as read + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v51/methods/messages_receivedQueue.md b/old_docs/API_docs_v51/methods/messages_receivedQueue.md index c91caa37..4ad78ba2 100644 --- a/old_docs/API_docs_v51/methods/messages_receivedQueue.md +++ b/old_docs/API_docs_v51/methods/messages_receivedQueue.md @@ -1,77 +1,13 @@ --- title: messages.receivedQueue -description: messages.receivedQueue parameters, return type and example +description: You cannot use this method directly --- ## Method: messages.receivedQueue [Back to methods index](index.md) -### Parameters: - -| Name | Type | Required | -|----------|---------------|----------| -|max\_qts|[CLICK ME int](../types/int.md) | Yes| - - -### 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| - - -### MadelineProto Example: - - -``` -if (!file_exists('madeline.php')) { - copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); -} -include 'madeline.php'; - -// !!! This API id/API hash combination will not work !!! -// !!! You must get your own @ my.telegram.org !!! -$api_id = 0; -$api_hash = ''; - -$MadelineProto = new \danog\MadelineProto\API('session.madeline', ['app_info' => ['api_id' => $api_id, 'api_hash' => $api_hash]]); -$MadelineProto->start(); - -$Vector_of_long = $MadelineProto->messages->receivedQueue(['max_qts' => int, ]); -``` - -### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): - -### As a bot: - -POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` - -Parameters: - -* method - messages.receivedQueue -* params - `{"max_qts": int, }` - - - -### As a user: - -POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.receivedQueue` - -Parameters: - -max_qts - Json encoded int +**You cannot use this method directly** -Or, if you're into Lua: - -``` -Vector_of_long = messages.receivedQueue({max_qts=int, }) -``` - diff --git a/old_docs/API_docs_v51/methods/messages_reorderStickerSets.md b/old_docs/API_docs_v51/methods/messages_reorderStickerSets.md index ad5df9fa..b2cbe4c1 100644 --- a/old_docs/API_docs_v51/methods/messages_reorderStickerSets.md +++ b/old_docs/API_docs_v51/methods/messages_reorderStickerSets.md @@ -1,16 +1,18 @@ --- title: messages.reorderStickerSets -description: messages.reorderStickerSets parameters, return type and example +description: Reorder sticker sets --- ## Method: messages.reorderStickerSets [Back to methods index](index.md) +Reorder sticker sets + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|order|Array of [CLICK ME long](../types/long.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|order|Array of [CLICK ME long](../types/long.md) | Yes|The order| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v51/methods/messages_saveGif.md b/old_docs/API_docs_v51/methods/messages_saveGif.md index 4a3b6166..6f608c4c 100644 --- a/old_docs/API_docs_v51/methods/messages_saveGif.md +++ b/old_docs/API_docs_v51/methods/messages_saveGif.md @@ -1,17 +1,19 @@ --- title: messages.saveGif -description: messages.saveGif parameters, return type and example +description: Save a GIF --- ## Method: messages.saveGif [Back to methods index](index.md) +Save a GIF + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional| -|unsave|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The GIF to save| +|unsave|[CLICK ME Bool](../types/Bool.md) | Yes|Remove the gif?| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v51/methods/messages_searchGifs.md b/old_docs/API_docs_v51/methods/messages_searchGifs.md index fefef1d7..103ebfeb 100644 --- a/old_docs/API_docs_v51/methods/messages_searchGifs.md +++ b/old_docs/API_docs_v51/methods/messages_searchGifs.md @@ -1,17 +1,19 @@ --- title: messages.searchGifs -description: messages.searchGifs parameters, return type and example +description: Search gifs --- ## Method: messages.searchGifs [Back to methods index](index.md) +Search gifs + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|q|[CLICK ME string](../types/string.md) | Yes| -|offset|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|q|[CLICK ME string](../types/string.md) | Yes|The search query| +|offset|[CLICK ME int](../types/int.md) | Yes|The offset | ### Return type: [messages\_FoundGifs](../types/messages_FoundGifs.md) diff --git a/old_docs/API_docs_v51/methods/messages_searchGlobal.md b/old_docs/API_docs_v51/methods/messages_searchGlobal.md index 32ddd175..0edd1e40 100644 --- a/old_docs/API_docs_v51/methods/messages_searchGlobal.md +++ b/old_docs/API_docs_v51/methods/messages_searchGlobal.md @@ -1,20 +1,22 @@ --- title: messages.searchGlobal -description: messages.searchGlobal parameters, return type and example +description: Global message search --- ## Method: messages.searchGlobal [Back to methods index](index.md) +Global message search + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|q|[CLICK ME string](../types/string.md) | Yes| -|offset\_date|[CLICK ME int](../types/int.md) | Yes| -|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|offset\_id|[CLICK ME int](../types/int.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|q|[CLICK ME string](../types/string.md) | Yes|The query| +|offset\_date|[CLICK ME int](../types/int.md) | Yes|0 or the date offset| +|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|0 or the peer offset| +|offset\_id|[CLICK ME int](../types/int.md) | Yes|0 or the message ID offset| +|limit|[CLICK ME int](../types/int.md) | Yes|The number of results to return| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v51/methods/messages_sendEncrypted.md b/old_docs/API_docs_v51/methods/messages_sendEncrypted.md index 23461760..d48f88d7 100644 --- a/old_docs/API_docs_v51/methods/messages_sendEncrypted.md +++ b/old_docs/API_docs_v51/methods/messages_sendEncrypted.md @@ -1,17 +1,19 @@ --- title: messages.sendEncrypted -description: messages.sendEncrypted parameters, return type and example +description: Send message to secret chat --- ## Method: messages.sendEncrypted [Back to methods index](index.md) +Send message to secret chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the message| +|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v51/methods/messages_sendEncryptedFile.md b/old_docs/API_docs_v51/methods/messages_sendEncryptedFile.md index 64919abe..4fd0648e 100644 --- a/old_docs/API_docs_v51/methods/messages_sendEncryptedFile.md +++ b/old_docs/API_docs_v51/methods/messages_sendEncryptedFile.md @@ -1,18 +1,20 @@ --- title: messages.sendEncryptedFile -description: messages.sendEncryptedFile parameters, return type and example +description: Send a file to a secret chat --- ## Method: messages.sendEncryptedFile [Back to methods index](index.md) +Send a file to a secret chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes| -|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the file| +|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| +|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional|The file (optional)| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v51/methods/messages_sendEncryptedService.md b/old_docs/API_docs_v51/methods/messages_sendEncryptedService.md index 0a0eea8a..d66894bf 100644 --- a/old_docs/API_docs_v51/methods/messages_sendEncryptedService.md +++ b/old_docs/API_docs_v51/methods/messages_sendEncryptedService.md @@ -1,17 +1,19 @@ --- title: messages.sendEncryptedService -description: messages.sendEncryptedService parameters, return type and example +description: Send a service message to a secret chat --- ## Method: messages.sendEncryptedService [Back to methods index](index.md) +Send a service message to a secret chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the service message| +|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v51/methods/messages_sendInlineBotResult.md b/old_docs/API_docs_v51/methods/messages_sendInlineBotResult.md index bcbeb12d..17782848 100644 --- a/old_docs/API_docs_v51/methods/messages_sendInlineBotResult.md +++ b/old_docs/API_docs_v51/methods/messages_sendInlineBotResult.md @@ -1,22 +1,24 @@ --- title: messages.sendInlineBotResult -description: messages.sendInlineBotResult parameters, return type and example +description: Send a received bot result to the chat --- ## Method: messages.sendInlineBotResult [Back to methods index](index.md) +Send a received bot result to the chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|broadcast|[CLICK ME Bool](../types/Bool.md) | Optional| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional| -|background|[CLICK ME Bool](../types/Bool.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional| -|query\_id|[CLICK ME long](../types/long.md) | Yes| -|id|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|broadcast|[CLICK ME Bool](../types/Bool.md) | Optional|| +|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Disable notifications?| +|background|[CLICK ME Bool](../types/Bool.md) | Optional|Disable background notifications?| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the message| +|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| +|query\_id|[CLICK ME long](../types/long.md) | Yes|The inline query ID| +|id|[CLICK ME string](../types/string.md) | Yes|The result ID| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v51/methods/messages_setBotCallbackAnswer.md b/old_docs/API_docs_v51/methods/messages_setBotCallbackAnswer.md index 14907301..06a7fb44 100644 --- a/old_docs/API_docs_v51/methods/messages_setBotCallbackAnswer.md +++ b/old_docs/API_docs_v51/methods/messages_setBotCallbackAnswer.md @@ -1,18 +1,20 @@ --- title: messages.setBotCallbackAnswer -description: messages.setBotCallbackAnswer parameters, return type and example +description: Bots only: set the callback answer (after a button was clicked) --- ## Method: messages.setBotCallbackAnswer [Back to methods index](index.md) +Bots only: set the callback answer (after a button was clicked) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|alert|[CLICK ME Bool](../types/Bool.md) | Optional| -|query\_id|[CLICK ME long](../types/long.md) | Yes| -|message|[CLICK ME string](../types/string.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|alert|[CLICK ME Bool](../types/Bool.md) | Optional|Is this an alert?| +|query\_id|[CLICK ME long](../types/long.md) | Yes|The query ID| +|message|[CLICK ME string](../types/string.md) | Optional|The message| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v51/methods/messages_setEncryptedTyping.md b/old_docs/API_docs_v51/methods/messages_setEncryptedTyping.md index 3183fedf..e9afe99c 100644 --- a/old_docs/API_docs_v51/methods/messages_setEncryptedTyping.md +++ b/old_docs/API_docs_v51/methods/messages_setEncryptedTyping.md @@ -12,8 +12,8 @@ Send typing notification to secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|| -|typing|[CLICK ME Bool](../types/Bool.md) | Yes|| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to send the notification| +|typing|[CLICK ME Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v51/methods/messages_setInlineBotResults.md b/old_docs/API_docs_v51/methods/messages_setInlineBotResults.md index 915e3a4e..79493009 100644 --- a/old_docs/API_docs_v51/methods/messages_setInlineBotResults.md +++ b/old_docs/API_docs_v51/methods/messages_setInlineBotResults.md @@ -1,22 +1,24 @@ --- title: messages.setInlineBotResults -description: messages.setInlineBotResults parameters, return type and example +description: Bots only: set the results of an inline query --- ## Method: messages.setInlineBotResults [Back to methods index](index.md) +Bots only: set the results of an inline query + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|gallery|[CLICK ME Bool](../types/Bool.md) | Optional| -|private|[CLICK ME Bool](../types/Bool.md) | Optional| -|query\_id|[CLICK ME long](../types/long.md) | Yes| -|results|Array of [CLICK ME InputBotInlineResult](../types/InputBotInlineResult.md) | Yes| -|cache\_time|[CLICK ME int](../types/int.md) | Yes| -|next\_offset|[CLICK ME string](../types/string.md) | Optional| -|switch\_pm|[CLICK ME InlineBotSwitchPM](../types/InlineBotSwitchPM.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|gallery|[CLICK ME Bool](../types/Bool.md) | Optional|Is this a gallery?| +|private|[CLICK ME Bool](../types/Bool.md) | Optional|Is this result private (not cached)?| +|query\_id|[CLICK ME long](../types/long.md) | Yes|Query ID| +|results|Array of [CLICK ME InputBotInlineResult](../types/InputBotInlineResult.md) | Yes|Results| +|cache\_time|[CLICK ME int](../types/int.md) | Yes|Cache time| +|next\_offset|[CLICK ME string](../types/string.md) | Optional|The next offset| +|switch\_pm|[CLICK ME InlineBotSwitchPM](../types/InlineBotSwitchPM.md) | Optional|Switch to PM?| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v51/methods/messages_startBot.md b/old_docs/API_docs_v51/methods/messages_startBot.md index 0de0f1a5..94a4d86a 100644 --- a/old_docs/API_docs_v51/methods/messages_startBot.md +++ b/old_docs/API_docs_v51/methods/messages_startBot.md @@ -1,18 +1,20 @@ --- title: messages.startBot -description: messages.startBot parameters, return type and example +description: Start a bot --- ## Method: messages.startBot [Back to methods index](index.md) +Start a bot + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|start\_param|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot's ID or username| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to start the bot (@me or group ID/username)| +|start\_param|[CLICK ME string](../types/string.md) | Yes|The bot's start parameter| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v51/methods/messages_toggleChatAdmins.md b/old_docs/API_docs_v51/methods/messages_toggleChatAdmins.md index d56e5753..ab591fd9 100644 --- a/old_docs/API_docs_v51/methods/messages_toggleChatAdmins.md +++ b/old_docs/API_docs_v51/methods/messages_toggleChatAdmins.md @@ -1,17 +1,19 @@ --- title: messages.toggleChatAdmins -description: messages.toggleChatAdmins parameters, return type and example +description: Enable all users are admins in normal groups (not supergroups) --- ## Method: messages.toggleChatAdmins [Back to methods index](index.md) +Enable all users are admins in normal groups (not supergroups) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Group ID| +|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Enable all users are admins| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v51/methods/messages_uninstallStickerSet.md b/old_docs/API_docs_v51/methods/messages_uninstallStickerSet.md index 60b0ca0c..6d04e847 100644 --- a/old_docs/API_docs_v51/methods/messages_uninstallStickerSet.md +++ b/old_docs/API_docs_v51/methods/messages_uninstallStickerSet.md @@ -1,16 +1,18 @@ --- title: messages.uninstallStickerSet -description: messages.uninstallStickerSet parameters, return type and example +description: Remove a sticker set --- ## Method: messages.uninstallStickerSet [Back to methods index](index.md) +Remove a sticker set + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to remove| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v51/methods/photos_deletePhotos.md b/old_docs/API_docs_v51/methods/photos_deletePhotos.md index 104459b7..b9daca10 100644 --- a/old_docs/API_docs_v51/methods/photos_deletePhotos.md +++ b/old_docs/API_docs_v51/methods/photos_deletePhotos.md @@ -1,16 +1,18 @@ --- title: photos.deletePhotos -description: photos.deletePhotos parameters, return type and example +description: Delete profile photos --- ## Method: photos.deletePhotos [Back to methods index](index.md) +Delete profile photos + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Yes|The profile photos to delete| ### Return type: [Vector\_of\_long](../types/long.md) diff --git a/old_docs/API_docs_v51/methods/photos_getUserPhotos.md b/old_docs/API_docs_v51/methods/photos_getUserPhotos.md index 1a7515ba..ea27a44f 100644 --- a/old_docs/API_docs_v51/methods/photos_getUserPhotos.md +++ b/old_docs/API_docs_v51/methods/photos_getUserPhotos.md @@ -1,19 +1,21 @@ --- title: photos.getUserPhotos -description: photos.getUserPhotos parameters, return type and example +description: Get the profile photos of a user --- ## Method: photos.getUserPhotos [Back to methods index](index.md) +Get the profile photos of a user + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|offset|[CLICK ME int](../types/int.md) | Yes| -|max\_id|[CLICK ME long](../types/long.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| +|offset|[CLICK ME int](../types/int.md) | Yes|Offset| +|max\_id|[CLICK ME long](../types/long.md) | Yes|Maximum ID of photo to return| +|limit|[CLICK ME int](../types/int.md) | Yes|Number of photos to return| ### Return type: [photos\_Photos](../types/photos_Photos.md) diff --git a/old_docs/API_docs_v51/methods/photos_updateProfilePhoto.md b/old_docs/API_docs_v51/methods/photos_updateProfilePhoto.md index 386970d5..dc6edd6b 100644 --- a/old_docs/API_docs_v51/methods/photos_updateProfilePhoto.md +++ b/old_docs/API_docs_v51/methods/photos_updateProfilePhoto.md @@ -1,17 +1,19 @@ --- title: photos.updateProfilePhoto -description: photos.updateProfilePhoto parameters, return type and example +description: Update the profile photo (use photos->uploadProfilePhoto to upload the photo) --- ## Method: photos.updateProfilePhoto [Back to methods index](index.md) +Update the profile photo (use photos->uploadProfilePhoto to upload the photo) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional| -|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional|The photo to use| +|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|| ### Return type: [UserProfilePhoto](../types/UserProfilePhoto.md) diff --git a/old_docs/API_docs_v51/methods/photos_uploadProfilePhoto.md b/old_docs/API_docs_v51/methods/photos_uploadProfilePhoto.md index 07b9936c..fb0bc534 100644 --- a/old_docs/API_docs_v51/methods/photos_uploadProfilePhoto.md +++ b/old_docs/API_docs_v51/methods/photos_uploadProfilePhoto.md @@ -1,19 +1,21 @@ --- title: photos.uploadProfilePhoto -description: photos.uploadProfilePhoto parameters, return type and example +description: Upload profile photo --- ## Method: photos.uploadProfilePhoto [Back to methods index](index.md) +Upload profile photo + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|file|[File path or InputFile](../types/InputFile.md) | Yes| -|caption|[CLICK ME string](../types/string.md) | Yes| -|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional| -|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|file|[File path or InputFile](../types/InputFile.md) | Yes|The photo| +|caption|[CLICK ME string](../types/string.md) | Yes|| +|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional|| +|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|| ### Return type: [photos\_Photo](../types/photos_Photo.md) diff --git a/old_docs/API_docs_v53/methods/account_registerDevice.md b/old_docs/API_docs_v53/methods/account_registerDevice.md index cd28abcd..017b9af3 100644 --- a/old_docs/API_docs_v53/methods/account_registerDevice.md +++ b/old_docs/API_docs_v53/methods/account_registerDevice.md @@ -12,8 +12,8 @@ Register device for push notifications | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and oTher, see source code of official apps for more info| +|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and oTher, see source code of official apps for more info| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v53/methods/account_unregisterDevice.md b/old_docs/API_docs_v53/methods/account_unregisterDevice.md index 1d2b7670..32e44495 100644 --- a/old_docs/API_docs_v53/methods/account_unregisterDevice.md +++ b/old_docs/API_docs_v53/methods/account_unregisterDevice.md @@ -12,8 +12,8 @@ Stop sending PUSH notifications to app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and oTher, see source code of official apps for more info| +|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and oTher, see source code of official apps for more info| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v53/methods/channels_checkUsername.md b/old_docs/API_docs_v53/methods/channels_checkUsername.md index 371f4cd3..7bc7c245 100644 --- a/old_docs/API_docs_v53/methods/channels_checkUsername.md +++ b/old_docs/API_docs_v53/methods/channels_checkUsername.md @@ -1,17 +1,19 @@ --- title: channels.checkUsername -description: channels.checkUsername parameters, return type and example +description: Check if this username is free and can be assigned to a channel/supergroup --- ## Method: channels.checkUsername [Back to methods index](index.md) +Check if this username is free and can be assigned to a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|username|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|username|[CLICK ME string](../types/string.md) | Yes|The new username for this channel/supergroup| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v53/methods/channels_createChannel.md b/old_docs/API_docs_v53/methods/channels_createChannel.md index c5d21585..1305e4fb 100644 --- a/old_docs/API_docs_v53/methods/channels_createChannel.md +++ b/old_docs/API_docs_v53/methods/channels_createChannel.md @@ -1,19 +1,21 @@ --- title: channels.createChannel -description: channels.createChannel parameters, return type and example +description: Create channel/supergroup --- ## Method: channels.createChannel [Back to methods index](index.md) +Create channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|broadcast|[CLICK ME Bool](../types/Bool.md) | Optional| -|megagroup|[CLICK ME Bool](../types/Bool.md) | Optional| -|title|[CLICK ME string](../types/string.md) | Yes| -|about|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|broadcast|[CLICK ME Bool](../types/Bool.md) | Optional|Set this to true to create a channel| +|megagroup|[CLICK ME Bool](../types/Bool.md) | Optional|Set this to true to create a supergroup| +|title|[CLICK ME string](../types/string.md) | Yes|Supergroup/channel title| +|about|[CLICK ME string](../types/string.md) | Yes|About text| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v53/methods/channels_deleteChannel.md b/old_docs/API_docs_v53/methods/channels_deleteChannel.md index 61b29eac..e660d25c 100644 --- a/old_docs/API_docs_v53/methods/channels_deleteChannel.md +++ b/old_docs/API_docs_v53/methods/channels_deleteChannel.md @@ -1,16 +1,18 @@ --- title: channels.deleteChannel -description: channels.deleteChannel parameters, return type and example +description: Delete a channel/supergroup --- ## Method: channels.deleteChannel [Back to methods index](index.md) +Delete a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup to delete| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v53/methods/channels_deleteMessages.md b/old_docs/API_docs_v53/methods/channels_deleteMessages.md index 87a968c5..fb9d3cc2 100644 --- a/old_docs/API_docs_v53/methods/channels_deleteMessages.md +++ b/old_docs/API_docs_v53/methods/channels_deleteMessages.md @@ -1,17 +1,19 @@ --- title: channels.deleteMessages -description: channels.deleteMessages parameters, return type and example +description: Delete channel/supergroup messages --- ## Method: channels.deleteMessages [Back to methods index](index.md) +Delete channel/supergroup messages + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|id|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to delete| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v53/methods/channels_deleteUserHistory.md b/old_docs/API_docs_v53/methods/channels_deleteUserHistory.md index ee828f45..fbe34341 100644 --- a/old_docs/API_docs_v53/methods/channels_deleteUserHistory.md +++ b/old_docs/API_docs_v53/methods/channels_deleteUserHistory.md @@ -1,17 +1,19 @@ --- title: channels.deleteUserHistory -description: channels.deleteUserHistory parameters, return type and example +description: Delete all messages of a user in a channel/supergroup --- ## Method: channels.deleteUserHistory [Back to methods index](index.md) +Delete all messages of a user in a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) diff --git a/old_docs/API_docs_v53/methods/channels_editAbout.md b/old_docs/API_docs_v53/methods/channels_editAbout.md index 94be2503..8908f29e 100644 --- a/old_docs/API_docs_v53/methods/channels_editAbout.md +++ b/old_docs/API_docs_v53/methods/channels_editAbout.md @@ -1,17 +1,19 @@ --- title: channels.editAbout -description: channels.editAbout parameters, return type and example +description: Edit the about text of a channel/supergroup --- ## Method: channels.editAbout [Back to methods index](index.md) +Edit the about text of a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|about|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|about|[CLICK ME string](../types/string.md) | Yes|The new about text| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v53/methods/channels_editAdmin.md b/old_docs/API_docs_v53/methods/channels_editAdmin.md index e1917c89..695c5294 100644 --- a/old_docs/API_docs_v53/methods/channels_editAdmin.md +++ b/old_docs/API_docs_v53/methods/channels_editAdmin.md @@ -1,18 +1,20 @@ --- title: channels.editAdmin -description: channels.editAdmin parameters, return type and example +description: Edit admin permissions of a user in a channel/supergroup --- ## Method: channels.editAdmin [Back to methods index](index.md) +Edit admin permissions of a user in a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|role|[CLICK ME ChannelParticipantRole](../types/ChannelParticipantRole.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| +|role|[CLICK ME ChannelParticipantRole](../types/ChannelParticipantRole.md) | Yes|| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v53/methods/channels_editPhoto.md b/old_docs/API_docs_v53/methods/channels_editPhoto.md index 3a2c794b..9ccd864f 100644 --- a/old_docs/API_docs_v53/methods/channels_editPhoto.md +++ b/old_docs/API_docs_v53/methods/channels_editPhoto.md @@ -1,17 +1,19 @@ --- title: channels.editPhoto -description: channels.editPhoto parameters, return type and example +description: Edit the photo of a supergroup/channel --- ## Method: channels.editPhoto [Back to methods index](index.md) +Edit the photo of a supergroup/channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new photo| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v53/methods/channels_editTitle.md b/old_docs/API_docs_v53/methods/channels_editTitle.md index ec60e10f..b1024faf 100644 --- a/old_docs/API_docs_v53/methods/channels_editTitle.md +++ b/old_docs/API_docs_v53/methods/channels_editTitle.md @@ -1,17 +1,19 @@ --- title: channels.editTitle -description: channels.editTitle parameters, return type and example +description: Edit the title of a supergroup/channel --- ## Method: channels.editTitle [Back to methods index](index.md) +Edit the title of a supergroup/channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|title|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|title|[CLICK ME string](../types/string.md) | Yes|The new channel/supergroup title| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v53/methods/channels_exportInvite.md b/old_docs/API_docs_v53/methods/channels_exportInvite.md index 3c10f832..f0c737d5 100644 --- a/old_docs/API_docs_v53/methods/channels_exportInvite.md +++ b/old_docs/API_docs_v53/methods/channels_exportInvite.md @@ -1,16 +1,18 @@ --- title: channels.exportInvite -description: channels.exportInvite parameters, return type and example +description: Export the invite link of a channel --- ## Method: channels.exportInvite [Back to methods index](index.md) +Export the invite link of a channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| ### Return type: [ExportedChatInvite](../types/ExportedChatInvite.md) diff --git a/old_docs/API_docs_v53/methods/channels_exportMessageLink.md b/old_docs/API_docs_v53/methods/channels_exportMessageLink.md index 924dc0d5..f910b594 100644 --- a/old_docs/API_docs_v53/methods/channels_exportMessageLink.md +++ b/old_docs/API_docs_v53/methods/channels_exportMessageLink.md @@ -1,17 +1,19 @@ --- title: channels.exportMessageLink -description: channels.exportMessageLink parameters, return type and example +description: Get the link of a message in a channel --- ## Method: channels.exportMessageLink [Back to methods index](index.md) +Get the link of a message in a channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|id|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|id|[CLICK ME int](../types/int.md) | Yes|The ID of the message| ### Return type: [ExportedMessageLink](../types/ExportedMessageLink.md) diff --git a/old_docs/API_docs_v53/methods/channels_getChannels.md b/old_docs/API_docs_v53/methods/channels_getChannels.md index bd5958d6..9cd9e798 100644 --- a/old_docs/API_docs_v53/methods/channels_getChannels.md +++ b/old_docs/API_docs_v53/methods/channels_getChannels.md @@ -1,16 +1,18 @@ --- title: channels.getChannels -description: channels.getChannels parameters, return type and example +description: Get info about multiple channels/supergroups --- ## Method: channels.getChannels [Back to methods index](index.md) +Get info about multiple channels/supergroups + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|Array of [Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|Array of [Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Yes|The channel/supergroup MTProto IDs| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v53/methods/channels_getMessages.md b/old_docs/API_docs_v53/methods/channels_getMessages.md index 4440856c..cc944fe5 100644 --- a/old_docs/API_docs_v53/methods/channels_getMessages.md +++ b/old_docs/API_docs_v53/methods/channels_getMessages.md @@ -1,17 +1,19 @@ --- title: channels.getMessages -description: channels.getMessages parameters, return type and example +description: Get channel/supergroup messages --- ## Method: channels.getMessages [Back to methods index](index.md) +Get channel/supergroup messages + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|id|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The message IDs| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v53/methods/channels_getParticipant.md b/old_docs/API_docs_v53/methods/channels_getParticipant.md index c1819b6b..db9b1fc6 100644 --- a/old_docs/API_docs_v53/methods/channels_getParticipant.md +++ b/old_docs/API_docs_v53/methods/channels_getParticipant.md @@ -1,17 +1,19 @@ --- title: channels.getParticipant -description: channels.getParticipant parameters, return type and example +description: Get info about a certain channel/supergroup participant --- ## Method: channels.getParticipant [Back to methods index](index.md) +Get info about a certain channel/supergroup participant + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to fetch info about| ### Return type: [channels\_ChannelParticipant](../types/channels_ChannelParticipant.md) diff --git a/old_docs/API_docs_v53/methods/channels_getParticipants.md b/old_docs/API_docs_v53/methods/channels_getParticipants.md index 7ec8a980..96662466 100644 --- a/old_docs/API_docs_v53/methods/channels_getParticipants.md +++ b/old_docs/API_docs_v53/methods/channels_getParticipants.md @@ -1,19 +1,21 @@ --- title: channels.getParticipants -description: channels.getParticipants parameters, return type and example +description: Get channel/supergroup participants (you should use `$MadelineProto->get_pwr_chat($id)` instead) --- ## Method: channels.getParticipants [Back to methods index](index.md) +Get channel/supergroup participants (you should use `$MadelineProto->get_pwr_chat($id)` instead) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|filter|[CLICK ME ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) | Yes| -|offset|[CLICK ME int](../types/int.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|filter|[CLICK ME ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) | Yes|Member filter| +|offset|[CLICK ME int](../types/int.md) | Yes|Offset| +|limit|[CLICK ME int](../types/int.md) | Yes|Limit| ### Return type: [channels\_ChannelParticipants](../types/channels_ChannelParticipants.md) diff --git a/old_docs/API_docs_v53/methods/channels_inviteToChannel.md b/old_docs/API_docs_v53/methods/channels_inviteToChannel.md index 9bca2967..676f800c 100644 --- a/old_docs/API_docs_v53/methods/channels_inviteToChannel.md +++ b/old_docs/API_docs_v53/methods/channels_inviteToChannel.md @@ -1,17 +1,19 @@ --- title: channels.inviteToChannel -description: channels.inviteToChannel parameters, return type and example +description: Add users to channel/supergroup --- ## Method: channels.inviteToChannel [Back to methods index](index.md) +Add users to channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to add| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v53/methods/channels_joinChannel.md b/old_docs/API_docs_v53/methods/channels_joinChannel.md index 9ecdbe75..721f707c 100644 --- a/old_docs/API_docs_v53/methods/channels_joinChannel.md +++ b/old_docs/API_docs_v53/methods/channels_joinChannel.md @@ -1,16 +1,18 @@ --- title: channels.joinChannel -description: channels.joinChannel parameters, return type and example +description: Join a channel/supergroup --- ## Method: channels.joinChannel [Back to methods index](index.md) +Join a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup to join| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v53/methods/channels_leaveChannel.md b/old_docs/API_docs_v53/methods/channels_leaveChannel.md index 62c20a00..7f02e08c 100644 --- a/old_docs/API_docs_v53/methods/channels_leaveChannel.md +++ b/old_docs/API_docs_v53/methods/channels_leaveChannel.md @@ -1,16 +1,18 @@ --- title: channels.leaveChannel -description: channels.leaveChannel parameters, return type and example +description: Leave a channel/supergroup --- ## Method: channels.leaveChannel [Back to methods index](index.md) +Leave a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup to leave| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v53/methods/channels_readHistory.md b/old_docs/API_docs_v53/methods/channels_readHistory.md index 745893f6..cca891f0 100644 --- a/old_docs/API_docs_v53/methods/channels_readHistory.md +++ b/old_docs/API_docs_v53/methods/channels_readHistory.md @@ -1,17 +1,19 @@ --- title: channels.readHistory -description: channels.readHistory parameters, return type and example +description: Mark channel/supergroup history as read --- ## Method: channels.readHistory [Back to methods index](index.md) +Mark channel/supergroup history as read + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|max\_id|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to mark as read| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v53/methods/channels_reportSpam.md b/old_docs/API_docs_v53/methods/channels_reportSpam.md index 47dd7cff..09af14e0 100644 --- a/old_docs/API_docs_v53/methods/channels_reportSpam.md +++ b/old_docs/API_docs_v53/methods/channels_reportSpam.md @@ -1,18 +1,20 @@ --- title: channels.reportSpam -description: channels.reportSpam parameters, return type and example +description: Report a supergroup/channel for spam --- ## Method: channels.reportSpam [Back to methods index](index.md) +Report a supergroup/channel for spam + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|id|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that added you to this channel| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to report| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v53/methods/channels_toggleInvites.md b/old_docs/API_docs_v53/methods/channels_toggleInvites.md index b6771ed3..5b541f67 100644 --- a/old_docs/API_docs_v53/methods/channels_toggleInvites.md +++ b/old_docs/API_docs_v53/methods/channels_toggleInvites.md @@ -1,17 +1,19 @@ --- title: channels.toggleInvites -description: channels.toggleInvites parameters, return type and example +description: Allow or disallow any user to invite users to this channel/supergroup --- ## Method: channels.toggleInvites [Back to methods index](index.md) +Allow or disallow any user to invite users to this channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Allow or disallow| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v53/methods/channels_toggleSignatures.md b/old_docs/API_docs_v53/methods/channels_toggleSignatures.md index e8ff70a8..f233a8e1 100644 --- a/old_docs/API_docs_v53/methods/channels_toggleSignatures.md +++ b/old_docs/API_docs_v53/methods/channels_toggleSignatures.md @@ -1,17 +1,19 @@ --- title: channels.toggleSignatures -description: channels.toggleSignatures parameters, return type and example +description: Toggle channel signatures --- ## Method: channels.toggleSignatures [Back to methods index](index.md) +Toggle channel signatures + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Enable or disable channel signatures?| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v53/methods/channels_updatePinnedMessage.md b/old_docs/API_docs_v53/methods/channels_updatePinnedMessage.md index 7a14b68b..f06d1f0f 100644 --- a/old_docs/API_docs_v53/methods/channels_updatePinnedMessage.md +++ b/old_docs/API_docs_v53/methods/channels_updatePinnedMessage.md @@ -1,18 +1,20 @@ --- title: channels.updatePinnedMessage -description: channels.updatePinnedMessage parameters, return type and example +description: Set the pinned message of a channel/supergroup --- ## Method: channels.updatePinnedMessage [Back to methods index](index.md) +Set the pinned message of a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|id|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Pin silently| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|id|[CLICK ME int](../types/int.md) | Yes|The ID of the message to pin| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v53/methods/channels_updateUsername.md b/old_docs/API_docs_v53/methods/channels_updateUsername.md index 19647598..ad34490a 100644 --- a/old_docs/API_docs_v53/methods/channels_updateUsername.md +++ b/old_docs/API_docs_v53/methods/channels_updateUsername.md @@ -1,17 +1,19 @@ --- title: channels.updateUsername -description: channels.updateUsername parameters, return type and example +description: Update the username of a supergroup/channel --- ## Method: channels.updateUsername [Back to methods index](index.md) +Update the username of a supergroup/channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|username|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|username|[CLICK ME string](../types/string.md) | Yes|The new username| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v53/methods/contacts_getBlocked.md b/old_docs/API_docs_v53/methods/contacts_getBlocked.md index d7d8c5cc..300025af 100644 --- a/old_docs/API_docs_v53/methods/contacts_getBlocked.md +++ b/old_docs/API_docs_v53/methods/contacts_getBlocked.md @@ -12,7 +12,7 @@ Get blocked users | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, then set to the number of blocked contacts previously fetched| +|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, Then set to the number of blocked contacts previously fetched| |limit|[CLICK ME int](../types/int.md) | Yes|How many blocked contacts to fetch| diff --git a/old_docs/API_docs_v53/methods/contacts_getTopPeers.md b/old_docs/API_docs_v53/methods/contacts_getTopPeers.md index 2bad9a2a..b3f51975 100644 --- a/old_docs/API_docs_v53/methods/contacts_getTopPeers.md +++ b/old_docs/API_docs_v53/methods/contacts_getTopPeers.md @@ -17,7 +17,7 @@ Get most used chats |bots\_inline|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch inline bots?| |groups|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch groups?| |channels|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch channels and supergroups?| -|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, then `$offset += $contacts_TopPeers['categories']['count'];`| +|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, Then `$offset += $contacts_TopPeers['categories']['count'];`| |limit|[CLICK ME int](../types/int.md) | Yes|How many results to fetch| |hash|[CLICK ME int](../types/int.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched peer ids);| diff --git a/old_docs/API_docs_v53/methods/help_getAppChangelog.md b/old_docs/API_docs_v53/methods/help_getAppChangelog.md index 7378f490..208d3409 100644 --- a/old_docs/API_docs_v53/methods/help_getAppChangelog.md +++ b/old_docs/API_docs_v53/methods/help_getAppChangelog.md @@ -1,11 +1,13 @@ --- title: help.getAppChangelog -description: help.getAppChangelog parameters, return type and example +description: Get the changelog of this app --- ## Method: help.getAppChangelog [Back to methods index](index.md) +Get the changelog of this app + ### Return type: [help\_AppChangelog](../types/help_AppChangelog.md) diff --git a/old_docs/API_docs_v53/methods/help_getAppUpdate.md b/old_docs/API_docs_v53/methods/help_getAppUpdate.md index ef72cce2..b88906ae 100644 --- a/old_docs/API_docs_v53/methods/help_getAppUpdate.md +++ b/old_docs/API_docs_v53/methods/help_getAppUpdate.md @@ -1,11 +1,13 @@ --- title: help.getAppUpdate -description: help.getAppUpdate parameters, return type and example +description: Get info about app updates --- ## Method: help.getAppUpdate [Back to methods index](index.md) +Get info about app updates + ### Return type: [help\_AppUpdate](../types/help_AppUpdate.md) diff --git a/old_docs/API_docs_v53/methods/help_getConfig.md b/old_docs/API_docs_v53/methods/help_getConfig.md index 885ad5d3..16e25c68 100644 --- a/old_docs/API_docs_v53/methods/help_getConfig.md +++ b/old_docs/API_docs_v53/methods/help_getConfig.md @@ -1,11 +1,13 @@ --- title: help.getConfig -description: help.getConfig parameters, return type and example +description: Get server configuration --- ## Method: help.getConfig [Back to methods index](index.md) +Get server configuration + ### Return type: [Config](../types/Config.md) diff --git a/old_docs/API_docs_v53/methods/help_getInviteText.md b/old_docs/API_docs_v53/methods/help_getInviteText.md index 101ead40..6b226bff 100644 --- a/old_docs/API_docs_v53/methods/help_getInviteText.md +++ b/old_docs/API_docs_v53/methods/help_getInviteText.md @@ -1,11 +1,13 @@ --- title: help.getInviteText -description: help.getInviteText parameters, return type and example +description: Get invitation text --- ## Method: help.getInviteText [Back to methods index](index.md) +Get invitation text + ### Return type: [help\_InviteText](../types/help_InviteText.md) diff --git a/old_docs/API_docs_v53/methods/help_getNearestDc.md b/old_docs/API_docs_v53/methods/help_getNearestDc.md index 6196890b..35a8bf91 100644 --- a/old_docs/API_docs_v53/methods/help_getNearestDc.md +++ b/old_docs/API_docs_v53/methods/help_getNearestDc.md @@ -1,11 +1,13 @@ --- title: help.getNearestDc -description: help.getNearestDc parameters, return type and example +description: Get nearest datacenter --- ## Method: help.getNearestDc [Back to methods index](index.md) +Get nearest datacenter + ### Return type: [NearestDc](../types/NearestDc.md) diff --git a/old_docs/API_docs_v53/methods/help_getSupport.md b/old_docs/API_docs_v53/methods/help_getSupport.md index 9b269f78..a5bab0f2 100644 --- a/old_docs/API_docs_v53/methods/help_getSupport.md +++ b/old_docs/API_docs_v53/methods/help_getSupport.md @@ -1,11 +1,13 @@ --- title: help.getSupport -description: help.getSupport parameters, return type and example +description: Get info of support user --- ## Method: help.getSupport [Back to methods index](index.md) +Get info of support user + ### Return type: [help\_Support](../types/help_Support.md) diff --git a/old_docs/API_docs_v53/methods/help_getTermsOfService.md b/old_docs/API_docs_v53/methods/help_getTermsOfService.md index f63807ab..487cd83a 100644 --- a/old_docs/API_docs_v53/methods/help_getTermsOfService.md +++ b/old_docs/API_docs_v53/methods/help_getTermsOfService.md @@ -1,11 +1,13 @@ --- title: help.getTermsOfService -description: help.getTermsOfService parameters, return type and example +description: Get terms of service --- ## Method: help.getTermsOfService [Back to methods index](index.md) +Get terms of service + ### Return type: [help\_TermsOfService](../types/help_TermsOfService.md) diff --git a/old_docs/API_docs_v53/methods/help_saveAppLog.md b/old_docs/API_docs_v53/methods/help_saveAppLog.md index af6e94e2..0165b6e3 100644 --- a/old_docs/API_docs_v53/methods/help_saveAppLog.md +++ b/old_docs/API_docs_v53/methods/help_saveAppLog.md @@ -1,16 +1,18 @@ --- title: help.saveAppLog -description: help.saveAppLog parameters, return type and example +description: Log data for developer of this app --- ## Method: help.saveAppLog [Back to methods index](index.md) +Log data for developer of this app + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|events|Array of [CLICK ME InputAppEvent](../types/InputAppEvent.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|events|Array of [CLICK ME InputAppEvent](../types/InputAppEvent.md) | Yes|Event list| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v53/methods/messages_checkChatInvite.md b/old_docs/API_docs_v53/methods/messages_checkChatInvite.md index 4ddf5084..de1d9ff4 100644 --- a/old_docs/API_docs_v53/methods/messages_checkChatInvite.md +++ b/old_docs/API_docs_v53/methods/messages_checkChatInvite.md @@ -1,16 +1,18 @@ --- title: messages.checkChatInvite -description: messages.checkChatInvite parameters, return type and example +description: Check if an invitation link is valid --- ## Method: messages.checkChatInvite [Back to methods index](index.md) +Check if an invitation link is valid + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| ### Return type: [ChatInvite](../types/ChatInvite.md) diff --git a/old_docs/API_docs_v53/methods/messages_deleteChatUser.md b/old_docs/API_docs_v53/methods/messages_deleteChatUser.md index a71f4aaf..0a6830de 100644 --- a/old_docs/API_docs_v53/methods/messages_deleteChatUser.md +++ b/old_docs/API_docs_v53/methods/messages_deleteChatUser.md @@ -12,7 +12,7 @@ Delete a user from a chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The MTProto ID of the chat| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to delete (pass @me to leave the chat)| diff --git a/old_docs/API_docs_v53/methods/messages_editChatAdmin.md b/old_docs/API_docs_v53/methods/messages_editChatAdmin.md index 6bc8f9ae..7916f8b1 100644 --- a/old_docs/API_docs_v53/methods/messages_editChatAdmin.md +++ b/old_docs/API_docs_v53/methods/messages_editChatAdmin.md @@ -1,18 +1,20 @@ --- title: messages.editChatAdmin -description: messages.editChatAdmin parameters, return type and example +description: Edit admin permissions --- ## Method: messages.editChatAdmin [Back to methods index](index.md) +Edit admin permissions + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|is\_admin|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat ID (no supergroups)| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user ID| +|is\_admin|[CLICK ME Bool](../types/Bool.md) | Yes|Should the user be admin?| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v53/methods/messages_editChatPhoto.md b/old_docs/API_docs_v53/methods/messages_editChatPhoto.md index 8848eca7..122913c4 100644 --- a/old_docs/API_docs_v53/methods/messages_editChatPhoto.md +++ b/old_docs/API_docs_v53/methods/messages_editChatPhoto.md @@ -12,7 +12,7 @@ Edit the photo of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The MTProto ID of the chat| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| |photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| diff --git a/old_docs/API_docs_v53/methods/messages_editChatTitle.md b/old_docs/API_docs_v53/methods/messages_editChatTitle.md index 1c1c7a16..3a1e974b 100644 --- a/old_docs/API_docs_v53/methods/messages_editChatTitle.md +++ b/old_docs/API_docs_v53/methods/messages_editChatTitle.md @@ -12,7 +12,7 @@ Edit the title of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The MTProto ID of the chat| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| |title|[CLICK ME string](../types/string.md) | Yes|The new title| diff --git a/old_docs/API_docs_v53/methods/messages_editInlineBotMessage.md b/old_docs/API_docs_v53/methods/messages_editInlineBotMessage.md index c0d06614..2237fb20 100644 --- a/old_docs/API_docs_v53/methods/messages_editInlineBotMessage.md +++ b/old_docs/API_docs_v53/methods/messages_editInlineBotMessage.md @@ -1,20 +1,22 @@ --- title: messages.editInlineBotMessage -description: messages.editInlineBotMessage parameters, return type and example +description: Edit a sent inline message --- ## Method: messages.editInlineBotMessage [Back to methods index](index.md) +Edit a sent inline message + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional| -|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes| -|message|[CLICK ME string](../types/string.md) | Optional| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview| +|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The message ID| +|message|[CLICK ME string](../types/string.md) | Optional|The new message| +|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| +|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/old_docs/API_docs_v53/methods/messages_editMessage.md b/old_docs/API_docs_v53/methods/messages_editMessage.md index 2e98318d..177438a5 100644 --- a/old_docs/API_docs_v53/methods/messages_editMessage.md +++ b/old_docs/API_docs_v53/methods/messages_editMessage.md @@ -1,21 +1,23 @@ --- title: messages.editMessage -description: messages.editMessage parameters, return type and example +description: Edit a message --- ## Method: messages.editMessage [Back to methods index](index.md) +Edit a message + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|id|[CLICK ME int](../types/int.md) | Yes| -|message|[CLICK ME string](../types/string.md) | Optional| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| +|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|message|[CLICK ME string](../types/string.md) | Optional|The new message| +|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| +|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/old_docs/API_docs_v53/methods/messages_exportChatInvite.md b/old_docs/API_docs_v53/methods/messages_exportChatInvite.md index 74d70c21..98685d96 100644 --- a/old_docs/API_docs_v53/methods/messages_exportChatInvite.md +++ b/old_docs/API_docs_v53/methods/messages_exportChatInvite.md @@ -1,16 +1,18 @@ --- title: messages.exportChatInvite -description: messages.exportChatInvite parameters, return type and example +description: Export chat invite --- ## Method: messages.exportChatInvite [Back to methods index](index.md) +Export chat invite + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat id | ### Return type: [ExportedChatInvite](../types/ExportedChatInvite.md) diff --git a/old_docs/API_docs_v53/methods/messages_getAllDrafts.md b/old_docs/API_docs_v53/methods/messages_getAllDrafts.md index a5dd59f6..2c0ecd42 100644 --- a/old_docs/API_docs_v53/methods/messages_getAllDrafts.md +++ b/old_docs/API_docs_v53/methods/messages_getAllDrafts.md @@ -1,11 +1,13 @@ --- title: messages.getAllDrafts -description: messages.getAllDrafts parameters, return type and example +description: Get all message drafts --- ## Method: messages.getAllDrafts [Back to methods index](index.md) +Get all message drafts + ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v53/methods/messages_getAllStickers.md b/old_docs/API_docs_v53/methods/messages_getAllStickers.md index 575fcd49..16fdba6c 100644 --- a/old_docs/API_docs_v53/methods/messages_getAllStickers.md +++ b/old_docs/API_docs_v53/methods/messages_getAllStickers.md @@ -1,16 +1,18 @@ --- title: messages.getAllStickers -description: messages.getAllStickers parameters, return type and example +description: Get all stickerpacks --- ## Method: messages.getAllStickers [Back to methods index](index.md) +Get all stickerpacks + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v53/methods/messages_getBotCallbackAnswer.md b/old_docs/API_docs_v53/methods/messages_getBotCallbackAnswer.md index eb3094e6..bd83feb0 100644 --- a/old_docs/API_docs_v53/methods/messages_getBotCallbackAnswer.md +++ b/old_docs/API_docs_v53/methods/messages_getBotCallbackAnswer.md @@ -1,18 +1,20 @@ --- title: messages.getBotCallbackAnswer -description: messages.getBotCallbackAnswer parameters, return type and example +description: Get the callback answer of a bot (after clicking a button) --- ## Method: messages.getBotCallbackAnswer [Back to methods index](index.md) +Get the callback answer of a bot (after clicking a button) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|msg\_id|[CLICK ME int](../types/int.md) | Yes| -|data|[CLICK ME bytes](../types/bytes.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| +|msg\_id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|data|[CLICK ME bytes](../types/bytes.md) | Yes|The data to send to the bot| ### Return type: [messages\_BotCallbackAnswer](../types/messages_BotCallbackAnswer.md) diff --git a/old_docs/API_docs_v53/methods/messages_getDocumentByHash.md b/old_docs/API_docs_v53/methods/messages_getDocumentByHash.md index b7c45398..1af5bad4 100644 --- a/old_docs/API_docs_v53/methods/messages_getDocumentByHash.md +++ b/old_docs/API_docs_v53/methods/messages_getDocumentByHash.md @@ -1,18 +1,20 @@ --- title: messages.getDocumentByHash -description: messages.getDocumentByHash parameters, return type and example +description: Get document by SHA256 hash --- ## Method: messages.getDocumentByHash [Back to methods index](index.md) +Get document by SHA256 hash + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|sha256|[CLICK ME bytes](../types/bytes.md) | Yes| -|size|[CLICK ME int](../types/int.md) | Yes| -|mime\_type|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|sha256|[CLICK ME bytes](../types/bytes.md) | Yes|`hash('sha256', $filename, true);`| +|size|[CLICK ME int](../types/int.md) | Yes|The file size| +|mime\_type|[CLICK ME string](../types/string.md) | Yes|The mime type of the file| ### Return type: [Document](../types/Document.md) diff --git a/old_docs/API_docs_v53/methods/messages_getInlineBotResults.md b/old_docs/API_docs_v53/methods/messages_getInlineBotResults.md index 5b2bb254..8ab5bf78 100644 --- a/old_docs/API_docs_v53/methods/messages_getInlineBotResults.md +++ b/old_docs/API_docs_v53/methods/messages_getInlineBotResults.md @@ -1,20 +1,22 @@ --- title: messages.getInlineBotResults -description: messages.getInlineBotResults parameters, return type and example +description: Call inline bot --- ## Method: messages.getInlineBotResults [Back to methods index](index.md) +Call inline bot + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional| -|query|[CLICK ME string](../types/string.md) | Yes| -|offset|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot to call| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to call the bot| +|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional|The current location| +|query|[CLICK ME string](../types/string.md) | Yes|The query to send to the bot| +|offset|[CLICK ME string](../types/string.md) | Yes|The offset to send to the bot| ### Return type: [messages\_BotResults](../types/messages_BotResults.md) diff --git a/old_docs/API_docs_v53/methods/messages_getMessageEditData.md b/old_docs/API_docs_v53/methods/messages_getMessageEditData.md index 339678bd..12e71bee 100644 --- a/old_docs/API_docs_v53/methods/messages_getMessageEditData.md +++ b/old_docs/API_docs_v53/methods/messages_getMessageEditData.md @@ -1,17 +1,19 @@ --- title: messages.getMessageEditData -description: messages.getMessageEditData parameters, return type and example +description: Check if about to edit a message or a media caption --- ## Method: messages.getMessageEditData [Back to methods index](index.md) +Check if about to edit a message or a media caption + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|id|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| +|id|[CLICK ME int](../types/int.md) | Yes|The message ID| ### Return type: [messages\_MessageEditData](../types/messages_MessageEditData.md) diff --git a/old_docs/API_docs_v53/methods/messages_getMessagesViews.md b/old_docs/API_docs_v53/methods/messages_getMessagesViews.md index e3f4e4ea..b8d78c85 100644 --- a/old_docs/API_docs_v53/methods/messages_getMessagesViews.md +++ b/old_docs/API_docs_v53/methods/messages_getMessagesViews.md @@ -1,18 +1,20 @@ --- title: messages.getMessagesViews -description: messages.getMessagesViews parameters, return type and example +description: Get and increase message views --- ## Method: messages.getMessagesViews [Back to methods index](index.md) +Get and increase message views + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|id|Array of [CLICK ME int](../types/int.md) | Yes| -|increment|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the message is located| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs messages to get| +|increment|[CLICK ME Bool](../types/Bool.md) | Yes|Increase message views?| ### Return type: [Vector\_of\_int](../types/int.md) diff --git a/old_docs/API_docs_v53/methods/messages_getPeerDialogs.md b/old_docs/API_docs_v53/methods/messages_getPeerDialogs.md index fe8a821c..da82cfc6 100644 --- a/old_docs/API_docs_v53/methods/messages_getPeerDialogs.md +++ b/old_docs/API_docs_v53/methods/messages_getPeerDialogs.md @@ -1,16 +1,18 @@ --- title: messages.getPeerDialogs -description: messages.getPeerDialogs parameters, return type and example +description: Get dialog info of peers --- ## Method: messages.getPeerDialogs [Back to methods index](index.md) +Get dialog info of peers + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peers|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peers|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Yes|The peers| ### Return type: [messages\_PeerDialogs](../types/messages_PeerDialogs.md) diff --git a/old_docs/API_docs_v53/methods/messages_getSavedGifs.md b/old_docs/API_docs_v53/methods/messages_getSavedGifs.md index 08dc4be6..f61348ce 100644 --- a/old_docs/API_docs_v53/methods/messages_getSavedGifs.md +++ b/old_docs/API_docs_v53/methods/messages_getSavedGifs.md @@ -1,16 +1,18 @@ --- title: messages.getSavedGifs -description: messages.getSavedGifs parameters, return type and example +description: Get saved gifs --- ## Method: messages.getSavedGifs [Back to methods index](index.md) +Get saved gifs + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_SavedGifs](../types/messages_SavedGifs.md) diff --git a/old_docs/API_docs_v53/methods/messages_getStickerSet.md b/old_docs/API_docs_v53/methods/messages_getStickerSet.md index 70bdd9ba..c86807e4 100644 --- a/old_docs/API_docs_v53/methods/messages_getStickerSet.md +++ b/old_docs/API_docs_v53/methods/messages_getStickerSet.md @@ -1,16 +1,18 @@ --- title: messages.getStickerSet -description: messages.getStickerSet parameters, return type and example +description: Get a stickerset --- ## Method: messages.getStickerSet [Back to methods index](index.md) +Get a stickerset + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset to get| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/old_docs/API_docs_v53/methods/messages_getStickers.md b/old_docs/API_docs_v53/methods/messages_getStickers.md index 178b897c..4854696d 100644 --- a/old_docs/API_docs_v53/methods/messages_getStickers.md +++ b/old_docs/API_docs_v53/methods/messages_getStickers.md @@ -1,17 +1,19 @@ --- title: messages.getStickers -description: messages.getStickers parameters, return type and example +description: Get stickers --- ## Method: messages.getStickers [Back to methods index](index.md) +Get stickers + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|emoticon|[CLICK ME string](../types/string.md) | Yes| -|hash|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|emoticon|[CLICK ME string](../types/string.md) | Yes|Search by emoji| +|hash|[CLICK ME string](../types/string.md) | Yes|0 or $MadelineProto->gen_vector_hash(previously fetched sticker IDs)| ### Return type: [messages\_Stickers](../types/messages_Stickers.md) diff --git a/old_docs/API_docs_v53/methods/messages_getWebPagePreview.md b/old_docs/API_docs_v53/methods/messages_getWebPagePreview.md index 35243c9f..d01bdd32 100644 --- a/old_docs/API_docs_v53/methods/messages_getWebPagePreview.md +++ b/old_docs/API_docs_v53/methods/messages_getWebPagePreview.md @@ -1,16 +1,18 @@ --- title: messages.getWebPagePreview -description: messages.getWebPagePreview parameters, return type and example +description: Get webpage preview --- ## Method: messages.getWebPagePreview [Back to methods index](index.md) +Get webpage preview + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|message|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|message|[CLICK ME string](../types/string.md) | Yes|Extract preview from this message| ### Return type: [MessageMedia](../types/MessageMedia.md) diff --git a/old_docs/API_docs_v53/methods/messages_importChatInvite.md b/old_docs/API_docs_v53/methods/messages_importChatInvite.md index 2bea5247..0d6cd7c8 100644 --- a/old_docs/API_docs_v53/methods/messages_importChatInvite.md +++ b/old_docs/API_docs_v53/methods/messages_importChatInvite.md @@ -1,16 +1,18 @@ --- title: messages.importChatInvite -description: messages.importChatInvite parameters, return type and example +description: Import chat invite --- ## Method: messages.importChatInvite [Back to methods index](index.md) +Import chat invite + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v53/methods/messages_installStickerSet.md b/old_docs/API_docs_v53/methods/messages_installStickerSet.md index 857aa738..f620c96a 100644 --- a/old_docs/API_docs_v53/methods/messages_installStickerSet.md +++ b/old_docs/API_docs_v53/methods/messages_installStickerSet.md @@ -1,17 +1,19 @@ --- title: messages.installStickerSet -description: messages.installStickerSet parameters, return type and example +description: Add a sticker set --- ## Method: messages.installStickerSet [Back to methods index](index.md) +Add a sticker set + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional| -|disabled|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to add| +|disabled|[CLICK ME Bool](../types/Bool.md) | Yes|| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v53/methods/messages_migrateChat.md b/old_docs/API_docs_v53/methods/messages_migrateChat.md index 5021ad45..db57adfa 100644 --- a/old_docs/API_docs_v53/methods/messages_migrateChat.md +++ b/old_docs/API_docs_v53/methods/messages_migrateChat.md @@ -1,16 +1,18 @@ --- title: messages.migrateChat -description: messages.migrateChat parameters, return type and example +description: Convert chat to supergroup --- ## Method: messages.migrateChat [Back to methods index](index.md) +Convert chat to supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat to convert| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v53/methods/messages_readEncryptedHistory.md b/old_docs/API_docs_v53/methods/messages_readEncryptedHistory.md index 4d341809..39b110e3 100644 --- a/old_docs/API_docs_v53/methods/messages_readEncryptedHistory.md +++ b/old_docs/API_docs_v53/methods/messages_readEncryptedHistory.md @@ -1,17 +1,19 @@ --- title: messages.readEncryptedHistory -description: messages.readEncryptedHistory parameters, return type and example +description: Mark messages as read in secret chats --- ## Method: messages.readEncryptedHistory [Back to methods index](index.md) +Mark messages as read in secret chats + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|max\_date|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to mark messages as read| +|max\_date|[CLICK ME int](../types/int.md) | Yes|Maximum date of messages to mark| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v53/methods/messages_readMessageContents.md b/old_docs/API_docs_v53/methods/messages_readMessageContents.md index 0d27c209..9bb1bee8 100644 --- a/old_docs/API_docs_v53/methods/messages_readMessageContents.md +++ b/old_docs/API_docs_v53/methods/messages_readMessageContents.md @@ -1,16 +1,18 @@ --- title: messages.readMessageContents -description: messages.readMessageContents parameters, return type and example +description: Mark message as read --- ## Method: messages.readMessageContents [Back to methods index](index.md) +Mark message as read + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v53/methods/messages_receivedQueue.md b/old_docs/API_docs_v53/methods/messages_receivedQueue.md index c91caa37..4ad78ba2 100644 --- a/old_docs/API_docs_v53/methods/messages_receivedQueue.md +++ b/old_docs/API_docs_v53/methods/messages_receivedQueue.md @@ -1,77 +1,13 @@ --- title: messages.receivedQueue -description: messages.receivedQueue parameters, return type and example +description: You cannot use this method directly --- ## Method: messages.receivedQueue [Back to methods index](index.md) -### Parameters: - -| Name | Type | Required | -|----------|---------------|----------| -|max\_qts|[CLICK ME int](../types/int.md) | Yes| - - -### 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| - - -### MadelineProto Example: - - -``` -if (!file_exists('madeline.php')) { - copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); -} -include 'madeline.php'; - -// !!! This API id/API hash combination will not work !!! -// !!! You must get your own @ my.telegram.org !!! -$api_id = 0; -$api_hash = ''; - -$MadelineProto = new \danog\MadelineProto\API('session.madeline', ['app_info' => ['api_id' => $api_id, 'api_hash' => $api_hash]]); -$MadelineProto->start(); - -$Vector_of_long = $MadelineProto->messages->receivedQueue(['max_qts' => int, ]); -``` - -### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): - -### As a bot: - -POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` - -Parameters: - -* method - messages.receivedQueue -* params - `{"max_qts": int, }` - - - -### As a user: - -POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.receivedQueue` - -Parameters: - -max_qts - Json encoded int +**You cannot use this method directly** -Or, if you're into Lua: - -``` -Vector_of_long = messages.receivedQueue({max_qts=int, }) -``` - diff --git a/old_docs/API_docs_v53/methods/messages_reorderStickerSets.md b/old_docs/API_docs_v53/methods/messages_reorderStickerSets.md index ad5df9fa..b2cbe4c1 100644 --- a/old_docs/API_docs_v53/methods/messages_reorderStickerSets.md +++ b/old_docs/API_docs_v53/methods/messages_reorderStickerSets.md @@ -1,16 +1,18 @@ --- title: messages.reorderStickerSets -description: messages.reorderStickerSets parameters, return type and example +description: Reorder sticker sets --- ## Method: messages.reorderStickerSets [Back to methods index](index.md) +Reorder sticker sets + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|order|Array of [CLICK ME long](../types/long.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|order|Array of [CLICK ME long](../types/long.md) | Yes|The order| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v53/methods/messages_saveDraft.md b/old_docs/API_docs_v53/methods/messages_saveDraft.md index 9104df33..bbeed707 100644 --- a/old_docs/API_docs_v53/methods/messages_saveDraft.md +++ b/old_docs/API_docs_v53/methods/messages_saveDraft.md @@ -1,20 +1,22 @@ --- title: messages.saveDraft -description: messages.saveDraft parameters, return type and example +description: Save a message draft --- ## Method: messages.saveDraft [Back to methods index](index.md) +Save a message draft + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|message|[CLICK ME string](../types/string.md) | Yes| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview| +|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| +|message|[CLICK ME string](../types/string.md) | Yes|The message| +|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|The entities (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/old_docs/API_docs_v53/methods/messages_saveGif.md b/old_docs/API_docs_v53/methods/messages_saveGif.md index 4a3b6166..6f608c4c 100644 --- a/old_docs/API_docs_v53/methods/messages_saveGif.md +++ b/old_docs/API_docs_v53/methods/messages_saveGif.md @@ -1,17 +1,19 @@ --- title: messages.saveGif -description: messages.saveGif parameters, return type and example +description: Save a GIF --- ## Method: messages.saveGif [Back to methods index](index.md) +Save a GIF + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional| -|unsave|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The GIF to save| +|unsave|[CLICK ME Bool](../types/Bool.md) | Yes|Remove the gif?| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v53/methods/messages_searchGifs.md b/old_docs/API_docs_v53/methods/messages_searchGifs.md index fefef1d7..103ebfeb 100644 --- a/old_docs/API_docs_v53/methods/messages_searchGifs.md +++ b/old_docs/API_docs_v53/methods/messages_searchGifs.md @@ -1,17 +1,19 @@ --- title: messages.searchGifs -description: messages.searchGifs parameters, return type and example +description: Search gifs --- ## Method: messages.searchGifs [Back to methods index](index.md) +Search gifs + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|q|[CLICK ME string](../types/string.md) | Yes| -|offset|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|q|[CLICK ME string](../types/string.md) | Yes|The search query| +|offset|[CLICK ME int](../types/int.md) | Yes|The offset | ### Return type: [messages\_FoundGifs](../types/messages_FoundGifs.md) diff --git a/old_docs/API_docs_v53/methods/messages_searchGlobal.md b/old_docs/API_docs_v53/methods/messages_searchGlobal.md index 32ddd175..0edd1e40 100644 --- a/old_docs/API_docs_v53/methods/messages_searchGlobal.md +++ b/old_docs/API_docs_v53/methods/messages_searchGlobal.md @@ -1,20 +1,22 @@ --- title: messages.searchGlobal -description: messages.searchGlobal parameters, return type and example +description: Global message search --- ## Method: messages.searchGlobal [Back to methods index](index.md) +Global message search + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|q|[CLICK ME string](../types/string.md) | Yes| -|offset\_date|[CLICK ME int](../types/int.md) | Yes| -|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|offset\_id|[CLICK ME int](../types/int.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|q|[CLICK ME string](../types/string.md) | Yes|The query| +|offset\_date|[CLICK ME int](../types/int.md) | Yes|0 or the date offset| +|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|0 or the peer offset| +|offset\_id|[CLICK ME int](../types/int.md) | Yes|0 or the message ID offset| +|limit|[CLICK ME int](../types/int.md) | Yes|The number of results to return| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v53/methods/messages_sendEncrypted.md b/old_docs/API_docs_v53/methods/messages_sendEncrypted.md index 23461760..d48f88d7 100644 --- a/old_docs/API_docs_v53/methods/messages_sendEncrypted.md +++ b/old_docs/API_docs_v53/methods/messages_sendEncrypted.md @@ -1,17 +1,19 @@ --- title: messages.sendEncrypted -description: messages.sendEncrypted parameters, return type and example +description: Send message to secret chat --- ## Method: messages.sendEncrypted [Back to methods index](index.md) +Send message to secret chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the message| +|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v53/methods/messages_sendEncryptedFile.md b/old_docs/API_docs_v53/methods/messages_sendEncryptedFile.md index 64919abe..4fd0648e 100644 --- a/old_docs/API_docs_v53/methods/messages_sendEncryptedFile.md +++ b/old_docs/API_docs_v53/methods/messages_sendEncryptedFile.md @@ -1,18 +1,20 @@ --- title: messages.sendEncryptedFile -description: messages.sendEncryptedFile parameters, return type and example +description: Send a file to a secret chat --- ## Method: messages.sendEncryptedFile [Back to methods index](index.md) +Send a file to a secret chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes| -|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the file| +|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| +|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional|The file (optional)| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v53/methods/messages_sendEncryptedService.md b/old_docs/API_docs_v53/methods/messages_sendEncryptedService.md index 0a0eea8a..d66894bf 100644 --- a/old_docs/API_docs_v53/methods/messages_sendEncryptedService.md +++ b/old_docs/API_docs_v53/methods/messages_sendEncryptedService.md @@ -1,17 +1,19 @@ --- title: messages.sendEncryptedService -description: messages.sendEncryptedService parameters, return type and example +description: Send a service message to a secret chat --- ## Method: messages.sendEncryptedService [Back to methods index](index.md) +Send a service message to a secret chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the service message| +|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v53/methods/messages_sendInlineBotResult.md b/old_docs/API_docs_v53/methods/messages_sendInlineBotResult.md index 4cb9243e..386ac7e3 100644 --- a/old_docs/API_docs_v53/methods/messages_sendInlineBotResult.md +++ b/old_docs/API_docs_v53/methods/messages_sendInlineBotResult.md @@ -1,22 +1,24 @@ --- title: messages.sendInlineBotResult -description: messages.sendInlineBotResult parameters, return type and example +description: Send a received bot result to the chat --- ## Method: messages.sendInlineBotResult [Back to methods index](index.md) +Send a received bot result to the chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional| -|background|[CLICK ME Bool](../types/Bool.md) | Optional| -|clear\_draft|[CLICK ME Bool](../types/Bool.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional| -|query\_id|[CLICK ME long](../types/long.md) | Yes| -|id|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Disable notifications?| +|background|[CLICK ME Bool](../types/Bool.md) | Optional|Disable background notifications?| +|clear\_draft|[CLICK ME Bool](../types/Bool.md) | Optional|Clear the message draft?| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the message| +|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| +|query\_id|[CLICK ME long](../types/long.md) | Yes|The inline query ID| +|id|[CLICK ME string](../types/string.md) | Yes|The result ID| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v53/methods/messages_setBotCallbackAnswer.md b/old_docs/API_docs_v53/methods/messages_setBotCallbackAnswer.md index 14907301..06a7fb44 100644 --- a/old_docs/API_docs_v53/methods/messages_setBotCallbackAnswer.md +++ b/old_docs/API_docs_v53/methods/messages_setBotCallbackAnswer.md @@ -1,18 +1,20 @@ --- title: messages.setBotCallbackAnswer -description: messages.setBotCallbackAnswer parameters, return type and example +description: Bots only: set the callback answer (after a button was clicked) --- ## Method: messages.setBotCallbackAnswer [Back to methods index](index.md) +Bots only: set the callback answer (after a button was clicked) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|alert|[CLICK ME Bool](../types/Bool.md) | Optional| -|query\_id|[CLICK ME long](../types/long.md) | Yes| -|message|[CLICK ME string](../types/string.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|alert|[CLICK ME Bool](../types/Bool.md) | Optional|Is this an alert?| +|query\_id|[CLICK ME long](../types/long.md) | Yes|The query ID| +|message|[CLICK ME string](../types/string.md) | Optional|The message| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v53/methods/messages_setEncryptedTyping.md b/old_docs/API_docs_v53/methods/messages_setEncryptedTyping.md index 3183fedf..e9afe99c 100644 --- a/old_docs/API_docs_v53/methods/messages_setEncryptedTyping.md +++ b/old_docs/API_docs_v53/methods/messages_setEncryptedTyping.md @@ -12,8 +12,8 @@ Send typing notification to secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|| -|typing|[CLICK ME Bool](../types/Bool.md) | Yes|| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to send the notification| +|typing|[CLICK ME Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v53/methods/messages_setInlineBotResults.md b/old_docs/API_docs_v53/methods/messages_setInlineBotResults.md index 915e3a4e..79493009 100644 --- a/old_docs/API_docs_v53/methods/messages_setInlineBotResults.md +++ b/old_docs/API_docs_v53/methods/messages_setInlineBotResults.md @@ -1,22 +1,24 @@ --- title: messages.setInlineBotResults -description: messages.setInlineBotResults parameters, return type and example +description: Bots only: set the results of an inline query --- ## Method: messages.setInlineBotResults [Back to methods index](index.md) +Bots only: set the results of an inline query + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|gallery|[CLICK ME Bool](../types/Bool.md) | Optional| -|private|[CLICK ME Bool](../types/Bool.md) | Optional| -|query\_id|[CLICK ME long](../types/long.md) | Yes| -|results|Array of [CLICK ME InputBotInlineResult](../types/InputBotInlineResult.md) | Yes| -|cache\_time|[CLICK ME int](../types/int.md) | Yes| -|next\_offset|[CLICK ME string](../types/string.md) | Optional| -|switch\_pm|[CLICK ME InlineBotSwitchPM](../types/InlineBotSwitchPM.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|gallery|[CLICK ME Bool](../types/Bool.md) | Optional|Is this a gallery?| +|private|[CLICK ME Bool](../types/Bool.md) | Optional|Is this result private (not cached)?| +|query\_id|[CLICK ME long](../types/long.md) | Yes|Query ID| +|results|Array of [CLICK ME InputBotInlineResult](../types/InputBotInlineResult.md) | Yes|Results| +|cache\_time|[CLICK ME int](../types/int.md) | Yes|Cache time| +|next\_offset|[CLICK ME string](../types/string.md) | Optional|The next offset| +|switch\_pm|[CLICK ME InlineBotSwitchPM](../types/InlineBotSwitchPM.md) | Optional|Switch to PM?| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v53/methods/messages_startBot.md b/old_docs/API_docs_v53/methods/messages_startBot.md index 0de0f1a5..94a4d86a 100644 --- a/old_docs/API_docs_v53/methods/messages_startBot.md +++ b/old_docs/API_docs_v53/methods/messages_startBot.md @@ -1,18 +1,20 @@ --- title: messages.startBot -description: messages.startBot parameters, return type and example +description: Start a bot --- ## Method: messages.startBot [Back to methods index](index.md) +Start a bot + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|start\_param|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot's ID or username| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to start the bot (@me or group ID/username)| +|start\_param|[CLICK ME string](../types/string.md) | Yes|The bot's start parameter| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v53/methods/messages_toggleChatAdmins.md b/old_docs/API_docs_v53/methods/messages_toggleChatAdmins.md index d56e5753..ab591fd9 100644 --- a/old_docs/API_docs_v53/methods/messages_toggleChatAdmins.md +++ b/old_docs/API_docs_v53/methods/messages_toggleChatAdmins.md @@ -1,17 +1,19 @@ --- title: messages.toggleChatAdmins -description: messages.toggleChatAdmins parameters, return type and example +description: Enable all users are admins in normal groups (not supergroups) --- ## Method: messages.toggleChatAdmins [Back to methods index](index.md) +Enable all users are admins in normal groups (not supergroups) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Group ID| +|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Enable all users are admins| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v53/methods/messages_uninstallStickerSet.md b/old_docs/API_docs_v53/methods/messages_uninstallStickerSet.md index 60b0ca0c..6d04e847 100644 --- a/old_docs/API_docs_v53/methods/messages_uninstallStickerSet.md +++ b/old_docs/API_docs_v53/methods/messages_uninstallStickerSet.md @@ -1,16 +1,18 @@ --- title: messages.uninstallStickerSet -description: messages.uninstallStickerSet parameters, return type and example +description: Remove a sticker set --- ## Method: messages.uninstallStickerSet [Back to methods index](index.md) +Remove a sticker set + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to remove| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v53/methods/photos_deletePhotos.md b/old_docs/API_docs_v53/methods/photos_deletePhotos.md index 104459b7..b9daca10 100644 --- a/old_docs/API_docs_v53/methods/photos_deletePhotos.md +++ b/old_docs/API_docs_v53/methods/photos_deletePhotos.md @@ -1,16 +1,18 @@ --- title: photos.deletePhotos -description: photos.deletePhotos parameters, return type and example +description: Delete profile photos --- ## Method: photos.deletePhotos [Back to methods index](index.md) +Delete profile photos + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Yes|The profile photos to delete| ### Return type: [Vector\_of\_long](../types/long.md) diff --git a/old_docs/API_docs_v53/methods/photos_getUserPhotos.md b/old_docs/API_docs_v53/methods/photos_getUserPhotos.md index 1a7515ba..ea27a44f 100644 --- a/old_docs/API_docs_v53/methods/photos_getUserPhotos.md +++ b/old_docs/API_docs_v53/methods/photos_getUserPhotos.md @@ -1,19 +1,21 @@ --- title: photos.getUserPhotos -description: photos.getUserPhotos parameters, return type and example +description: Get the profile photos of a user --- ## Method: photos.getUserPhotos [Back to methods index](index.md) +Get the profile photos of a user + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|offset|[CLICK ME int](../types/int.md) | Yes| -|max\_id|[CLICK ME long](../types/long.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| +|offset|[CLICK ME int](../types/int.md) | Yes|Offset| +|max\_id|[CLICK ME long](../types/long.md) | Yes|Maximum ID of photo to return| +|limit|[CLICK ME int](../types/int.md) | Yes|Number of photos to return| ### Return type: [photos\_Photos](../types/photos_Photos.md) diff --git a/old_docs/API_docs_v53/methods/photos_updateProfilePhoto.md b/old_docs/API_docs_v53/methods/photos_updateProfilePhoto.md index 386970d5..dc6edd6b 100644 --- a/old_docs/API_docs_v53/methods/photos_updateProfilePhoto.md +++ b/old_docs/API_docs_v53/methods/photos_updateProfilePhoto.md @@ -1,17 +1,19 @@ --- title: photos.updateProfilePhoto -description: photos.updateProfilePhoto parameters, return type and example +description: Update the profile photo (use photos->uploadProfilePhoto to upload the photo) --- ## Method: photos.updateProfilePhoto [Back to methods index](index.md) +Update the profile photo (use photos->uploadProfilePhoto to upload the photo) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional| -|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional|The photo to use| +|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|| ### Return type: [UserProfilePhoto](../types/UserProfilePhoto.md) diff --git a/old_docs/API_docs_v53/methods/photos_uploadProfilePhoto.md b/old_docs/API_docs_v53/methods/photos_uploadProfilePhoto.md index 07b9936c..fb0bc534 100644 --- a/old_docs/API_docs_v53/methods/photos_uploadProfilePhoto.md +++ b/old_docs/API_docs_v53/methods/photos_uploadProfilePhoto.md @@ -1,19 +1,21 @@ --- title: photos.uploadProfilePhoto -description: photos.uploadProfilePhoto parameters, return type and example +description: Upload profile photo --- ## Method: photos.uploadProfilePhoto [Back to methods index](index.md) +Upload profile photo + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|file|[File path or InputFile](../types/InputFile.md) | Yes| -|caption|[CLICK ME string](../types/string.md) | Yes| -|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional| -|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|file|[File path or InputFile](../types/InputFile.md) | Yes|The photo| +|caption|[CLICK ME string](../types/string.md) | Yes|| +|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional|| +|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|| ### Return type: [photos\_Photo](../types/photos_Photo.md) diff --git a/old_docs/API_docs_v55/methods/account_registerDevice.md b/old_docs/API_docs_v55/methods/account_registerDevice.md index cd28abcd..017b9af3 100644 --- a/old_docs/API_docs_v55/methods/account_registerDevice.md +++ b/old_docs/API_docs_v55/methods/account_registerDevice.md @@ -12,8 +12,8 @@ Register device for push notifications | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and oTher, see source code of official apps for more info| +|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and oTher, see source code of official apps for more info| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v55/methods/account_unregisterDevice.md b/old_docs/API_docs_v55/methods/account_unregisterDevice.md index 1d2b7670..32e44495 100644 --- a/old_docs/API_docs_v55/methods/account_unregisterDevice.md +++ b/old_docs/API_docs_v55/methods/account_unregisterDevice.md @@ -12,8 +12,8 @@ Stop sending PUSH notifications to app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and oTher, see source code of official apps for more info| +|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and oTher, see source code of official apps for more info| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v55/methods/channels_checkUsername.md b/old_docs/API_docs_v55/methods/channels_checkUsername.md index 371f4cd3..7bc7c245 100644 --- a/old_docs/API_docs_v55/methods/channels_checkUsername.md +++ b/old_docs/API_docs_v55/methods/channels_checkUsername.md @@ -1,17 +1,19 @@ --- title: channels.checkUsername -description: channels.checkUsername parameters, return type and example +description: Check if this username is free and can be assigned to a channel/supergroup --- ## Method: channels.checkUsername [Back to methods index](index.md) +Check if this username is free and can be assigned to a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|username|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|username|[CLICK ME string](../types/string.md) | Yes|The new username for this channel/supergroup| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v55/methods/channels_createChannel.md b/old_docs/API_docs_v55/methods/channels_createChannel.md index c5d21585..1305e4fb 100644 --- a/old_docs/API_docs_v55/methods/channels_createChannel.md +++ b/old_docs/API_docs_v55/methods/channels_createChannel.md @@ -1,19 +1,21 @@ --- title: channels.createChannel -description: channels.createChannel parameters, return type and example +description: Create channel/supergroup --- ## Method: channels.createChannel [Back to methods index](index.md) +Create channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|broadcast|[CLICK ME Bool](../types/Bool.md) | Optional| -|megagroup|[CLICK ME Bool](../types/Bool.md) | Optional| -|title|[CLICK ME string](../types/string.md) | Yes| -|about|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|broadcast|[CLICK ME Bool](../types/Bool.md) | Optional|Set this to true to create a channel| +|megagroup|[CLICK ME Bool](../types/Bool.md) | Optional|Set this to true to create a supergroup| +|title|[CLICK ME string](../types/string.md) | Yes|Supergroup/channel title| +|about|[CLICK ME string](../types/string.md) | Yes|About text| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v55/methods/channels_deleteChannel.md b/old_docs/API_docs_v55/methods/channels_deleteChannel.md index 61b29eac..e660d25c 100644 --- a/old_docs/API_docs_v55/methods/channels_deleteChannel.md +++ b/old_docs/API_docs_v55/methods/channels_deleteChannel.md @@ -1,16 +1,18 @@ --- title: channels.deleteChannel -description: channels.deleteChannel parameters, return type and example +description: Delete a channel/supergroup --- ## Method: channels.deleteChannel [Back to methods index](index.md) +Delete a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup to delete| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v55/methods/channels_deleteMessages.md b/old_docs/API_docs_v55/methods/channels_deleteMessages.md index 87a968c5..fb9d3cc2 100644 --- a/old_docs/API_docs_v55/methods/channels_deleteMessages.md +++ b/old_docs/API_docs_v55/methods/channels_deleteMessages.md @@ -1,17 +1,19 @@ --- title: channels.deleteMessages -description: channels.deleteMessages parameters, return type and example +description: Delete channel/supergroup messages --- ## Method: channels.deleteMessages [Back to methods index](index.md) +Delete channel/supergroup messages + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|id|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to delete| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v55/methods/channels_deleteUserHistory.md b/old_docs/API_docs_v55/methods/channels_deleteUserHistory.md index ee828f45..fbe34341 100644 --- a/old_docs/API_docs_v55/methods/channels_deleteUserHistory.md +++ b/old_docs/API_docs_v55/methods/channels_deleteUserHistory.md @@ -1,17 +1,19 @@ --- title: channels.deleteUserHistory -description: channels.deleteUserHistory parameters, return type and example +description: Delete all messages of a user in a channel/supergroup --- ## Method: channels.deleteUserHistory [Back to methods index](index.md) +Delete all messages of a user in a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) diff --git a/old_docs/API_docs_v55/methods/channels_editAbout.md b/old_docs/API_docs_v55/methods/channels_editAbout.md index 94be2503..8908f29e 100644 --- a/old_docs/API_docs_v55/methods/channels_editAbout.md +++ b/old_docs/API_docs_v55/methods/channels_editAbout.md @@ -1,17 +1,19 @@ --- title: channels.editAbout -description: channels.editAbout parameters, return type and example +description: Edit the about text of a channel/supergroup --- ## Method: channels.editAbout [Back to methods index](index.md) +Edit the about text of a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|about|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|about|[CLICK ME string](../types/string.md) | Yes|The new about text| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v55/methods/channels_editAdmin.md b/old_docs/API_docs_v55/methods/channels_editAdmin.md index e1917c89..695c5294 100644 --- a/old_docs/API_docs_v55/methods/channels_editAdmin.md +++ b/old_docs/API_docs_v55/methods/channels_editAdmin.md @@ -1,18 +1,20 @@ --- title: channels.editAdmin -description: channels.editAdmin parameters, return type and example +description: Edit admin permissions of a user in a channel/supergroup --- ## Method: channels.editAdmin [Back to methods index](index.md) +Edit admin permissions of a user in a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|role|[CLICK ME ChannelParticipantRole](../types/ChannelParticipantRole.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| +|role|[CLICK ME ChannelParticipantRole](../types/ChannelParticipantRole.md) | Yes|| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v55/methods/channels_editPhoto.md b/old_docs/API_docs_v55/methods/channels_editPhoto.md index 3a2c794b..9ccd864f 100644 --- a/old_docs/API_docs_v55/methods/channels_editPhoto.md +++ b/old_docs/API_docs_v55/methods/channels_editPhoto.md @@ -1,17 +1,19 @@ --- title: channels.editPhoto -description: channels.editPhoto parameters, return type and example +description: Edit the photo of a supergroup/channel --- ## Method: channels.editPhoto [Back to methods index](index.md) +Edit the photo of a supergroup/channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new photo| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v55/methods/channels_editTitle.md b/old_docs/API_docs_v55/methods/channels_editTitle.md index ec60e10f..b1024faf 100644 --- a/old_docs/API_docs_v55/methods/channels_editTitle.md +++ b/old_docs/API_docs_v55/methods/channels_editTitle.md @@ -1,17 +1,19 @@ --- title: channels.editTitle -description: channels.editTitle parameters, return type and example +description: Edit the title of a supergroup/channel --- ## Method: channels.editTitle [Back to methods index](index.md) +Edit the title of a supergroup/channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|title|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|title|[CLICK ME string](../types/string.md) | Yes|The new channel/supergroup title| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v55/methods/channels_exportInvite.md b/old_docs/API_docs_v55/methods/channels_exportInvite.md index 3c10f832..f0c737d5 100644 --- a/old_docs/API_docs_v55/methods/channels_exportInvite.md +++ b/old_docs/API_docs_v55/methods/channels_exportInvite.md @@ -1,16 +1,18 @@ --- title: channels.exportInvite -description: channels.exportInvite parameters, return type and example +description: Export the invite link of a channel --- ## Method: channels.exportInvite [Back to methods index](index.md) +Export the invite link of a channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| ### Return type: [ExportedChatInvite](../types/ExportedChatInvite.md) diff --git a/old_docs/API_docs_v55/methods/channels_exportMessageLink.md b/old_docs/API_docs_v55/methods/channels_exportMessageLink.md index 924dc0d5..f910b594 100644 --- a/old_docs/API_docs_v55/methods/channels_exportMessageLink.md +++ b/old_docs/API_docs_v55/methods/channels_exportMessageLink.md @@ -1,17 +1,19 @@ --- title: channels.exportMessageLink -description: channels.exportMessageLink parameters, return type and example +description: Get the link of a message in a channel --- ## Method: channels.exportMessageLink [Back to methods index](index.md) +Get the link of a message in a channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|id|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|id|[CLICK ME int](../types/int.md) | Yes|The ID of the message| ### Return type: [ExportedMessageLink](../types/ExportedMessageLink.md) diff --git a/old_docs/API_docs_v55/methods/channels_getChannels.md b/old_docs/API_docs_v55/methods/channels_getChannels.md index bd5958d6..9cd9e798 100644 --- a/old_docs/API_docs_v55/methods/channels_getChannels.md +++ b/old_docs/API_docs_v55/methods/channels_getChannels.md @@ -1,16 +1,18 @@ --- title: channels.getChannels -description: channels.getChannels parameters, return type and example +description: Get info about multiple channels/supergroups --- ## Method: channels.getChannels [Back to methods index](index.md) +Get info about multiple channels/supergroups + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|Array of [Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|Array of [Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Yes|The channel/supergroup MTProto IDs| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v55/methods/channels_getMessages.md b/old_docs/API_docs_v55/methods/channels_getMessages.md index 4440856c..cc944fe5 100644 --- a/old_docs/API_docs_v55/methods/channels_getMessages.md +++ b/old_docs/API_docs_v55/methods/channels_getMessages.md @@ -1,17 +1,19 @@ --- title: channels.getMessages -description: channels.getMessages parameters, return type and example +description: Get channel/supergroup messages --- ## Method: channels.getMessages [Back to methods index](index.md) +Get channel/supergroup messages + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|id|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The message IDs| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v55/methods/channels_getParticipant.md b/old_docs/API_docs_v55/methods/channels_getParticipant.md index c1819b6b..db9b1fc6 100644 --- a/old_docs/API_docs_v55/methods/channels_getParticipant.md +++ b/old_docs/API_docs_v55/methods/channels_getParticipant.md @@ -1,17 +1,19 @@ --- title: channels.getParticipant -description: channels.getParticipant parameters, return type and example +description: Get info about a certain channel/supergroup participant --- ## Method: channels.getParticipant [Back to methods index](index.md) +Get info about a certain channel/supergroup participant + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to fetch info about| ### Return type: [channels\_ChannelParticipant](../types/channels_ChannelParticipant.md) diff --git a/old_docs/API_docs_v55/methods/channels_getParticipants.md b/old_docs/API_docs_v55/methods/channels_getParticipants.md index 7ec8a980..96662466 100644 --- a/old_docs/API_docs_v55/methods/channels_getParticipants.md +++ b/old_docs/API_docs_v55/methods/channels_getParticipants.md @@ -1,19 +1,21 @@ --- title: channels.getParticipants -description: channels.getParticipants parameters, return type and example +description: Get channel/supergroup participants (you should use `$MadelineProto->get_pwr_chat($id)` instead) --- ## Method: channels.getParticipants [Back to methods index](index.md) +Get channel/supergroup participants (you should use `$MadelineProto->get_pwr_chat($id)` instead) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|filter|[CLICK ME ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) | Yes| -|offset|[CLICK ME int](../types/int.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|filter|[CLICK ME ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) | Yes|Member filter| +|offset|[CLICK ME int](../types/int.md) | Yes|Offset| +|limit|[CLICK ME int](../types/int.md) | Yes|Limit| ### Return type: [channels\_ChannelParticipants](../types/channels_ChannelParticipants.md) diff --git a/old_docs/API_docs_v55/methods/channels_inviteToChannel.md b/old_docs/API_docs_v55/methods/channels_inviteToChannel.md index 9bca2967..676f800c 100644 --- a/old_docs/API_docs_v55/methods/channels_inviteToChannel.md +++ b/old_docs/API_docs_v55/methods/channels_inviteToChannel.md @@ -1,17 +1,19 @@ --- title: channels.inviteToChannel -description: channels.inviteToChannel parameters, return type and example +description: Add users to channel/supergroup --- ## Method: channels.inviteToChannel [Back to methods index](index.md) +Add users to channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to add| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v55/methods/channels_joinChannel.md b/old_docs/API_docs_v55/methods/channels_joinChannel.md index 9ecdbe75..721f707c 100644 --- a/old_docs/API_docs_v55/methods/channels_joinChannel.md +++ b/old_docs/API_docs_v55/methods/channels_joinChannel.md @@ -1,16 +1,18 @@ --- title: channels.joinChannel -description: channels.joinChannel parameters, return type and example +description: Join a channel/supergroup --- ## Method: channels.joinChannel [Back to methods index](index.md) +Join a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup to join| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v55/methods/channels_leaveChannel.md b/old_docs/API_docs_v55/methods/channels_leaveChannel.md index 62c20a00..7f02e08c 100644 --- a/old_docs/API_docs_v55/methods/channels_leaveChannel.md +++ b/old_docs/API_docs_v55/methods/channels_leaveChannel.md @@ -1,16 +1,18 @@ --- title: channels.leaveChannel -description: channels.leaveChannel parameters, return type and example +description: Leave a channel/supergroup --- ## Method: channels.leaveChannel [Back to methods index](index.md) +Leave a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup to leave| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v55/methods/channels_readHistory.md b/old_docs/API_docs_v55/methods/channels_readHistory.md index 745893f6..cca891f0 100644 --- a/old_docs/API_docs_v55/methods/channels_readHistory.md +++ b/old_docs/API_docs_v55/methods/channels_readHistory.md @@ -1,17 +1,19 @@ --- title: channels.readHistory -description: channels.readHistory parameters, return type and example +description: Mark channel/supergroup history as read --- ## Method: channels.readHistory [Back to methods index](index.md) +Mark channel/supergroup history as read + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|max\_id|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to mark as read| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v55/methods/channels_reportSpam.md b/old_docs/API_docs_v55/methods/channels_reportSpam.md index 47dd7cff..09af14e0 100644 --- a/old_docs/API_docs_v55/methods/channels_reportSpam.md +++ b/old_docs/API_docs_v55/methods/channels_reportSpam.md @@ -1,18 +1,20 @@ --- title: channels.reportSpam -description: channels.reportSpam parameters, return type and example +description: Report a supergroup/channel for spam --- ## Method: channels.reportSpam [Back to methods index](index.md) +Report a supergroup/channel for spam + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|id|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that added you to this channel| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to report| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v55/methods/channels_toggleInvites.md b/old_docs/API_docs_v55/methods/channels_toggleInvites.md index b6771ed3..5b541f67 100644 --- a/old_docs/API_docs_v55/methods/channels_toggleInvites.md +++ b/old_docs/API_docs_v55/methods/channels_toggleInvites.md @@ -1,17 +1,19 @@ --- title: channels.toggleInvites -description: channels.toggleInvites parameters, return type and example +description: Allow or disallow any user to invite users to this channel/supergroup --- ## Method: channels.toggleInvites [Back to methods index](index.md) +Allow or disallow any user to invite users to this channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Allow or disallow| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v55/methods/channels_toggleSignatures.md b/old_docs/API_docs_v55/methods/channels_toggleSignatures.md index e8ff70a8..f233a8e1 100644 --- a/old_docs/API_docs_v55/methods/channels_toggleSignatures.md +++ b/old_docs/API_docs_v55/methods/channels_toggleSignatures.md @@ -1,17 +1,19 @@ --- title: channels.toggleSignatures -description: channels.toggleSignatures parameters, return type and example +description: Toggle channel signatures --- ## Method: channels.toggleSignatures [Back to methods index](index.md) +Toggle channel signatures + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Enable or disable channel signatures?| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v55/methods/channels_updatePinnedMessage.md b/old_docs/API_docs_v55/methods/channels_updatePinnedMessage.md index 7a14b68b..f06d1f0f 100644 --- a/old_docs/API_docs_v55/methods/channels_updatePinnedMessage.md +++ b/old_docs/API_docs_v55/methods/channels_updatePinnedMessage.md @@ -1,18 +1,20 @@ --- title: channels.updatePinnedMessage -description: channels.updatePinnedMessage parameters, return type and example +description: Set the pinned message of a channel/supergroup --- ## Method: channels.updatePinnedMessage [Back to methods index](index.md) +Set the pinned message of a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|id|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Pin silently| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|id|[CLICK ME int](../types/int.md) | Yes|The ID of the message to pin| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v55/methods/channels_updateUsername.md b/old_docs/API_docs_v55/methods/channels_updateUsername.md index 19647598..ad34490a 100644 --- a/old_docs/API_docs_v55/methods/channels_updateUsername.md +++ b/old_docs/API_docs_v55/methods/channels_updateUsername.md @@ -1,17 +1,19 @@ --- title: channels.updateUsername -description: channels.updateUsername parameters, return type and example +description: Update the username of a supergroup/channel --- ## Method: channels.updateUsername [Back to methods index](index.md) +Update the username of a supergroup/channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|username|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|username|[CLICK ME string](../types/string.md) | Yes|The new username| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v55/methods/contacts_getBlocked.md b/old_docs/API_docs_v55/methods/contacts_getBlocked.md index d7d8c5cc..300025af 100644 --- a/old_docs/API_docs_v55/methods/contacts_getBlocked.md +++ b/old_docs/API_docs_v55/methods/contacts_getBlocked.md @@ -12,7 +12,7 @@ Get blocked users | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, then set to the number of blocked contacts previously fetched| +|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, Then set to the number of blocked contacts previously fetched| |limit|[CLICK ME int](../types/int.md) | Yes|How many blocked contacts to fetch| diff --git a/old_docs/API_docs_v55/methods/contacts_getTopPeers.md b/old_docs/API_docs_v55/methods/contacts_getTopPeers.md index 2bad9a2a..b3f51975 100644 --- a/old_docs/API_docs_v55/methods/contacts_getTopPeers.md +++ b/old_docs/API_docs_v55/methods/contacts_getTopPeers.md @@ -17,7 +17,7 @@ Get most used chats |bots\_inline|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch inline bots?| |groups|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch groups?| |channels|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch channels and supergroups?| -|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, then `$offset += $contacts_TopPeers['categories']['count'];`| +|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, Then `$offset += $contacts_TopPeers['categories']['count'];`| |limit|[CLICK ME int](../types/int.md) | Yes|How many results to fetch| |hash|[CLICK ME int](../types/int.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched peer ids);| diff --git a/old_docs/API_docs_v55/methods/help_getAppChangelog.md b/old_docs/API_docs_v55/methods/help_getAppChangelog.md index 7378f490..208d3409 100644 --- a/old_docs/API_docs_v55/methods/help_getAppChangelog.md +++ b/old_docs/API_docs_v55/methods/help_getAppChangelog.md @@ -1,11 +1,13 @@ --- title: help.getAppChangelog -description: help.getAppChangelog parameters, return type and example +description: Get the changelog of this app --- ## Method: help.getAppChangelog [Back to methods index](index.md) +Get the changelog of this app + ### Return type: [help\_AppChangelog](../types/help_AppChangelog.md) diff --git a/old_docs/API_docs_v55/methods/help_getAppUpdate.md b/old_docs/API_docs_v55/methods/help_getAppUpdate.md index ef72cce2..b88906ae 100644 --- a/old_docs/API_docs_v55/methods/help_getAppUpdate.md +++ b/old_docs/API_docs_v55/methods/help_getAppUpdate.md @@ -1,11 +1,13 @@ --- title: help.getAppUpdate -description: help.getAppUpdate parameters, return type and example +description: Get info about app updates --- ## Method: help.getAppUpdate [Back to methods index](index.md) +Get info about app updates + ### Return type: [help\_AppUpdate](../types/help_AppUpdate.md) diff --git a/old_docs/API_docs_v55/methods/help_getConfig.md b/old_docs/API_docs_v55/methods/help_getConfig.md index 885ad5d3..16e25c68 100644 --- a/old_docs/API_docs_v55/methods/help_getConfig.md +++ b/old_docs/API_docs_v55/methods/help_getConfig.md @@ -1,11 +1,13 @@ --- title: help.getConfig -description: help.getConfig parameters, return type and example +description: Get server configuration --- ## Method: help.getConfig [Back to methods index](index.md) +Get server configuration + ### Return type: [Config](../types/Config.md) diff --git a/old_docs/API_docs_v55/methods/help_getInviteText.md b/old_docs/API_docs_v55/methods/help_getInviteText.md index 101ead40..6b226bff 100644 --- a/old_docs/API_docs_v55/methods/help_getInviteText.md +++ b/old_docs/API_docs_v55/methods/help_getInviteText.md @@ -1,11 +1,13 @@ --- title: help.getInviteText -description: help.getInviteText parameters, return type and example +description: Get invitation text --- ## Method: help.getInviteText [Back to methods index](index.md) +Get invitation text + ### Return type: [help\_InviteText](../types/help_InviteText.md) diff --git a/old_docs/API_docs_v55/methods/help_getNearestDc.md b/old_docs/API_docs_v55/methods/help_getNearestDc.md index 6196890b..35a8bf91 100644 --- a/old_docs/API_docs_v55/methods/help_getNearestDc.md +++ b/old_docs/API_docs_v55/methods/help_getNearestDc.md @@ -1,11 +1,13 @@ --- title: help.getNearestDc -description: help.getNearestDc parameters, return type and example +description: Get nearest datacenter --- ## Method: help.getNearestDc [Back to methods index](index.md) +Get nearest datacenter + ### Return type: [NearestDc](../types/NearestDc.md) diff --git a/old_docs/API_docs_v55/methods/help_getSupport.md b/old_docs/API_docs_v55/methods/help_getSupport.md index 9b269f78..a5bab0f2 100644 --- a/old_docs/API_docs_v55/methods/help_getSupport.md +++ b/old_docs/API_docs_v55/methods/help_getSupport.md @@ -1,11 +1,13 @@ --- title: help.getSupport -description: help.getSupport parameters, return type and example +description: Get info of support user --- ## Method: help.getSupport [Back to methods index](index.md) +Get info of support user + ### Return type: [help\_Support](../types/help_Support.md) diff --git a/old_docs/API_docs_v55/methods/help_getTermsOfService.md b/old_docs/API_docs_v55/methods/help_getTermsOfService.md index f63807ab..487cd83a 100644 --- a/old_docs/API_docs_v55/methods/help_getTermsOfService.md +++ b/old_docs/API_docs_v55/methods/help_getTermsOfService.md @@ -1,11 +1,13 @@ --- title: help.getTermsOfService -description: help.getTermsOfService parameters, return type and example +description: Get terms of service --- ## Method: help.getTermsOfService [Back to methods index](index.md) +Get terms of service + ### Return type: [help\_TermsOfService](../types/help_TermsOfService.md) diff --git a/old_docs/API_docs_v55/methods/help_saveAppLog.md b/old_docs/API_docs_v55/methods/help_saveAppLog.md index af6e94e2..0165b6e3 100644 --- a/old_docs/API_docs_v55/methods/help_saveAppLog.md +++ b/old_docs/API_docs_v55/methods/help_saveAppLog.md @@ -1,16 +1,18 @@ --- title: help.saveAppLog -description: help.saveAppLog parameters, return type and example +description: Log data for developer of this app --- ## Method: help.saveAppLog [Back to methods index](index.md) +Log data for developer of this app + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|events|Array of [CLICK ME InputAppEvent](../types/InputAppEvent.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|events|Array of [CLICK ME InputAppEvent](../types/InputAppEvent.md) | Yes|Event list| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v55/methods/messages_checkChatInvite.md b/old_docs/API_docs_v55/methods/messages_checkChatInvite.md index 4ddf5084..de1d9ff4 100644 --- a/old_docs/API_docs_v55/methods/messages_checkChatInvite.md +++ b/old_docs/API_docs_v55/methods/messages_checkChatInvite.md @@ -1,16 +1,18 @@ --- title: messages.checkChatInvite -description: messages.checkChatInvite parameters, return type and example +description: Check if an invitation link is valid --- ## Method: messages.checkChatInvite [Back to methods index](index.md) +Check if an invitation link is valid + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| ### Return type: [ChatInvite](../types/ChatInvite.md) diff --git a/old_docs/API_docs_v55/methods/messages_clearRecentStickers.md b/old_docs/API_docs_v55/methods/messages_clearRecentStickers.md index 91c78dbf..19e1f2dc 100644 --- a/old_docs/API_docs_v55/methods/messages_clearRecentStickers.md +++ b/old_docs/API_docs_v55/methods/messages_clearRecentStickers.md @@ -1,11 +1,13 @@ --- title: messages.clearRecentStickers -description: messages.clearRecentStickers parameters, return type and example +description: Clear all recent stickers --- ## Method: messages.clearRecentStickers [Back to methods index](index.md) +Clear all recent stickers + ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v55/methods/messages_deleteChatUser.md b/old_docs/API_docs_v55/methods/messages_deleteChatUser.md index a71f4aaf..0a6830de 100644 --- a/old_docs/API_docs_v55/methods/messages_deleteChatUser.md +++ b/old_docs/API_docs_v55/methods/messages_deleteChatUser.md @@ -12,7 +12,7 @@ Delete a user from a chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The MTProto ID of the chat| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to delete (pass @me to leave the chat)| diff --git a/old_docs/API_docs_v55/methods/messages_editChatAdmin.md b/old_docs/API_docs_v55/methods/messages_editChatAdmin.md index 6bc8f9ae..7916f8b1 100644 --- a/old_docs/API_docs_v55/methods/messages_editChatAdmin.md +++ b/old_docs/API_docs_v55/methods/messages_editChatAdmin.md @@ -1,18 +1,20 @@ --- title: messages.editChatAdmin -description: messages.editChatAdmin parameters, return type and example +description: Edit admin permissions --- ## Method: messages.editChatAdmin [Back to methods index](index.md) +Edit admin permissions + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|is\_admin|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat ID (no supergroups)| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user ID| +|is\_admin|[CLICK ME Bool](../types/Bool.md) | Yes|Should the user be admin?| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v55/methods/messages_editChatPhoto.md b/old_docs/API_docs_v55/methods/messages_editChatPhoto.md index 8848eca7..122913c4 100644 --- a/old_docs/API_docs_v55/methods/messages_editChatPhoto.md +++ b/old_docs/API_docs_v55/methods/messages_editChatPhoto.md @@ -12,7 +12,7 @@ Edit the photo of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The MTProto ID of the chat| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| |photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| diff --git a/old_docs/API_docs_v55/methods/messages_editChatTitle.md b/old_docs/API_docs_v55/methods/messages_editChatTitle.md index 1c1c7a16..3a1e974b 100644 --- a/old_docs/API_docs_v55/methods/messages_editChatTitle.md +++ b/old_docs/API_docs_v55/methods/messages_editChatTitle.md @@ -12,7 +12,7 @@ Edit the title of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The MTProto ID of the chat| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| |title|[CLICK ME string](../types/string.md) | Yes|The new title| diff --git a/old_docs/API_docs_v55/methods/messages_editInlineBotMessage.md b/old_docs/API_docs_v55/methods/messages_editInlineBotMessage.md index c0d06614..2237fb20 100644 --- a/old_docs/API_docs_v55/methods/messages_editInlineBotMessage.md +++ b/old_docs/API_docs_v55/methods/messages_editInlineBotMessage.md @@ -1,20 +1,22 @@ --- title: messages.editInlineBotMessage -description: messages.editInlineBotMessage parameters, return type and example +description: Edit a sent inline message --- ## Method: messages.editInlineBotMessage [Back to methods index](index.md) +Edit a sent inline message + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional| -|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes| -|message|[CLICK ME string](../types/string.md) | Optional| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview| +|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The message ID| +|message|[CLICK ME string](../types/string.md) | Optional|The new message| +|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| +|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/old_docs/API_docs_v55/methods/messages_editMessage.md b/old_docs/API_docs_v55/methods/messages_editMessage.md index 2e98318d..177438a5 100644 --- a/old_docs/API_docs_v55/methods/messages_editMessage.md +++ b/old_docs/API_docs_v55/methods/messages_editMessage.md @@ -1,21 +1,23 @@ --- title: messages.editMessage -description: messages.editMessage parameters, return type and example +description: Edit a message --- ## Method: messages.editMessage [Back to methods index](index.md) +Edit a message + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|id|[CLICK ME int](../types/int.md) | Yes| -|message|[CLICK ME string](../types/string.md) | Optional| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| +|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|message|[CLICK ME string](../types/string.md) | Optional|The new message| +|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| +|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/old_docs/API_docs_v55/methods/messages_exportChatInvite.md b/old_docs/API_docs_v55/methods/messages_exportChatInvite.md index 74d70c21..98685d96 100644 --- a/old_docs/API_docs_v55/methods/messages_exportChatInvite.md +++ b/old_docs/API_docs_v55/methods/messages_exportChatInvite.md @@ -1,16 +1,18 @@ --- title: messages.exportChatInvite -description: messages.exportChatInvite parameters, return type and example +description: Export chat invite --- ## Method: messages.exportChatInvite [Back to methods index](index.md) +Export chat invite + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat id | ### Return type: [ExportedChatInvite](../types/ExportedChatInvite.md) diff --git a/old_docs/API_docs_v55/methods/messages_getAllDrafts.md b/old_docs/API_docs_v55/methods/messages_getAllDrafts.md index a5dd59f6..2c0ecd42 100644 --- a/old_docs/API_docs_v55/methods/messages_getAllDrafts.md +++ b/old_docs/API_docs_v55/methods/messages_getAllDrafts.md @@ -1,11 +1,13 @@ --- title: messages.getAllDrafts -description: messages.getAllDrafts parameters, return type and example +description: Get all message drafts --- ## Method: messages.getAllDrafts [Back to methods index](index.md) +Get all message drafts + ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v55/methods/messages_getAllStickers.md b/old_docs/API_docs_v55/methods/messages_getAllStickers.md index 575fcd49..16fdba6c 100644 --- a/old_docs/API_docs_v55/methods/messages_getAllStickers.md +++ b/old_docs/API_docs_v55/methods/messages_getAllStickers.md @@ -1,16 +1,18 @@ --- title: messages.getAllStickers -description: messages.getAllStickers parameters, return type and example +description: Get all stickerpacks --- ## Method: messages.getAllStickers [Back to methods index](index.md) +Get all stickerpacks + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v55/methods/messages_getArchivedStickers.md b/old_docs/API_docs_v55/methods/messages_getArchivedStickers.md index e87ab096..ad6e894d 100644 --- a/old_docs/API_docs_v55/methods/messages_getArchivedStickers.md +++ b/old_docs/API_docs_v55/methods/messages_getArchivedStickers.md @@ -1,17 +1,19 @@ --- title: messages.getArchivedStickers -description: messages.getArchivedStickers parameters, return type and example +description: Get all archived stickers --- ## Method: messages.getArchivedStickers [Back to methods index](index.md) +Get all archived stickers + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|offset\_id|[CLICK ME long](../types/long.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|offset\_id|[CLICK ME long](../types/long.md) | Yes|Sticker ID offset| +|limit|[CLICK ME int](../types/int.md) | Yes|Number of stickers to fetch| ### Return type: [messages\_ArchivedStickers](../types/messages_ArchivedStickers.md) diff --git a/old_docs/API_docs_v55/methods/messages_getBotCallbackAnswer.md b/old_docs/API_docs_v55/methods/messages_getBotCallbackAnswer.md index eb3094e6..bd83feb0 100644 --- a/old_docs/API_docs_v55/methods/messages_getBotCallbackAnswer.md +++ b/old_docs/API_docs_v55/methods/messages_getBotCallbackAnswer.md @@ -1,18 +1,20 @@ --- title: messages.getBotCallbackAnswer -description: messages.getBotCallbackAnswer parameters, return type and example +description: Get the callback answer of a bot (after clicking a button) --- ## Method: messages.getBotCallbackAnswer [Back to methods index](index.md) +Get the callback answer of a bot (after clicking a button) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|msg\_id|[CLICK ME int](../types/int.md) | Yes| -|data|[CLICK ME bytes](../types/bytes.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| +|msg\_id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|data|[CLICK ME bytes](../types/bytes.md) | Yes|The data to send to the bot| ### Return type: [messages\_BotCallbackAnswer](../types/messages_BotCallbackAnswer.md) diff --git a/old_docs/API_docs_v55/methods/messages_getDocumentByHash.md b/old_docs/API_docs_v55/methods/messages_getDocumentByHash.md index b7c45398..1af5bad4 100644 --- a/old_docs/API_docs_v55/methods/messages_getDocumentByHash.md +++ b/old_docs/API_docs_v55/methods/messages_getDocumentByHash.md @@ -1,18 +1,20 @@ --- title: messages.getDocumentByHash -description: messages.getDocumentByHash parameters, return type and example +description: Get document by SHA256 hash --- ## Method: messages.getDocumentByHash [Back to methods index](index.md) +Get document by SHA256 hash + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|sha256|[CLICK ME bytes](../types/bytes.md) | Yes| -|size|[CLICK ME int](../types/int.md) | Yes| -|mime\_type|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|sha256|[CLICK ME bytes](../types/bytes.md) | Yes|`hash('sha256', $filename, true);`| +|size|[CLICK ME int](../types/int.md) | Yes|The file size| +|mime\_type|[CLICK ME string](../types/string.md) | Yes|The mime type of the file| ### Return type: [Document](../types/Document.md) diff --git a/old_docs/API_docs_v55/methods/messages_getFeaturedStickers.md b/old_docs/API_docs_v55/methods/messages_getFeaturedStickers.md index 88b5609c..512f2e85 100644 --- a/old_docs/API_docs_v55/methods/messages_getFeaturedStickers.md +++ b/old_docs/API_docs_v55/methods/messages_getFeaturedStickers.md @@ -1,16 +1,18 @@ --- title: messages.getFeaturedStickers -description: messages.getFeaturedStickers parameters, return type and example +description: Get featured stickers --- ## Method: messages.getFeaturedStickers [Back to methods index](index.md) +Get featured stickers + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_FeaturedStickers](../types/messages_FeaturedStickers.md) diff --git a/old_docs/API_docs_v55/methods/messages_getInlineBotResults.md b/old_docs/API_docs_v55/methods/messages_getInlineBotResults.md index 5b2bb254..8ab5bf78 100644 --- a/old_docs/API_docs_v55/methods/messages_getInlineBotResults.md +++ b/old_docs/API_docs_v55/methods/messages_getInlineBotResults.md @@ -1,20 +1,22 @@ --- title: messages.getInlineBotResults -description: messages.getInlineBotResults parameters, return type and example +description: Call inline bot --- ## Method: messages.getInlineBotResults [Back to methods index](index.md) +Call inline bot + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional| -|query|[CLICK ME string](../types/string.md) | Yes| -|offset|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot to call| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to call the bot| +|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional|The current location| +|query|[CLICK ME string](../types/string.md) | Yes|The query to send to the bot| +|offset|[CLICK ME string](../types/string.md) | Yes|The offset to send to the bot| ### Return type: [messages\_BotResults](../types/messages_BotResults.md) diff --git a/old_docs/API_docs_v55/methods/messages_getMessageEditData.md b/old_docs/API_docs_v55/methods/messages_getMessageEditData.md index 339678bd..12e71bee 100644 --- a/old_docs/API_docs_v55/methods/messages_getMessageEditData.md +++ b/old_docs/API_docs_v55/methods/messages_getMessageEditData.md @@ -1,17 +1,19 @@ --- title: messages.getMessageEditData -description: messages.getMessageEditData parameters, return type and example +description: Check if about to edit a message or a media caption --- ## Method: messages.getMessageEditData [Back to methods index](index.md) +Check if about to edit a message or a media caption + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|id|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| +|id|[CLICK ME int](../types/int.md) | Yes|The message ID| ### Return type: [messages\_MessageEditData](../types/messages_MessageEditData.md) diff --git a/old_docs/API_docs_v55/methods/messages_getMessagesViews.md b/old_docs/API_docs_v55/methods/messages_getMessagesViews.md index e3f4e4ea..b8d78c85 100644 --- a/old_docs/API_docs_v55/methods/messages_getMessagesViews.md +++ b/old_docs/API_docs_v55/methods/messages_getMessagesViews.md @@ -1,18 +1,20 @@ --- title: messages.getMessagesViews -description: messages.getMessagesViews parameters, return type and example +description: Get and increase message views --- ## Method: messages.getMessagesViews [Back to methods index](index.md) +Get and increase message views + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|id|Array of [CLICK ME int](../types/int.md) | Yes| -|increment|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the message is located| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs messages to get| +|increment|[CLICK ME Bool](../types/Bool.md) | Yes|Increase message views?| ### Return type: [Vector\_of\_int](../types/int.md) diff --git a/old_docs/API_docs_v55/methods/messages_getPeerDialogs.md b/old_docs/API_docs_v55/methods/messages_getPeerDialogs.md index fe8a821c..da82cfc6 100644 --- a/old_docs/API_docs_v55/methods/messages_getPeerDialogs.md +++ b/old_docs/API_docs_v55/methods/messages_getPeerDialogs.md @@ -1,16 +1,18 @@ --- title: messages.getPeerDialogs -description: messages.getPeerDialogs parameters, return type and example +description: Get dialog info of peers --- ## Method: messages.getPeerDialogs [Back to methods index](index.md) +Get dialog info of peers + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peers|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peers|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Yes|The peers| ### Return type: [messages\_PeerDialogs](../types/messages_PeerDialogs.md) diff --git a/old_docs/API_docs_v55/methods/messages_getRecentStickers.md b/old_docs/API_docs_v55/methods/messages_getRecentStickers.md index 3316aa66..2fe2cdff 100644 --- a/old_docs/API_docs_v55/methods/messages_getRecentStickers.md +++ b/old_docs/API_docs_v55/methods/messages_getRecentStickers.md @@ -1,16 +1,18 @@ --- title: messages.getRecentStickers -description: messages.getRecentStickers parameters, return type and example +description: Get recent stickers --- ## Method: messages.getRecentStickers [Back to methods index](index.md) +Get recent stickers + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_RecentStickers](../types/messages_RecentStickers.md) diff --git a/old_docs/API_docs_v55/methods/messages_getSavedGifs.md b/old_docs/API_docs_v55/methods/messages_getSavedGifs.md index 08dc4be6..f61348ce 100644 --- a/old_docs/API_docs_v55/methods/messages_getSavedGifs.md +++ b/old_docs/API_docs_v55/methods/messages_getSavedGifs.md @@ -1,16 +1,18 @@ --- title: messages.getSavedGifs -description: messages.getSavedGifs parameters, return type and example +description: Get saved gifs --- ## Method: messages.getSavedGifs [Back to methods index](index.md) +Get saved gifs + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_SavedGifs](../types/messages_SavedGifs.md) diff --git a/old_docs/API_docs_v55/methods/messages_getStickerSet.md b/old_docs/API_docs_v55/methods/messages_getStickerSet.md index 70bdd9ba..c86807e4 100644 --- a/old_docs/API_docs_v55/methods/messages_getStickerSet.md +++ b/old_docs/API_docs_v55/methods/messages_getStickerSet.md @@ -1,16 +1,18 @@ --- title: messages.getStickerSet -description: messages.getStickerSet parameters, return type and example +description: Get a stickerset --- ## Method: messages.getStickerSet [Back to methods index](index.md) +Get a stickerset + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset to get| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/old_docs/API_docs_v55/methods/messages_getStickers.md b/old_docs/API_docs_v55/methods/messages_getStickers.md index 178b897c..4854696d 100644 --- a/old_docs/API_docs_v55/methods/messages_getStickers.md +++ b/old_docs/API_docs_v55/methods/messages_getStickers.md @@ -1,17 +1,19 @@ --- title: messages.getStickers -description: messages.getStickers parameters, return type and example +description: Get stickers --- ## Method: messages.getStickers [Back to methods index](index.md) +Get stickers + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|emoticon|[CLICK ME string](../types/string.md) | Yes| -|hash|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|emoticon|[CLICK ME string](../types/string.md) | Yes|Search by emoji| +|hash|[CLICK ME string](../types/string.md) | Yes|0 or $MadelineProto->gen_vector_hash(previously fetched sticker IDs)| ### Return type: [messages\_Stickers](../types/messages_Stickers.md) diff --git a/old_docs/API_docs_v55/methods/messages_getWebPagePreview.md b/old_docs/API_docs_v55/methods/messages_getWebPagePreview.md index 35243c9f..d01bdd32 100644 --- a/old_docs/API_docs_v55/methods/messages_getWebPagePreview.md +++ b/old_docs/API_docs_v55/methods/messages_getWebPagePreview.md @@ -1,16 +1,18 @@ --- title: messages.getWebPagePreview -description: messages.getWebPagePreview parameters, return type and example +description: Get webpage preview --- ## Method: messages.getWebPagePreview [Back to methods index](index.md) +Get webpage preview + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|message|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|message|[CLICK ME string](../types/string.md) | Yes|Extract preview from this message| ### Return type: [MessageMedia](../types/MessageMedia.md) diff --git a/old_docs/API_docs_v55/methods/messages_importChatInvite.md b/old_docs/API_docs_v55/methods/messages_importChatInvite.md index 2bea5247..0d6cd7c8 100644 --- a/old_docs/API_docs_v55/methods/messages_importChatInvite.md +++ b/old_docs/API_docs_v55/methods/messages_importChatInvite.md @@ -1,16 +1,18 @@ --- title: messages.importChatInvite -description: messages.importChatInvite parameters, return type and example +description: Import chat invite --- ## Method: messages.importChatInvite [Back to methods index](index.md) +Import chat invite + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v55/methods/messages_installStickerSet.md b/old_docs/API_docs_v55/methods/messages_installStickerSet.md index 61513182..9f6f098c 100644 --- a/old_docs/API_docs_v55/methods/messages_installStickerSet.md +++ b/old_docs/API_docs_v55/methods/messages_installStickerSet.md @@ -1,17 +1,19 @@ --- title: messages.installStickerSet -description: messages.installStickerSet parameters, return type and example +description: Add a sticker set --- ## Method: messages.installStickerSet [Back to methods index](index.md) +Add a sticker set + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional| -|archived|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to add| +|archived|[CLICK ME Bool](../types/Bool.md) | Yes|Archive this set?| ### Return type: [messages\_StickerSetInstallResult](../types/messages_StickerSetInstallResult.md) diff --git a/old_docs/API_docs_v55/methods/messages_migrateChat.md b/old_docs/API_docs_v55/methods/messages_migrateChat.md index 5021ad45..db57adfa 100644 --- a/old_docs/API_docs_v55/methods/messages_migrateChat.md +++ b/old_docs/API_docs_v55/methods/messages_migrateChat.md @@ -1,16 +1,18 @@ --- title: messages.migrateChat -description: messages.migrateChat parameters, return type and example +description: Convert chat to supergroup --- ## Method: messages.migrateChat [Back to methods index](index.md) +Convert chat to supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat to convert| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v55/methods/messages_readEncryptedHistory.md b/old_docs/API_docs_v55/methods/messages_readEncryptedHistory.md index 4d341809..39b110e3 100644 --- a/old_docs/API_docs_v55/methods/messages_readEncryptedHistory.md +++ b/old_docs/API_docs_v55/methods/messages_readEncryptedHistory.md @@ -1,17 +1,19 @@ --- title: messages.readEncryptedHistory -description: messages.readEncryptedHistory parameters, return type and example +description: Mark messages as read in secret chats --- ## Method: messages.readEncryptedHistory [Back to methods index](index.md) +Mark messages as read in secret chats + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|max\_date|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to mark messages as read| +|max\_date|[CLICK ME int](../types/int.md) | Yes|Maximum date of messages to mark| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v55/methods/messages_readFeaturedStickers.md b/old_docs/API_docs_v55/methods/messages_readFeaturedStickers.md index 81ecee3f..5958aab7 100644 --- a/old_docs/API_docs_v55/methods/messages_readFeaturedStickers.md +++ b/old_docs/API_docs_v55/methods/messages_readFeaturedStickers.md @@ -1,11 +1,13 @@ --- title: messages.readFeaturedStickers -description: messages.readFeaturedStickers parameters, return type and example +description: Mark new featured stickers as read --- ## Method: messages.readFeaturedStickers [Back to methods index](index.md) +Mark new featured stickers as read + ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v55/methods/messages_readMessageContents.md b/old_docs/API_docs_v55/methods/messages_readMessageContents.md index 0d27c209..9bb1bee8 100644 --- a/old_docs/API_docs_v55/methods/messages_readMessageContents.md +++ b/old_docs/API_docs_v55/methods/messages_readMessageContents.md @@ -1,16 +1,18 @@ --- title: messages.readMessageContents -description: messages.readMessageContents parameters, return type and example +description: Mark message as read --- ## Method: messages.readMessageContents [Back to methods index](index.md) +Mark message as read + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v55/methods/messages_receivedQueue.md b/old_docs/API_docs_v55/methods/messages_receivedQueue.md index c91caa37..4ad78ba2 100644 --- a/old_docs/API_docs_v55/methods/messages_receivedQueue.md +++ b/old_docs/API_docs_v55/methods/messages_receivedQueue.md @@ -1,77 +1,13 @@ --- title: messages.receivedQueue -description: messages.receivedQueue parameters, return type and example +description: You cannot use this method directly --- ## Method: messages.receivedQueue [Back to methods index](index.md) -### Parameters: - -| Name | Type | Required | -|----------|---------------|----------| -|max\_qts|[CLICK ME int](../types/int.md) | Yes| - - -### 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| - - -### MadelineProto Example: - - -``` -if (!file_exists('madeline.php')) { - copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); -} -include 'madeline.php'; - -// !!! This API id/API hash combination will not work !!! -// !!! You must get your own @ my.telegram.org !!! -$api_id = 0; -$api_hash = ''; - -$MadelineProto = new \danog\MadelineProto\API('session.madeline', ['app_info' => ['api_id' => $api_id, 'api_hash' => $api_hash]]); -$MadelineProto->start(); - -$Vector_of_long = $MadelineProto->messages->receivedQueue(['max_qts' => int, ]); -``` - -### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): - -### As a bot: - -POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` - -Parameters: - -* method - messages.receivedQueue -* params - `{"max_qts": int, }` - - - -### As a user: - -POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.receivedQueue` - -Parameters: - -max_qts - Json encoded int +**You cannot use this method directly** -Or, if you're into Lua: - -``` -Vector_of_long = messages.receivedQueue({max_qts=int, }) -``` - diff --git a/old_docs/API_docs_v55/methods/messages_reorderStickerSets.md b/old_docs/API_docs_v55/methods/messages_reorderStickerSets.md index ad5df9fa..b2cbe4c1 100644 --- a/old_docs/API_docs_v55/methods/messages_reorderStickerSets.md +++ b/old_docs/API_docs_v55/methods/messages_reorderStickerSets.md @@ -1,16 +1,18 @@ --- title: messages.reorderStickerSets -description: messages.reorderStickerSets parameters, return type and example +description: Reorder sticker sets --- ## Method: messages.reorderStickerSets [Back to methods index](index.md) +Reorder sticker sets + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|order|Array of [CLICK ME long](../types/long.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|order|Array of [CLICK ME long](../types/long.md) | Yes|The order| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v55/methods/messages_saveDraft.md b/old_docs/API_docs_v55/methods/messages_saveDraft.md index 9104df33..bbeed707 100644 --- a/old_docs/API_docs_v55/methods/messages_saveDraft.md +++ b/old_docs/API_docs_v55/methods/messages_saveDraft.md @@ -1,20 +1,22 @@ --- title: messages.saveDraft -description: messages.saveDraft parameters, return type and example +description: Save a message draft --- ## Method: messages.saveDraft [Back to methods index](index.md) +Save a message draft + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|message|[CLICK ME string](../types/string.md) | Yes| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview| +|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| +|message|[CLICK ME string](../types/string.md) | Yes|The message| +|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|The entities (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/old_docs/API_docs_v55/methods/messages_saveGif.md b/old_docs/API_docs_v55/methods/messages_saveGif.md index 4a3b6166..6f608c4c 100644 --- a/old_docs/API_docs_v55/methods/messages_saveGif.md +++ b/old_docs/API_docs_v55/methods/messages_saveGif.md @@ -1,17 +1,19 @@ --- title: messages.saveGif -description: messages.saveGif parameters, return type and example +description: Save a GIF --- ## Method: messages.saveGif [Back to methods index](index.md) +Save a GIF + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional| -|unsave|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The GIF to save| +|unsave|[CLICK ME Bool](../types/Bool.md) | Yes|Remove the gif?| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v55/methods/messages_saveRecentSticker.md b/old_docs/API_docs_v55/methods/messages_saveRecentSticker.md index 8e9b0948..57514ad9 100644 --- a/old_docs/API_docs_v55/methods/messages_saveRecentSticker.md +++ b/old_docs/API_docs_v55/methods/messages_saveRecentSticker.md @@ -1,17 +1,19 @@ --- title: messages.saveRecentSticker -description: messages.saveRecentSticker parameters, return type and example +description: Add a sticker to recent stickers --- ## Method: messages.saveRecentSticker [Back to methods index](index.md) +Add a sticker to recent stickers + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional| -|unsave|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker| +|unsave|[CLICK ME Bool](../types/Bool.md) | Yes|Remove the sticker from recent stickers?| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v55/methods/messages_searchGifs.md b/old_docs/API_docs_v55/methods/messages_searchGifs.md index fefef1d7..103ebfeb 100644 --- a/old_docs/API_docs_v55/methods/messages_searchGifs.md +++ b/old_docs/API_docs_v55/methods/messages_searchGifs.md @@ -1,17 +1,19 @@ --- title: messages.searchGifs -description: messages.searchGifs parameters, return type and example +description: Search gifs --- ## Method: messages.searchGifs [Back to methods index](index.md) +Search gifs + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|q|[CLICK ME string](../types/string.md) | Yes| -|offset|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|q|[CLICK ME string](../types/string.md) | Yes|The search query| +|offset|[CLICK ME int](../types/int.md) | Yes|The offset | ### Return type: [messages\_FoundGifs](../types/messages_FoundGifs.md) diff --git a/old_docs/API_docs_v55/methods/messages_searchGlobal.md b/old_docs/API_docs_v55/methods/messages_searchGlobal.md index 32ddd175..0edd1e40 100644 --- a/old_docs/API_docs_v55/methods/messages_searchGlobal.md +++ b/old_docs/API_docs_v55/methods/messages_searchGlobal.md @@ -1,20 +1,22 @@ --- title: messages.searchGlobal -description: messages.searchGlobal parameters, return type and example +description: Global message search --- ## Method: messages.searchGlobal [Back to methods index](index.md) +Global message search + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|q|[CLICK ME string](../types/string.md) | Yes| -|offset\_date|[CLICK ME int](../types/int.md) | Yes| -|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|offset\_id|[CLICK ME int](../types/int.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|q|[CLICK ME string](../types/string.md) | Yes|The query| +|offset\_date|[CLICK ME int](../types/int.md) | Yes|0 or the date offset| +|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|0 or the peer offset| +|offset\_id|[CLICK ME int](../types/int.md) | Yes|0 or the message ID offset| +|limit|[CLICK ME int](../types/int.md) | Yes|The number of results to return| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v55/methods/messages_sendEncrypted.md b/old_docs/API_docs_v55/methods/messages_sendEncrypted.md index 23461760..d48f88d7 100644 --- a/old_docs/API_docs_v55/methods/messages_sendEncrypted.md +++ b/old_docs/API_docs_v55/methods/messages_sendEncrypted.md @@ -1,17 +1,19 @@ --- title: messages.sendEncrypted -description: messages.sendEncrypted parameters, return type and example +description: Send message to secret chat --- ## Method: messages.sendEncrypted [Back to methods index](index.md) +Send message to secret chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the message| +|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v55/methods/messages_sendEncryptedFile.md b/old_docs/API_docs_v55/methods/messages_sendEncryptedFile.md index 64919abe..4fd0648e 100644 --- a/old_docs/API_docs_v55/methods/messages_sendEncryptedFile.md +++ b/old_docs/API_docs_v55/methods/messages_sendEncryptedFile.md @@ -1,18 +1,20 @@ --- title: messages.sendEncryptedFile -description: messages.sendEncryptedFile parameters, return type and example +description: Send a file to a secret chat --- ## Method: messages.sendEncryptedFile [Back to methods index](index.md) +Send a file to a secret chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes| -|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the file| +|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| +|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional|The file (optional)| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v55/methods/messages_sendEncryptedService.md b/old_docs/API_docs_v55/methods/messages_sendEncryptedService.md index 0a0eea8a..d66894bf 100644 --- a/old_docs/API_docs_v55/methods/messages_sendEncryptedService.md +++ b/old_docs/API_docs_v55/methods/messages_sendEncryptedService.md @@ -1,17 +1,19 @@ --- title: messages.sendEncryptedService -description: messages.sendEncryptedService parameters, return type and example +description: Send a service message to a secret chat --- ## Method: messages.sendEncryptedService [Back to methods index](index.md) +Send a service message to a secret chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the service message| +|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v55/methods/messages_sendInlineBotResult.md b/old_docs/API_docs_v55/methods/messages_sendInlineBotResult.md index 4cb9243e..386ac7e3 100644 --- a/old_docs/API_docs_v55/methods/messages_sendInlineBotResult.md +++ b/old_docs/API_docs_v55/methods/messages_sendInlineBotResult.md @@ -1,22 +1,24 @@ --- title: messages.sendInlineBotResult -description: messages.sendInlineBotResult parameters, return type and example +description: Send a received bot result to the chat --- ## Method: messages.sendInlineBotResult [Back to methods index](index.md) +Send a received bot result to the chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional| -|background|[CLICK ME Bool](../types/Bool.md) | Optional| -|clear\_draft|[CLICK ME Bool](../types/Bool.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional| -|query\_id|[CLICK ME long](../types/long.md) | Yes| -|id|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Disable notifications?| +|background|[CLICK ME Bool](../types/Bool.md) | Optional|Disable background notifications?| +|clear\_draft|[CLICK ME Bool](../types/Bool.md) | Optional|Clear the message draft?| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the message| +|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| +|query\_id|[CLICK ME long](../types/long.md) | Yes|The inline query ID| +|id|[CLICK ME string](../types/string.md) | Yes|The result ID| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v55/methods/messages_setBotCallbackAnswer.md b/old_docs/API_docs_v55/methods/messages_setBotCallbackAnswer.md index 1d168e42..9700a1f1 100644 --- a/old_docs/API_docs_v55/methods/messages_setBotCallbackAnswer.md +++ b/old_docs/API_docs_v55/methods/messages_setBotCallbackAnswer.md @@ -1,19 +1,21 @@ --- title: messages.setBotCallbackAnswer -description: messages.setBotCallbackAnswer parameters, return type and example +description: Bots only: set the callback answer (after a button was clicked) --- ## Method: messages.setBotCallbackAnswer [Back to methods index](index.md) +Bots only: set the callback answer (after a button was clicked) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|alert|[CLICK ME Bool](../types/Bool.md) | Optional| -|query\_id|[CLICK ME long](../types/long.md) | Yes| -|message|[CLICK ME string](../types/string.md) | Optional| -|url|[CLICK ME string](../types/string.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|alert|[CLICK ME Bool](../types/Bool.md) | Optional|Is this an alert?| +|query\_id|[CLICK ME long](../types/long.md) | Yes|The query ID| +|message|[CLICK ME string](../types/string.md) | Optional|The message| +|url|[CLICK ME string](../types/string.md) | Optional|The URL| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v55/methods/messages_setEncryptedTyping.md b/old_docs/API_docs_v55/methods/messages_setEncryptedTyping.md index 3183fedf..e9afe99c 100644 --- a/old_docs/API_docs_v55/methods/messages_setEncryptedTyping.md +++ b/old_docs/API_docs_v55/methods/messages_setEncryptedTyping.md @@ -12,8 +12,8 @@ Send typing notification to secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|| -|typing|[CLICK ME Bool](../types/Bool.md) | Yes|| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to send the notification| +|typing|[CLICK ME Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v55/methods/messages_setInlineBotResults.md b/old_docs/API_docs_v55/methods/messages_setInlineBotResults.md index 915e3a4e..79493009 100644 --- a/old_docs/API_docs_v55/methods/messages_setInlineBotResults.md +++ b/old_docs/API_docs_v55/methods/messages_setInlineBotResults.md @@ -1,22 +1,24 @@ --- title: messages.setInlineBotResults -description: messages.setInlineBotResults parameters, return type and example +description: Bots only: set the results of an inline query --- ## Method: messages.setInlineBotResults [Back to methods index](index.md) +Bots only: set the results of an inline query + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|gallery|[CLICK ME Bool](../types/Bool.md) | Optional| -|private|[CLICK ME Bool](../types/Bool.md) | Optional| -|query\_id|[CLICK ME long](../types/long.md) | Yes| -|results|Array of [CLICK ME InputBotInlineResult](../types/InputBotInlineResult.md) | Yes| -|cache\_time|[CLICK ME int](../types/int.md) | Yes| -|next\_offset|[CLICK ME string](../types/string.md) | Optional| -|switch\_pm|[CLICK ME InlineBotSwitchPM](../types/InlineBotSwitchPM.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|gallery|[CLICK ME Bool](../types/Bool.md) | Optional|Is this a gallery?| +|private|[CLICK ME Bool](../types/Bool.md) | Optional|Is this result private (not cached)?| +|query\_id|[CLICK ME long](../types/long.md) | Yes|Query ID| +|results|Array of [CLICK ME InputBotInlineResult](../types/InputBotInlineResult.md) | Yes|Results| +|cache\_time|[CLICK ME int](../types/int.md) | Yes|Cache time| +|next\_offset|[CLICK ME string](../types/string.md) | Optional|The next offset| +|switch\_pm|[CLICK ME InlineBotSwitchPM](../types/InlineBotSwitchPM.md) | Optional|Switch to PM?| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v55/methods/messages_startBot.md b/old_docs/API_docs_v55/methods/messages_startBot.md index 0de0f1a5..94a4d86a 100644 --- a/old_docs/API_docs_v55/methods/messages_startBot.md +++ b/old_docs/API_docs_v55/methods/messages_startBot.md @@ -1,18 +1,20 @@ --- title: messages.startBot -description: messages.startBot parameters, return type and example +description: Start a bot --- ## Method: messages.startBot [Back to methods index](index.md) +Start a bot + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|start\_param|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot's ID or username| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to start the bot (@me or group ID/username)| +|start\_param|[CLICK ME string](../types/string.md) | Yes|The bot's start parameter| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v55/methods/messages_toggleChatAdmins.md b/old_docs/API_docs_v55/methods/messages_toggleChatAdmins.md index d56e5753..ab591fd9 100644 --- a/old_docs/API_docs_v55/methods/messages_toggleChatAdmins.md +++ b/old_docs/API_docs_v55/methods/messages_toggleChatAdmins.md @@ -1,17 +1,19 @@ --- title: messages.toggleChatAdmins -description: messages.toggleChatAdmins parameters, return type and example +description: Enable all users are admins in normal groups (not supergroups) --- ## Method: messages.toggleChatAdmins [Back to methods index](index.md) +Enable all users are admins in normal groups (not supergroups) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Group ID| +|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Enable all users are admins| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v55/methods/messages_uninstallStickerSet.md b/old_docs/API_docs_v55/methods/messages_uninstallStickerSet.md index 60b0ca0c..6d04e847 100644 --- a/old_docs/API_docs_v55/methods/messages_uninstallStickerSet.md +++ b/old_docs/API_docs_v55/methods/messages_uninstallStickerSet.md @@ -1,16 +1,18 @@ --- title: messages.uninstallStickerSet -description: messages.uninstallStickerSet parameters, return type and example +description: Remove a sticker set --- ## Method: messages.uninstallStickerSet [Back to methods index](index.md) +Remove a sticker set + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to remove| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v55/methods/photos_deletePhotos.md b/old_docs/API_docs_v55/methods/photos_deletePhotos.md index 104459b7..b9daca10 100644 --- a/old_docs/API_docs_v55/methods/photos_deletePhotos.md +++ b/old_docs/API_docs_v55/methods/photos_deletePhotos.md @@ -1,16 +1,18 @@ --- title: photos.deletePhotos -description: photos.deletePhotos parameters, return type and example +description: Delete profile photos --- ## Method: photos.deletePhotos [Back to methods index](index.md) +Delete profile photos + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Yes|The profile photos to delete| ### Return type: [Vector\_of\_long](../types/long.md) diff --git a/old_docs/API_docs_v55/methods/photos_getUserPhotos.md b/old_docs/API_docs_v55/methods/photos_getUserPhotos.md index 1a7515ba..ea27a44f 100644 --- a/old_docs/API_docs_v55/methods/photos_getUserPhotos.md +++ b/old_docs/API_docs_v55/methods/photos_getUserPhotos.md @@ -1,19 +1,21 @@ --- title: photos.getUserPhotos -description: photos.getUserPhotos parameters, return type and example +description: Get the profile photos of a user --- ## Method: photos.getUserPhotos [Back to methods index](index.md) +Get the profile photos of a user + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|offset|[CLICK ME int](../types/int.md) | Yes| -|max\_id|[CLICK ME long](../types/long.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| +|offset|[CLICK ME int](../types/int.md) | Yes|Offset| +|max\_id|[CLICK ME long](../types/long.md) | Yes|Maximum ID of photo to return| +|limit|[CLICK ME int](../types/int.md) | Yes|Number of photos to return| ### Return type: [photos\_Photos](../types/photos_Photos.md) diff --git a/old_docs/API_docs_v55/methods/photos_updateProfilePhoto.md b/old_docs/API_docs_v55/methods/photos_updateProfilePhoto.md index 386970d5..dc6edd6b 100644 --- a/old_docs/API_docs_v55/methods/photos_updateProfilePhoto.md +++ b/old_docs/API_docs_v55/methods/photos_updateProfilePhoto.md @@ -1,17 +1,19 @@ --- title: photos.updateProfilePhoto -description: photos.updateProfilePhoto parameters, return type and example +description: Update the profile photo (use photos->uploadProfilePhoto to upload the photo) --- ## Method: photos.updateProfilePhoto [Back to methods index](index.md) +Update the profile photo (use photos->uploadProfilePhoto to upload the photo) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional| -|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional|The photo to use| +|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|| ### Return type: [UserProfilePhoto](../types/UserProfilePhoto.md) diff --git a/old_docs/API_docs_v55/methods/photos_uploadProfilePhoto.md b/old_docs/API_docs_v55/methods/photos_uploadProfilePhoto.md index 07b9936c..fb0bc534 100644 --- a/old_docs/API_docs_v55/methods/photos_uploadProfilePhoto.md +++ b/old_docs/API_docs_v55/methods/photos_uploadProfilePhoto.md @@ -1,19 +1,21 @@ --- title: photos.uploadProfilePhoto -description: photos.uploadProfilePhoto parameters, return type and example +description: Upload profile photo --- ## Method: photos.uploadProfilePhoto [Back to methods index](index.md) +Upload profile photo + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|file|[File path or InputFile](../types/InputFile.md) | Yes| -|caption|[CLICK ME string](../types/string.md) | Yes| -|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional| -|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|file|[File path or InputFile](../types/InputFile.md) | Yes|The photo| +|caption|[CLICK ME string](../types/string.md) | Yes|| +|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional|| +|crop|[CLICK ME InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|| ### Return type: [photos\_Photo](../types/photos_Photo.md) diff --git a/old_docs/API_docs_v57/methods/account_registerDevice.md b/old_docs/API_docs_v57/methods/account_registerDevice.md index cd28abcd..017b9af3 100644 --- a/old_docs/API_docs_v57/methods/account_registerDevice.md +++ b/old_docs/API_docs_v57/methods/account_registerDevice.md @@ -12,8 +12,8 @@ Register device for push notifications | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and oTher, see source code of official apps for more info| +|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and oTher, see source code of official apps for more info| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v57/methods/account_unregisterDevice.md b/old_docs/API_docs_v57/methods/account_unregisterDevice.md index 1d2b7670..32e44495 100644 --- a/old_docs/API_docs_v57/methods/account_unregisterDevice.md +++ b/old_docs/API_docs_v57/methods/account_unregisterDevice.md @@ -12,8 +12,8 @@ Stop sending PUSH notifications to app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and oTher, see source code of official apps for more info| +|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and oTher, see source code of official apps for more info| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v57/methods/channels_checkUsername.md b/old_docs/API_docs_v57/methods/channels_checkUsername.md index 371f4cd3..7bc7c245 100644 --- a/old_docs/API_docs_v57/methods/channels_checkUsername.md +++ b/old_docs/API_docs_v57/methods/channels_checkUsername.md @@ -1,17 +1,19 @@ --- title: channels.checkUsername -description: channels.checkUsername parameters, return type and example +description: Check if this username is free and can be assigned to a channel/supergroup --- ## Method: channels.checkUsername [Back to methods index](index.md) +Check if this username is free and can be assigned to a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|username|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|username|[CLICK ME string](../types/string.md) | Yes|The new username for this channel/supergroup| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v57/methods/channels_createChannel.md b/old_docs/API_docs_v57/methods/channels_createChannel.md index c5d21585..1305e4fb 100644 --- a/old_docs/API_docs_v57/methods/channels_createChannel.md +++ b/old_docs/API_docs_v57/methods/channels_createChannel.md @@ -1,19 +1,21 @@ --- title: channels.createChannel -description: channels.createChannel parameters, return type and example +description: Create channel/supergroup --- ## Method: channels.createChannel [Back to methods index](index.md) +Create channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|broadcast|[CLICK ME Bool](../types/Bool.md) | Optional| -|megagroup|[CLICK ME Bool](../types/Bool.md) | Optional| -|title|[CLICK ME string](../types/string.md) | Yes| -|about|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|broadcast|[CLICK ME Bool](../types/Bool.md) | Optional|Set this to true to create a channel| +|megagroup|[CLICK ME Bool](../types/Bool.md) | Optional|Set this to true to create a supergroup| +|title|[CLICK ME string](../types/string.md) | Yes|Supergroup/channel title| +|about|[CLICK ME string](../types/string.md) | Yes|About text| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v57/methods/channels_deleteChannel.md b/old_docs/API_docs_v57/methods/channels_deleteChannel.md index 61b29eac..e660d25c 100644 --- a/old_docs/API_docs_v57/methods/channels_deleteChannel.md +++ b/old_docs/API_docs_v57/methods/channels_deleteChannel.md @@ -1,16 +1,18 @@ --- title: channels.deleteChannel -description: channels.deleteChannel parameters, return type and example +description: Delete a channel/supergroup --- ## Method: channels.deleteChannel [Back to methods index](index.md) +Delete a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup to delete| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v57/methods/channels_deleteMessages.md b/old_docs/API_docs_v57/methods/channels_deleteMessages.md index 87a968c5..fb9d3cc2 100644 --- a/old_docs/API_docs_v57/methods/channels_deleteMessages.md +++ b/old_docs/API_docs_v57/methods/channels_deleteMessages.md @@ -1,17 +1,19 @@ --- title: channels.deleteMessages -description: channels.deleteMessages parameters, return type and example +description: Delete channel/supergroup messages --- ## Method: channels.deleteMessages [Back to methods index](index.md) +Delete channel/supergroup messages + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|id|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to delete| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v57/methods/channels_deleteUserHistory.md b/old_docs/API_docs_v57/methods/channels_deleteUserHistory.md index ee828f45..fbe34341 100644 --- a/old_docs/API_docs_v57/methods/channels_deleteUserHistory.md +++ b/old_docs/API_docs_v57/methods/channels_deleteUserHistory.md @@ -1,17 +1,19 @@ --- title: channels.deleteUserHistory -description: channels.deleteUserHistory parameters, return type and example +description: Delete all messages of a user in a channel/supergroup --- ## Method: channels.deleteUserHistory [Back to methods index](index.md) +Delete all messages of a user in a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) diff --git a/old_docs/API_docs_v57/methods/channels_editAbout.md b/old_docs/API_docs_v57/methods/channels_editAbout.md index 94be2503..8908f29e 100644 --- a/old_docs/API_docs_v57/methods/channels_editAbout.md +++ b/old_docs/API_docs_v57/methods/channels_editAbout.md @@ -1,17 +1,19 @@ --- title: channels.editAbout -description: channels.editAbout parameters, return type and example +description: Edit the about text of a channel/supergroup --- ## Method: channels.editAbout [Back to methods index](index.md) +Edit the about text of a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|about|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|about|[CLICK ME string](../types/string.md) | Yes|The new about text| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v57/methods/channels_editAdmin.md b/old_docs/API_docs_v57/methods/channels_editAdmin.md index e1917c89..695c5294 100644 --- a/old_docs/API_docs_v57/methods/channels_editAdmin.md +++ b/old_docs/API_docs_v57/methods/channels_editAdmin.md @@ -1,18 +1,20 @@ --- title: channels.editAdmin -description: channels.editAdmin parameters, return type and example +description: Edit admin permissions of a user in a channel/supergroup --- ## Method: channels.editAdmin [Back to methods index](index.md) +Edit admin permissions of a user in a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|role|[CLICK ME ChannelParticipantRole](../types/ChannelParticipantRole.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| +|role|[CLICK ME ChannelParticipantRole](../types/ChannelParticipantRole.md) | Yes|| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v57/methods/channels_editPhoto.md b/old_docs/API_docs_v57/methods/channels_editPhoto.md index 3a2c794b..9ccd864f 100644 --- a/old_docs/API_docs_v57/methods/channels_editPhoto.md +++ b/old_docs/API_docs_v57/methods/channels_editPhoto.md @@ -1,17 +1,19 @@ --- title: channels.editPhoto -description: channels.editPhoto parameters, return type and example +description: Edit the photo of a supergroup/channel --- ## Method: channels.editPhoto [Back to methods index](index.md) +Edit the photo of a supergroup/channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new photo| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v57/methods/channels_editTitle.md b/old_docs/API_docs_v57/methods/channels_editTitle.md index ec60e10f..b1024faf 100644 --- a/old_docs/API_docs_v57/methods/channels_editTitle.md +++ b/old_docs/API_docs_v57/methods/channels_editTitle.md @@ -1,17 +1,19 @@ --- title: channels.editTitle -description: channels.editTitle parameters, return type and example +description: Edit the title of a supergroup/channel --- ## Method: channels.editTitle [Back to methods index](index.md) +Edit the title of a supergroup/channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|title|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|title|[CLICK ME string](../types/string.md) | Yes|The new channel/supergroup title| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v57/methods/channels_exportInvite.md b/old_docs/API_docs_v57/methods/channels_exportInvite.md index 3c10f832..f0c737d5 100644 --- a/old_docs/API_docs_v57/methods/channels_exportInvite.md +++ b/old_docs/API_docs_v57/methods/channels_exportInvite.md @@ -1,16 +1,18 @@ --- title: channels.exportInvite -description: channels.exportInvite parameters, return type and example +description: Export the invite link of a channel --- ## Method: channels.exportInvite [Back to methods index](index.md) +Export the invite link of a channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| ### Return type: [ExportedChatInvite](../types/ExportedChatInvite.md) diff --git a/old_docs/API_docs_v57/methods/channels_exportMessageLink.md b/old_docs/API_docs_v57/methods/channels_exportMessageLink.md index 924dc0d5..f910b594 100644 --- a/old_docs/API_docs_v57/methods/channels_exportMessageLink.md +++ b/old_docs/API_docs_v57/methods/channels_exportMessageLink.md @@ -1,17 +1,19 @@ --- title: channels.exportMessageLink -description: channels.exportMessageLink parameters, return type and example +description: Get the link of a message in a channel --- ## Method: channels.exportMessageLink [Back to methods index](index.md) +Get the link of a message in a channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|id|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|id|[CLICK ME int](../types/int.md) | Yes|The ID of the message| ### Return type: [ExportedMessageLink](../types/ExportedMessageLink.md) diff --git a/old_docs/API_docs_v57/methods/channels_getAdminedPublicChannels.md b/old_docs/API_docs_v57/methods/channels_getAdminedPublicChannels.md index f2b48050..9646f529 100644 --- a/old_docs/API_docs_v57/methods/channels_getAdminedPublicChannels.md +++ b/old_docs/API_docs_v57/methods/channels_getAdminedPublicChannels.md @@ -1,11 +1,13 @@ --- title: channels.getAdminedPublicChannels -description: channels.getAdminedPublicChannels parameters, return type and example +description: Get all supergroups/channels where you're admin --- ## Method: channels.getAdminedPublicChannels [Back to methods index](index.md) +Get all supergroups/channels where you're admin + ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v57/methods/channels_getChannels.md b/old_docs/API_docs_v57/methods/channels_getChannels.md index bd5958d6..9cd9e798 100644 --- a/old_docs/API_docs_v57/methods/channels_getChannels.md +++ b/old_docs/API_docs_v57/methods/channels_getChannels.md @@ -1,16 +1,18 @@ --- title: channels.getChannels -description: channels.getChannels parameters, return type and example +description: Get info about multiple channels/supergroups --- ## Method: channels.getChannels [Back to methods index](index.md) +Get info about multiple channels/supergroups + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|Array of [Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|Array of [Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Yes|The channel/supergroup MTProto IDs| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v57/methods/channels_getMessages.md b/old_docs/API_docs_v57/methods/channels_getMessages.md index 4440856c..cc944fe5 100644 --- a/old_docs/API_docs_v57/methods/channels_getMessages.md +++ b/old_docs/API_docs_v57/methods/channels_getMessages.md @@ -1,17 +1,19 @@ --- title: channels.getMessages -description: channels.getMessages parameters, return type and example +description: Get channel/supergroup messages --- ## Method: channels.getMessages [Back to methods index](index.md) +Get channel/supergroup messages + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|id|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The message IDs| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v57/methods/channels_getParticipant.md b/old_docs/API_docs_v57/methods/channels_getParticipant.md index c1819b6b..db9b1fc6 100644 --- a/old_docs/API_docs_v57/methods/channels_getParticipant.md +++ b/old_docs/API_docs_v57/methods/channels_getParticipant.md @@ -1,17 +1,19 @@ --- title: channels.getParticipant -description: channels.getParticipant parameters, return type and example +description: Get info about a certain channel/supergroup participant --- ## Method: channels.getParticipant [Back to methods index](index.md) +Get info about a certain channel/supergroup participant + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to fetch info about| ### Return type: [channels\_ChannelParticipant](../types/channels_ChannelParticipant.md) diff --git a/old_docs/API_docs_v57/methods/channels_getParticipants.md b/old_docs/API_docs_v57/methods/channels_getParticipants.md index 7ec8a980..96662466 100644 --- a/old_docs/API_docs_v57/methods/channels_getParticipants.md +++ b/old_docs/API_docs_v57/methods/channels_getParticipants.md @@ -1,19 +1,21 @@ --- title: channels.getParticipants -description: channels.getParticipants parameters, return type and example +description: Get channel/supergroup participants (you should use `$MadelineProto->get_pwr_chat($id)` instead) --- ## Method: channels.getParticipants [Back to methods index](index.md) +Get channel/supergroup participants (you should use `$MadelineProto->get_pwr_chat($id)` instead) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|filter|[CLICK ME ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) | Yes| -|offset|[CLICK ME int](../types/int.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|filter|[CLICK ME ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) | Yes|Member filter| +|offset|[CLICK ME int](../types/int.md) | Yes|Offset| +|limit|[CLICK ME int](../types/int.md) | Yes|Limit| ### Return type: [channels\_ChannelParticipants](../types/channels_ChannelParticipants.md) diff --git a/old_docs/API_docs_v57/methods/channels_inviteToChannel.md b/old_docs/API_docs_v57/methods/channels_inviteToChannel.md index 9bca2967..676f800c 100644 --- a/old_docs/API_docs_v57/methods/channels_inviteToChannel.md +++ b/old_docs/API_docs_v57/methods/channels_inviteToChannel.md @@ -1,17 +1,19 @@ --- title: channels.inviteToChannel -description: channels.inviteToChannel parameters, return type and example +description: Add users to channel/supergroup --- ## Method: channels.inviteToChannel [Back to methods index](index.md) +Add users to channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to add| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v57/methods/channels_joinChannel.md b/old_docs/API_docs_v57/methods/channels_joinChannel.md index 9ecdbe75..721f707c 100644 --- a/old_docs/API_docs_v57/methods/channels_joinChannel.md +++ b/old_docs/API_docs_v57/methods/channels_joinChannel.md @@ -1,16 +1,18 @@ --- title: channels.joinChannel -description: channels.joinChannel parameters, return type and example +description: Join a channel/supergroup --- ## Method: channels.joinChannel [Back to methods index](index.md) +Join a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup to join| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v57/methods/channels_leaveChannel.md b/old_docs/API_docs_v57/methods/channels_leaveChannel.md index 62c20a00..7f02e08c 100644 --- a/old_docs/API_docs_v57/methods/channels_leaveChannel.md +++ b/old_docs/API_docs_v57/methods/channels_leaveChannel.md @@ -1,16 +1,18 @@ --- title: channels.leaveChannel -description: channels.leaveChannel parameters, return type and example +description: Leave a channel/supergroup --- ## Method: channels.leaveChannel [Back to methods index](index.md) +Leave a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup to leave| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v57/methods/channels_readHistory.md b/old_docs/API_docs_v57/methods/channels_readHistory.md index 745893f6..cca891f0 100644 --- a/old_docs/API_docs_v57/methods/channels_readHistory.md +++ b/old_docs/API_docs_v57/methods/channels_readHistory.md @@ -1,17 +1,19 @@ --- title: channels.readHistory -description: channels.readHistory parameters, return type and example +description: Mark channel/supergroup history as read --- ## Method: channels.readHistory [Back to methods index](index.md) +Mark channel/supergroup history as read + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|max\_id|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to mark as read| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v57/methods/channels_reportSpam.md b/old_docs/API_docs_v57/methods/channels_reportSpam.md index 47dd7cff..09af14e0 100644 --- a/old_docs/API_docs_v57/methods/channels_reportSpam.md +++ b/old_docs/API_docs_v57/methods/channels_reportSpam.md @@ -1,18 +1,20 @@ --- title: channels.reportSpam -description: channels.reportSpam parameters, return type and example +description: Report a supergroup/channel for spam --- ## Method: channels.reportSpam [Back to methods index](index.md) +Report a supergroup/channel for spam + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|id|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that added you to this channel| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to report| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v57/methods/channels_toggleInvites.md b/old_docs/API_docs_v57/methods/channels_toggleInvites.md index b6771ed3..5b541f67 100644 --- a/old_docs/API_docs_v57/methods/channels_toggleInvites.md +++ b/old_docs/API_docs_v57/methods/channels_toggleInvites.md @@ -1,17 +1,19 @@ --- title: channels.toggleInvites -description: channels.toggleInvites parameters, return type and example +description: Allow or disallow any user to invite users to this channel/supergroup --- ## Method: channels.toggleInvites [Back to methods index](index.md) +Allow or disallow any user to invite users to this channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Allow or disallow| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v57/methods/channels_toggleSignatures.md b/old_docs/API_docs_v57/methods/channels_toggleSignatures.md index e8ff70a8..f233a8e1 100644 --- a/old_docs/API_docs_v57/methods/channels_toggleSignatures.md +++ b/old_docs/API_docs_v57/methods/channels_toggleSignatures.md @@ -1,17 +1,19 @@ --- title: channels.toggleSignatures -description: channels.toggleSignatures parameters, return type and example +description: Toggle channel signatures --- ## Method: channels.toggleSignatures [Back to methods index](index.md) +Toggle channel signatures + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Enable or disable channel signatures?| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v57/methods/channels_updatePinnedMessage.md b/old_docs/API_docs_v57/methods/channels_updatePinnedMessage.md index 7a14b68b..f06d1f0f 100644 --- a/old_docs/API_docs_v57/methods/channels_updatePinnedMessage.md +++ b/old_docs/API_docs_v57/methods/channels_updatePinnedMessage.md @@ -1,18 +1,20 @@ --- title: channels.updatePinnedMessage -description: channels.updatePinnedMessage parameters, return type and example +description: Set the pinned message of a channel/supergroup --- ## Method: channels.updatePinnedMessage [Back to methods index](index.md) +Set the pinned message of a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|id|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Pin silently| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|id|[CLICK ME int](../types/int.md) | Yes|The ID of the message to pin| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v57/methods/channels_updateUsername.md b/old_docs/API_docs_v57/methods/channels_updateUsername.md index 19647598..ad34490a 100644 --- a/old_docs/API_docs_v57/methods/channels_updateUsername.md +++ b/old_docs/API_docs_v57/methods/channels_updateUsername.md @@ -1,17 +1,19 @@ --- title: channels.updateUsername -description: channels.updateUsername parameters, return type and example +description: Update the username of a supergroup/channel --- ## Method: channels.updateUsername [Back to methods index](index.md) +Update the username of a supergroup/channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|username|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|username|[CLICK ME string](../types/string.md) | Yes|The new username| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v57/methods/contacts_getBlocked.md b/old_docs/API_docs_v57/methods/contacts_getBlocked.md index d7d8c5cc..300025af 100644 --- a/old_docs/API_docs_v57/methods/contacts_getBlocked.md +++ b/old_docs/API_docs_v57/methods/contacts_getBlocked.md @@ -12,7 +12,7 @@ Get blocked users | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, then set to the number of blocked contacts previously fetched| +|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, Then set to the number of blocked contacts previously fetched| |limit|[CLICK ME int](../types/int.md) | Yes|How many blocked contacts to fetch| diff --git a/old_docs/API_docs_v57/methods/contacts_getTopPeers.md b/old_docs/API_docs_v57/methods/contacts_getTopPeers.md index 2bad9a2a..b3f51975 100644 --- a/old_docs/API_docs_v57/methods/contacts_getTopPeers.md +++ b/old_docs/API_docs_v57/methods/contacts_getTopPeers.md @@ -17,7 +17,7 @@ Get most used chats |bots\_inline|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch inline bots?| |groups|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch groups?| |channels|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch channels and supergroups?| -|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, then `$offset += $contacts_TopPeers['categories']['count'];`| +|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, Then `$offset += $contacts_TopPeers['categories']['count'];`| |limit|[CLICK ME int](../types/int.md) | Yes|How many results to fetch| |hash|[CLICK ME int](../types/int.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched peer ids);| diff --git a/old_docs/API_docs_v57/methods/help_getAppChangelog.md b/old_docs/API_docs_v57/methods/help_getAppChangelog.md index 7378f490..208d3409 100644 --- a/old_docs/API_docs_v57/methods/help_getAppChangelog.md +++ b/old_docs/API_docs_v57/methods/help_getAppChangelog.md @@ -1,11 +1,13 @@ --- title: help.getAppChangelog -description: help.getAppChangelog parameters, return type and example +description: Get the changelog of this app --- ## Method: help.getAppChangelog [Back to methods index](index.md) +Get the changelog of this app + ### Return type: [help\_AppChangelog](../types/help_AppChangelog.md) diff --git a/old_docs/API_docs_v57/methods/help_getAppUpdate.md b/old_docs/API_docs_v57/methods/help_getAppUpdate.md index ef72cce2..b88906ae 100644 --- a/old_docs/API_docs_v57/methods/help_getAppUpdate.md +++ b/old_docs/API_docs_v57/methods/help_getAppUpdate.md @@ -1,11 +1,13 @@ --- title: help.getAppUpdate -description: help.getAppUpdate parameters, return type and example +description: Get info about app updates --- ## Method: help.getAppUpdate [Back to methods index](index.md) +Get info about app updates + ### Return type: [help\_AppUpdate](../types/help_AppUpdate.md) diff --git a/old_docs/API_docs_v57/methods/help_getConfig.md b/old_docs/API_docs_v57/methods/help_getConfig.md index 885ad5d3..16e25c68 100644 --- a/old_docs/API_docs_v57/methods/help_getConfig.md +++ b/old_docs/API_docs_v57/methods/help_getConfig.md @@ -1,11 +1,13 @@ --- title: help.getConfig -description: help.getConfig parameters, return type and example +description: Get server configuration --- ## Method: help.getConfig [Back to methods index](index.md) +Get server configuration + ### Return type: [Config](../types/Config.md) diff --git a/old_docs/API_docs_v57/methods/help_getInviteText.md b/old_docs/API_docs_v57/methods/help_getInviteText.md index 101ead40..6b226bff 100644 --- a/old_docs/API_docs_v57/methods/help_getInviteText.md +++ b/old_docs/API_docs_v57/methods/help_getInviteText.md @@ -1,11 +1,13 @@ --- title: help.getInviteText -description: help.getInviteText parameters, return type and example +description: Get invitation text --- ## Method: help.getInviteText [Back to methods index](index.md) +Get invitation text + ### Return type: [help\_InviteText](../types/help_InviteText.md) diff --git a/old_docs/API_docs_v57/methods/help_getNearestDc.md b/old_docs/API_docs_v57/methods/help_getNearestDc.md index 6196890b..35a8bf91 100644 --- a/old_docs/API_docs_v57/methods/help_getNearestDc.md +++ b/old_docs/API_docs_v57/methods/help_getNearestDc.md @@ -1,11 +1,13 @@ --- title: help.getNearestDc -description: help.getNearestDc parameters, return type and example +description: Get nearest datacenter --- ## Method: help.getNearestDc [Back to methods index](index.md) +Get nearest datacenter + ### Return type: [NearestDc](../types/NearestDc.md) diff --git a/old_docs/API_docs_v57/methods/help_getSupport.md b/old_docs/API_docs_v57/methods/help_getSupport.md index 9b269f78..a5bab0f2 100644 --- a/old_docs/API_docs_v57/methods/help_getSupport.md +++ b/old_docs/API_docs_v57/methods/help_getSupport.md @@ -1,11 +1,13 @@ --- title: help.getSupport -description: help.getSupport parameters, return type and example +description: Get info of support user --- ## Method: help.getSupport [Back to methods index](index.md) +Get info of support user + ### Return type: [help\_Support](../types/help_Support.md) diff --git a/old_docs/API_docs_v57/methods/help_getTermsOfService.md b/old_docs/API_docs_v57/methods/help_getTermsOfService.md index f63807ab..487cd83a 100644 --- a/old_docs/API_docs_v57/methods/help_getTermsOfService.md +++ b/old_docs/API_docs_v57/methods/help_getTermsOfService.md @@ -1,11 +1,13 @@ --- title: help.getTermsOfService -description: help.getTermsOfService parameters, return type and example +description: Get terms of service --- ## Method: help.getTermsOfService [Back to methods index](index.md) +Get terms of service + ### Return type: [help\_TermsOfService](../types/help_TermsOfService.md) diff --git a/old_docs/API_docs_v57/methods/help_saveAppLog.md b/old_docs/API_docs_v57/methods/help_saveAppLog.md index af6e94e2..0165b6e3 100644 --- a/old_docs/API_docs_v57/methods/help_saveAppLog.md +++ b/old_docs/API_docs_v57/methods/help_saveAppLog.md @@ -1,16 +1,18 @@ --- title: help.saveAppLog -description: help.saveAppLog parameters, return type and example +description: Log data for developer of this app --- ## Method: help.saveAppLog [Back to methods index](index.md) +Log data for developer of this app + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|events|Array of [CLICK ME InputAppEvent](../types/InputAppEvent.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|events|Array of [CLICK ME InputAppEvent](../types/InputAppEvent.md) | Yes|Event list| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v57/methods/messages_checkChatInvite.md b/old_docs/API_docs_v57/methods/messages_checkChatInvite.md index 4ddf5084..de1d9ff4 100644 --- a/old_docs/API_docs_v57/methods/messages_checkChatInvite.md +++ b/old_docs/API_docs_v57/methods/messages_checkChatInvite.md @@ -1,16 +1,18 @@ --- title: messages.checkChatInvite -description: messages.checkChatInvite parameters, return type and example +description: Check if an invitation link is valid --- ## Method: messages.checkChatInvite [Back to methods index](index.md) +Check if an invitation link is valid + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| ### Return type: [ChatInvite](../types/ChatInvite.md) diff --git a/old_docs/API_docs_v57/methods/messages_clearRecentStickers.md b/old_docs/API_docs_v57/methods/messages_clearRecentStickers.md index f017087f..9c1b3754 100644 --- a/old_docs/API_docs_v57/methods/messages_clearRecentStickers.md +++ b/old_docs/API_docs_v57/methods/messages_clearRecentStickers.md @@ -1,16 +1,18 @@ --- title: messages.clearRecentStickers -description: messages.clearRecentStickers parameters, return type and example +description: Clear all recent stickers --- ## Method: messages.clearRecentStickers [Back to methods index](index.md) +Clear all recent stickers + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|attached|[CLICK ME Bool](../types/Bool.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|attached|[CLICK ME Bool](../types/Bool.md) | Optional|Clear recent stickers attached to images?| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v57/methods/messages_deleteChatUser.md b/old_docs/API_docs_v57/methods/messages_deleteChatUser.md index a71f4aaf..0a6830de 100644 --- a/old_docs/API_docs_v57/methods/messages_deleteChatUser.md +++ b/old_docs/API_docs_v57/methods/messages_deleteChatUser.md @@ -12,7 +12,7 @@ Delete a user from a chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The MTProto ID of the chat| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to delete (pass @me to leave the chat)| diff --git a/old_docs/API_docs_v57/methods/messages_editChatAdmin.md b/old_docs/API_docs_v57/methods/messages_editChatAdmin.md index 6bc8f9ae..7916f8b1 100644 --- a/old_docs/API_docs_v57/methods/messages_editChatAdmin.md +++ b/old_docs/API_docs_v57/methods/messages_editChatAdmin.md @@ -1,18 +1,20 @@ --- title: messages.editChatAdmin -description: messages.editChatAdmin parameters, return type and example +description: Edit admin permissions --- ## Method: messages.editChatAdmin [Back to methods index](index.md) +Edit admin permissions + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|is\_admin|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat ID (no supergroups)| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user ID| +|is\_admin|[CLICK ME Bool](../types/Bool.md) | Yes|Should the user be admin?| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v57/methods/messages_editChatPhoto.md b/old_docs/API_docs_v57/methods/messages_editChatPhoto.md index 8848eca7..122913c4 100644 --- a/old_docs/API_docs_v57/methods/messages_editChatPhoto.md +++ b/old_docs/API_docs_v57/methods/messages_editChatPhoto.md @@ -12,7 +12,7 @@ Edit the photo of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The MTProto ID of the chat| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| |photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| diff --git a/old_docs/API_docs_v57/methods/messages_editChatTitle.md b/old_docs/API_docs_v57/methods/messages_editChatTitle.md index 1c1c7a16..3a1e974b 100644 --- a/old_docs/API_docs_v57/methods/messages_editChatTitle.md +++ b/old_docs/API_docs_v57/methods/messages_editChatTitle.md @@ -12,7 +12,7 @@ Edit the title of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The MTProto ID of the chat| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| |title|[CLICK ME string](../types/string.md) | Yes|The new title| diff --git a/old_docs/API_docs_v57/methods/messages_editInlineBotMessage.md b/old_docs/API_docs_v57/methods/messages_editInlineBotMessage.md index c0d06614..2237fb20 100644 --- a/old_docs/API_docs_v57/methods/messages_editInlineBotMessage.md +++ b/old_docs/API_docs_v57/methods/messages_editInlineBotMessage.md @@ -1,20 +1,22 @@ --- title: messages.editInlineBotMessage -description: messages.editInlineBotMessage parameters, return type and example +description: Edit a sent inline message --- ## Method: messages.editInlineBotMessage [Back to methods index](index.md) +Edit a sent inline message + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional| -|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes| -|message|[CLICK ME string](../types/string.md) | Optional| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview| +|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The message ID| +|message|[CLICK ME string](../types/string.md) | Optional|The new message| +|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| +|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/old_docs/API_docs_v57/methods/messages_editMessage.md b/old_docs/API_docs_v57/methods/messages_editMessage.md index 2e98318d..177438a5 100644 --- a/old_docs/API_docs_v57/methods/messages_editMessage.md +++ b/old_docs/API_docs_v57/methods/messages_editMessage.md @@ -1,21 +1,23 @@ --- title: messages.editMessage -description: messages.editMessage parameters, return type and example +description: Edit a message --- ## Method: messages.editMessage [Back to methods index](index.md) +Edit a message + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|id|[CLICK ME int](../types/int.md) | Yes| -|message|[CLICK ME string](../types/string.md) | Optional| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| +|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|message|[CLICK ME string](../types/string.md) | Optional|The new message| +|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| +|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/old_docs/API_docs_v57/methods/messages_exportChatInvite.md b/old_docs/API_docs_v57/methods/messages_exportChatInvite.md index 74d70c21..98685d96 100644 --- a/old_docs/API_docs_v57/methods/messages_exportChatInvite.md +++ b/old_docs/API_docs_v57/methods/messages_exportChatInvite.md @@ -1,16 +1,18 @@ --- title: messages.exportChatInvite -description: messages.exportChatInvite parameters, return type and example +description: Export chat invite --- ## Method: messages.exportChatInvite [Back to methods index](index.md) +Export chat invite + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat id | ### Return type: [ExportedChatInvite](../types/ExportedChatInvite.md) diff --git a/old_docs/API_docs_v57/methods/messages_getAllDrafts.md b/old_docs/API_docs_v57/methods/messages_getAllDrafts.md index a5dd59f6..2c0ecd42 100644 --- a/old_docs/API_docs_v57/methods/messages_getAllDrafts.md +++ b/old_docs/API_docs_v57/methods/messages_getAllDrafts.md @@ -1,11 +1,13 @@ --- title: messages.getAllDrafts -description: messages.getAllDrafts parameters, return type and example +description: Get all message drafts --- ## Method: messages.getAllDrafts [Back to methods index](index.md) +Get all message drafts + ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v57/methods/messages_getAllStickers.md b/old_docs/API_docs_v57/methods/messages_getAllStickers.md index 575fcd49..16fdba6c 100644 --- a/old_docs/API_docs_v57/methods/messages_getAllStickers.md +++ b/old_docs/API_docs_v57/methods/messages_getAllStickers.md @@ -1,16 +1,18 @@ --- title: messages.getAllStickers -description: messages.getAllStickers parameters, return type and example +description: Get all stickerpacks --- ## Method: messages.getAllStickers [Back to methods index](index.md) +Get all stickerpacks + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v57/methods/messages_getArchivedStickers.md b/old_docs/API_docs_v57/methods/messages_getArchivedStickers.md index 1b4aaa93..f037e1bc 100644 --- a/old_docs/API_docs_v57/methods/messages_getArchivedStickers.md +++ b/old_docs/API_docs_v57/methods/messages_getArchivedStickers.md @@ -1,18 +1,20 @@ --- title: messages.getArchivedStickers -description: messages.getArchivedStickers parameters, return type and example +description: Get all archived stickers --- ## Method: messages.getArchivedStickers [Back to methods index](index.md) +Get all archived stickers + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|masks|[CLICK ME Bool](../types/Bool.md) | Optional| -|offset\_id|[CLICK ME long](../types/long.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|masks|[CLICK ME Bool](../types/Bool.md) | Optional|Get masks?| +|offset\_id|[CLICK ME long](../types/long.md) | Yes|Sticker ID offset| +|limit|[CLICK ME int](../types/int.md) | Yes|Number of stickers to fetch| ### Return type: [messages\_ArchivedStickers](../types/messages_ArchivedStickers.md) diff --git a/old_docs/API_docs_v57/methods/messages_getAttachedStickers.md b/old_docs/API_docs_v57/methods/messages_getAttachedStickers.md index a0d89b31..890680cd 100644 --- a/old_docs/API_docs_v57/methods/messages_getAttachedStickers.md +++ b/old_docs/API_docs_v57/methods/messages_getAttachedStickers.md @@ -1,16 +1,18 @@ --- title: messages.getAttachedStickers -description: messages.getAttachedStickers parameters, return type and example +description: Get stickers attachable to images --- ## Method: messages.getAttachedStickers [Back to methods index](index.md) +Get stickers attachable to images + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|media|[CLICK ME InputStickeredMedia](../types/InputStickeredMedia.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|media|[CLICK ME InputStickeredMedia](../types/InputStickeredMedia.md) | Yes|The stickered media| ### Return type: [Vector\_of\_StickerSetCovered](../types/StickerSetCovered.md) diff --git a/old_docs/API_docs_v57/methods/messages_getBotCallbackAnswer.md b/old_docs/API_docs_v57/methods/messages_getBotCallbackAnswer.md index 7ccd0d1b..09c283f5 100644 --- a/old_docs/API_docs_v57/methods/messages_getBotCallbackAnswer.md +++ b/old_docs/API_docs_v57/methods/messages_getBotCallbackAnswer.md @@ -1,19 +1,21 @@ --- title: messages.getBotCallbackAnswer -description: messages.getBotCallbackAnswer parameters, return type and example +description: Get the callback answer of a bot (after clicking a button) --- ## Method: messages.getBotCallbackAnswer [Back to methods index](index.md) +Get the callback answer of a bot (after clicking a button) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|game|[CLICK ME Bool](../types/Bool.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|msg\_id|[CLICK ME int](../types/int.md) | Yes| -|data|[CLICK ME bytes](../types/bytes.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|game|[CLICK ME Bool](../types/Bool.md) | Optional|Is this a game?| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| +|msg\_id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|data|[CLICK ME bytes](../types/bytes.md) | Optional|The data to send to the bot| ### Return type: [messages\_BotCallbackAnswer](../types/messages_BotCallbackAnswer.md) diff --git a/old_docs/API_docs_v57/methods/messages_getDocumentByHash.md b/old_docs/API_docs_v57/methods/messages_getDocumentByHash.md index b7c45398..1af5bad4 100644 --- a/old_docs/API_docs_v57/methods/messages_getDocumentByHash.md +++ b/old_docs/API_docs_v57/methods/messages_getDocumentByHash.md @@ -1,18 +1,20 @@ --- title: messages.getDocumentByHash -description: messages.getDocumentByHash parameters, return type and example +description: Get document by SHA256 hash --- ## Method: messages.getDocumentByHash [Back to methods index](index.md) +Get document by SHA256 hash + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|sha256|[CLICK ME bytes](../types/bytes.md) | Yes| -|size|[CLICK ME int](../types/int.md) | Yes| -|mime\_type|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|sha256|[CLICK ME bytes](../types/bytes.md) | Yes|`hash('sha256', $filename, true);`| +|size|[CLICK ME int](../types/int.md) | Yes|The file size| +|mime\_type|[CLICK ME string](../types/string.md) | Yes|The mime type of the file| ### Return type: [Document](../types/Document.md) diff --git a/old_docs/API_docs_v57/methods/messages_getFeaturedStickers.md b/old_docs/API_docs_v57/methods/messages_getFeaturedStickers.md index 88b5609c..512f2e85 100644 --- a/old_docs/API_docs_v57/methods/messages_getFeaturedStickers.md +++ b/old_docs/API_docs_v57/methods/messages_getFeaturedStickers.md @@ -1,16 +1,18 @@ --- title: messages.getFeaturedStickers -description: messages.getFeaturedStickers parameters, return type and example +description: Get featured stickers --- ## Method: messages.getFeaturedStickers [Back to methods index](index.md) +Get featured stickers + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_FeaturedStickers](../types/messages_FeaturedStickers.md) diff --git a/old_docs/API_docs_v57/methods/messages_getGameHighScores.md b/old_docs/API_docs_v57/methods/messages_getGameHighScores.md index 2c95af05..5137baea 100644 --- a/old_docs/API_docs_v57/methods/messages_getGameHighScores.md +++ b/old_docs/API_docs_v57/methods/messages_getGameHighScores.md @@ -1,18 +1,20 @@ --- title: messages.getGameHighScores -description: messages.getGameHighScores parameters, return type and example +description: Get high scores of a game --- ## Method: messages.getGameHighScores [Back to methods index](index.md) +Get high scores of a game + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|id|[CLICK ME int](../types/int.md) | Yes| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| +|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the high scores| ### Return type: [messages\_HighScores](../types/messages_HighScores.md) diff --git a/old_docs/API_docs_v57/methods/messages_getInlineBotResults.md b/old_docs/API_docs_v57/methods/messages_getInlineBotResults.md index 5b2bb254..8ab5bf78 100644 --- a/old_docs/API_docs_v57/methods/messages_getInlineBotResults.md +++ b/old_docs/API_docs_v57/methods/messages_getInlineBotResults.md @@ -1,20 +1,22 @@ --- title: messages.getInlineBotResults -description: messages.getInlineBotResults parameters, return type and example +description: Call inline bot --- ## Method: messages.getInlineBotResults [Back to methods index](index.md) +Call inline bot + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional| -|query|[CLICK ME string](../types/string.md) | Yes| -|offset|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot to call| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to call the bot| +|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional|The current location| +|query|[CLICK ME string](../types/string.md) | Yes|The query to send to the bot| +|offset|[CLICK ME string](../types/string.md) | Yes|The offset to send to the bot| ### Return type: [messages\_BotResults](../types/messages_BotResults.md) diff --git a/old_docs/API_docs_v57/methods/messages_getInlineGameHighScores.md b/old_docs/API_docs_v57/methods/messages_getInlineGameHighScores.md index 447a55dd..790bfdd9 100644 --- a/old_docs/API_docs_v57/methods/messages_getInlineGameHighScores.md +++ b/old_docs/API_docs_v57/methods/messages_getInlineGameHighScores.md @@ -1,17 +1,19 @@ --- title: messages.getInlineGameHighScores -description: messages.getInlineGameHighScores parameters, return type and example +description: Get high scores of a game sent in an inline message --- ## Method: messages.getInlineGameHighScores [Back to methods index](index.md) +Get high scores of a game sent in an inline message + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The inline message| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the high scores| ### Return type: [messages\_HighScores](../types/messages_HighScores.md) diff --git a/old_docs/API_docs_v57/methods/messages_getMaskStickers.md b/old_docs/API_docs_v57/methods/messages_getMaskStickers.md index 80c16471..f4ed9411 100644 --- a/old_docs/API_docs_v57/methods/messages_getMaskStickers.md +++ b/old_docs/API_docs_v57/methods/messages_getMaskStickers.md @@ -1,16 +1,18 @@ --- title: messages.getMaskStickers -description: messages.getMaskStickers parameters, return type and example +description: Get masks --- ## Method: messages.getMaskStickers [Back to methods index](index.md) +Get masks + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v57/methods/messages_getMessageEditData.md b/old_docs/API_docs_v57/methods/messages_getMessageEditData.md index 339678bd..12e71bee 100644 --- a/old_docs/API_docs_v57/methods/messages_getMessageEditData.md +++ b/old_docs/API_docs_v57/methods/messages_getMessageEditData.md @@ -1,17 +1,19 @@ --- title: messages.getMessageEditData -description: messages.getMessageEditData parameters, return type and example +description: Check if about to edit a message or a media caption --- ## Method: messages.getMessageEditData [Back to methods index](index.md) +Check if about to edit a message or a media caption + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|id|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| +|id|[CLICK ME int](../types/int.md) | Yes|The message ID| ### Return type: [messages\_MessageEditData](../types/messages_MessageEditData.md) diff --git a/old_docs/API_docs_v57/methods/messages_getMessagesViews.md b/old_docs/API_docs_v57/methods/messages_getMessagesViews.md index e3f4e4ea..b8d78c85 100644 --- a/old_docs/API_docs_v57/methods/messages_getMessagesViews.md +++ b/old_docs/API_docs_v57/methods/messages_getMessagesViews.md @@ -1,18 +1,20 @@ --- title: messages.getMessagesViews -description: messages.getMessagesViews parameters, return type and example +description: Get and increase message views --- ## Method: messages.getMessagesViews [Back to methods index](index.md) +Get and increase message views + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|id|Array of [CLICK ME int](../types/int.md) | Yes| -|increment|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the message is located| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs messages to get| +|increment|[CLICK ME Bool](../types/Bool.md) | Yes|Increase message views?| ### Return type: [Vector\_of\_int](../types/int.md) diff --git a/old_docs/API_docs_v57/methods/messages_getPeerDialogs.md b/old_docs/API_docs_v57/methods/messages_getPeerDialogs.md index fe8a821c..da82cfc6 100644 --- a/old_docs/API_docs_v57/methods/messages_getPeerDialogs.md +++ b/old_docs/API_docs_v57/methods/messages_getPeerDialogs.md @@ -1,16 +1,18 @@ --- title: messages.getPeerDialogs -description: messages.getPeerDialogs parameters, return type and example +description: Get dialog info of peers --- ## Method: messages.getPeerDialogs [Back to methods index](index.md) +Get dialog info of peers + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peers|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peers|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Yes|The peers| ### Return type: [messages\_PeerDialogs](../types/messages_PeerDialogs.md) diff --git a/old_docs/API_docs_v57/methods/messages_getRecentStickers.md b/old_docs/API_docs_v57/methods/messages_getRecentStickers.md index abab7f44..d76a2160 100644 --- a/old_docs/API_docs_v57/methods/messages_getRecentStickers.md +++ b/old_docs/API_docs_v57/methods/messages_getRecentStickers.md @@ -1,17 +1,19 @@ --- title: messages.getRecentStickers -description: messages.getRecentStickers parameters, return type and example +description: Get recent stickers --- ## Method: messages.getRecentStickers [Back to methods index](index.md) +Get recent stickers + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|attached|[CLICK ME Bool](../types/Bool.md) | Optional| -|hash|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|attached|[CLICK ME Bool](../types/Bool.md) | Optional|Get stickers attached to image?| +|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_RecentStickers](../types/messages_RecentStickers.md) diff --git a/old_docs/API_docs_v57/methods/messages_getSavedGifs.md b/old_docs/API_docs_v57/methods/messages_getSavedGifs.md index 08dc4be6..f61348ce 100644 --- a/old_docs/API_docs_v57/methods/messages_getSavedGifs.md +++ b/old_docs/API_docs_v57/methods/messages_getSavedGifs.md @@ -1,16 +1,18 @@ --- title: messages.getSavedGifs -description: messages.getSavedGifs parameters, return type and example +description: Get saved gifs --- ## Method: messages.getSavedGifs [Back to methods index](index.md) +Get saved gifs + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_SavedGifs](../types/messages_SavedGifs.md) diff --git a/old_docs/API_docs_v57/methods/messages_getStickerSet.md b/old_docs/API_docs_v57/methods/messages_getStickerSet.md index 70bdd9ba..c86807e4 100644 --- a/old_docs/API_docs_v57/methods/messages_getStickerSet.md +++ b/old_docs/API_docs_v57/methods/messages_getStickerSet.md @@ -1,16 +1,18 @@ --- title: messages.getStickerSet -description: messages.getStickerSet parameters, return type and example +description: Get a stickerset --- ## Method: messages.getStickerSet [Back to methods index](index.md) +Get a stickerset + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset to get| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/old_docs/API_docs_v57/methods/messages_getWebPagePreview.md b/old_docs/API_docs_v57/methods/messages_getWebPagePreview.md index 35243c9f..d01bdd32 100644 --- a/old_docs/API_docs_v57/methods/messages_getWebPagePreview.md +++ b/old_docs/API_docs_v57/methods/messages_getWebPagePreview.md @@ -1,16 +1,18 @@ --- title: messages.getWebPagePreview -description: messages.getWebPagePreview parameters, return type and example +description: Get webpage preview --- ## Method: messages.getWebPagePreview [Back to methods index](index.md) +Get webpage preview + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|message|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|message|[CLICK ME string](../types/string.md) | Yes|Extract preview from this message| ### Return type: [MessageMedia](../types/MessageMedia.md) diff --git a/old_docs/API_docs_v57/methods/messages_importChatInvite.md b/old_docs/API_docs_v57/methods/messages_importChatInvite.md index 2bea5247..0d6cd7c8 100644 --- a/old_docs/API_docs_v57/methods/messages_importChatInvite.md +++ b/old_docs/API_docs_v57/methods/messages_importChatInvite.md @@ -1,16 +1,18 @@ --- title: messages.importChatInvite -description: messages.importChatInvite parameters, return type and example +description: Import chat invite --- ## Method: messages.importChatInvite [Back to methods index](index.md) +Import chat invite + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v57/methods/messages_installStickerSet.md b/old_docs/API_docs_v57/methods/messages_installStickerSet.md index 61513182..9f6f098c 100644 --- a/old_docs/API_docs_v57/methods/messages_installStickerSet.md +++ b/old_docs/API_docs_v57/methods/messages_installStickerSet.md @@ -1,17 +1,19 @@ --- title: messages.installStickerSet -description: messages.installStickerSet parameters, return type and example +description: Add a sticker set --- ## Method: messages.installStickerSet [Back to methods index](index.md) +Add a sticker set + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional| -|archived|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to add| +|archived|[CLICK ME Bool](../types/Bool.md) | Yes|Archive this set?| ### Return type: [messages\_StickerSetInstallResult](../types/messages_StickerSetInstallResult.md) diff --git a/old_docs/API_docs_v57/methods/messages_migrateChat.md b/old_docs/API_docs_v57/methods/messages_migrateChat.md index 5021ad45..db57adfa 100644 --- a/old_docs/API_docs_v57/methods/messages_migrateChat.md +++ b/old_docs/API_docs_v57/methods/messages_migrateChat.md @@ -1,16 +1,18 @@ --- title: messages.migrateChat -description: messages.migrateChat parameters, return type and example +description: Convert chat to supergroup --- ## Method: messages.migrateChat [Back to methods index](index.md) +Convert chat to supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat to convert| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v57/methods/messages_readEncryptedHistory.md b/old_docs/API_docs_v57/methods/messages_readEncryptedHistory.md index 4d341809..39b110e3 100644 --- a/old_docs/API_docs_v57/methods/messages_readEncryptedHistory.md +++ b/old_docs/API_docs_v57/methods/messages_readEncryptedHistory.md @@ -1,17 +1,19 @@ --- title: messages.readEncryptedHistory -description: messages.readEncryptedHistory parameters, return type and example +description: Mark messages as read in secret chats --- ## Method: messages.readEncryptedHistory [Back to methods index](index.md) +Mark messages as read in secret chats + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|max\_date|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to mark messages as read| +|max\_date|[CLICK ME int](../types/int.md) | Yes|Maximum date of messages to mark| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v57/methods/messages_readFeaturedStickers.md b/old_docs/API_docs_v57/methods/messages_readFeaturedStickers.md index 0631ca5b..4035c76d 100644 --- a/old_docs/API_docs_v57/methods/messages_readFeaturedStickers.md +++ b/old_docs/API_docs_v57/methods/messages_readFeaturedStickers.md @@ -1,16 +1,18 @@ --- title: messages.readFeaturedStickers -description: messages.readFeaturedStickers parameters, return type and example +description: Mark new featured stickers as read --- ## Method: messages.readFeaturedStickers [Back to methods index](index.md) +Mark new featured stickers as read + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|Array of [CLICK ME long](../types/long.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|Array of [CLICK ME long](../types/long.md) | Yes|The stickers to mark as read| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v57/methods/messages_readMessageContents.md b/old_docs/API_docs_v57/methods/messages_readMessageContents.md index 0d27c209..9bb1bee8 100644 --- a/old_docs/API_docs_v57/methods/messages_readMessageContents.md +++ b/old_docs/API_docs_v57/methods/messages_readMessageContents.md @@ -1,16 +1,18 @@ --- title: messages.readMessageContents -description: messages.readMessageContents parameters, return type and example +description: Mark message as read --- ## Method: messages.readMessageContents [Back to methods index](index.md) +Mark message as read + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v57/methods/messages_receivedQueue.md b/old_docs/API_docs_v57/methods/messages_receivedQueue.md index c91caa37..4ad78ba2 100644 --- a/old_docs/API_docs_v57/methods/messages_receivedQueue.md +++ b/old_docs/API_docs_v57/methods/messages_receivedQueue.md @@ -1,77 +1,13 @@ --- title: messages.receivedQueue -description: messages.receivedQueue parameters, return type and example +description: You cannot use this method directly --- ## Method: messages.receivedQueue [Back to methods index](index.md) -### Parameters: - -| Name | Type | Required | -|----------|---------------|----------| -|max\_qts|[CLICK ME int](../types/int.md) | Yes| - - -### 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| - - -### MadelineProto Example: - - -``` -if (!file_exists('madeline.php')) { - copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); -} -include 'madeline.php'; - -// !!! This API id/API hash combination will not work !!! -// !!! You must get your own @ my.telegram.org !!! -$api_id = 0; -$api_hash = ''; - -$MadelineProto = new \danog\MadelineProto\API('session.madeline', ['app_info' => ['api_id' => $api_id, 'api_hash' => $api_hash]]); -$MadelineProto->start(); - -$Vector_of_long = $MadelineProto->messages->receivedQueue(['max_qts' => int, ]); -``` - -### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): - -### As a bot: - -POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` - -Parameters: - -* method - messages.receivedQueue -* params - `{"max_qts": int, }` - - - -### As a user: - -POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.receivedQueue` - -Parameters: - -max_qts - Json encoded int +**You cannot use this method directly** -Or, if you're into Lua: - -``` -Vector_of_long = messages.receivedQueue({max_qts=int, }) -``` - diff --git a/old_docs/API_docs_v57/methods/messages_reorderStickerSets.md b/old_docs/API_docs_v57/methods/messages_reorderStickerSets.md index e4f1623c..ddc78dd0 100644 --- a/old_docs/API_docs_v57/methods/messages_reorderStickerSets.md +++ b/old_docs/API_docs_v57/methods/messages_reorderStickerSets.md @@ -1,17 +1,19 @@ --- title: messages.reorderStickerSets -description: messages.reorderStickerSets parameters, return type and example +description: Reorder sticker sets --- ## Method: messages.reorderStickerSets [Back to methods index](index.md) +Reorder sticker sets + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|masks|[CLICK ME Bool](../types/Bool.md) | Optional| -|order|Array of [CLICK ME long](../types/long.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|masks|[CLICK ME Bool](../types/Bool.md) | Optional|Reorder masks?| +|order|Array of [CLICK ME long](../types/long.md) | Yes|The order| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v57/methods/messages_saveDraft.md b/old_docs/API_docs_v57/methods/messages_saveDraft.md index 9104df33..bbeed707 100644 --- a/old_docs/API_docs_v57/methods/messages_saveDraft.md +++ b/old_docs/API_docs_v57/methods/messages_saveDraft.md @@ -1,20 +1,22 @@ --- title: messages.saveDraft -description: messages.saveDraft parameters, return type and example +description: Save a message draft --- ## Method: messages.saveDraft [Back to methods index](index.md) +Save a message draft + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|message|[CLICK ME string](../types/string.md) | Yes| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview| +|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| +|message|[CLICK ME string](../types/string.md) | Yes|The message| +|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|The entities (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/old_docs/API_docs_v57/methods/messages_saveGif.md b/old_docs/API_docs_v57/methods/messages_saveGif.md index 4a3b6166..6f608c4c 100644 --- a/old_docs/API_docs_v57/methods/messages_saveGif.md +++ b/old_docs/API_docs_v57/methods/messages_saveGif.md @@ -1,17 +1,19 @@ --- title: messages.saveGif -description: messages.saveGif parameters, return type and example +description: Save a GIF --- ## Method: messages.saveGif [Back to methods index](index.md) +Save a GIF + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional| -|unsave|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The GIF to save| +|unsave|[CLICK ME Bool](../types/Bool.md) | Yes|Remove the gif?| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v57/methods/messages_saveRecentSticker.md b/old_docs/API_docs_v57/methods/messages_saveRecentSticker.md index b4f43e13..81ad5d48 100644 --- a/old_docs/API_docs_v57/methods/messages_saveRecentSticker.md +++ b/old_docs/API_docs_v57/methods/messages_saveRecentSticker.md @@ -1,18 +1,20 @@ --- title: messages.saveRecentSticker -description: messages.saveRecentSticker parameters, return type and example +description: Add a sticker to recent stickers --- ## Method: messages.saveRecentSticker [Back to methods index](index.md) +Add a sticker to recent stickers + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|attached|[CLICK ME Bool](../types/Bool.md) | Optional| -|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional| -|unsave|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|attached|[CLICK ME Bool](../types/Bool.md) | Optional|Get stickers attached to image?| +|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker| +|unsave|[CLICK ME Bool](../types/Bool.md) | Yes|Remove the sticker from recent stickers?| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v57/methods/messages_searchGifs.md b/old_docs/API_docs_v57/methods/messages_searchGifs.md index fefef1d7..103ebfeb 100644 --- a/old_docs/API_docs_v57/methods/messages_searchGifs.md +++ b/old_docs/API_docs_v57/methods/messages_searchGifs.md @@ -1,17 +1,19 @@ --- title: messages.searchGifs -description: messages.searchGifs parameters, return type and example +description: Search gifs --- ## Method: messages.searchGifs [Back to methods index](index.md) +Search gifs + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|q|[CLICK ME string](../types/string.md) | Yes| -|offset|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|q|[CLICK ME string](../types/string.md) | Yes|The search query| +|offset|[CLICK ME int](../types/int.md) | Yes|The offset | ### Return type: [messages\_FoundGifs](../types/messages_FoundGifs.md) diff --git a/old_docs/API_docs_v57/methods/messages_searchGlobal.md b/old_docs/API_docs_v57/methods/messages_searchGlobal.md index 32ddd175..0edd1e40 100644 --- a/old_docs/API_docs_v57/methods/messages_searchGlobal.md +++ b/old_docs/API_docs_v57/methods/messages_searchGlobal.md @@ -1,20 +1,22 @@ --- title: messages.searchGlobal -description: messages.searchGlobal parameters, return type and example +description: Global message search --- ## Method: messages.searchGlobal [Back to methods index](index.md) +Global message search + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|q|[CLICK ME string](../types/string.md) | Yes| -|offset\_date|[CLICK ME int](../types/int.md) | Yes| -|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|offset\_id|[CLICK ME int](../types/int.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|q|[CLICK ME string](../types/string.md) | Yes|The query| +|offset\_date|[CLICK ME int](../types/int.md) | Yes|0 or the date offset| +|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|0 or the peer offset| +|offset\_id|[CLICK ME int](../types/int.md) | Yes|0 or the message ID offset| +|limit|[CLICK ME int](../types/int.md) | Yes|The number of results to return| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v57/methods/messages_sendEncrypted.md b/old_docs/API_docs_v57/methods/messages_sendEncrypted.md index 23461760..d48f88d7 100644 --- a/old_docs/API_docs_v57/methods/messages_sendEncrypted.md +++ b/old_docs/API_docs_v57/methods/messages_sendEncrypted.md @@ -1,17 +1,19 @@ --- title: messages.sendEncrypted -description: messages.sendEncrypted parameters, return type and example +description: Send message to secret chat --- ## Method: messages.sendEncrypted [Back to methods index](index.md) +Send message to secret chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the message| +|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v57/methods/messages_sendEncryptedFile.md b/old_docs/API_docs_v57/methods/messages_sendEncryptedFile.md index 64919abe..4fd0648e 100644 --- a/old_docs/API_docs_v57/methods/messages_sendEncryptedFile.md +++ b/old_docs/API_docs_v57/methods/messages_sendEncryptedFile.md @@ -1,18 +1,20 @@ --- title: messages.sendEncryptedFile -description: messages.sendEncryptedFile parameters, return type and example +description: Send a file to a secret chat --- ## Method: messages.sendEncryptedFile [Back to methods index](index.md) +Send a file to a secret chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes| -|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the file| +|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| +|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional|The file (optional)| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v57/methods/messages_sendEncryptedService.md b/old_docs/API_docs_v57/methods/messages_sendEncryptedService.md index 0a0eea8a..d66894bf 100644 --- a/old_docs/API_docs_v57/methods/messages_sendEncryptedService.md +++ b/old_docs/API_docs_v57/methods/messages_sendEncryptedService.md @@ -1,17 +1,19 @@ --- title: messages.sendEncryptedService -description: messages.sendEncryptedService parameters, return type and example +description: Send a service message to a secret chat --- ## Method: messages.sendEncryptedService [Back to methods index](index.md) +Send a service message to a secret chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the service message| +|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v57/methods/messages_sendInlineBotResult.md b/old_docs/API_docs_v57/methods/messages_sendInlineBotResult.md index 4cb9243e..386ac7e3 100644 --- a/old_docs/API_docs_v57/methods/messages_sendInlineBotResult.md +++ b/old_docs/API_docs_v57/methods/messages_sendInlineBotResult.md @@ -1,22 +1,24 @@ --- title: messages.sendInlineBotResult -description: messages.sendInlineBotResult parameters, return type and example +description: Send a received bot result to the chat --- ## Method: messages.sendInlineBotResult [Back to methods index](index.md) +Send a received bot result to the chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional| -|background|[CLICK ME Bool](../types/Bool.md) | Optional| -|clear\_draft|[CLICK ME Bool](../types/Bool.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional| -|query\_id|[CLICK ME long](../types/long.md) | Yes| -|id|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Disable notifications?| +|background|[CLICK ME Bool](../types/Bool.md) | Optional|Disable background notifications?| +|clear\_draft|[CLICK ME Bool](../types/Bool.md) | Optional|Clear the message draft?| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the message| +|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| +|query\_id|[CLICK ME long](../types/long.md) | Yes|The inline query ID| +|id|[CLICK ME string](../types/string.md) | Yes|The result ID| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v57/methods/messages_setBotCallbackAnswer.md b/old_docs/API_docs_v57/methods/messages_setBotCallbackAnswer.md index 1d168e42..9700a1f1 100644 --- a/old_docs/API_docs_v57/methods/messages_setBotCallbackAnswer.md +++ b/old_docs/API_docs_v57/methods/messages_setBotCallbackAnswer.md @@ -1,19 +1,21 @@ --- title: messages.setBotCallbackAnswer -description: messages.setBotCallbackAnswer parameters, return type and example +description: Bots only: set the callback answer (after a button was clicked) --- ## Method: messages.setBotCallbackAnswer [Back to methods index](index.md) +Bots only: set the callback answer (after a button was clicked) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|alert|[CLICK ME Bool](../types/Bool.md) | Optional| -|query\_id|[CLICK ME long](../types/long.md) | Yes| -|message|[CLICK ME string](../types/string.md) | Optional| -|url|[CLICK ME string](../types/string.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|alert|[CLICK ME Bool](../types/Bool.md) | Optional|Is this an alert?| +|query\_id|[CLICK ME long](../types/long.md) | Yes|The query ID| +|message|[CLICK ME string](../types/string.md) | Optional|The message| +|url|[CLICK ME string](../types/string.md) | Optional|The URL| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v57/methods/messages_setEncryptedTyping.md b/old_docs/API_docs_v57/methods/messages_setEncryptedTyping.md index 3183fedf..e9afe99c 100644 --- a/old_docs/API_docs_v57/methods/messages_setEncryptedTyping.md +++ b/old_docs/API_docs_v57/methods/messages_setEncryptedTyping.md @@ -12,8 +12,8 @@ Send typing notification to secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|| -|typing|[CLICK ME Bool](../types/Bool.md) | Yes|| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to send the notification| +|typing|[CLICK ME Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v57/methods/messages_setGameScore.md b/old_docs/API_docs_v57/methods/messages_setGameScore.md index 0a236469..53e8eb7f 100644 --- a/old_docs/API_docs_v57/methods/messages_setGameScore.md +++ b/old_docs/API_docs_v57/methods/messages_setGameScore.md @@ -1,20 +1,22 @@ --- title: messages.setGameScore -description: messages.setGameScore parameters, return type and example +description: Set the game score --- ## Method: messages.setGameScore [Back to methods index](index.md) +Set the game score + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|edit\_message|[CLICK ME Bool](../types/Bool.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|id|[CLICK ME int](../types/int.md) | Yes| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|score|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|edit\_message|[CLICK ME Bool](../types/Bool.md) | Optional|Should the message with the game be edited?| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the game was sent| +|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the score| +|score|[CLICK ME int](../types/int.md) | Yes|The score| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v57/methods/messages_setInlineBotResults.md b/old_docs/API_docs_v57/methods/messages_setInlineBotResults.md index 915e3a4e..79493009 100644 --- a/old_docs/API_docs_v57/methods/messages_setInlineBotResults.md +++ b/old_docs/API_docs_v57/methods/messages_setInlineBotResults.md @@ -1,22 +1,24 @@ --- title: messages.setInlineBotResults -description: messages.setInlineBotResults parameters, return type and example +description: Bots only: set the results of an inline query --- ## Method: messages.setInlineBotResults [Back to methods index](index.md) +Bots only: set the results of an inline query + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|gallery|[CLICK ME Bool](../types/Bool.md) | Optional| -|private|[CLICK ME Bool](../types/Bool.md) | Optional| -|query\_id|[CLICK ME long](../types/long.md) | Yes| -|results|Array of [CLICK ME InputBotInlineResult](../types/InputBotInlineResult.md) | Yes| -|cache\_time|[CLICK ME int](../types/int.md) | Yes| -|next\_offset|[CLICK ME string](../types/string.md) | Optional| -|switch\_pm|[CLICK ME InlineBotSwitchPM](../types/InlineBotSwitchPM.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|gallery|[CLICK ME Bool](../types/Bool.md) | Optional|Is this a gallery?| +|private|[CLICK ME Bool](../types/Bool.md) | Optional|Is this result private (not cached)?| +|query\_id|[CLICK ME long](../types/long.md) | Yes|Query ID| +|results|Array of [CLICK ME InputBotInlineResult](../types/InputBotInlineResult.md) | Yes|Results| +|cache\_time|[CLICK ME int](../types/int.md) | Yes|Cache time| +|next\_offset|[CLICK ME string](../types/string.md) | Optional|The next offset| +|switch\_pm|[CLICK ME InlineBotSwitchPM](../types/InlineBotSwitchPM.md) | Optional|Switch to PM?| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v57/methods/messages_setInlineGameScore.md b/old_docs/API_docs_v57/methods/messages_setInlineGameScore.md index b1825f1d..a3f030d3 100644 --- a/old_docs/API_docs_v57/methods/messages_setInlineGameScore.md +++ b/old_docs/API_docs_v57/methods/messages_setInlineGameScore.md @@ -1,19 +1,21 @@ --- title: messages.setInlineGameScore -description: messages.setInlineGameScore parameters, return type and example +description: Set the game score of an inline message --- ## Method: messages.setInlineGameScore [Back to methods index](index.md) +Set the game score of an inline message + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|edit\_message|[CLICK ME Bool](../types/Bool.md) | Optional| -|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|score|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|edit\_message|[CLICK ME Bool](../types/Bool.md) | Optional|Should the message with the game be edited?| +|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The ID of the inline message| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the score| +|score|[CLICK ME int](../types/int.md) | Yes|The score| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v57/methods/messages_startBot.md b/old_docs/API_docs_v57/methods/messages_startBot.md index 0de0f1a5..94a4d86a 100644 --- a/old_docs/API_docs_v57/methods/messages_startBot.md +++ b/old_docs/API_docs_v57/methods/messages_startBot.md @@ -1,18 +1,20 @@ --- title: messages.startBot -description: messages.startBot parameters, return type and example +description: Start a bot --- ## Method: messages.startBot [Back to methods index](index.md) +Start a bot + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|start\_param|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot's ID or username| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to start the bot (@me or group ID/username)| +|start\_param|[CLICK ME string](../types/string.md) | Yes|The bot's start parameter| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v57/methods/messages_toggleChatAdmins.md b/old_docs/API_docs_v57/methods/messages_toggleChatAdmins.md index d56e5753..ab591fd9 100644 --- a/old_docs/API_docs_v57/methods/messages_toggleChatAdmins.md +++ b/old_docs/API_docs_v57/methods/messages_toggleChatAdmins.md @@ -1,17 +1,19 @@ --- title: messages.toggleChatAdmins -description: messages.toggleChatAdmins parameters, return type and example +description: Enable all users are admins in normal groups (not supergroups) --- ## Method: messages.toggleChatAdmins [Back to methods index](index.md) +Enable all users are admins in normal groups (not supergroups) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Group ID| +|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Enable all users are admins| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v57/methods/messages_uninstallStickerSet.md b/old_docs/API_docs_v57/methods/messages_uninstallStickerSet.md index 60b0ca0c..6d04e847 100644 --- a/old_docs/API_docs_v57/methods/messages_uninstallStickerSet.md +++ b/old_docs/API_docs_v57/methods/messages_uninstallStickerSet.md @@ -1,16 +1,18 @@ --- title: messages.uninstallStickerSet -description: messages.uninstallStickerSet parameters, return type and example +description: Remove a sticker set --- ## Method: messages.uninstallStickerSet [Back to methods index](index.md) +Remove a sticker set + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to remove| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v57/methods/photos_deletePhotos.md b/old_docs/API_docs_v57/methods/photos_deletePhotos.md index 104459b7..b9daca10 100644 --- a/old_docs/API_docs_v57/methods/photos_deletePhotos.md +++ b/old_docs/API_docs_v57/methods/photos_deletePhotos.md @@ -1,16 +1,18 @@ --- title: photos.deletePhotos -description: photos.deletePhotos parameters, return type and example +description: Delete profile photos --- ## Method: photos.deletePhotos [Back to methods index](index.md) +Delete profile photos + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Yes|The profile photos to delete| ### Return type: [Vector\_of\_long](../types/long.md) diff --git a/old_docs/API_docs_v57/methods/photos_getUserPhotos.md b/old_docs/API_docs_v57/methods/photos_getUserPhotos.md index 1a7515ba..ea27a44f 100644 --- a/old_docs/API_docs_v57/methods/photos_getUserPhotos.md +++ b/old_docs/API_docs_v57/methods/photos_getUserPhotos.md @@ -1,19 +1,21 @@ --- title: photos.getUserPhotos -description: photos.getUserPhotos parameters, return type and example +description: Get the profile photos of a user --- ## Method: photos.getUserPhotos [Back to methods index](index.md) +Get the profile photos of a user + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|offset|[CLICK ME int](../types/int.md) | Yes| -|max\_id|[CLICK ME long](../types/long.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| +|offset|[CLICK ME int](../types/int.md) | Yes|Offset| +|max\_id|[CLICK ME long](../types/long.md) | Yes|Maximum ID of photo to return| +|limit|[CLICK ME int](../types/int.md) | Yes|Number of photos to return| ### Return type: [photos\_Photos](../types/photos_Photos.md) diff --git a/old_docs/API_docs_v57/methods/photos_updateProfilePhoto.md b/old_docs/API_docs_v57/methods/photos_updateProfilePhoto.md index 28ab5fbf..7f0a4c69 100644 --- a/old_docs/API_docs_v57/methods/photos_updateProfilePhoto.md +++ b/old_docs/API_docs_v57/methods/photos_updateProfilePhoto.md @@ -1,16 +1,18 @@ --- title: photos.updateProfilePhoto -description: photos.updateProfilePhoto parameters, return type and example +description: Update the profile photo (use photos->uploadProfilePhoto to upload the photo) --- ## Method: photos.updateProfilePhoto [Back to methods index](index.md) +Update the profile photo (use photos->uploadProfilePhoto to upload the photo) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional|The photo to use| ### Return type: [UserProfilePhoto](../types/UserProfilePhoto.md) diff --git a/old_docs/API_docs_v57/methods/photos_uploadProfilePhoto.md b/old_docs/API_docs_v57/methods/photos_uploadProfilePhoto.md index 7cc9e9e5..efa08bb0 100644 --- a/old_docs/API_docs_v57/methods/photos_uploadProfilePhoto.md +++ b/old_docs/API_docs_v57/methods/photos_uploadProfilePhoto.md @@ -1,16 +1,18 @@ --- title: photos.uploadProfilePhoto -description: photos.uploadProfilePhoto parameters, return type and example +description: Upload profile photo --- ## Method: photos.uploadProfilePhoto [Back to methods index](index.md) +Upload profile photo + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|file|[File path or InputFile](../types/InputFile.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|file|[File path or InputFile](../types/InputFile.md) | Yes|The photo| ### Return type: [photos\_Photo](../types/photos_Photo.md) diff --git a/old_docs/API_docs_v62/methods/account_registerDevice.md b/old_docs/API_docs_v62/methods/account_registerDevice.md index cd28abcd..017b9af3 100644 --- a/old_docs/API_docs_v62/methods/account_registerDevice.md +++ b/old_docs/API_docs_v62/methods/account_registerDevice.md @@ -12,8 +12,8 @@ Register device for push notifications | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and oTher, see source code of official apps for more info| +|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and oTher, see source code of official apps for more info| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v62/methods/account_unregisterDevice.md b/old_docs/API_docs_v62/methods/account_unregisterDevice.md index 1d2b7670..32e44495 100644 --- a/old_docs/API_docs_v62/methods/account_unregisterDevice.md +++ b/old_docs/API_docs_v62/methods/account_unregisterDevice.md @@ -12,8 +12,8 @@ Stop sending PUSH notifications to app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and oTher, see source code of official apps for more info| +|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and oTher, see source code of official apps for more info| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v62/methods/channels_checkUsername.md b/old_docs/API_docs_v62/methods/channels_checkUsername.md index 371f4cd3..7bc7c245 100644 --- a/old_docs/API_docs_v62/methods/channels_checkUsername.md +++ b/old_docs/API_docs_v62/methods/channels_checkUsername.md @@ -1,17 +1,19 @@ --- title: channels.checkUsername -description: channels.checkUsername parameters, return type and example +description: Check if this username is free and can be assigned to a channel/supergroup --- ## Method: channels.checkUsername [Back to methods index](index.md) +Check if this username is free and can be assigned to a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|username|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|username|[CLICK ME string](../types/string.md) | Yes|The new username for this channel/supergroup| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v62/methods/channels_createChannel.md b/old_docs/API_docs_v62/methods/channels_createChannel.md index c5d21585..1305e4fb 100644 --- a/old_docs/API_docs_v62/methods/channels_createChannel.md +++ b/old_docs/API_docs_v62/methods/channels_createChannel.md @@ -1,19 +1,21 @@ --- title: channels.createChannel -description: channels.createChannel parameters, return type and example +description: Create channel/supergroup --- ## Method: channels.createChannel [Back to methods index](index.md) +Create channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|broadcast|[CLICK ME Bool](../types/Bool.md) | Optional| -|megagroup|[CLICK ME Bool](../types/Bool.md) | Optional| -|title|[CLICK ME string](../types/string.md) | Yes| -|about|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|broadcast|[CLICK ME Bool](../types/Bool.md) | Optional|Set this to true to create a channel| +|megagroup|[CLICK ME Bool](../types/Bool.md) | Optional|Set this to true to create a supergroup| +|title|[CLICK ME string](../types/string.md) | Yes|Supergroup/channel title| +|about|[CLICK ME string](../types/string.md) | Yes|About text| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v62/methods/channels_deleteChannel.md b/old_docs/API_docs_v62/methods/channels_deleteChannel.md index 61b29eac..e660d25c 100644 --- a/old_docs/API_docs_v62/methods/channels_deleteChannel.md +++ b/old_docs/API_docs_v62/methods/channels_deleteChannel.md @@ -1,16 +1,18 @@ --- title: channels.deleteChannel -description: channels.deleteChannel parameters, return type and example +description: Delete a channel/supergroup --- ## Method: channels.deleteChannel [Back to methods index](index.md) +Delete a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup to delete| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v62/methods/channels_deleteMessages.md b/old_docs/API_docs_v62/methods/channels_deleteMessages.md index 87a968c5..fb9d3cc2 100644 --- a/old_docs/API_docs_v62/methods/channels_deleteMessages.md +++ b/old_docs/API_docs_v62/methods/channels_deleteMessages.md @@ -1,17 +1,19 @@ --- title: channels.deleteMessages -description: channels.deleteMessages parameters, return type and example +description: Delete channel/supergroup messages --- ## Method: channels.deleteMessages [Back to methods index](index.md) +Delete channel/supergroup messages + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|id|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to delete| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v62/methods/channels_deleteUserHistory.md b/old_docs/API_docs_v62/methods/channels_deleteUserHistory.md index ee828f45..fbe34341 100644 --- a/old_docs/API_docs_v62/methods/channels_deleteUserHistory.md +++ b/old_docs/API_docs_v62/methods/channels_deleteUserHistory.md @@ -1,17 +1,19 @@ --- title: channels.deleteUserHistory -description: channels.deleteUserHistory parameters, return type and example +description: Delete all messages of a user in a channel/supergroup --- ## Method: channels.deleteUserHistory [Back to methods index](index.md) +Delete all messages of a user in a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) diff --git a/old_docs/API_docs_v62/methods/channels_editAbout.md b/old_docs/API_docs_v62/methods/channels_editAbout.md index 94be2503..8908f29e 100644 --- a/old_docs/API_docs_v62/methods/channels_editAbout.md +++ b/old_docs/API_docs_v62/methods/channels_editAbout.md @@ -1,17 +1,19 @@ --- title: channels.editAbout -description: channels.editAbout parameters, return type and example +description: Edit the about text of a channel/supergroup --- ## Method: channels.editAbout [Back to methods index](index.md) +Edit the about text of a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|about|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|about|[CLICK ME string](../types/string.md) | Yes|The new about text| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v62/methods/channels_editAdmin.md b/old_docs/API_docs_v62/methods/channels_editAdmin.md index e1917c89..695c5294 100644 --- a/old_docs/API_docs_v62/methods/channels_editAdmin.md +++ b/old_docs/API_docs_v62/methods/channels_editAdmin.md @@ -1,18 +1,20 @@ --- title: channels.editAdmin -description: channels.editAdmin parameters, return type and example +description: Edit admin permissions of a user in a channel/supergroup --- ## Method: channels.editAdmin [Back to methods index](index.md) +Edit admin permissions of a user in a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|role|[CLICK ME ChannelParticipantRole](../types/ChannelParticipantRole.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| +|role|[CLICK ME ChannelParticipantRole](../types/ChannelParticipantRole.md) | Yes|| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v62/methods/channels_editPhoto.md b/old_docs/API_docs_v62/methods/channels_editPhoto.md index 3a2c794b..9ccd864f 100644 --- a/old_docs/API_docs_v62/methods/channels_editPhoto.md +++ b/old_docs/API_docs_v62/methods/channels_editPhoto.md @@ -1,17 +1,19 @@ --- title: channels.editPhoto -description: channels.editPhoto parameters, return type and example +description: Edit the photo of a supergroup/channel --- ## Method: channels.editPhoto [Back to methods index](index.md) +Edit the photo of a supergroup/channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new photo| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v62/methods/channels_editTitle.md b/old_docs/API_docs_v62/methods/channels_editTitle.md index ec60e10f..b1024faf 100644 --- a/old_docs/API_docs_v62/methods/channels_editTitle.md +++ b/old_docs/API_docs_v62/methods/channels_editTitle.md @@ -1,17 +1,19 @@ --- title: channels.editTitle -description: channels.editTitle parameters, return type and example +description: Edit the title of a supergroup/channel --- ## Method: channels.editTitle [Back to methods index](index.md) +Edit the title of a supergroup/channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|title|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|title|[CLICK ME string](../types/string.md) | Yes|The new channel/supergroup title| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v62/methods/channels_exportInvite.md b/old_docs/API_docs_v62/methods/channels_exportInvite.md index 3c10f832..f0c737d5 100644 --- a/old_docs/API_docs_v62/methods/channels_exportInvite.md +++ b/old_docs/API_docs_v62/methods/channels_exportInvite.md @@ -1,16 +1,18 @@ --- title: channels.exportInvite -description: channels.exportInvite parameters, return type and example +description: Export the invite link of a channel --- ## Method: channels.exportInvite [Back to methods index](index.md) +Export the invite link of a channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| ### Return type: [ExportedChatInvite](../types/ExportedChatInvite.md) diff --git a/old_docs/API_docs_v62/methods/channels_exportMessageLink.md b/old_docs/API_docs_v62/methods/channels_exportMessageLink.md index 924dc0d5..f910b594 100644 --- a/old_docs/API_docs_v62/methods/channels_exportMessageLink.md +++ b/old_docs/API_docs_v62/methods/channels_exportMessageLink.md @@ -1,17 +1,19 @@ --- title: channels.exportMessageLink -description: channels.exportMessageLink parameters, return type and example +description: Get the link of a message in a channel --- ## Method: channels.exportMessageLink [Back to methods index](index.md) +Get the link of a message in a channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|id|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|id|[CLICK ME int](../types/int.md) | Yes|The ID of the message| ### Return type: [ExportedMessageLink](../types/ExportedMessageLink.md) diff --git a/old_docs/API_docs_v62/methods/channels_getAdminedPublicChannels.md b/old_docs/API_docs_v62/methods/channels_getAdminedPublicChannels.md index f2b48050..9646f529 100644 --- a/old_docs/API_docs_v62/methods/channels_getAdminedPublicChannels.md +++ b/old_docs/API_docs_v62/methods/channels_getAdminedPublicChannels.md @@ -1,11 +1,13 @@ --- title: channels.getAdminedPublicChannels -description: channels.getAdminedPublicChannels parameters, return type and example +description: Get all supergroups/channels where you're admin --- ## Method: channels.getAdminedPublicChannels [Back to methods index](index.md) +Get all supergroups/channels where you're admin + ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v62/methods/channels_getChannels.md b/old_docs/API_docs_v62/methods/channels_getChannels.md index bd5958d6..9cd9e798 100644 --- a/old_docs/API_docs_v62/methods/channels_getChannels.md +++ b/old_docs/API_docs_v62/methods/channels_getChannels.md @@ -1,16 +1,18 @@ --- title: channels.getChannels -description: channels.getChannels parameters, return type and example +description: Get info about multiple channels/supergroups --- ## Method: channels.getChannels [Back to methods index](index.md) +Get info about multiple channels/supergroups + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|Array of [Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|Array of [Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Yes|The channel/supergroup MTProto IDs| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v62/methods/channels_getMessages.md b/old_docs/API_docs_v62/methods/channels_getMessages.md index 4440856c..cc944fe5 100644 --- a/old_docs/API_docs_v62/methods/channels_getMessages.md +++ b/old_docs/API_docs_v62/methods/channels_getMessages.md @@ -1,17 +1,19 @@ --- title: channels.getMessages -description: channels.getMessages parameters, return type and example +description: Get channel/supergroup messages --- ## Method: channels.getMessages [Back to methods index](index.md) +Get channel/supergroup messages + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|id|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The message IDs| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v62/methods/channels_getParticipant.md b/old_docs/API_docs_v62/methods/channels_getParticipant.md index c1819b6b..db9b1fc6 100644 --- a/old_docs/API_docs_v62/methods/channels_getParticipant.md +++ b/old_docs/API_docs_v62/methods/channels_getParticipant.md @@ -1,17 +1,19 @@ --- title: channels.getParticipant -description: channels.getParticipant parameters, return type and example +description: Get info about a certain channel/supergroup participant --- ## Method: channels.getParticipant [Back to methods index](index.md) +Get info about a certain channel/supergroup participant + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to fetch info about| ### Return type: [channels\_ChannelParticipant](../types/channels_ChannelParticipant.md) diff --git a/old_docs/API_docs_v62/methods/channels_getParticipants.md b/old_docs/API_docs_v62/methods/channels_getParticipants.md index 7ec8a980..96662466 100644 --- a/old_docs/API_docs_v62/methods/channels_getParticipants.md +++ b/old_docs/API_docs_v62/methods/channels_getParticipants.md @@ -1,19 +1,21 @@ --- title: channels.getParticipants -description: channels.getParticipants parameters, return type and example +description: Get channel/supergroup participants (you should use `$MadelineProto->get_pwr_chat($id)` instead) --- ## Method: channels.getParticipants [Back to methods index](index.md) +Get channel/supergroup participants (you should use `$MadelineProto->get_pwr_chat($id)` instead) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|filter|[CLICK ME ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) | Yes| -|offset|[CLICK ME int](../types/int.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|filter|[CLICK ME ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) | Yes|Member filter| +|offset|[CLICK ME int](../types/int.md) | Yes|Offset| +|limit|[CLICK ME int](../types/int.md) | Yes|Limit| ### Return type: [channels\_ChannelParticipants](../types/channels_ChannelParticipants.md) diff --git a/old_docs/API_docs_v62/methods/channels_inviteToChannel.md b/old_docs/API_docs_v62/methods/channels_inviteToChannel.md index 9bca2967..676f800c 100644 --- a/old_docs/API_docs_v62/methods/channels_inviteToChannel.md +++ b/old_docs/API_docs_v62/methods/channels_inviteToChannel.md @@ -1,17 +1,19 @@ --- title: channels.inviteToChannel -description: channels.inviteToChannel parameters, return type and example +description: Add users to channel/supergroup --- ## Method: channels.inviteToChannel [Back to methods index](index.md) +Add users to channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to add| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v62/methods/channels_joinChannel.md b/old_docs/API_docs_v62/methods/channels_joinChannel.md index 9ecdbe75..721f707c 100644 --- a/old_docs/API_docs_v62/methods/channels_joinChannel.md +++ b/old_docs/API_docs_v62/methods/channels_joinChannel.md @@ -1,16 +1,18 @@ --- title: channels.joinChannel -description: channels.joinChannel parameters, return type and example +description: Join a channel/supergroup --- ## Method: channels.joinChannel [Back to methods index](index.md) +Join a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup to join| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v62/methods/channels_leaveChannel.md b/old_docs/API_docs_v62/methods/channels_leaveChannel.md index 62c20a00..7f02e08c 100644 --- a/old_docs/API_docs_v62/methods/channels_leaveChannel.md +++ b/old_docs/API_docs_v62/methods/channels_leaveChannel.md @@ -1,16 +1,18 @@ --- title: channels.leaveChannel -description: channels.leaveChannel parameters, return type and example +description: Leave a channel/supergroup --- ## Method: channels.leaveChannel [Back to methods index](index.md) +Leave a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup to leave| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v62/methods/channels_readHistory.md b/old_docs/API_docs_v62/methods/channels_readHistory.md index 745893f6..cca891f0 100644 --- a/old_docs/API_docs_v62/methods/channels_readHistory.md +++ b/old_docs/API_docs_v62/methods/channels_readHistory.md @@ -1,17 +1,19 @@ --- title: channels.readHistory -description: channels.readHistory parameters, return type and example +description: Mark channel/supergroup history as read --- ## Method: channels.readHistory [Back to methods index](index.md) +Mark channel/supergroup history as read + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|max\_id|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to mark as read| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v62/methods/channels_reportSpam.md b/old_docs/API_docs_v62/methods/channels_reportSpam.md index 47dd7cff..09af14e0 100644 --- a/old_docs/API_docs_v62/methods/channels_reportSpam.md +++ b/old_docs/API_docs_v62/methods/channels_reportSpam.md @@ -1,18 +1,20 @@ --- title: channels.reportSpam -description: channels.reportSpam parameters, return type and example +description: Report a supergroup/channel for spam --- ## Method: channels.reportSpam [Back to methods index](index.md) +Report a supergroup/channel for spam + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|id|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that added you to this channel| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to report| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v62/methods/channels_toggleInvites.md b/old_docs/API_docs_v62/methods/channels_toggleInvites.md index b6771ed3..5b541f67 100644 --- a/old_docs/API_docs_v62/methods/channels_toggleInvites.md +++ b/old_docs/API_docs_v62/methods/channels_toggleInvites.md @@ -1,17 +1,19 @@ --- title: channels.toggleInvites -description: channels.toggleInvites parameters, return type and example +description: Allow or disallow any user to invite users to this channel/supergroup --- ## Method: channels.toggleInvites [Back to methods index](index.md) +Allow or disallow any user to invite users to this channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Allow or disallow| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v62/methods/channels_toggleSignatures.md b/old_docs/API_docs_v62/methods/channels_toggleSignatures.md index e8ff70a8..f233a8e1 100644 --- a/old_docs/API_docs_v62/methods/channels_toggleSignatures.md +++ b/old_docs/API_docs_v62/methods/channels_toggleSignatures.md @@ -1,17 +1,19 @@ --- title: channels.toggleSignatures -description: channels.toggleSignatures parameters, return type and example +description: Toggle channel signatures --- ## Method: channels.toggleSignatures [Back to methods index](index.md) +Toggle channel signatures + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Enable or disable channel signatures?| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v62/methods/channels_updatePinnedMessage.md b/old_docs/API_docs_v62/methods/channels_updatePinnedMessage.md index 7a14b68b..f06d1f0f 100644 --- a/old_docs/API_docs_v62/methods/channels_updatePinnedMessage.md +++ b/old_docs/API_docs_v62/methods/channels_updatePinnedMessage.md @@ -1,18 +1,20 @@ --- title: channels.updatePinnedMessage -description: channels.updatePinnedMessage parameters, return type and example +description: Set the pinned message of a channel/supergroup --- ## Method: channels.updatePinnedMessage [Back to methods index](index.md) +Set the pinned message of a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|id|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Pin silently| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|id|[CLICK ME int](../types/int.md) | Yes|The ID of the message to pin| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v62/methods/channels_updateUsername.md b/old_docs/API_docs_v62/methods/channels_updateUsername.md index 19647598..ad34490a 100644 --- a/old_docs/API_docs_v62/methods/channels_updateUsername.md +++ b/old_docs/API_docs_v62/methods/channels_updateUsername.md @@ -1,17 +1,19 @@ --- title: channels.updateUsername -description: channels.updateUsername parameters, return type and example +description: Update the username of a supergroup/channel --- ## Method: channels.updateUsername [Back to methods index](index.md) +Update the username of a supergroup/channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|username|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|username|[CLICK ME string](../types/string.md) | Yes|The new username| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v62/methods/contacts_getBlocked.md b/old_docs/API_docs_v62/methods/contacts_getBlocked.md index d7d8c5cc..300025af 100644 --- a/old_docs/API_docs_v62/methods/contacts_getBlocked.md +++ b/old_docs/API_docs_v62/methods/contacts_getBlocked.md @@ -12,7 +12,7 @@ Get blocked users | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, then set to the number of blocked contacts previously fetched| +|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, Then set to the number of blocked contacts previously fetched| |limit|[CLICK ME int](../types/int.md) | Yes|How many blocked contacts to fetch| diff --git a/old_docs/API_docs_v62/methods/contacts_getTopPeers.md b/old_docs/API_docs_v62/methods/contacts_getTopPeers.md index 2bad9a2a..b3f51975 100644 --- a/old_docs/API_docs_v62/methods/contacts_getTopPeers.md +++ b/old_docs/API_docs_v62/methods/contacts_getTopPeers.md @@ -17,7 +17,7 @@ Get most used chats |bots\_inline|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch inline bots?| |groups|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch groups?| |channels|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch channels and supergroups?| -|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, then `$offset += $contacts_TopPeers['categories']['count'];`| +|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, Then `$offset += $contacts_TopPeers['categories']['count'];`| |limit|[CLICK ME int](../types/int.md) | Yes|How many results to fetch| |hash|[CLICK ME int](../types/int.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched peer ids);| diff --git a/old_docs/API_docs_v62/methods/help_getAppChangelog.md b/old_docs/API_docs_v62/methods/help_getAppChangelog.md index 7378f490..208d3409 100644 --- a/old_docs/API_docs_v62/methods/help_getAppChangelog.md +++ b/old_docs/API_docs_v62/methods/help_getAppChangelog.md @@ -1,11 +1,13 @@ --- title: help.getAppChangelog -description: help.getAppChangelog parameters, return type and example +description: Get the changelog of this app --- ## Method: help.getAppChangelog [Back to methods index](index.md) +Get the changelog of this app + ### Return type: [help\_AppChangelog](../types/help_AppChangelog.md) diff --git a/old_docs/API_docs_v62/methods/help_getAppUpdate.md b/old_docs/API_docs_v62/methods/help_getAppUpdate.md index ef72cce2..b88906ae 100644 --- a/old_docs/API_docs_v62/methods/help_getAppUpdate.md +++ b/old_docs/API_docs_v62/methods/help_getAppUpdate.md @@ -1,11 +1,13 @@ --- title: help.getAppUpdate -description: help.getAppUpdate parameters, return type and example +description: Get info about app updates --- ## Method: help.getAppUpdate [Back to methods index](index.md) +Get info about app updates + ### Return type: [help\_AppUpdate](../types/help_AppUpdate.md) diff --git a/old_docs/API_docs_v62/methods/help_getConfig.md b/old_docs/API_docs_v62/methods/help_getConfig.md index 885ad5d3..16e25c68 100644 --- a/old_docs/API_docs_v62/methods/help_getConfig.md +++ b/old_docs/API_docs_v62/methods/help_getConfig.md @@ -1,11 +1,13 @@ --- title: help.getConfig -description: help.getConfig parameters, return type and example +description: Get server configuration --- ## Method: help.getConfig [Back to methods index](index.md) +Get server configuration + ### Return type: [Config](../types/Config.md) diff --git a/old_docs/API_docs_v62/methods/help_getInviteText.md b/old_docs/API_docs_v62/methods/help_getInviteText.md index 101ead40..6b226bff 100644 --- a/old_docs/API_docs_v62/methods/help_getInviteText.md +++ b/old_docs/API_docs_v62/methods/help_getInviteText.md @@ -1,11 +1,13 @@ --- title: help.getInviteText -description: help.getInviteText parameters, return type and example +description: Get invitation text --- ## Method: help.getInviteText [Back to methods index](index.md) +Get invitation text + ### Return type: [help\_InviteText](../types/help_InviteText.md) diff --git a/old_docs/API_docs_v62/methods/help_getNearestDc.md b/old_docs/API_docs_v62/methods/help_getNearestDc.md index 6196890b..35a8bf91 100644 --- a/old_docs/API_docs_v62/methods/help_getNearestDc.md +++ b/old_docs/API_docs_v62/methods/help_getNearestDc.md @@ -1,11 +1,13 @@ --- title: help.getNearestDc -description: help.getNearestDc parameters, return type and example +description: Get nearest datacenter --- ## Method: help.getNearestDc [Back to methods index](index.md) +Get nearest datacenter + ### Return type: [NearestDc](../types/NearestDc.md) diff --git a/old_docs/API_docs_v62/methods/help_getSupport.md b/old_docs/API_docs_v62/methods/help_getSupport.md index 9b269f78..a5bab0f2 100644 --- a/old_docs/API_docs_v62/methods/help_getSupport.md +++ b/old_docs/API_docs_v62/methods/help_getSupport.md @@ -1,11 +1,13 @@ --- title: help.getSupport -description: help.getSupport parameters, return type and example +description: Get info of support user --- ## Method: help.getSupport [Back to methods index](index.md) +Get info of support user + ### Return type: [help\_Support](../types/help_Support.md) diff --git a/old_docs/API_docs_v62/methods/help_getTermsOfService.md b/old_docs/API_docs_v62/methods/help_getTermsOfService.md index f63807ab..487cd83a 100644 --- a/old_docs/API_docs_v62/methods/help_getTermsOfService.md +++ b/old_docs/API_docs_v62/methods/help_getTermsOfService.md @@ -1,11 +1,13 @@ --- title: help.getTermsOfService -description: help.getTermsOfService parameters, return type and example +description: Get terms of service --- ## Method: help.getTermsOfService [Back to methods index](index.md) +Get terms of service + ### Return type: [help\_TermsOfService](../types/help_TermsOfService.md) diff --git a/old_docs/API_docs_v62/methods/help_saveAppLog.md b/old_docs/API_docs_v62/methods/help_saveAppLog.md index af6e94e2..0165b6e3 100644 --- a/old_docs/API_docs_v62/methods/help_saveAppLog.md +++ b/old_docs/API_docs_v62/methods/help_saveAppLog.md @@ -1,16 +1,18 @@ --- title: help.saveAppLog -description: help.saveAppLog parameters, return type and example +description: Log data for developer of this app --- ## Method: help.saveAppLog [Back to methods index](index.md) +Log data for developer of this app + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|events|Array of [CLICK ME InputAppEvent](../types/InputAppEvent.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|events|Array of [CLICK ME InputAppEvent](../types/InputAppEvent.md) | Yes|Event list| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v62/methods/help_setBotUpdatesStatus.md b/old_docs/API_docs_v62/methods/help_setBotUpdatesStatus.md index 3351fab4..ff314b5c 100644 --- a/old_docs/API_docs_v62/methods/help_setBotUpdatesStatus.md +++ b/old_docs/API_docs_v62/methods/help_setBotUpdatesStatus.md @@ -1,17 +1,19 @@ --- title: help.setBotUpdatesStatus -description: help.setBotUpdatesStatus parameters, return type and example +description: Set the update status of webhook --- ## Method: help.setBotUpdatesStatus [Back to methods index](index.md) +Set the update status of webhook + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|pending\_updates\_count|[CLICK ME int](../types/int.md) | Yes| -|message|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|pending\_updates\_count|[CLICK ME int](../types/int.md) | Yes|Pending update count| +|message|[CLICK ME string](../types/string.md) | Yes|Message| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v62/methods/messages_checkChatInvite.md b/old_docs/API_docs_v62/methods/messages_checkChatInvite.md index 4ddf5084..de1d9ff4 100644 --- a/old_docs/API_docs_v62/methods/messages_checkChatInvite.md +++ b/old_docs/API_docs_v62/methods/messages_checkChatInvite.md @@ -1,16 +1,18 @@ --- title: messages.checkChatInvite -description: messages.checkChatInvite parameters, return type and example +description: Check if an invitation link is valid --- ## Method: messages.checkChatInvite [Back to methods index](index.md) +Check if an invitation link is valid + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| ### Return type: [ChatInvite](../types/ChatInvite.md) diff --git a/old_docs/API_docs_v62/methods/messages_clearRecentStickers.md b/old_docs/API_docs_v62/methods/messages_clearRecentStickers.md index f017087f..9c1b3754 100644 --- a/old_docs/API_docs_v62/methods/messages_clearRecentStickers.md +++ b/old_docs/API_docs_v62/methods/messages_clearRecentStickers.md @@ -1,16 +1,18 @@ --- title: messages.clearRecentStickers -description: messages.clearRecentStickers parameters, return type and example +description: Clear all recent stickers --- ## Method: messages.clearRecentStickers [Back to methods index](index.md) +Clear all recent stickers + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|attached|[CLICK ME Bool](../types/Bool.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|attached|[CLICK ME Bool](../types/Bool.md) | Optional|Clear recent stickers attached to images?| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v62/methods/messages_deleteChatUser.md b/old_docs/API_docs_v62/methods/messages_deleteChatUser.md index a71f4aaf..0a6830de 100644 --- a/old_docs/API_docs_v62/methods/messages_deleteChatUser.md +++ b/old_docs/API_docs_v62/methods/messages_deleteChatUser.md @@ -12,7 +12,7 @@ Delete a user from a chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The MTProto ID of the chat| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to delete (pass @me to leave the chat)| diff --git a/old_docs/API_docs_v62/methods/messages_editChatAdmin.md b/old_docs/API_docs_v62/methods/messages_editChatAdmin.md index 6bc8f9ae..7916f8b1 100644 --- a/old_docs/API_docs_v62/methods/messages_editChatAdmin.md +++ b/old_docs/API_docs_v62/methods/messages_editChatAdmin.md @@ -1,18 +1,20 @@ --- title: messages.editChatAdmin -description: messages.editChatAdmin parameters, return type and example +description: Edit admin permissions --- ## Method: messages.editChatAdmin [Back to methods index](index.md) +Edit admin permissions + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|is\_admin|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat ID (no supergroups)| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user ID| +|is\_admin|[CLICK ME Bool](../types/Bool.md) | Yes|Should the user be admin?| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v62/methods/messages_editChatPhoto.md b/old_docs/API_docs_v62/methods/messages_editChatPhoto.md index 8848eca7..122913c4 100644 --- a/old_docs/API_docs_v62/methods/messages_editChatPhoto.md +++ b/old_docs/API_docs_v62/methods/messages_editChatPhoto.md @@ -12,7 +12,7 @@ Edit the photo of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The MTProto ID of the chat| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| |photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| diff --git a/old_docs/API_docs_v62/methods/messages_editChatTitle.md b/old_docs/API_docs_v62/methods/messages_editChatTitle.md index 1c1c7a16..3a1e974b 100644 --- a/old_docs/API_docs_v62/methods/messages_editChatTitle.md +++ b/old_docs/API_docs_v62/methods/messages_editChatTitle.md @@ -12,7 +12,7 @@ Edit the title of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The MTProto ID of the chat| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| |title|[CLICK ME string](../types/string.md) | Yes|The new title| diff --git a/old_docs/API_docs_v62/methods/messages_editInlineBotMessage.md b/old_docs/API_docs_v62/methods/messages_editInlineBotMessage.md index c0d06614..2237fb20 100644 --- a/old_docs/API_docs_v62/methods/messages_editInlineBotMessage.md +++ b/old_docs/API_docs_v62/methods/messages_editInlineBotMessage.md @@ -1,20 +1,22 @@ --- title: messages.editInlineBotMessage -description: messages.editInlineBotMessage parameters, return type and example +description: Edit a sent inline message --- ## Method: messages.editInlineBotMessage [Back to methods index](index.md) +Edit a sent inline message + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional| -|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes| -|message|[CLICK ME string](../types/string.md) | Optional| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview| +|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The message ID| +|message|[CLICK ME string](../types/string.md) | Optional|The new message| +|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| +|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/old_docs/API_docs_v62/methods/messages_editMessage.md b/old_docs/API_docs_v62/methods/messages_editMessage.md index 2e98318d..177438a5 100644 --- a/old_docs/API_docs_v62/methods/messages_editMessage.md +++ b/old_docs/API_docs_v62/methods/messages_editMessage.md @@ -1,21 +1,23 @@ --- title: messages.editMessage -description: messages.editMessage parameters, return type and example +description: Edit a message --- ## Method: messages.editMessage [Back to methods index](index.md) +Edit a message + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|id|[CLICK ME int](../types/int.md) | Yes| -|message|[CLICK ME string](../types/string.md) | Optional| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| +|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|message|[CLICK ME string](../types/string.md) | Optional|The new message| +|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| +|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/old_docs/API_docs_v62/methods/messages_exportChatInvite.md b/old_docs/API_docs_v62/methods/messages_exportChatInvite.md index 74d70c21..98685d96 100644 --- a/old_docs/API_docs_v62/methods/messages_exportChatInvite.md +++ b/old_docs/API_docs_v62/methods/messages_exportChatInvite.md @@ -1,16 +1,18 @@ --- title: messages.exportChatInvite -description: messages.exportChatInvite parameters, return type and example +description: Export chat invite --- ## Method: messages.exportChatInvite [Back to methods index](index.md) +Export chat invite + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat id | ### Return type: [ExportedChatInvite](../types/ExportedChatInvite.md) diff --git a/old_docs/API_docs_v62/methods/messages_getAllChats.md b/old_docs/API_docs_v62/methods/messages_getAllChats.md index 4b87df49..127456e4 100644 --- a/old_docs/API_docs_v62/methods/messages_getAllChats.md +++ b/old_docs/API_docs_v62/methods/messages_getAllChats.md @@ -1,16 +1,18 @@ --- title: messages.getAllChats -description: messages.getAllChats parameters, return type and example +description: Get all chats (not supergroups or channels) --- ## Method: messages.getAllChats [Back to methods index](index.md) +Get all chats (not supergroups or channels) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|except\_ids|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|except\_ids|Array of [CLICK ME int](../types/int.md) | Yes|Do not fetch these chats (MTProto id)| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v62/methods/messages_getAllDrafts.md b/old_docs/API_docs_v62/methods/messages_getAllDrafts.md index a5dd59f6..2c0ecd42 100644 --- a/old_docs/API_docs_v62/methods/messages_getAllDrafts.md +++ b/old_docs/API_docs_v62/methods/messages_getAllDrafts.md @@ -1,11 +1,13 @@ --- title: messages.getAllDrafts -description: messages.getAllDrafts parameters, return type and example +description: Get all message drafts --- ## Method: messages.getAllDrafts [Back to methods index](index.md) +Get all message drafts + ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v62/methods/messages_getAllStickers.md b/old_docs/API_docs_v62/methods/messages_getAllStickers.md index 575fcd49..16fdba6c 100644 --- a/old_docs/API_docs_v62/methods/messages_getAllStickers.md +++ b/old_docs/API_docs_v62/methods/messages_getAllStickers.md @@ -1,16 +1,18 @@ --- title: messages.getAllStickers -description: messages.getAllStickers parameters, return type and example +description: Get all stickerpacks --- ## Method: messages.getAllStickers [Back to methods index](index.md) +Get all stickerpacks + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v62/methods/messages_getArchivedStickers.md b/old_docs/API_docs_v62/methods/messages_getArchivedStickers.md index 1b4aaa93..f037e1bc 100644 --- a/old_docs/API_docs_v62/methods/messages_getArchivedStickers.md +++ b/old_docs/API_docs_v62/methods/messages_getArchivedStickers.md @@ -1,18 +1,20 @@ --- title: messages.getArchivedStickers -description: messages.getArchivedStickers parameters, return type and example +description: Get all archived stickers --- ## Method: messages.getArchivedStickers [Back to methods index](index.md) +Get all archived stickers + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|masks|[CLICK ME Bool](../types/Bool.md) | Optional| -|offset\_id|[CLICK ME long](../types/long.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|masks|[CLICK ME Bool](../types/Bool.md) | Optional|Get masks?| +|offset\_id|[CLICK ME long](../types/long.md) | Yes|Sticker ID offset| +|limit|[CLICK ME int](../types/int.md) | Yes|Number of stickers to fetch| ### Return type: [messages\_ArchivedStickers](../types/messages_ArchivedStickers.md) diff --git a/old_docs/API_docs_v62/methods/messages_getAttachedStickers.md b/old_docs/API_docs_v62/methods/messages_getAttachedStickers.md index a0d89b31..890680cd 100644 --- a/old_docs/API_docs_v62/methods/messages_getAttachedStickers.md +++ b/old_docs/API_docs_v62/methods/messages_getAttachedStickers.md @@ -1,16 +1,18 @@ --- title: messages.getAttachedStickers -description: messages.getAttachedStickers parameters, return type and example +description: Get stickers attachable to images --- ## Method: messages.getAttachedStickers [Back to methods index](index.md) +Get stickers attachable to images + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|media|[CLICK ME InputStickeredMedia](../types/InputStickeredMedia.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|media|[CLICK ME InputStickeredMedia](../types/InputStickeredMedia.md) | Yes|The stickered media| ### Return type: [Vector\_of\_StickerSetCovered](../types/StickerSetCovered.md) diff --git a/old_docs/API_docs_v62/methods/messages_getBotCallbackAnswer.md b/old_docs/API_docs_v62/methods/messages_getBotCallbackAnswer.md index 7ccd0d1b..09c283f5 100644 --- a/old_docs/API_docs_v62/methods/messages_getBotCallbackAnswer.md +++ b/old_docs/API_docs_v62/methods/messages_getBotCallbackAnswer.md @@ -1,19 +1,21 @@ --- title: messages.getBotCallbackAnswer -description: messages.getBotCallbackAnswer parameters, return type and example +description: Get the callback answer of a bot (after clicking a button) --- ## Method: messages.getBotCallbackAnswer [Back to methods index](index.md) +Get the callback answer of a bot (after clicking a button) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|game|[CLICK ME Bool](../types/Bool.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|msg\_id|[CLICK ME int](../types/int.md) | Yes| -|data|[CLICK ME bytes](../types/bytes.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|game|[CLICK ME Bool](../types/Bool.md) | Optional|Is this a game?| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| +|msg\_id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|data|[CLICK ME bytes](../types/bytes.md) | Optional|The data to send to the bot| ### Return type: [messages\_BotCallbackAnswer](../types/messages_BotCallbackAnswer.md) diff --git a/old_docs/API_docs_v62/methods/messages_getCommonChats.md b/old_docs/API_docs_v62/methods/messages_getCommonChats.md index a57d7f5a..e6eca283 100644 --- a/old_docs/API_docs_v62/methods/messages_getCommonChats.md +++ b/old_docs/API_docs_v62/methods/messages_getCommonChats.md @@ -1,18 +1,20 @@ --- title: messages.getCommonChats -description: messages.getCommonChats parameters, return type and example +description: Get chats in common with a user --- ## Method: messages.getCommonChats [Back to methods index](index.md) +Get chats in common with a user + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|max\_id|[CLICK ME int](../types/int.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| +|max\_id|[CLICK ME int](../types/int.md) | Yes|The maximum chat ID to fetch| +|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to fetch| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v62/methods/messages_getDocumentByHash.md b/old_docs/API_docs_v62/methods/messages_getDocumentByHash.md index b7c45398..1af5bad4 100644 --- a/old_docs/API_docs_v62/methods/messages_getDocumentByHash.md +++ b/old_docs/API_docs_v62/methods/messages_getDocumentByHash.md @@ -1,18 +1,20 @@ --- title: messages.getDocumentByHash -description: messages.getDocumentByHash parameters, return type and example +description: Get document by SHA256 hash --- ## Method: messages.getDocumentByHash [Back to methods index](index.md) +Get document by SHA256 hash + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|sha256|[CLICK ME bytes](../types/bytes.md) | Yes| -|size|[CLICK ME int](../types/int.md) | Yes| -|mime\_type|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|sha256|[CLICK ME bytes](../types/bytes.md) | Yes|`hash('sha256', $filename, true);`| +|size|[CLICK ME int](../types/int.md) | Yes|The file size| +|mime\_type|[CLICK ME string](../types/string.md) | Yes|The mime type of the file| ### Return type: [Document](../types/Document.md) diff --git a/old_docs/API_docs_v62/methods/messages_getFeaturedStickers.md b/old_docs/API_docs_v62/methods/messages_getFeaturedStickers.md index 88b5609c..512f2e85 100644 --- a/old_docs/API_docs_v62/methods/messages_getFeaturedStickers.md +++ b/old_docs/API_docs_v62/methods/messages_getFeaturedStickers.md @@ -1,16 +1,18 @@ --- title: messages.getFeaturedStickers -description: messages.getFeaturedStickers parameters, return type and example +description: Get featured stickers --- ## Method: messages.getFeaturedStickers [Back to methods index](index.md) +Get featured stickers + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_FeaturedStickers](../types/messages_FeaturedStickers.md) diff --git a/old_docs/API_docs_v62/methods/messages_getGameHighScores.md b/old_docs/API_docs_v62/methods/messages_getGameHighScores.md index 2c95af05..5137baea 100644 --- a/old_docs/API_docs_v62/methods/messages_getGameHighScores.md +++ b/old_docs/API_docs_v62/methods/messages_getGameHighScores.md @@ -1,18 +1,20 @@ --- title: messages.getGameHighScores -description: messages.getGameHighScores parameters, return type and example +description: Get high scores of a game --- ## Method: messages.getGameHighScores [Back to methods index](index.md) +Get high scores of a game + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|id|[CLICK ME int](../types/int.md) | Yes| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| +|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the high scores| ### Return type: [messages\_HighScores](../types/messages_HighScores.md) diff --git a/old_docs/API_docs_v62/methods/messages_getInlineBotResults.md b/old_docs/API_docs_v62/methods/messages_getInlineBotResults.md index 5b2bb254..8ab5bf78 100644 --- a/old_docs/API_docs_v62/methods/messages_getInlineBotResults.md +++ b/old_docs/API_docs_v62/methods/messages_getInlineBotResults.md @@ -1,20 +1,22 @@ --- title: messages.getInlineBotResults -description: messages.getInlineBotResults parameters, return type and example +description: Call inline bot --- ## Method: messages.getInlineBotResults [Back to methods index](index.md) +Call inline bot + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional| -|query|[CLICK ME string](../types/string.md) | Yes| -|offset|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot to call| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to call the bot| +|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional|The current location| +|query|[CLICK ME string](../types/string.md) | Yes|The query to send to the bot| +|offset|[CLICK ME string](../types/string.md) | Yes|The offset to send to the bot| ### Return type: [messages\_BotResults](../types/messages_BotResults.md) diff --git a/old_docs/API_docs_v62/methods/messages_getInlineGameHighScores.md b/old_docs/API_docs_v62/methods/messages_getInlineGameHighScores.md index 447a55dd..790bfdd9 100644 --- a/old_docs/API_docs_v62/methods/messages_getInlineGameHighScores.md +++ b/old_docs/API_docs_v62/methods/messages_getInlineGameHighScores.md @@ -1,17 +1,19 @@ --- title: messages.getInlineGameHighScores -description: messages.getInlineGameHighScores parameters, return type and example +description: Get high scores of a game sent in an inline message --- ## Method: messages.getInlineGameHighScores [Back to methods index](index.md) +Get high scores of a game sent in an inline message + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The inline message| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the high scores| ### Return type: [messages\_HighScores](../types/messages_HighScores.md) diff --git a/old_docs/API_docs_v62/methods/messages_getMaskStickers.md b/old_docs/API_docs_v62/methods/messages_getMaskStickers.md index 80c16471..f4ed9411 100644 --- a/old_docs/API_docs_v62/methods/messages_getMaskStickers.md +++ b/old_docs/API_docs_v62/methods/messages_getMaskStickers.md @@ -1,16 +1,18 @@ --- title: messages.getMaskStickers -description: messages.getMaskStickers parameters, return type and example +description: Get masks --- ## Method: messages.getMaskStickers [Back to methods index](index.md) +Get masks + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v62/methods/messages_getMessageEditData.md b/old_docs/API_docs_v62/methods/messages_getMessageEditData.md index 339678bd..12e71bee 100644 --- a/old_docs/API_docs_v62/methods/messages_getMessageEditData.md +++ b/old_docs/API_docs_v62/methods/messages_getMessageEditData.md @@ -1,17 +1,19 @@ --- title: messages.getMessageEditData -description: messages.getMessageEditData parameters, return type and example +description: Check if about to edit a message or a media caption --- ## Method: messages.getMessageEditData [Back to methods index](index.md) +Check if about to edit a message or a media caption + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|id|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| +|id|[CLICK ME int](../types/int.md) | Yes|The message ID| ### Return type: [messages\_MessageEditData](../types/messages_MessageEditData.md) diff --git a/old_docs/API_docs_v62/methods/messages_getMessagesViews.md b/old_docs/API_docs_v62/methods/messages_getMessagesViews.md index e3f4e4ea..b8d78c85 100644 --- a/old_docs/API_docs_v62/methods/messages_getMessagesViews.md +++ b/old_docs/API_docs_v62/methods/messages_getMessagesViews.md @@ -1,18 +1,20 @@ --- title: messages.getMessagesViews -description: messages.getMessagesViews parameters, return type and example +description: Get and increase message views --- ## Method: messages.getMessagesViews [Back to methods index](index.md) +Get and increase message views + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|id|Array of [CLICK ME int](../types/int.md) | Yes| -|increment|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the message is located| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs messages to get| +|increment|[CLICK ME Bool](../types/Bool.md) | Yes|Increase message views?| ### Return type: [Vector\_of\_int](../types/int.md) diff --git a/old_docs/API_docs_v62/methods/messages_getPeerDialogs.md b/old_docs/API_docs_v62/methods/messages_getPeerDialogs.md index fe8a821c..da82cfc6 100644 --- a/old_docs/API_docs_v62/methods/messages_getPeerDialogs.md +++ b/old_docs/API_docs_v62/methods/messages_getPeerDialogs.md @@ -1,16 +1,18 @@ --- title: messages.getPeerDialogs -description: messages.getPeerDialogs parameters, return type and example +description: Get dialog info of peers --- ## Method: messages.getPeerDialogs [Back to methods index](index.md) +Get dialog info of peers + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peers|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peers|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Yes|The peers| ### Return type: [messages\_PeerDialogs](../types/messages_PeerDialogs.md) diff --git a/old_docs/API_docs_v62/methods/messages_getPinnedDialogs.md b/old_docs/API_docs_v62/methods/messages_getPinnedDialogs.md index 99ff5651..d12779fe 100644 --- a/old_docs/API_docs_v62/methods/messages_getPinnedDialogs.md +++ b/old_docs/API_docs_v62/methods/messages_getPinnedDialogs.md @@ -1,11 +1,13 @@ --- title: messages.getPinnedDialogs -description: messages.getPinnedDialogs parameters, return type and example +description: Get pinned dialogs --- ## Method: messages.getPinnedDialogs [Back to methods index](index.md) +Get pinned dialogs + ### Return type: [messages\_PeerDialogs](../types/messages_PeerDialogs.md) diff --git a/old_docs/API_docs_v62/methods/messages_getRecentStickers.md b/old_docs/API_docs_v62/methods/messages_getRecentStickers.md index abab7f44..d76a2160 100644 --- a/old_docs/API_docs_v62/methods/messages_getRecentStickers.md +++ b/old_docs/API_docs_v62/methods/messages_getRecentStickers.md @@ -1,17 +1,19 @@ --- title: messages.getRecentStickers -description: messages.getRecentStickers parameters, return type and example +description: Get recent stickers --- ## Method: messages.getRecentStickers [Back to methods index](index.md) +Get recent stickers + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|attached|[CLICK ME Bool](../types/Bool.md) | Optional| -|hash|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|attached|[CLICK ME Bool](../types/Bool.md) | Optional|Get stickers attached to image?| +|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_RecentStickers](../types/messages_RecentStickers.md) diff --git a/old_docs/API_docs_v62/methods/messages_getSavedGifs.md b/old_docs/API_docs_v62/methods/messages_getSavedGifs.md index 08dc4be6..f61348ce 100644 --- a/old_docs/API_docs_v62/methods/messages_getSavedGifs.md +++ b/old_docs/API_docs_v62/methods/messages_getSavedGifs.md @@ -1,16 +1,18 @@ --- title: messages.getSavedGifs -description: messages.getSavedGifs parameters, return type and example +description: Get saved gifs --- ## Method: messages.getSavedGifs [Back to methods index](index.md) +Get saved gifs + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_SavedGifs](../types/messages_SavedGifs.md) diff --git a/old_docs/API_docs_v62/methods/messages_getStickerSet.md b/old_docs/API_docs_v62/methods/messages_getStickerSet.md index 70bdd9ba..c86807e4 100644 --- a/old_docs/API_docs_v62/methods/messages_getStickerSet.md +++ b/old_docs/API_docs_v62/methods/messages_getStickerSet.md @@ -1,16 +1,18 @@ --- title: messages.getStickerSet -description: messages.getStickerSet parameters, return type and example +description: Get a stickerset --- ## Method: messages.getStickerSet [Back to methods index](index.md) +Get a stickerset + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset to get| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/old_docs/API_docs_v62/methods/messages_getWebPage.md b/old_docs/API_docs_v62/methods/messages_getWebPage.md index b29e5d25..129f8f06 100644 --- a/old_docs/API_docs_v62/methods/messages_getWebPage.md +++ b/old_docs/API_docs_v62/methods/messages_getWebPage.md @@ -1,17 +1,19 @@ --- title: messages.getWebPage -description: messages.getWebPage parameters, return type and example +description: Get webpage preview --- ## Method: messages.getWebPage [Back to methods index](index.md) +Get webpage preview + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|url|[CLICK ME string](../types/string.md) | Yes| -|hash|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|url|[CLICK ME string](../types/string.md) | Yes|URL| +|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [WebPage](../types/WebPage.md) diff --git a/old_docs/API_docs_v62/methods/messages_getWebPagePreview.md b/old_docs/API_docs_v62/methods/messages_getWebPagePreview.md index 35243c9f..d01bdd32 100644 --- a/old_docs/API_docs_v62/methods/messages_getWebPagePreview.md +++ b/old_docs/API_docs_v62/methods/messages_getWebPagePreview.md @@ -1,16 +1,18 @@ --- title: messages.getWebPagePreview -description: messages.getWebPagePreview parameters, return type and example +description: Get webpage preview --- ## Method: messages.getWebPagePreview [Back to methods index](index.md) +Get webpage preview + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|message|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|message|[CLICK ME string](../types/string.md) | Yes|Extract preview from this message| ### Return type: [MessageMedia](../types/MessageMedia.md) diff --git a/old_docs/API_docs_v62/methods/messages_importChatInvite.md b/old_docs/API_docs_v62/methods/messages_importChatInvite.md index 2bea5247..0d6cd7c8 100644 --- a/old_docs/API_docs_v62/methods/messages_importChatInvite.md +++ b/old_docs/API_docs_v62/methods/messages_importChatInvite.md @@ -1,16 +1,18 @@ --- title: messages.importChatInvite -description: messages.importChatInvite parameters, return type and example +description: Import chat invite --- ## Method: messages.importChatInvite [Back to methods index](index.md) +Import chat invite + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v62/methods/messages_installStickerSet.md b/old_docs/API_docs_v62/methods/messages_installStickerSet.md index 61513182..9f6f098c 100644 --- a/old_docs/API_docs_v62/methods/messages_installStickerSet.md +++ b/old_docs/API_docs_v62/methods/messages_installStickerSet.md @@ -1,17 +1,19 @@ --- title: messages.installStickerSet -description: messages.installStickerSet parameters, return type and example +description: Add a sticker set --- ## Method: messages.installStickerSet [Back to methods index](index.md) +Add a sticker set + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional| -|archived|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to add| +|archived|[CLICK ME Bool](../types/Bool.md) | Yes|Archive this set?| ### Return type: [messages\_StickerSetInstallResult](../types/messages_StickerSetInstallResult.md) diff --git a/old_docs/API_docs_v62/methods/messages_migrateChat.md b/old_docs/API_docs_v62/methods/messages_migrateChat.md index 5021ad45..db57adfa 100644 --- a/old_docs/API_docs_v62/methods/messages_migrateChat.md +++ b/old_docs/API_docs_v62/methods/messages_migrateChat.md @@ -1,16 +1,18 @@ --- title: messages.migrateChat -description: messages.migrateChat parameters, return type and example +description: Convert chat to supergroup --- ## Method: messages.migrateChat [Back to methods index](index.md) +Convert chat to supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat to convert| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v62/methods/messages_readEncryptedHistory.md b/old_docs/API_docs_v62/methods/messages_readEncryptedHistory.md index 4d341809..39b110e3 100644 --- a/old_docs/API_docs_v62/methods/messages_readEncryptedHistory.md +++ b/old_docs/API_docs_v62/methods/messages_readEncryptedHistory.md @@ -1,17 +1,19 @@ --- title: messages.readEncryptedHistory -description: messages.readEncryptedHistory parameters, return type and example +description: Mark messages as read in secret chats --- ## Method: messages.readEncryptedHistory [Back to methods index](index.md) +Mark messages as read in secret chats + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|max\_date|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to mark messages as read| +|max\_date|[CLICK ME int](../types/int.md) | Yes|Maximum date of messages to mark| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v62/methods/messages_readFeaturedStickers.md b/old_docs/API_docs_v62/methods/messages_readFeaturedStickers.md index 0631ca5b..4035c76d 100644 --- a/old_docs/API_docs_v62/methods/messages_readFeaturedStickers.md +++ b/old_docs/API_docs_v62/methods/messages_readFeaturedStickers.md @@ -1,16 +1,18 @@ --- title: messages.readFeaturedStickers -description: messages.readFeaturedStickers parameters, return type and example +description: Mark new featured stickers as read --- ## Method: messages.readFeaturedStickers [Back to methods index](index.md) +Mark new featured stickers as read + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|Array of [CLICK ME long](../types/long.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|Array of [CLICK ME long](../types/long.md) | Yes|The stickers to mark as read| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v62/methods/messages_readMessageContents.md b/old_docs/API_docs_v62/methods/messages_readMessageContents.md index 0d27c209..9bb1bee8 100644 --- a/old_docs/API_docs_v62/methods/messages_readMessageContents.md +++ b/old_docs/API_docs_v62/methods/messages_readMessageContents.md @@ -1,16 +1,18 @@ --- title: messages.readMessageContents -description: messages.readMessageContents parameters, return type and example +description: Mark message as read --- ## Method: messages.readMessageContents [Back to methods index](index.md) +Mark message as read + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v62/methods/messages_receivedQueue.md b/old_docs/API_docs_v62/methods/messages_receivedQueue.md index c91caa37..4ad78ba2 100644 --- a/old_docs/API_docs_v62/methods/messages_receivedQueue.md +++ b/old_docs/API_docs_v62/methods/messages_receivedQueue.md @@ -1,77 +1,13 @@ --- title: messages.receivedQueue -description: messages.receivedQueue parameters, return type and example +description: You cannot use this method directly --- ## Method: messages.receivedQueue [Back to methods index](index.md) -### Parameters: - -| Name | Type | Required | -|----------|---------------|----------| -|max\_qts|[CLICK ME int](../types/int.md) | Yes| - - -### 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| - - -### MadelineProto Example: - - -``` -if (!file_exists('madeline.php')) { - copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); -} -include 'madeline.php'; - -// !!! This API id/API hash combination will not work !!! -// !!! You must get your own @ my.telegram.org !!! -$api_id = 0; -$api_hash = ''; - -$MadelineProto = new \danog\MadelineProto\API('session.madeline', ['app_info' => ['api_id' => $api_id, 'api_hash' => $api_hash]]); -$MadelineProto->start(); - -$Vector_of_long = $MadelineProto->messages->receivedQueue(['max_qts' => int, ]); -``` - -### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): - -### As a bot: - -POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` - -Parameters: - -* method - messages.receivedQueue -* params - `{"max_qts": int, }` - - - -### As a user: - -POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.receivedQueue` - -Parameters: - -max_qts - Json encoded int +**You cannot use this method directly** -Or, if you're into Lua: - -``` -Vector_of_long = messages.receivedQueue({max_qts=int, }) -``` - diff --git a/old_docs/API_docs_v62/methods/messages_reorderPinnedDialogs.md b/old_docs/API_docs_v62/methods/messages_reorderPinnedDialogs.md index 0bf5e073..710caf10 100644 --- a/old_docs/API_docs_v62/methods/messages_reorderPinnedDialogs.md +++ b/old_docs/API_docs_v62/methods/messages_reorderPinnedDialogs.md @@ -1,17 +1,19 @@ --- title: messages.reorderPinnedDialogs -description: messages.reorderPinnedDialogs parameters, return type and example +description: Reorder pinned dialogs --- ## Method: messages.reorderPinnedDialogs [Back to methods index](index.md) +Reorder pinned dialogs + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|force|[CLICK ME Bool](../types/Bool.md) | Optional| -|order|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|force|[CLICK ME Bool](../types/Bool.md) | Optional|Force reordering| +|order|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Yes|New order| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v62/methods/messages_reorderStickerSets.md b/old_docs/API_docs_v62/methods/messages_reorderStickerSets.md index e4f1623c..ddc78dd0 100644 --- a/old_docs/API_docs_v62/methods/messages_reorderStickerSets.md +++ b/old_docs/API_docs_v62/methods/messages_reorderStickerSets.md @@ -1,17 +1,19 @@ --- title: messages.reorderStickerSets -description: messages.reorderStickerSets parameters, return type and example +description: Reorder sticker sets --- ## Method: messages.reorderStickerSets [Back to methods index](index.md) +Reorder sticker sets + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|masks|[CLICK ME Bool](../types/Bool.md) | Optional| -|order|Array of [CLICK ME long](../types/long.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|masks|[CLICK ME Bool](../types/Bool.md) | Optional|Reorder masks?| +|order|Array of [CLICK ME long](../types/long.md) | Yes|The order| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v62/methods/messages_reportEncryptedSpam.md b/old_docs/API_docs_v62/methods/messages_reportEncryptedSpam.md index 44482c76..58b684d1 100644 --- a/old_docs/API_docs_v62/methods/messages_reportEncryptedSpam.md +++ b/old_docs/API_docs_v62/methods/messages_reportEncryptedSpam.md @@ -1,16 +1,18 @@ --- title: messages.reportEncryptedSpam -description: messages.reportEncryptedSpam parameters, return type and example +description: Report for spam a secret chat --- ## Method: messages.reportEncryptedSpam [Back to methods index](index.md) +Report for spam a secret chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat to report| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v62/methods/messages_saveDraft.md b/old_docs/API_docs_v62/methods/messages_saveDraft.md index 9104df33..bbeed707 100644 --- a/old_docs/API_docs_v62/methods/messages_saveDraft.md +++ b/old_docs/API_docs_v62/methods/messages_saveDraft.md @@ -1,20 +1,22 @@ --- title: messages.saveDraft -description: messages.saveDraft parameters, return type and example +description: Save a message draft --- ## Method: messages.saveDraft [Back to methods index](index.md) +Save a message draft + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|message|[CLICK ME string](../types/string.md) | Yes| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview| +|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| +|message|[CLICK ME string](../types/string.md) | Yes|The message| +|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|The entities (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/old_docs/API_docs_v62/methods/messages_saveGif.md b/old_docs/API_docs_v62/methods/messages_saveGif.md index 4a3b6166..6f608c4c 100644 --- a/old_docs/API_docs_v62/methods/messages_saveGif.md +++ b/old_docs/API_docs_v62/methods/messages_saveGif.md @@ -1,17 +1,19 @@ --- title: messages.saveGif -description: messages.saveGif parameters, return type and example +description: Save a GIF --- ## Method: messages.saveGif [Back to methods index](index.md) +Save a GIF + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional| -|unsave|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The GIF to save| +|unsave|[CLICK ME Bool](../types/Bool.md) | Yes|Remove the gif?| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v62/methods/messages_saveRecentSticker.md b/old_docs/API_docs_v62/methods/messages_saveRecentSticker.md index b4f43e13..81ad5d48 100644 --- a/old_docs/API_docs_v62/methods/messages_saveRecentSticker.md +++ b/old_docs/API_docs_v62/methods/messages_saveRecentSticker.md @@ -1,18 +1,20 @@ --- title: messages.saveRecentSticker -description: messages.saveRecentSticker parameters, return type and example +description: Add a sticker to recent stickers --- ## Method: messages.saveRecentSticker [Back to methods index](index.md) +Add a sticker to recent stickers + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|attached|[CLICK ME Bool](../types/Bool.md) | Optional| -|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional| -|unsave|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|attached|[CLICK ME Bool](../types/Bool.md) | Optional|Get stickers attached to image?| +|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker| +|unsave|[CLICK ME Bool](../types/Bool.md) | Yes|Remove the sticker from recent stickers?| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v62/methods/messages_searchGifs.md b/old_docs/API_docs_v62/methods/messages_searchGifs.md index fefef1d7..103ebfeb 100644 --- a/old_docs/API_docs_v62/methods/messages_searchGifs.md +++ b/old_docs/API_docs_v62/methods/messages_searchGifs.md @@ -1,17 +1,19 @@ --- title: messages.searchGifs -description: messages.searchGifs parameters, return type and example +description: Search gifs --- ## Method: messages.searchGifs [Back to methods index](index.md) +Search gifs + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|q|[CLICK ME string](../types/string.md) | Yes| -|offset|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|q|[CLICK ME string](../types/string.md) | Yes|The search query| +|offset|[CLICK ME int](../types/int.md) | Yes|The offset | ### Return type: [messages\_FoundGifs](../types/messages_FoundGifs.md) diff --git a/old_docs/API_docs_v62/methods/messages_searchGlobal.md b/old_docs/API_docs_v62/methods/messages_searchGlobal.md index 32ddd175..0edd1e40 100644 --- a/old_docs/API_docs_v62/methods/messages_searchGlobal.md +++ b/old_docs/API_docs_v62/methods/messages_searchGlobal.md @@ -1,20 +1,22 @@ --- title: messages.searchGlobal -description: messages.searchGlobal parameters, return type and example +description: Global message search --- ## Method: messages.searchGlobal [Back to methods index](index.md) +Global message search + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|q|[CLICK ME string](../types/string.md) | Yes| -|offset\_date|[CLICK ME int](../types/int.md) | Yes| -|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|offset\_id|[CLICK ME int](../types/int.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|q|[CLICK ME string](../types/string.md) | Yes|The query| +|offset\_date|[CLICK ME int](../types/int.md) | Yes|0 or the date offset| +|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|0 or the peer offset| +|offset\_id|[CLICK ME int](../types/int.md) | Yes|0 or the message ID offset| +|limit|[CLICK ME int](../types/int.md) | Yes|The number of results to return| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v62/methods/messages_sendEncrypted.md b/old_docs/API_docs_v62/methods/messages_sendEncrypted.md index 23461760..d48f88d7 100644 --- a/old_docs/API_docs_v62/methods/messages_sendEncrypted.md +++ b/old_docs/API_docs_v62/methods/messages_sendEncrypted.md @@ -1,17 +1,19 @@ --- title: messages.sendEncrypted -description: messages.sendEncrypted parameters, return type and example +description: Send message to secret chat --- ## Method: messages.sendEncrypted [Back to methods index](index.md) +Send message to secret chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the message| +|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v62/methods/messages_sendEncryptedFile.md b/old_docs/API_docs_v62/methods/messages_sendEncryptedFile.md index 64919abe..4fd0648e 100644 --- a/old_docs/API_docs_v62/methods/messages_sendEncryptedFile.md +++ b/old_docs/API_docs_v62/methods/messages_sendEncryptedFile.md @@ -1,18 +1,20 @@ --- title: messages.sendEncryptedFile -description: messages.sendEncryptedFile parameters, return type and example +description: Send a file to a secret chat --- ## Method: messages.sendEncryptedFile [Back to methods index](index.md) +Send a file to a secret chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes| -|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the file| +|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| +|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional|The file (optional)| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v62/methods/messages_sendEncryptedService.md b/old_docs/API_docs_v62/methods/messages_sendEncryptedService.md index 0a0eea8a..d66894bf 100644 --- a/old_docs/API_docs_v62/methods/messages_sendEncryptedService.md +++ b/old_docs/API_docs_v62/methods/messages_sendEncryptedService.md @@ -1,17 +1,19 @@ --- title: messages.sendEncryptedService -description: messages.sendEncryptedService parameters, return type and example +description: Send a service message to a secret chat --- ## Method: messages.sendEncryptedService [Back to methods index](index.md) +Send a service message to a secret chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the service message| +|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v62/methods/messages_sendInlineBotResult.md b/old_docs/API_docs_v62/methods/messages_sendInlineBotResult.md index 4cb9243e..386ac7e3 100644 --- a/old_docs/API_docs_v62/methods/messages_sendInlineBotResult.md +++ b/old_docs/API_docs_v62/methods/messages_sendInlineBotResult.md @@ -1,22 +1,24 @@ --- title: messages.sendInlineBotResult -description: messages.sendInlineBotResult parameters, return type and example +description: Send a received bot result to the chat --- ## Method: messages.sendInlineBotResult [Back to methods index](index.md) +Send a received bot result to the chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional| -|background|[CLICK ME Bool](../types/Bool.md) | Optional| -|clear\_draft|[CLICK ME Bool](../types/Bool.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional| -|query\_id|[CLICK ME long](../types/long.md) | Yes| -|id|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Disable notifications?| +|background|[CLICK ME Bool](../types/Bool.md) | Optional|Disable background notifications?| +|clear\_draft|[CLICK ME Bool](../types/Bool.md) | Optional|Clear the message draft?| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the message| +|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| +|query\_id|[CLICK ME long](../types/long.md) | Yes|The inline query ID| +|id|[CLICK ME string](../types/string.md) | Yes|The result ID| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v62/methods/messages_setBotCallbackAnswer.md b/old_docs/API_docs_v62/methods/messages_setBotCallbackAnswer.md index 5590828e..e6dc6b09 100644 --- a/old_docs/API_docs_v62/methods/messages_setBotCallbackAnswer.md +++ b/old_docs/API_docs_v62/methods/messages_setBotCallbackAnswer.md @@ -1,20 +1,22 @@ --- title: messages.setBotCallbackAnswer -description: messages.setBotCallbackAnswer parameters, return type and example +description: Bots only: set the callback answer (after a button was clicked) --- ## Method: messages.setBotCallbackAnswer [Back to methods index](index.md) +Bots only: set the callback answer (after a button was clicked) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|alert|[CLICK ME Bool](../types/Bool.md) | Optional| -|query\_id|[CLICK ME long](../types/long.md) | Yes| -|message|[CLICK ME string](../types/string.md) | Optional| -|url|[CLICK ME string](../types/string.md) | Optional| -|cache\_time|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|alert|[CLICK ME Bool](../types/Bool.md) | Optional|Is this an alert?| +|query\_id|[CLICK ME long](../types/long.md) | Yes|The query ID| +|message|[CLICK ME string](../types/string.md) | Optional|The message| +|url|[CLICK ME string](../types/string.md) | Optional|The URL| +|cache\_time|[CLICK ME int](../types/int.md) | Yes|Cache time| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v62/methods/messages_setEncryptedTyping.md b/old_docs/API_docs_v62/methods/messages_setEncryptedTyping.md index 3183fedf..e9afe99c 100644 --- a/old_docs/API_docs_v62/methods/messages_setEncryptedTyping.md +++ b/old_docs/API_docs_v62/methods/messages_setEncryptedTyping.md @@ -12,8 +12,8 @@ Send typing notification to secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|| -|typing|[CLICK ME Bool](../types/Bool.md) | Yes|| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to send the notification| +|typing|[CLICK ME Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v62/methods/messages_setGameScore.md b/old_docs/API_docs_v62/methods/messages_setGameScore.md index c44145c0..aa1f4f0c 100644 --- a/old_docs/API_docs_v62/methods/messages_setGameScore.md +++ b/old_docs/API_docs_v62/methods/messages_setGameScore.md @@ -1,21 +1,23 @@ --- title: messages.setGameScore -description: messages.setGameScore parameters, return type and example +description: Set the game score --- ## Method: messages.setGameScore [Back to methods index](index.md) +Set the game score + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|edit\_message|[CLICK ME Bool](../types/Bool.md) | Optional| -|force|[CLICK ME Bool](../types/Bool.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|id|[CLICK ME int](../types/int.md) | Yes| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|score|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|edit\_message|[CLICK ME Bool](../types/Bool.md) | Optional|Should the message with the game be edited?| +|force|[CLICK ME Bool](../types/Bool.md) | Optional|Force setting the game score| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the game was sent| +|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the score| +|score|[CLICK ME int](../types/int.md) | Yes|The score| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v62/methods/messages_setInlineBotResults.md b/old_docs/API_docs_v62/methods/messages_setInlineBotResults.md index 915e3a4e..79493009 100644 --- a/old_docs/API_docs_v62/methods/messages_setInlineBotResults.md +++ b/old_docs/API_docs_v62/methods/messages_setInlineBotResults.md @@ -1,22 +1,24 @@ --- title: messages.setInlineBotResults -description: messages.setInlineBotResults parameters, return type and example +description: Bots only: set the results of an inline query --- ## Method: messages.setInlineBotResults [Back to methods index](index.md) +Bots only: set the results of an inline query + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|gallery|[CLICK ME Bool](../types/Bool.md) | Optional| -|private|[CLICK ME Bool](../types/Bool.md) | Optional| -|query\_id|[CLICK ME long](../types/long.md) | Yes| -|results|Array of [CLICK ME InputBotInlineResult](../types/InputBotInlineResult.md) | Yes| -|cache\_time|[CLICK ME int](../types/int.md) | Yes| -|next\_offset|[CLICK ME string](../types/string.md) | Optional| -|switch\_pm|[CLICK ME InlineBotSwitchPM](../types/InlineBotSwitchPM.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|gallery|[CLICK ME Bool](../types/Bool.md) | Optional|Is this a gallery?| +|private|[CLICK ME Bool](../types/Bool.md) | Optional|Is this result private (not cached)?| +|query\_id|[CLICK ME long](../types/long.md) | Yes|Query ID| +|results|Array of [CLICK ME InputBotInlineResult](../types/InputBotInlineResult.md) | Yes|Results| +|cache\_time|[CLICK ME int](../types/int.md) | Yes|Cache time| +|next\_offset|[CLICK ME string](../types/string.md) | Optional|The next offset| +|switch\_pm|[CLICK ME InlineBotSwitchPM](../types/InlineBotSwitchPM.md) | Optional|Switch to PM?| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v62/methods/messages_setInlineGameScore.md b/old_docs/API_docs_v62/methods/messages_setInlineGameScore.md index 55e2c063..385c8308 100644 --- a/old_docs/API_docs_v62/methods/messages_setInlineGameScore.md +++ b/old_docs/API_docs_v62/methods/messages_setInlineGameScore.md @@ -1,20 +1,22 @@ --- title: messages.setInlineGameScore -description: messages.setInlineGameScore parameters, return type and example +description: Set the game score of an inline message --- ## Method: messages.setInlineGameScore [Back to methods index](index.md) +Set the game score of an inline message + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|edit\_message|[CLICK ME Bool](../types/Bool.md) | Optional| -|force|[CLICK ME Bool](../types/Bool.md) | Optional| -|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|score|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|edit\_message|[CLICK ME Bool](../types/Bool.md) | Optional|Should the message with the game be edited?| +|force|[CLICK ME Bool](../types/Bool.md) | Optional|Force setting the game score| +|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The ID of the inline message| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the score| +|score|[CLICK ME int](../types/int.md) | Yes|The score| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v62/methods/messages_startBot.md b/old_docs/API_docs_v62/methods/messages_startBot.md index 0de0f1a5..94a4d86a 100644 --- a/old_docs/API_docs_v62/methods/messages_startBot.md +++ b/old_docs/API_docs_v62/methods/messages_startBot.md @@ -1,18 +1,20 @@ --- title: messages.startBot -description: messages.startBot parameters, return type and example +description: Start a bot --- ## Method: messages.startBot [Back to methods index](index.md) +Start a bot + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|start\_param|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot's ID or username| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to start the bot (@me or group ID/username)| +|start\_param|[CLICK ME string](../types/string.md) | Yes|The bot's start parameter| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v62/methods/messages_toggleChatAdmins.md b/old_docs/API_docs_v62/methods/messages_toggleChatAdmins.md index d56e5753..ab591fd9 100644 --- a/old_docs/API_docs_v62/methods/messages_toggleChatAdmins.md +++ b/old_docs/API_docs_v62/methods/messages_toggleChatAdmins.md @@ -1,17 +1,19 @@ --- title: messages.toggleChatAdmins -description: messages.toggleChatAdmins parameters, return type and example +description: Enable all users are admins in normal groups (not supergroups) --- ## Method: messages.toggleChatAdmins [Back to methods index](index.md) +Enable all users are admins in normal groups (not supergroups) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Group ID| +|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Enable all users are admins| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v62/methods/messages_toggleDialogPin.md b/old_docs/API_docs_v62/methods/messages_toggleDialogPin.md index d6dc9692..2bd6a03d 100644 --- a/old_docs/API_docs_v62/methods/messages_toggleDialogPin.md +++ b/old_docs/API_docs_v62/methods/messages_toggleDialogPin.md @@ -1,17 +1,19 @@ --- title: messages.toggleDialogPin -description: messages.toggleDialogPin parameters, return type and example +description: Pin or unpin dialog --- ## Method: messages.toggleDialogPin [Back to methods index](index.md) +Pin or unpin dialog + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|pinned|[CLICK ME Bool](../types/Bool.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|pinned|[CLICK ME Bool](../types/Bool.md) | Optional|Pin or unpin the dialog?| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer to pin| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v62/methods/messages_uninstallStickerSet.md b/old_docs/API_docs_v62/methods/messages_uninstallStickerSet.md index 60b0ca0c..6d04e847 100644 --- a/old_docs/API_docs_v62/methods/messages_uninstallStickerSet.md +++ b/old_docs/API_docs_v62/methods/messages_uninstallStickerSet.md @@ -1,16 +1,18 @@ --- title: messages.uninstallStickerSet -description: messages.uninstallStickerSet parameters, return type and example +description: Remove a sticker set --- ## Method: messages.uninstallStickerSet [Back to methods index](index.md) +Remove a sticker set + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to remove| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v62/methods/photos_deletePhotos.md b/old_docs/API_docs_v62/methods/photos_deletePhotos.md index 104459b7..b9daca10 100644 --- a/old_docs/API_docs_v62/methods/photos_deletePhotos.md +++ b/old_docs/API_docs_v62/methods/photos_deletePhotos.md @@ -1,16 +1,18 @@ --- title: photos.deletePhotos -description: photos.deletePhotos parameters, return type and example +description: Delete profile photos --- ## Method: photos.deletePhotos [Back to methods index](index.md) +Delete profile photos + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Yes|The profile photos to delete| ### Return type: [Vector\_of\_long](../types/long.md) diff --git a/old_docs/API_docs_v62/methods/photos_getUserPhotos.md b/old_docs/API_docs_v62/methods/photos_getUserPhotos.md index 1a7515ba..ea27a44f 100644 --- a/old_docs/API_docs_v62/methods/photos_getUserPhotos.md +++ b/old_docs/API_docs_v62/methods/photos_getUserPhotos.md @@ -1,19 +1,21 @@ --- title: photos.getUserPhotos -description: photos.getUserPhotos parameters, return type and example +description: Get the profile photos of a user --- ## Method: photos.getUserPhotos [Back to methods index](index.md) +Get the profile photos of a user + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|offset|[CLICK ME int](../types/int.md) | Yes| -|max\_id|[CLICK ME long](../types/long.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| +|offset|[CLICK ME int](../types/int.md) | Yes|Offset| +|max\_id|[CLICK ME long](../types/long.md) | Yes|Maximum ID of photo to return| +|limit|[CLICK ME int](../types/int.md) | Yes|Number of photos to return| ### Return type: [photos\_Photos](../types/photos_Photos.md) diff --git a/old_docs/API_docs_v62/methods/photos_updateProfilePhoto.md b/old_docs/API_docs_v62/methods/photos_updateProfilePhoto.md index 28ab5fbf..7f0a4c69 100644 --- a/old_docs/API_docs_v62/methods/photos_updateProfilePhoto.md +++ b/old_docs/API_docs_v62/methods/photos_updateProfilePhoto.md @@ -1,16 +1,18 @@ --- title: photos.updateProfilePhoto -description: photos.updateProfilePhoto parameters, return type and example +description: Update the profile photo (use photos->uploadProfilePhoto to upload the photo) --- ## Method: photos.updateProfilePhoto [Back to methods index](index.md) +Update the profile photo (use photos->uploadProfilePhoto to upload the photo) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional|The photo to use| ### Return type: [UserProfilePhoto](../types/UserProfilePhoto.md) diff --git a/old_docs/API_docs_v62/methods/photos_uploadProfilePhoto.md b/old_docs/API_docs_v62/methods/photos_uploadProfilePhoto.md index 7cc9e9e5..efa08bb0 100644 --- a/old_docs/API_docs_v62/methods/photos_uploadProfilePhoto.md +++ b/old_docs/API_docs_v62/methods/photos_uploadProfilePhoto.md @@ -1,16 +1,18 @@ --- title: photos.uploadProfilePhoto -description: photos.uploadProfilePhoto parameters, return type and example +description: Upload profile photo --- ## Method: photos.uploadProfilePhoto [Back to methods index](index.md) +Upload profile photo + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|file|[File path or InputFile](../types/InputFile.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|file|[File path or InputFile](../types/InputFile.md) | Yes|The photo| ### Return type: [photos\_Photo](../types/photos_Photo.md) diff --git a/old_docs/API_docs_v65/methods/account_registerDevice.md b/old_docs/API_docs_v65/methods/account_registerDevice.md index cd28abcd..017b9af3 100644 --- a/old_docs/API_docs_v65/methods/account_registerDevice.md +++ b/old_docs/API_docs_v65/methods/account_registerDevice.md @@ -12,8 +12,8 @@ Register device for push notifications | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and oTher, see source code of official apps for more info| +|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and oTher, see source code of official apps for more info| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v65/methods/account_unregisterDevice.md b/old_docs/API_docs_v65/methods/account_unregisterDevice.md index 1d2b7670..32e44495 100644 --- a/old_docs/API_docs_v65/methods/account_unregisterDevice.md +++ b/old_docs/API_docs_v65/methods/account_unregisterDevice.md @@ -12,8 +12,8 @@ Stop sending PUSH notifications to app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and oTher, see source code of official apps for more info| +|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and oTher, see source code of official apps for more info| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v65/methods/bots_answerWebhookJSONQuery.md b/old_docs/API_docs_v65/methods/bots_answerWebhookJSONQuery.md index 205b30f9..61056bb4 100644 --- a/old_docs/API_docs_v65/methods/bots_answerWebhookJSONQuery.md +++ b/old_docs/API_docs_v65/methods/bots_answerWebhookJSONQuery.md @@ -1,17 +1,19 @@ --- title: bots.answerWebhookJSONQuery -description: bots.answerWebhookJSONQuery parameters, return type and example +description: Send webhook request via bot API --- ## Method: bots.answerWebhookJSONQuery [Back to methods index](index.md) +Send webhook request via bot API + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|query\_id|[CLICK ME long](../types/long.md) | Yes| -|data|[CLICK ME DataJSON](../types/DataJSON.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|query\_id|[CLICK ME long](../types/long.md) | Yes|The query ID| +|data|[CLICK ME DataJSON](../types/DataJSON.md) | Yes|The parameters| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v65/methods/bots_sendCustomRequest.md b/old_docs/API_docs_v65/methods/bots_sendCustomRequest.md index 590c47b6..fc8e764d 100644 --- a/old_docs/API_docs_v65/methods/bots_sendCustomRequest.md +++ b/old_docs/API_docs_v65/methods/bots_sendCustomRequest.md @@ -1,17 +1,19 @@ --- title: bots.sendCustomRequest -description: bots.sendCustomRequest parameters, return type and example +description: Send a custom request to the bot API --- ## Method: bots.sendCustomRequest [Back to methods index](index.md) +Send a custom request to the bot API + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|custom\_method|[CLICK ME string](../types/string.md) | Yes| -|params|[CLICK ME DataJSON](../types/DataJSON.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|custom\_method|[CLICK ME string](../types/string.md) | Yes|The method to call| +|params|[CLICK ME DataJSON](../types/DataJSON.md) | Yes|Method parameters| ### Return type: [DataJSON](../types/DataJSON.md) diff --git a/old_docs/API_docs_v65/methods/channels_checkUsername.md b/old_docs/API_docs_v65/methods/channels_checkUsername.md index 371f4cd3..7bc7c245 100644 --- a/old_docs/API_docs_v65/methods/channels_checkUsername.md +++ b/old_docs/API_docs_v65/methods/channels_checkUsername.md @@ -1,17 +1,19 @@ --- title: channels.checkUsername -description: channels.checkUsername parameters, return type and example +description: Check if this username is free and can be assigned to a channel/supergroup --- ## Method: channels.checkUsername [Back to methods index](index.md) +Check if this username is free and can be assigned to a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|username|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|username|[CLICK ME string](../types/string.md) | Yes|The new username for this channel/supergroup| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v65/methods/channels_createChannel.md b/old_docs/API_docs_v65/methods/channels_createChannel.md index c5d21585..1305e4fb 100644 --- a/old_docs/API_docs_v65/methods/channels_createChannel.md +++ b/old_docs/API_docs_v65/methods/channels_createChannel.md @@ -1,19 +1,21 @@ --- title: channels.createChannel -description: channels.createChannel parameters, return type and example +description: Create channel/supergroup --- ## Method: channels.createChannel [Back to methods index](index.md) +Create channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|broadcast|[CLICK ME Bool](../types/Bool.md) | Optional| -|megagroup|[CLICK ME Bool](../types/Bool.md) | Optional| -|title|[CLICK ME string](../types/string.md) | Yes| -|about|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|broadcast|[CLICK ME Bool](../types/Bool.md) | Optional|Set this to true to create a channel| +|megagroup|[CLICK ME Bool](../types/Bool.md) | Optional|Set this to true to create a supergroup| +|title|[CLICK ME string](../types/string.md) | Yes|Supergroup/channel title| +|about|[CLICK ME string](../types/string.md) | Yes|About text| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v65/methods/channels_deleteChannel.md b/old_docs/API_docs_v65/methods/channels_deleteChannel.md index 61b29eac..e660d25c 100644 --- a/old_docs/API_docs_v65/methods/channels_deleteChannel.md +++ b/old_docs/API_docs_v65/methods/channels_deleteChannel.md @@ -1,16 +1,18 @@ --- title: channels.deleteChannel -description: channels.deleteChannel parameters, return type and example +description: Delete a channel/supergroup --- ## Method: channels.deleteChannel [Back to methods index](index.md) +Delete a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup to delete| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v65/methods/channels_deleteMessages.md b/old_docs/API_docs_v65/methods/channels_deleteMessages.md index 87a968c5..fb9d3cc2 100644 --- a/old_docs/API_docs_v65/methods/channels_deleteMessages.md +++ b/old_docs/API_docs_v65/methods/channels_deleteMessages.md @@ -1,17 +1,19 @@ --- title: channels.deleteMessages -description: channels.deleteMessages parameters, return type and example +description: Delete channel/supergroup messages --- ## Method: channels.deleteMessages [Back to methods index](index.md) +Delete channel/supergroup messages + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|id|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to delete| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v65/methods/channels_deleteUserHistory.md b/old_docs/API_docs_v65/methods/channels_deleteUserHistory.md index ee828f45..fbe34341 100644 --- a/old_docs/API_docs_v65/methods/channels_deleteUserHistory.md +++ b/old_docs/API_docs_v65/methods/channels_deleteUserHistory.md @@ -1,17 +1,19 @@ --- title: channels.deleteUserHistory -description: channels.deleteUserHistory parameters, return type and example +description: Delete all messages of a user in a channel/supergroup --- ## Method: channels.deleteUserHistory [Back to methods index](index.md) +Delete all messages of a user in a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) diff --git a/old_docs/API_docs_v65/methods/channels_editAbout.md b/old_docs/API_docs_v65/methods/channels_editAbout.md index 94be2503..8908f29e 100644 --- a/old_docs/API_docs_v65/methods/channels_editAbout.md +++ b/old_docs/API_docs_v65/methods/channels_editAbout.md @@ -1,17 +1,19 @@ --- title: channels.editAbout -description: channels.editAbout parameters, return type and example +description: Edit the about text of a channel/supergroup --- ## Method: channels.editAbout [Back to methods index](index.md) +Edit the about text of a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|about|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|about|[CLICK ME string](../types/string.md) | Yes|The new about text| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v65/methods/channels_editAdmin.md b/old_docs/API_docs_v65/methods/channels_editAdmin.md index e1917c89..695c5294 100644 --- a/old_docs/API_docs_v65/methods/channels_editAdmin.md +++ b/old_docs/API_docs_v65/methods/channels_editAdmin.md @@ -1,18 +1,20 @@ --- title: channels.editAdmin -description: channels.editAdmin parameters, return type and example +description: Edit admin permissions of a user in a channel/supergroup --- ## Method: channels.editAdmin [Back to methods index](index.md) +Edit admin permissions of a user in a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|role|[CLICK ME ChannelParticipantRole](../types/ChannelParticipantRole.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| +|role|[CLICK ME ChannelParticipantRole](../types/ChannelParticipantRole.md) | Yes|| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v65/methods/channels_editPhoto.md b/old_docs/API_docs_v65/methods/channels_editPhoto.md index 3a2c794b..9ccd864f 100644 --- a/old_docs/API_docs_v65/methods/channels_editPhoto.md +++ b/old_docs/API_docs_v65/methods/channels_editPhoto.md @@ -1,17 +1,19 @@ --- title: channels.editPhoto -description: channels.editPhoto parameters, return type and example +description: Edit the photo of a supergroup/channel --- ## Method: channels.editPhoto [Back to methods index](index.md) +Edit the photo of a supergroup/channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new photo| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v65/methods/channels_editTitle.md b/old_docs/API_docs_v65/methods/channels_editTitle.md index ec60e10f..b1024faf 100644 --- a/old_docs/API_docs_v65/methods/channels_editTitle.md +++ b/old_docs/API_docs_v65/methods/channels_editTitle.md @@ -1,17 +1,19 @@ --- title: channels.editTitle -description: channels.editTitle parameters, return type and example +description: Edit the title of a supergroup/channel --- ## Method: channels.editTitle [Back to methods index](index.md) +Edit the title of a supergroup/channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|title|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|title|[CLICK ME string](../types/string.md) | Yes|The new channel/supergroup title| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v65/methods/channels_exportInvite.md b/old_docs/API_docs_v65/methods/channels_exportInvite.md index 3c10f832..f0c737d5 100644 --- a/old_docs/API_docs_v65/methods/channels_exportInvite.md +++ b/old_docs/API_docs_v65/methods/channels_exportInvite.md @@ -1,16 +1,18 @@ --- title: channels.exportInvite -description: channels.exportInvite parameters, return type and example +description: Export the invite link of a channel --- ## Method: channels.exportInvite [Back to methods index](index.md) +Export the invite link of a channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| ### Return type: [ExportedChatInvite](../types/ExportedChatInvite.md) diff --git a/old_docs/API_docs_v65/methods/channels_exportMessageLink.md b/old_docs/API_docs_v65/methods/channels_exportMessageLink.md index 924dc0d5..f910b594 100644 --- a/old_docs/API_docs_v65/methods/channels_exportMessageLink.md +++ b/old_docs/API_docs_v65/methods/channels_exportMessageLink.md @@ -1,17 +1,19 @@ --- title: channels.exportMessageLink -description: channels.exportMessageLink parameters, return type and example +description: Get the link of a message in a channel --- ## Method: channels.exportMessageLink [Back to methods index](index.md) +Get the link of a message in a channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|id|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|id|[CLICK ME int](../types/int.md) | Yes|The ID of the message| ### Return type: [ExportedMessageLink](../types/ExportedMessageLink.md) diff --git a/old_docs/API_docs_v65/methods/channels_getAdminedPublicChannels.md b/old_docs/API_docs_v65/methods/channels_getAdminedPublicChannels.md index f2b48050..9646f529 100644 --- a/old_docs/API_docs_v65/methods/channels_getAdminedPublicChannels.md +++ b/old_docs/API_docs_v65/methods/channels_getAdminedPublicChannels.md @@ -1,11 +1,13 @@ --- title: channels.getAdminedPublicChannels -description: channels.getAdminedPublicChannels parameters, return type and example +description: Get all supergroups/channels where you're admin --- ## Method: channels.getAdminedPublicChannels [Back to methods index](index.md) +Get all supergroups/channels where you're admin + ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v65/methods/channels_getChannels.md b/old_docs/API_docs_v65/methods/channels_getChannels.md index bd5958d6..9cd9e798 100644 --- a/old_docs/API_docs_v65/methods/channels_getChannels.md +++ b/old_docs/API_docs_v65/methods/channels_getChannels.md @@ -1,16 +1,18 @@ --- title: channels.getChannels -description: channels.getChannels parameters, return type and example +description: Get info about multiple channels/supergroups --- ## Method: channels.getChannels [Back to methods index](index.md) +Get info about multiple channels/supergroups + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|Array of [Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|Array of [Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Yes|The channel/supergroup MTProto IDs| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v65/methods/channels_getMessages.md b/old_docs/API_docs_v65/methods/channels_getMessages.md index 4440856c..cc944fe5 100644 --- a/old_docs/API_docs_v65/methods/channels_getMessages.md +++ b/old_docs/API_docs_v65/methods/channels_getMessages.md @@ -1,17 +1,19 @@ --- title: channels.getMessages -description: channels.getMessages parameters, return type and example +description: Get channel/supergroup messages --- ## Method: channels.getMessages [Back to methods index](index.md) +Get channel/supergroup messages + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|id|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The message IDs| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v65/methods/channels_getParticipant.md b/old_docs/API_docs_v65/methods/channels_getParticipant.md index c1819b6b..db9b1fc6 100644 --- a/old_docs/API_docs_v65/methods/channels_getParticipant.md +++ b/old_docs/API_docs_v65/methods/channels_getParticipant.md @@ -1,17 +1,19 @@ --- title: channels.getParticipant -description: channels.getParticipant parameters, return type and example +description: Get info about a certain channel/supergroup participant --- ## Method: channels.getParticipant [Back to methods index](index.md) +Get info about a certain channel/supergroup participant + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to fetch info about| ### Return type: [channels\_ChannelParticipant](../types/channels_ChannelParticipant.md) diff --git a/old_docs/API_docs_v65/methods/channels_getParticipants.md b/old_docs/API_docs_v65/methods/channels_getParticipants.md index 7ec8a980..96662466 100644 --- a/old_docs/API_docs_v65/methods/channels_getParticipants.md +++ b/old_docs/API_docs_v65/methods/channels_getParticipants.md @@ -1,19 +1,21 @@ --- title: channels.getParticipants -description: channels.getParticipants parameters, return type and example +description: Get channel/supergroup participants (you should use `$MadelineProto->get_pwr_chat($id)` instead) --- ## Method: channels.getParticipants [Back to methods index](index.md) +Get channel/supergroup participants (you should use `$MadelineProto->get_pwr_chat($id)` instead) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|filter|[CLICK ME ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) | Yes| -|offset|[CLICK ME int](../types/int.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|filter|[CLICK ME ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) | Yes|Member filter| +|offset|[CLICK ME int](../types/int.md) | Yes|Offset| +|limit|[CLICK ME int](../types/int.md) | Yes|Limit| ### Return type: [channels\_ChannelParticipants](../types/channels_ChannelParticipants.md) diff --git a/old_docs/API_docs_v65/methods/channels_inviteToChannel.md b/old_docs/API_docs_v65/methods/channels_inviteToChannel.md index 9bca2967..676f800c 100644 --- a/old_docs/API_docs_v65/methods/channels_inviteToChannel.md +++ b/old_docs/API_docs_v65/methods/channels_inviteToChannel.md @@ -1,17 +1,19 @@ --- title: channels.inviteToChannel -description: channels.inviteToChannel parameters, return type and example +description: Add users to channel/supergroup --- ## Method: channels.inviteToChannel [Back to methods index](index.md) +Add users to channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to add| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v65/methods/channels_joinChannel.md b/old_docs/API_docs_v65/methods/channels_joinChannel.md index 9ecdbe75..721f707c 100644 --- a/old_docs/API_docs_v65/methods/channels_joinChannel.md +++ b/old_docs/API_docs_v65/methods/channels_joinChannel.md @@ -1,16 +1,18 @@ --- title: channels.joinChannel -description: channels.joinChannel parameters, return type and example +description: Join a channel/supergroup --- ## Method: channels.joinChannel [Back to methods index](index.md) +Join a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup to join| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v65/methods/channels_leaveChannel.md b/old_docs/API_docs_v65/methods/channels_leaveChannel.md index 62c20a00..7f02e08c 100644 --- a/old_docs/API_docs_v65/methods/channels_leaveChannel.md +++ b/old_docs/API_docs_v65/methods/channels_leaveChannel.md @@ -1,16 +1,18 @@ --- title: channels.leaveChannel -description: channels.leaveChannel parameters, return type and example +description: Leave a channel/supergroup --- ## Method: channels.leaveChannel [Back to methods index](index.md) +Leave a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup to leave| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v65/methods/channels_readHistory.md b/old_docs/API_docs_v65/methods/channels_readHistory.md index 745893f6..cca891f0 100644 --- a/old_docs/API_docs_v65/methods/channels_readHistory.md +++ b/old_docs/API_docs_v65/methods/channels_readHistory.md @@ -1,17 +1,19 @@ --- title: channels.readHistory -description: channels.readHistory parameters, return type and example +description: Mark channel/supergroup history as read --- ## Method: channels.readHistory [Back to methods index](index.md) +Mark channel/supergroup history as read + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|max\_id|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to mark as read| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v65/methods/channels_reportSpam.md b/old_docs/API_docs_v65/methods/channels_reportSpam.md index 47dd7cff..09af14e0 100644 --- a/old_docs/API_docs_v65/methods/channels_reportSpam.md +++ b/old_docs/API_docs_v65/methods/channels_reportSpam.md @@ -1,18 +1,20 @@ --- title: channels.reportSpam -description: channels.reportSpam parameters, return type and example +description: Report a supergroup/channel for spam --- ## Method: channels.reportSpam [Back to methods index](index.md) +Report a supergroup/channel for spam + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|id|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that added you to this channel| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to report| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v65/methods/channels_toggleInvites.md b/old_docs/API_docs_v65/methods/channels_toggleInvites.md index b6771ed3..5b541f67 100644 --- a/old_docs/API_docs_v65/methods/channels_toggleInvites.md +++ b/old_docs/API_docs_v65/methods/channels_toggleInvites.md @@ -1,17 +1,19 @@ --- title: channels.toggleInvites -description: channels.toggleInvites parameters, return type and example +description: Allow or disallow any user to invite users to this channel/supergroup --- ## Method: channels.toggleInvites [Back to methods index](index.md) +Allow or disallow any user to invite users to this channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Allow or disallow| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v65/methods/channels_toggleSignatures.md b/old_docs/API_docs_v65/methods/channels_toggleSignatures.md index e8ff70a8..f233a8e1 100644 --- a/old_docs/API_docs_v65/methods/channels_toggleSignatures.md +++ b/old_docs/API_docs_v65/methods/channels_toggleSignatures.md @@ -1,17 +1,19 @@ --- title: channels.toggleSignatures -description: channels.toggleSignatures parameters, return type and example +description: Toggle channel signatures --- ## Method: channels.toggleSignatures [Back to methods index](index.md) +Toggle channel signatures + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Enable or disable channel signatures?| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v65/methods/channels_updatePinnedMessage.md b/old_docs/API_docs_v65/methods/channels_updatePinnedMessage.md index 7a14b68b..f06d1f0f 100644 --- a/old_docs/API_docs_v65/methods/channels_updatePinnedMessage.md +++ b/old_docs/API_docs_v65/methods/channels_updatePinnedMessage.md @@ -1,18 +1,20 @@ --- title: channels.updatePinnedMessage -description: channels.updatePinnedMessage parameters, return type and example +description: Set the pinned message of a channel/supergroup --- ## Method: channels.updatePinnedMessage [Back to methods index](index.md) +Set the pinned message of a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|id|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Pin silently| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|id|[CLICK ME int](../types/int.md) | Yes|The ID of the message to pin| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v65/methods/channels_updateUsername.md b/old_docs/API_docs_v65/methods/channels_updateUsername.md index 19647598..ad34490a 100644 --- a/old_docs/API_docs_v65/methods/channels_updateUsername.md +++ b/old_docs/API_docs_v65/methods/channels_updateUsername.md @@ -1,17 +1,19 @@ --- title: channels.updateUsername -description: channels.updateUsername parameters, return type and example +description: Update the username of a supergroup/channel --- ## Method: channels.updateUsername [Back to methods index](index.md) +Update the username of a supergroup/channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|username|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|username|[CLICK ME string](../types/string.md) | Yes|The new username| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v65/methods/contacts_getBlocked.md b/old_docs/API_docs_v65/methods/contacts_getBlocked.md index d7d8c5cc..300025af 100644 --- a/old_docs/API_docs_v65/methods/contacts_getBlocked.md +++ b/old_docs/API_docs_v65/methods/contacts_getBlocked.md @@ -12,7 +12,7 @@ Get blocked users | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, then set to the number of blocked contacts previously fetched| +|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, Then set to the number of blocked contacts previously fetched| |limit|[CLICK ME int](../types/int.md) | Yes|How many blocked contacts to fetch| diff --git a/old_docs/API_docs_v65/methods/contacts_getTopPeers.md b/old_docs/API_docs_v65/methods/contacts_getTopPeers.md index 2bad9a2a..b3f51975 100644 --- a/old_docs/API_docs_v65/methods/contacts_getTopPeers.md +++ b/old_docs/API_docs_v65/methods/contacts_getTopPeers.md @@ -17,7 +17,7 @@ Get most used chats |bots\_inline|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch inline bots?| |groups|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch groups?| |channels|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch channels and supergroups?| -|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, then `$offset += $contacts_TopPeers['categories']['count'];`| +|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, Then `$offset += $contacts_TopPeers['categories']['count'];`| |limit|[CLICK ME int](../types/int.md) | Yes|How many results to fetch| |hash|[CLICK ME int](../types/int.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched peer ids);| diff --git a/old_docs/API_docs_v65/methods/help_getAppChangelog.md b/old_docs/API_docs_v65/methods/help_getAppChangelog.md index ea7192f6..477df2f8 100644 --- a/old_docs/API_docs_v65/methods/help_getAppChangelog.md +++ b/old_docs/API_docs_v65/methods/help_getAppChangelog.md @@ -1,16 +1,18 @@ --- title: help.getAppChangelog -description: help.getAppChangelog parameters, return type and example +description: Get the changelog of this app --- ## Method: help.getAppChangelog [Back to methods index](index.md) +Get the changelog of this app + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|prev\_app\_version|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|prev\_app\_version|[CLICK ME string](../types/string.md) | Yes|Previous app version| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v65/methods/help_getAppUpdate.md b/old_docs/API_docs_v65/methods/help_getAppUpdate.md index ef72cce2..b88906ae 100644 --- a/old_docs/API_docs_v65/methods/help_getAppUpdate.md +++ b/old_docs/API_docs_v65/methods/help_getAppUpdate.md @@ -1,11 +1,13 @@ --- title: help.getAppUpdate -description: help.getAppUpdate parameters, return type and example +description: Get info about app updates --- ## Method: help.getAppUpdate [Back to methods index](index.md) +Get info about app updates + ### Return type: [help\_AppUpdate](../types/help_AppUpdate.md) diff --git a/old_docs/API_docs_v65/methods/help_getConfig.md b/old_docs/API_docs_v65/methods/help_getConfig.md index 885ad5d3..16e25c68 100644 --- a/old_docs/API_docs_v65/methods/help_getConfig.md +++ b/old_docs/API_docs_v65/methods/help_getConfig.md @@ -1,11 +1,13 @@ --- title: help.getConfig -description: help.getConfig parameters, return type and example +description: Get server configuration --- ## Method: help.getConfig [Back to methods index](index.md) +Get server configuration + ### Return type: [Config](../types/Config.md) diff --git a/old_docs/API_docs_v65/methods/help_getInviteText.md b/old_docs/API_docs_v65/methods/help_getInviteText.md index 101ead40..6b226bff 100644 --- a/old_docs/API_docs_v65/methods/help_getInviteText.md +++ b/old_docs/API_docs_v65/methods/help_getInviteText.md @@ -1,11 +1,13 @@ --- title: help.getInviteText -description: help.getInviteText parameters, return type and example +description: Get invitation text --- ## Method: help.getInviteText [Back to methods index](index.md) +Get invitation text + ### Return type: [help\_InviteText](../types/help_InviteText.md) diff --git a/old_docs/API_docs_v65/methods/help_getNearestDc.md b/old_docs/API_docs_v65/methods/help_getNearestDc.md index 6196890b..35a8bf91 100644 --- a/old_docs/API_docs_v65/methods/help_getNearestDc.md +++ b/old_docs/API_docs_v65/methods/help_getNearestDc.md @@ -1,11 +1,13 @@ --- title: help.getNearestDc -description: help.getNearestDc parameters, return type and example +description: Get nearest datacenter --- ## Method: help.getNearestDc [Back to methods index](index.md) +Get nearest datacenter + ### Return type: [NearestDc](../types/NearestDc.md) diff --git a/old_docs/API_docs_v65/methods/help_getSupport.md b/old_docs/API_docs_v65/methods/help_getSupport.md index 9b269f78..a5bab0f2 100644 --- a/old_docs/API_docs_v65/methods/help_getSupport.md +++ b/old_docs/API_docs_v65/methods/help_getSupport.md @@ -1,11 +1,13 @@ --- title: help.getSupport -description: help.getSupport parameters, return type and example +description: Get info of support user --- ## Method: help.getSupport [Back to methods index](index.md) +Get info of support user + ### Return type: [help\_Support](../types/help_Support.md) diff --git a/old_docs/API_docs_v65/methods/help_getTermsOfService.md b/old_docs/API_docs_v65/methods/help_getTermsOfService.md index f63807ab..487cd83a 100644 --- a/old_docs/API_docs_v65/methods/help_getTermsOfService.md +++ b/old_docs/API_docs_v65/methods/help_getTermsOfService.md @@ -1,11 +1,13 @@ --- title: help.getTermsOfService -description: help.getTermsOfService parameters, return type and example +description: Get terms of service --- ## Method: help.getTermsOfService [Back to methods index](index.md) +Get terms of service + ### Return type: [help\_TermsOfService](../types/help_TermsOfService.md) diff --git a/old_docs/API_docs_v65/methods/help_saveAppLog.md b/old_docs/API_docs_v65/methods/help_saveAppLog.md index af6e94e2..0165b6e3 100644 --- a/old_docs/API_docs_v65/methods/help_saveAppLog.md +++ b/old_docs/API_docs_v65/methods/help_saveAppLog.md @@ -1,16 +1,18 @@ --- title: help.saveAppLog -description: help.saveAppLog parameters, return type and example +description: Log data for developer of this app --- ## Method: help.saveAppLog [Back to methods index](index.md) +Log data for developer of this app + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|events|Array of [CLICK ME InputAppEvent](../types/InputAppEvent.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|events|Array of [CLICK ME InputAppEvent](../types/InputAppEvent.md) | Yes|Event list| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v65/methods/help_setBotUpdatesStatus.md b/old_docs/API_docs_v65/methods/help_setBotUpdatesStatus.md index 3351fab4..ff314b5c 100644 --- a/old_docs/API_docs_v65/methods/help_setBotUpdatesStatus.md +++ b/old_docs/API_docs_v65/methods/help_setBotUpdatesStatus.md @@ -1,17 +1,19 @@ --- title: help.setBotUpdatesStatus -description: help.setBotUpdatesStatus parameters, return type and example +description: Set the update status of webhook --- ## Method: help.setBotUpdatesStatus [Back to methods index](index.md) +Set the update status of webhook + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|pending\_updates\_count|[CLICK ME int](../types/int.md) | Yes| -|message|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|pending\_updates\_count|[CLICK ME int](../types/int.md) | Yes|Pending update count| +|message|[CLICK ME string](../types/string.md) | Yes|Message| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v65/methods/messages_checkChatInvite.md b/old_docs/API_docs_v65/methods/messages_checkChatInvite.md index 4ddf5084..de1d9ff4 100644 --- a/old_docs/API_docs_v65/methods/messages_checkChatInvite.md +++ b/old_docs/API_docs_v65/methods/messages_checkChatInvite.md @@ -1,16 +1,18 @@ --- title: messages.checkChatInvite -description: messages.checkChatInvite parameters, return type and example +description: Check if an invitation link is valid --- ## Method: messages.checkChatInvite [Back to methods index](index.md) +Check if an invitation link is valid + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| ### Return type: [ChatInvite](../types/ChatInvite.md) diff --git a/old_docs/API_docs_v65/methods/messages_clearRecentStickers.md b/old_docs/API_docs_v65/methods/messages_clearRecentStickers.md index f017087f..9c1b3754 100644 --- a/old_docs/API_docs_v65/methods/messages_clearRecentStickers.md +++ b/old_docs/API_docs_v65/methods/messages_clearRecentStickers.md @@ -1,16 +1,18 @@ --- title: messages.clearRecentStickers -description: messages.clearRecentStickers parameters, return type and example +description: Clear all recent stickers --- ## Method: messages.clearRecentStickers [Back to methods index](index.md) +Clear all recent stickers + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|attached|[CLICK ME Bool](../types/Bool.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|attached|[CLICK ME Bool](../types/Bool.md) | Optional|Clear recent stickers attached to images?| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v65/methods/messages_deleteChatUser.md b/old_docs/API_docs_v65/methods/messages_deleteChatUser.md index a71f4aaf..0a6830de 100644 --- a/old_docs/API_docs_v65/methods/messages_deleteChatUser.md +++ b/old_docs/API_docs_v65/methods/messages_deleteChatUser.md @@ -12,7 +12,7 @@ Delete a user from a chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The MTProto ID of the chat| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to delete (pass @me to leave the chat)| diff --git a/old_docs/API_docs_v65/methods/messages_editChatAdmin.md b/old_docs/API_docs_v65/methods/messages_editChatAdmin.md index 6bc8f9ae..7916f8b1 100644 --- a/old_docs/API_docs_v65/methods/messages_editChatAdmin.md +++ b/old_docs/API_docs_v65/methods/messages_editChatAdmin.md @@ -1,18 +1,20 @@ --- title: messages.editChatAdmin -description: messages.editChatAdmin parameters, return type and example +description: Edit admin permissions --- ## Method: messages.editChatAdmin [Back to methods index](index.md) +Edit admin permissions + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|is\_admin|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat ID (no supergroups)| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user ID| +|is\_admin|[CLICK ME Bool](../types/Bool.md) | Yes|Should the user be admin?| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v65/methods/messages_editChatPhoto.md b/old_docs/API_docs_v65/methods/messages_editChatPhoto.md index 8848eca7..122913c4 100644 --- a/old_docs/API_docs_v65/methods/messages_editChatPhoto.md +++ b/old_docs/API_docs_v65/methods/messages_editChatPhoto.md @@ -12,7 +12,7 @@ Edit the photo of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The MTProto ID of the chat| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| |photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| diff --git a/old_docs/API_docs_v65/methods/messages_editChatTitle.md b/old_docs/API_docs_v65/methods/messages_editChatTitle.md index 1c1c7a16..3a1e974b 100644 --- a/old_docs/API_docs_v65/methods/messages_editChatTitle.md +++ b/old_docs/API_docs_v65/methods/messages_editChatTitle.md @@ -12,7 +12,7 @@ Edit the title of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The MTProto ID of the chat| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| |title|[CLICK ME string](../types/string.md) | Yes|The new title| diff --git a/old_docs/API_docs_v65/methods/messages_editInlineBotMessage.md b/old_docs/API_docs_v65/methods/messages_editInlineBotMessage.md index c0d06614..2237fb20 100644 --- a/old_docs/API_docs_v65/methods/messages_editInlineBotMessage.md +++ b/old_docs/API_docs_v65/methods/messages_editInlineBotMessage.md @@ -1,20 +1,22 @@ --- title: messages.editInlineBotMessage -description: messages.editInlineBotMessage parameters, return type and example +description: Edit a sent inline message --- ## Method: messages.editInlineBotMessage [Back to methods index](index.md) +Edit a sent inline message + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional| -|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes| -|message|[CLICK ME string](../types/string.md) | Optional| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview| +|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The message ID| +|message|[CLICK ME string](../types/string.md) | Optional|The new message| +|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| +|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/old_docs/API_docs_v65/methods/messages_editMessage.md b/old_docs/API_docs_v65/methods/messages_editMessage.md index 2e98318d..177438a5 100644 --- a/old_docs/API_docs_v65/methods/messages_editMessage.md +++ b/old_docs/API_docs_v65/methods/messages_editMessage.md @@ -1,21 +1,23 @@ --- title: messages.editMessage -description: messages.editMessage parameters, return type and example +description: Edit a message --- ## Method: messages.editMessage [Back to methods index](index.md) +Edit a message + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|id|[CLICK ME int](../types/int.md) | Yes| -|message|[CLICK ME string](../types/string.md) | Optional| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| +|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|message|[CLICK ME string](../types/string.md) | Optional|The new message| +|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| +|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/old_docs/API_docs_v65/methods/messages_exportChatInvite.md b/old_docs/API_docs_v65/methods/messages_exportChatInvite.md index 74d70c21..98685d96 100644 --- a/old_docs/API_docs_v65/methods/messages_exportChatInvite.md +++ b/old_docs/API_docs_v65/methods/messages_exportChatInvite.md @@ -1,16 +1,18 @@ --- title: messages.exportChatInvite -description: messages.exportChatInvite parameters, return type and example +description: Export chat invite --- ## Method: messages.exportChatInvite [Back to methods index](index.md) +Export chat invite + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat id | ### Return type: [ExportedChatInvite](../types/ExportedChatInvite.md) diff --git a/old_docs/API_docs_v65/methods/messages_getAllChats.md b/old_docs/API_docs_v65/methods/messages_getAllChats.md index 4b87df49..127456e4 100644 --- a/old_docs/API_docs_v65/methods/messages_getAllChats.md +++ b/old_docs/API_docs_v65/methods/messages_getAllChats.md @@ -1,16 +1,18 @@ --- title: messages.getAllChats -description: messages.getAllChats parameters, return type and example +description: Get all chats (not supergroups or channels) --- ## Method: messages.getAllChats [Back to methods index](index.md) +Get all chats (not supergroups or channels) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|except\_ids|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|except\_ids|Array of [CLICK ME int](../types/int.md) | Yes|Do not fetch these chats (MTProto id)| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v65/methods/messages_getAllDrafts.md b/old_docs/API_docs_v65/methods/messages_getAllDrafts.md index a5dd59f6..2c0ecd42 100644 --- a/old_docs/API_docs_v65/methods/messages_getAllDrafts.md +++ b/old_docs/API_docs_v65/methods/messages_getAllDrafts.md @@ -1,11 +1,13 @@ --- title: messages.getAllDrafts -description: messages.getAllDrafts parameters, return type and example +description: Get all message drafts --- ## Method: messages.getAllDrafts [Back to methods index](index.md) +Get all message drafts + ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v65/methods/messages_getAllStickers.md b/old_docs/API_docs_v65/methods/messages_getAllStickers.md index 575fcd49..16fdba6c 100644 --- a/old_docs/API_docs_v65/methods/messages_getAllStickers.md +++ b/old_docs/API_docs_v65/methods/messages_getAllStickers.md @@ -1,16 +1,18 @@ --- title: messages.getAllStickers -description: messages.getAllStickers parameters, return type and example +description: Get all stickerpacks --- ## Method: messages.getAllStickers [Back to methods index](index.md) +Get all stickerpacks + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v65/methods/messages_getArchivedStickers.md b/old_docs/API_docs_v65/methods/messages_getArchivedStickers.md index 1b4aaa93..f037e1bc 100644 --- a/old_docs/API_docs_v65/methods/messages_getArchivedStickers.md +++ b/old_docs/API_docs_v65/methods/messages_getArchivedStickers.md @@ -1,18 +1,20 @@ --- title: messages.getArchivedStickers -description: messages.getArchivedStickers parameters, return type and example +description: Get all archived stickers --- ## Method: messages.getArchivedStickers [Back to methods index](index.md) +Get all archived stickers + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|masks|[CLICK ME Bool](../types/Bool.md) | Optional| -|offset\_id|[CLICK ME long](../types/long.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|masks|[CLICK ME Bool](../types/Bool.md) | Optional|Get masks?| +|offset\_id|[CLICK ME long](../types/long.md) | Yes|Sticker ID offset| +|limit|[CLICK ME int](../types/int.md) | Yes|Number of stickers to fetch| ### Return type: [messages\_ArchivedStickers](../types/messages_ArchivedStickers.md) diff --git a/old_docs/API_docs_v65/methods/messages_getAttachedStickers.md b/old_docs/API_docs_v65/methods/messages_getAttachedStickers.md index a0d89b31..890680cd 100644 --- a/old_docs/API_docs_v65/methods/messages_getAttachedStickers.md +++ b/old_docs/API_docs_v65/methods/messages_getAttachedStickers.md @@ -1,16 +1,18 @@ --- title: messages.getAttachedStickers -description: messages.getAttachedStickers parameters, return type and example +description: Get stickers attachable to images --- ## Method: messages.getAttachedStickers [Back to methods index](index.md) +Get stickers attachable to images + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|media|[CLICK ME InputStickeredMedia](../types/InputStickeredMedia.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|media|[CLICK ME InputStickeredMedia](../types/InputStickeredMedia.md) | Yes|The stickered media| ### Return type: [Vector\_of\_StickerSetCovered](../types/StickerSetCovered.md) diff --git a/old_docs/API_docs_v65/methods/messages_getBotCallbackAnswer.md b/old_docs/API_docs_v65/methods/messages_getBotCallbackAnswer.md index 7ccd0d1b..09c283f5 100644 --- a/old_docs/API_docs_v65/methods/messages_getBotCallbackAnswer.md +++ b/old_docs/API_docs_v65/methods/messages_getBotCallbackAnswer.md @@ -1,19 +1,21 @@ --- title: messages.getBotCallbackAnswer -description: messages.getBotCallbackAnswer parameters, return type and example +description: Get the callback answer of a bot (after clicking a button) --- ## Method: messages.getBotCallbackAnswer [Back to methods index](index.md) +Get the callback answer of a bot (after clicking a button) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|game|[CLICK ME Bool](../types/Bool.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|msg\_id|[CLICK ME int](../types/int.md) | Yes| -|data|[CLICK ME bytes](../types/bytes.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|game|[CLICK ME Bool](../types/Bool.md) | Optional|Is this a game?| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| +|msg\_id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|data|[CLICK ME bytes](../types/bytes.md) | Optional|The data to send to the bot| ### Return type: [messages\_BotCallbackAnswer](../types/messages_BotCallbackAnswer.md) diff --git a/old_docs/API_docs_v65/methods/messages_getCommonChats.md b/old_docs/API_docs_v65/methods/messages_getCommonChats.md index a57d7f5a..e6eca283 100644 --- a/old_docs/API_docs_v65/methods/messages_getCommonChats.md +++ b/old_docs/API_docs_v65/methods/messages_getCommonChats.md @@ -1,18 +1,20 @@ --- title: messages.getCommonChats -description: messages.getCommonChats parameters, return type and example +description: Get chats in common with a user --- ## Method: messages.getCommonChats [Back to methods index](index.md) +Get chats in common with a user + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|max\_id|[CLICK ME int](../types/int.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| +|max\_id|[CLICK ME int](../types/int.md) | Yes|The maximum chat ID to fetch| +|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to fetch| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v65/methods/messages_getDocumentByHash.md b/old_docs/API_docs_v65/methods/messages_getDocumentByHash.md index b7c45398..1af5bad4 100644 --- a/old_docs/API_docs_v65/methods/messages_getDocumentByHash.md +++ b/old_docs/API_docs_v65/methods/messages_getDocumentByHash.md @@ -1,18 +1,20 @@ --- title: messages.getDocumentByHash -description: messages.getDocumentByHash parameters, return type and example +description: Get document by SHA256 hash --- ## Method: messages.getDocumentByHash [Back to methods index](index.md) +Get document by SHA256 hash + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|sha256|[CLICK ME bytes](../types/bytes.md) | Yes| -|size|[CLICK ME int](../types/int.md) | Yes| -|mime\_type|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|sha256|[CLICK ME bytes](../types/bytes.md) | Yes|`hash('sha256', $filename, true);`| +|size|[CLICK ME int](../types/int.md) | Yes|The file size| +|mime\_type|[CLICK ME string](../types/string.md) | Yes|The mime type of the file| ### Return type: [Document](../types/Document.md) diff --git a/old_docs/API_docs_v65/methods/messages_getFeaturedStickers.md b/old_docs/API_docs_v65/methods/messages_getFeaturedStickers.md index 88b5609c..512f2e85 100644 --- a/old_docs/API_docs_v65/methods/messages_getFeaturedStickers.md +++ b/old_docs/API_docs_v65/methods/messages_getFeaturedStickers.md @@ -1,16 +1,18 @@ --- title: messages.getFeaturedStickers -description: messages.getFeaturedStickers parameters, return type and example +description: Get featured stickers --- ## Method: messages.getFeaturedStickers [Back to methods index](index.md) +Get featured stickers + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_FeaturedStickers](../types/messages_FeaturedStickers.md) diff --git a/old_docs/API_docs_v65/methods/messages_getGameHighScores.md b/old_docs/API_docs_v65/methods/messages_getGameHighScores.md index 2c95af05..5137baea 100644 --- a/old_docs/API_docs_v65/methods/messages_getGameHighScores.md +++ b/old_docs/API_docs_v65/methods/messages_getGameHighScores.md @@ -1,18 +1,20 @@ --- title: messages.getGameHighScores -description: messages.getGameHighScores parameters, return type and example +description: Get high scores of a game --- ## Method: messages.getGameHighScores [Back to methods index](index.md) +Get high scores of a game + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|id|[CLICK ME int](../types/int.md) | Yes| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| +|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the high scores| ### Return type: [messages\_HighScores](../types/messages_HighScores.md) diff --git a/old_docs/API_docs_v65/methods/messages_getInlineBotResults.md b/old_docs/API_docs_v65/methods/messages_getInlineBotResults.md index 5b2bb254..8ab5bf78 100644 --- a/old_docs/API_docs_v65/methods/messages_getInlineBotResults.md +++ b/old_docs/API_docs_v65/methods/messages_getInlineBotResults.md @@ -1,20 +1,22 @@ --- title: messages.getInlineBotResults -description: messages.getInlineBotResults parameters, return type and example +description: Call inline bot --- ## Method: messages.getInlineBotResults [Back to methods index](index.md) +Call inline bot + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional| -|query|[CLICK ME string](../types/string.md) | Yes| -|offset|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot to call| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to call the bot| +|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional|The current location| +|query|[CLICK ME string](../types/string.md) | Yes|The query to send to the bot| +|offset|[CLICK ME string](../types/string.md) | Yes|The offset to send to the bot| ### Return type: [messages\_BotResults](../types/messages_BotResults.md) diff --git a/old_docs/API_docs_v65/methods/messages_getInlineGameHighScores.md b/old_docs/API_docs_v65/methods/messages_getInlineGameHighScores.md index 447a55dd..790bfdd9 100644 --- a/old_docs/API_docs_v65/methods/messages_getInlineGameHighScores.md +++ b/old_docs/API_docs_v65/methods/messages_getInlineGameHighScores.md @@ -1,17 +1,19 @@ --- title: messages.getInlineGameHighScores -description: messages.getInlineGameHighScores parameters, return type and example +description: Get high scores of a game sent in an inline message --- ## Method: messages.getInlineGameHighScores [Back to methods index](index.md) +Get high scores of a game sent in an inline message + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The inline message| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the high scores| ### Return type: [messages\_HighScores](../types/messages_HighScores.md) diff --git a/old_docs/API_docs_v65/methods/messages_getMaskStickers.md b/old_docs/API_docs_v65/methods/messages_getMaskStickers.md index 80c16471..f4ed9411 100644 --- a/old_docs/API_docs_v65/methods/messages_getMaskStickers.md +++ b/old_docs/API_docs_v65/methods/messages_getMaskStickers.md @@ -1,16 +1,18 @@ --- title: messages.getMaskStickers -description: messages.getMaskStickers parameters, return type and example +description: Get masks --- ## Method: messages.getMaskStickers [Back to methods index](index.md) +Get masks + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v65/methods/messages_getMessageEditData.md b/old_docs/API_docs_v65/methods/messages_getMessageEditData.md index 339678bd..12e71bee 100644 --- a/old_docs/API_docs_v65/methods/messages_getMessageEditData.md +++ b/old_docs/API_docs_v65/methods/messages_getMessageEditData.md @@ -1,17 +1,19 @@ --- title: messages.getMessageEditData -description: messages.getMessageEditData parameters, return type and example +description: Check if about to edit a message or a media caption --- ## Method: messages.getMessageEditData [Back to methods index](index.md) +Check if about to edit a message or a media caption + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|id|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| +|id|[CLICK ME int](../types/int.md) | Yes|The message ID| ### Return type: [messages\_MessageEditData](../types/messages_MessageEditData.md) diff --git a/old_docs/API_docs_v65/methods/messages_getMessagesViews.md b/old_docs/API_docs_v65/methods/messages_getMessagesViews.md index e3f4e4ea..b8d78c85 100644 --- a/old_docs/API_docs_v65/methods/messages_getMessagesViews.md +++ b/old_docs/API_docs_v65/methods/messages_getMessagesViews.md @@ -1,18 +1,20 @@ --- title: messages.getMessagesViews -description: messages.getMessagesViews parameters, return type and example +description: Get and increase message views --- ## Method: messages.getMessagesViews [Back to methods index](index.md) +Get and increase message views + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|id|Array of [CLICK ME int](../types/int.md) | Yes| -|increment|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the message is located| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs messages to get| +|increment|[CLICK ME Bool](../types/Bool.md) | Yes|Increase message views?| ### Return type: [Vector\_of\_int](../types/int.md) diff --git a/old_docs/API_docs_v65/methods/messages_getPeerDialogs.md b/old_docs/API_docs_v65/methods/messages_getPeerDialogs.md index fe8a821c..da82cfc6 100644 --- a/old_docs/API_docs_v65/methods/messages_getPeerDialogs.md +++ b/old_docs/API_docs_v65/methods/messages_getPeerDialogs.md @@ -1,16 +1,18 @@ --- title: messages.getPeerDialogs -description: messages.getPeerDialogs parameters, return type and example +description: Get dialog info of peers --- ## Method: messages.getPeerDialogs [Back to methods index](index.md) +Get dialog info of peers + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peers|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peers|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Yes|The peers| ### Return type: [messages\_PeerDialogs](../types/messages_PeerDialogs.md) diff --git a/old_docs/API_docs_v65/methods/messages_getPinnedDialogs.md b/old_docs/API_docs_v65/methods/messages_getPinnedDialogs.md index 99ff5651..d12779fe 100644 --- a/old_docs/API_docs_v65/methods/messages_getPinnedDialogs.md +++ b/old_docs/API_docs_v65/methods/messages_getPinnedDialogs.md @@ -1,11 +1,13 @@ --- title: messages.getPinnedDialogs -description: messages.getPinnedDialogs parameters, return type and example +description: Get pinned dialogs --- ## Method: messages.getPinnedDialogs [Back to methods index](index.md) +Get pinned dialogs + ### Return type: [messages\_PeerDialogs](../types/messages_PeerDialogs.md) diff --git a/old_docs/API_docs_v65/methods/messages_getRecentStickers.md b/old_docs/API_docs_v65/methods/messages_getRecentStickers.md index abab7f44..d76a2160 100644 --- a/old_docs/API_docs_v65/methods/messages_getRecentStickers.md +++ b/old_docs/API_docs_v65/methods/messages_getRecentStickers.md @@ -1,17 +1,19 @@ --- title: messages.getRecentStickers -description: messages.getRecentStickers parameters, return type and example +description: Get recent stickers --- ## Method: messages.getRecentStickers [Back to methods index](index.md) +Get recent stickers + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|attached|[CLICK ME Bool](../types/Bool.md) | Optional| -|hash|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|attached|[CLICK ME Bool](../types/Bool.md) | Optional|Get stickers attached to image?| +|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_RecentStickers](../types/messages_RecentStickers.md) diff --git a/old_docs/API_docs_v65/methods/messages_getSavedGifs.md b/old_docs/API_docs_v65/methods/messages_getSavedGifs.md index 08dc4be6..f61348ce 100644 --- a/old_docs/API_docs_v65/methods/messages_getSavedGifs.md +++ b/old_docs/API_docs_v65/methods/messages_getSavedGifs.md @@ -1,16 +1,18 @@ --- title: messages.getSavedGifs -description: messages.getSavedGifs parameters, return type and example +description: Get saved gifs --- ## Method: messages.getSavedGifs [Back to methods index](index.md) +Get saved gifs + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_SavedGifs](../types/messages_SavedGifs.md) diff --git a/old_docs/API_docs_v65/methods/messages_getStickerSet.md b/old_docs/API_docs_v65/methods/messages_getStickerSet.md index 70bdd9ba..c86807e4 100644 --- a/old_docs/API_docs_v65/methods/messages_getStickerSet.md +++ b/old_docs/API_docs_v65/methods/messages_getStickerSet.md @@ -1,16 +1,18 @@ --- title: messages.getStickerSet -description: messages.getStickerSet parameters, return type and example +description: Get a stickerset --- ## Method: messages.getStickerSet [Back to methods index](index.md) +Get a stickerset + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset to get| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/old_docs/API_docs_v65/methods/messages_getWebPage.md b/old_docs/API_docs_v65/methods/messages_getWebPage.md index b29e5d25..129f8f06 100644 --- a/old_docs/API_docs_v65/methods/messages_getWebPage.md +++ b/old_docs/API_docs_v65/methods/messages_getWebPage.md @@ -1,17 +1,19 @@ --- title: messages.getWebPage -description: messages.getWebPage parameters, return type and example +description: Get webpage preview --- ## Method: messages.getWebPage [Back to methods index](index.md) +Get webpage preview + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|url|[CLICK ME string](../types/string.md) | Yes| -|hash|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|url|[CLICK ME string](../types/string.md) | Yes|URL| +|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [WebPage](../types/WebPage.md) diff --git a/old_docs/API_docs_v65/methods/messages_getWebPagePreview.md b/old_docs/API_docs_v65/methods/messages_getWebPagePreview.md index 35243c9f..d01bdd32 100644 --- a/old_docs/API_docs_v65/methods/messages_getWebPagePreview.md +++ b/old_docs/API_docs_v65/methods/messages_getWebPagePreview.md @@ -1,16 +1,18 @@ --- title: messages.getWebPagePreview -description: messages.getWebPagePreview parameters, return type and example +description: Get webpage preview --- ## Method: messages.getWebPagePreview [Back to methods index](index.md) +Get webpage preview + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|message|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|message|[CLICK ME string](../types/string.md) | Yes|Extract preview from this message| ### Return type: [MessageMedia](../types/MessageMedia.md) diff --git a/old_docs/API_docs_v65/methods/messages_importChatInvite.md b/old_docs/API_docs_v65/methods/messages_importChatInvite.md index 2bea5247..0d6cd7c8 100644 --- a/old_docs/API_docs_v65/methods/messages_importChatInvite.md +++ b/old_docs/API_docs_v65/methods/messages_importChatInvite.md @@ -1,16 +1,18 @@ --- title: messages.importChatInvite -description: messages.importChatInvite parameters, return type and example +description: Import chat invite --- ## Method: messages.importChatInvite [Back to methods index](index.md) +Import chat invite + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v65/methods/messages_installStickerSet.md b/old_docs/API_docs_v65/methods/messages_installStickerSet.md index 61513182..9f6f098c 100644 --- a/old_docs/API_docs_v65/methods/messages_installStickerSet.md +++ b/old_docs/API_docs_v65/methods/messages_installStickerSet.md @@ -1,17 +1,19 @@ --- title: messages.installStickerSet -description: messages.installStickerSet parameters, return type and example +description: Add a sticker set --- ## Method: messages.installStickerSet [Back to methods index](index.md) +Add a sticker set + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional| -|archived|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to add| +|archived|[CLICK ME Bool](../types/Bool.md) | Yes|Archive this set?| ### Return type: [messages\_StickerSetInstallResult](../types/messages_StickerSetInstallResult.md) diff --git a/old_docs/API_docs_v65/methods/messages_migrateChat.md b/old_docs/API_docs_v65/methods/messages_migrateChat.md index 5021ad45..db57adfa 100644 --- a/old_docs/API_docs_v65/methods/messages_migrateChat.md +++ b/old_docs/API_docs_v65/methods/messages_migrateChat.md @@ -1,16 +1,18 @@ --- title: messages.migrateChat -description: messages.migrateChat parameters, return type and example +description: Convert chat to supergroup --- ## Method: messages.migrateChat [Back to methods index](index.md) +Convert chat to supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat to convert| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v65/methods/messages_readEncryptedHistory.md b/old_docs/API_docs_v65/methods/messages_readEncryptedHistory.md index 4d341809..39b110e3 100644 --- a/old_docs/API_docs_v65/methods/messages_readEncryptedHistory.md +++ b/old_docs/API_docs_v65/methods/messages_readEncryptedHistory.md @@ -1,17 +1,19 @@ --- title: messages.readEncryptedHistory -description: messages.readEncryptedHistory parameters, return type and example +description: Mark messages as read in secret chats --- ## Method: messages.readEncryptedHistory [Back to methods index](index.md) +Mark messages as read in secret chats + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|max\_date|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to mark messages as read| +|max\_date|[CLICK ME int](../types/int.md) | Yes|Maximum date of messages to mark| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v65/methods/messages_readFeaturedStickers.md b/old_docs/API_docs_v65/methods/messages_readFeaturedStickers.md index 0631ca5b..4035c76d 100644 --- a/old_docs/API_docs_v65/methods/messages_readFeaturedStickers.md +++ b/old_docs/API_docs_v65/methods/messages_readFeaturedStickers.md @@ -1,16 +1,18 @@ --- title: messages.readFeaturedStickers -description: messages.readFeaturedStickers parameters, return type and example +description: Mark new featured stickers as read --- ## Method: messages.readFeaturedStickers [Back to methods index](index.md) +Mark new featured stickers as read + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|Array of [CLICK ME long](../types/long.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|Array of [CLICK ME long](../types/long.md) | Yes|The stickers to mark as read| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v65/methods/messages_readMessageContents.md b/old_docs/API_docs_v65/methods/messages_readMessageContents.md index 0d27c209..9bb1bee8 100644 --- a/old_docs/API_docs_v65/methods/messages_readMessageContents.md +++ b/old_docs/API_docs_v65/methods/messages_readMessageContents.md @@ -1,16 +1,18 @@ --- title: messages.readMessageContents -description: messages.readMessageContents parameters, return type and example +description: Mark message as read --- ## Method: messages.readMessageContents [Back to methods index](index.md) +Mark message as read + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v65/methods/messages_receivedQueue.md b/old_docs/API_docs_v65/methods/messages_receivedQueue.md index c91caa37..4ad78ba2 100644 --- a/old_docs/API_docs_v65/methods/messages_receivedQueue.md +++ b/old_docs/API_docs_v65/methods/messages_receivedQueue.md @@ -1,77 +1,13 @@ --- title: messages.receivedQueue -description: messages.receivedQueue parameters, return type and example +description: You cannot use this method directly --- ## Method: messages.receivedQueue [Back to methods index](index.md) -### Parameters: - -| Name | Type | Required | -|----------|---------------|----------| -|max\_qts|[CLICK ME int](../types/int.md) | Yes| - - -### 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| - - -### MadelineProto Example: - - -``` -if (!file_exists('madeline.php')) { - copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); -} -include 'madeline.php'; - -// !!! This API id/API hash combination will not work !!! -// !!! You must get your own @ my.telegram.org !!! -$api_id = 0; -$api_hash = ''; - -$MadelineProto = new \danog\MadelineProto\API('session.madeline', ['app_info' => ['api_id' => $api_id, 'api_hash' => $api_hash]]); -$MadelineProto->start(); - -$Vector_of_long = $MadelineProto->messages->receivedQueue(['max_qts' => int, ]); -``` - -### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): - -### As a bot: - -POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` - -Parameters: - -* method - messages.receivedQueue -* params - `{"max_qts": int, }` - - - -### As a user: - -POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.receivedQueue` - -Parameters: - -max_qts - Json encoded int +**You cannot use this method directly** -Or, if you're into Lua: - -``` -Vector_of_long = messages.receivedQueue({max_qts=int, }) -``` - diff --git a/old_docs/API_docs_v65/methods/messages_reorderPinnedDialogs.md b/old_docs/API_docs_v65/methods/messages_reorderPinnedDialogs.md index 0bf5e073..710caf10 100644 --- a/old_docs/API_docs_v65/methods/messages_reorderPinnedDialogs.md +++ b/old_docs/API_docs_v65/methods/messages_reorderPinnedDialogs.md @@ -1,17 +1,19 @@ --- title: messages.reorderPinnedDialogs -description: messages.reorderPinnedDialogs parameters, return type and example +description: Reorder pinned dialogs --- ## Method: messages.reorderPinnedDialogs [Back to methods index](index.md) +Reorder pinned dialogs + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|force|[CLICK ME Bool](../types/Bool.md) | Optional| -|order|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|force|[CLICK ME Bool](../types/Bool.md) | Optional|Force reordering| +|order|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Yes|New order| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v65/methods/messages_reorderStickerSets.md b/old_docs/API_docs_v65/methods/messages_reorderStickerSets.md index e4f1623c..ddc78dd0 100644 --- a/old_docs/API_docs_v65/methods/messages_reorderStickerSets.md +++ b/old_docs/API_docs_v65/methods/messages_reorderStickerSets.md @@ -1,17 +1,19 @@ --- title: messages.reorderStickerSets -description: messages.reorderStickerSets parameters, return type and example +description: Reorder sticker sets --- ## Method: messages.reorderStickerSets [Back to methods index](index.md) +Reorder sticker sets + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|masks|[CLICK ME Bool](../types/Bool.md) | Optional| -|order|Array of [CLICK ME long](../types/long.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|masks|[CLICK ME Bool](../types/Bool.md) | Optional|Reorder masks?| +|order|Array of [CLICK ME long](../types/long.md) | Yes|The order| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v65/methods/messages_reportEncryptedSpam.md b/old_docs/API_docs_v65/methods/messages_reportEncryptedSpam.md index 44482c76..58b684d1 100644 --- a/old_docs/API_docs_v65/methods/messages_reportEncryptedSpam.md +++ b/old_docs/API_docs_v65/methods/messages_reportEncryptedSpam.md @@ -1,16 +1,18 @@ --- title: messages.reportEncryptedSpam -description: messages.reportEncryptedSpam parameters, return type and example +description: Report for spam a secret chat --- ## Method: messages.reportEncryptedSpam [Back to methods index](index.md) +Report for spam a secret chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat to report| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v65/methods/messages_saveDraft.md b/old_docs/API_docs_v65/methods/messages_saveDraft.md index 9104df33..bbeed707 100644 --- a/old_docs/API_docs_v65/methods/messages_saveDraft.md +++ b/old_docs/API_docs_v65/methods/messages_saveDraft.md @@ -1,20 +1,22 @@ --- title: messages.saveDraft -description: messages.saveDraft parameters, return type and example +description: Save a message draft --- ## Method: messages.saveDraft [Back to methods index](index.md) +Save a message draft + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|message|[CLICK ME string](../types/string.md) | Yes| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview| +|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| +|message|[CLICK ME string](../types/string.md) | Yes|The message| +|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|The entities (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/old_docs/API_docs_v65/methods/messages_saveGif.md b/old_docs/API_docs_v65/methods/messages_saveGif.md index 4a3b6166..6f608c4c 100644 --- a/old_docs/API_docs_v65/methods/messages_saveGif.md +++ b/old_docs/API_docs_v65/methods/messages_saveGif.md @@ -1,17 +1,19 @@ --- title: messages.saveGif -description: messages.saveGif parameters, return type and example +description: Save a GIF --- ## Method: messages.saveGif [Back to methods index](index.md) +Save a GIF + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional| -|unsave|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The GIF to save| +|unsave|[CLICK ME Bool](../types/Bool.md) | Yes|Remove the gif?| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v65/methods/messages_saveRecentSticker.md b/old_docs/API_docs_v65/methods/messages_saveRecentSticker.md index b4f43e13..81ad5d48 100644 --- a/old_docs/API_docs_v65/methods/messages_saveRecentSticker.md +++ b/old_docs/API_docs_v65/methods/messages_saveRecentSticker.md @@ -1,18 +1,20 @@ --- title: messages.saveRecentSticker -description: messages.saveRecentSticker parameters, return type and example +description: Add a sticker to recent stickers --- ## Method: messages.saveRecentSticker [Back to methods index](index.md) +Add a sticker to recent stickers + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|attached|[CLICK ME Bool](../types/Bool.md) | Optional| -|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional| -|unsave|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|attached|[CLICK ME Bool](../types/Bool.md) | Optional|Get stickers attached to image?| +|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker| +|unsave|[CLICK ME Bool](../types/Bool.md) | Yes|Remove the sticker from recent stickers?| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v65/methods/messages_searchGifs.md b/old_docs/API_docs_v65/methods/messages_searchGifs.md index fefef1d7..103ebfeb 100644 --- a/old_docs/API_docs_v65/methods/messages_searchGifs.md +++ b/old_docs/API_docs_v65/methods/messages_searchGifs.md @@ -1,17 +1,19 @@ --- title: messages.searchGifs -description: messages.searchGifs parameters, return type and example +description: Search gifs --- ## Method: messages.searchGifs [Back to methods index](index.md) +Search gifs + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|q|[CLICK ME string](../types/string.md) | Yes| -|offset|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|q|[CLICK ME string](../types/string.md) | Yes|The search query| +|offset|[CLICK ME int](../types/int.md) | Yes|The offset | ### Return type: [messages\_FoundGifs](../types/messages_FoundGifs.md) diff --git a/old_docs/API_docs_v65/methods/messages_searchGlobal.md b/old_docs/API_docs_v65/methods/messages_searchGlobal.md index 32ddd175..0edd1e40 100644 --- a/old_docs/API_docs_v65/methods/messages_searchGlobal.md +++ b/old_docs/API_docs_v65/methods/messages_searchGlobal.md @@ -1,20 +1,22 @@ --- title: messages.searchGlobal -description: messages.searchGlobal parameters, return type and example +description: Global message search --- ## Method: messages.searchGlobal [Back to methods index](index.md) +Global message search + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|q|[CLICK ME string](../types/string.md) | Yes| -|offset\_date|[CLICK ME int](../types/int.md) | Yes| -|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|offset\_id|[CLICK ME int](../types/int.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|q|[CLICK ME string](../types/string.md) | Yes|The query| +|offset\_date|[CLICK ME int](../types/int.md) | Yes|0 or the date offset| +|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|0 or the peer offset| +|offset\_id|[CLICK ME int](../types/int.md) | Yes|0 or the message ID offset| +|limit|[CLICK ME int](../types/int.md) | Yes|The number of results to return| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v65/methods/messages_sendEncrypted.md b/old_docs/API_docs_v65/methods/messages_sendEncrypted.md index 23461760..d48f88d7 100644 --- a/old_docs/API_docs_v65/methods/messages_sendEncrypted.md +++ b/old_docs/API_docs_v65/methods/messages_sendEncrypted.md @@ -1,17 +1,19 @@ --- title: messages.sendEncrypted -description: messages.sendEncrypted parameters, return type and example +description: Send message to secret chat --- ## Method: messages.sendEncrypted [Back to methods index](index.md) +Send message to secret chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the message| +|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v65/methods/messages_sendEncryptedFile.md b/old_docs/API_docs_v65/methods/messages_sendEncryptedFile.md index 64919abe..4fd0648e 100644 --- a/old_docs/API_docs_v65/methods/messages_sendEncryptedFile.md +++ b/old_docs/API_docs_v65/methods/messages_sendEncryptedFile.md @@ -1,18 +1,20 @@ --- title: messages.sendEncryptedFile -description: messages.sendEncryptedFile parameters, return type and example +description: Send a file to a secret chat --- ## Method: messages.sendEncryptedFile [Back to methods index](index.md) +Send a file to a secret chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes| -|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the file| +|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| +|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional|The file (optional)| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v65/methods/messages_sendEncryptedService.md b/old_docs/API_docs_v65/methods/messages_sendEncryptedService.md index 0a0eea8a..d66894bf 100644 --- a/old_docs/API_docs_v65/methods/messages_sendEncryptedService.md +++ b/old_docs/API_docs_v65/methods/messages_sendEncryptedService.md @@ -1,17 +1,19 @@ --- title: messages.sendEncryptedService -description: messages.sendEncryptedService parameters, return type and example +description: Send a service message to a secret chat --- ## Method: messages.sendEncryptedService [Back to methods index](index.md) +Send a service message to a secret chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the service message| +|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v65/methods/messages_sendInlineBotResult.md b/old_docs/API_docs_v65/methods/messages_sendInlineBotResult.md index 4cb9243e..386ac7e3 100644 --- a/old_docs/API_docs_v65/methods/messages_sendInlineBotResult.md +++ b/old_docs/API_docs_v65/methods/messages_sendInlineBotResult.md @@ -1,22 +1,24 @@ --- title: messages.sendInlineBotResult -description: messages.sendInlineBotResult parameters, return type and example +description: Send a received bot result to the chat --- ## Method: messages.sendInlineBotResult [Back to methods index](index.md) +Send a received bot result to the chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional| -|background|[CLICK ME Bool](../types/Bool.md) | Optional| -|clear\_draft|[CLICK ME Bool](../types/Bool.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional| -|query\_id|[CLICK ME long](../types/long.md) | Yes| -|id|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Disable notifications?| +|background|[CLICK ME Bool](../types/Bool.md) | Optional|Disable background notifications?| +|clear\_draft|[CLICK ME Bool](../types/Bool.md) | Optional|Clear the message draft?| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the message| +|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| +|query\_id|[CLICK ME long](../types/long.md) | Yes|The inline query ID| +|id|[CLICK ME string](../types/string.md) | Yes|The result ID| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v65/methods/messages_setBotCallbackAnswer.md b/old_docs/API_docs_v65/methods/messages_setBotCallbackAnswer.md index 5590828e..e6dc6b09 100644 --- a/old_docs/API_docs_v65/methods/messages_setBotCallbackAnswer.md +++ b/old_docs/API_docs_v65/methods/messages_setBotCallbackAnswer.md @@ -1,20 +1,22 @@ --- title: messages.setBotCallbackAnswer -description: messages.setBotCallbackAnswer parameters, return type and example +description: Bots only: set the callback answer (after a button was clicked) --- ## Method: messages.setBotCallbackAnswer [Back to methods index](index.md) +Bots only: set the callback answer (after a button was clicked) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|alert|[CLICK ME Bool](../types/Bool.md) | Optional| -|query\_id|[CLICK ME long](../types/long.md) | Yes| -|message|[CLICK ME string](../types/string.md) | Optional| -|url|[CLICK ME string](../types/string.md) | Optional| -|cache\_time|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|alert|[CLICK ME Bool](../types/Bool.md) | Optional|Is this an alert?| +|query\_id|[CLICK ME long](../types/long.md) | Yes|The query ID| +|message|[CLICK ME string](../types/string.md) | Optional|The message| +|url|[CLICK ME string](../types/string.md) | Optional|The URL| +|cache\_time|[CLICK ME int](../types/int.md) | Yes|Cache time| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v65/methods/messages_setBotPrecheckoutResults.md b/old_docs/API_docs_v65/methods/messages_setBotPrecheckoutResults.md index 5afa7789..722bff81 100644 --- a/old_docs/API_docs_v65/methods/messages_setBotPrecheckoutResults.md +++ b/old_docs/API_docs_v65/methods/messages_setBotPrecheckoutResults.md @@ -1,18 +1,20 @@ --- title: messages.setBotPrecheckoutResults -description: messages.setBotPrecheckoutResults parameters, return type and example +description: Bots only: set precheckout results --- ## Method: messages.setBotPrecheckoutResults [Back to methods index](index.md) +Bots only: set precheckout results + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|success|[CLICK ME Bool](../types/Bool.md) | Optional| -|query\_id|[CLICK ME long](../types/long.md) | Yes| -|error|[CLICK ME string](../types/string.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|success|[CLICK ME Bool](../types/Bool.md) | Optional|Success?| +|query\_id|[CLICK ME long](../types/long.md) | Yes|Query ID| +|error|[CLICK ME string](../types/string.md) | Optional|Error| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v65/methods/messages_setBotShippingResults.md b/old_docs/API_docs_v65/methods/messages_setBotShippingResults.md index b36dacce..d364a04d 100644 --- a/old_docs/API_docs_v65/methods/messages_setBotShippingResults.md +++ b/old_docs/API_docs_v65/methods/messages_setBotShippingResults.md @@ -1,18 +1,20 @@ --- title: messages.setBotShippingResults -description: messages.setBotShippingResults parameters, return type and example +description: Bots only: set shipping results --- ## Method: messages.setBotShippingResults [Back to methods index](index.md) +Bots only: set shipping results + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|query\_id|[CLICK ME long](../types/long.md) | Yes| -|error|[CLICK ME string](../types/string.md) | Optional| -|shipping\_options|Array of [CLICK ME ShippingOption](../types/ShippingOption.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|query\_id|[CLICK ME long](../types/long.md) | Yes|Query ID| +|error|[CLICK ME string](../types/string.md) | Optional|Error| +|shipping\_options|Array of [CLICK ME ShippingOption](../types/ShippingOption.md) | Optional|Shipping options| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v65/methods/messages_setEncryptedTyping.md b/old_docs/API_docs_v65/methods/messages_setEncryptedTyping.md index 3183fedf..e9afe99c 100644 --- a/old_docs/API_docs_v65/methods/messages_setEncryptedTyping.md +++ b/old_docs/API_docs_v65/methods/messages_setEncryptedTyping.md @@ -12,8 +12,8 @@ Send typing notification to secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|| -|typing|[CLICK ME Bool](../types/Bool.md) | Yes|| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to send the notification| +|typing|[CLICK ME Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v65/methods/messages_setGameScore.md b/old_docs/API_docs_v65/methods/messages_setGameScore.md index c44145c0..aa1f4f0c 100644 --- a/old_docs/API_docs_v65/methods/messages_setGameScore.md +++ b/old_docs/API_docs_v65/methods/messages_setGameScore.md @@ -1,21 +1,23 @@ --- title: messages.setGameScore -description: messages.setGameScore parameters, return type and example +description: Set the game score --- ## Method: messages.setGameScore [Back to methods index](index.md) +Set the game score + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|edit\_message|[CLICK ME Bool](../types/Bool.md) | Optional| -|force|[CLICK ME Bool](../types/Bool.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|id|[CLICK ME int](../types/int.md) | Yes| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|score|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|edit\_message|[CLICK ME Bool](../types/Bool.md) | Optional|Should the message with the game be edited?| +|force|[CLICK ME Bool](../types/Bool.md) | Optional|Force setting the game score| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the game was sent| +|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the score| +|score|[CLICK ME int](../types/int.md) | Yes|The score| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v65/methods/messages_setInlineBotResults.md b/old_docs/API_docs_v65/methods/messages_setInlineBotResults.md index 915e3a4e..79493009 100644 --- a/old_docs/API_docs_v65/methods/messages_setInlineBotResults.md +++ b/old_docs/API_docs_v65/methods/messages_setInlineBotResults.md @@ -1,22 +1,24 @@ --- title: messages.setInlineBotResults -description: messages.setInlineBotResults parameters, return type and example +description: Bots only: set the results of an inline query --- ## Method: messages.setInlineBotResults [Back to methods index](index.md) +Bots only: set the results of an inline query + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|gallery|[CLICK ME Bool](../types/Bool.md) | Optional| -|private|[CLICK ME Bool](../types/Bool.md) | Optional| -|query\_id|[CLICK ME long](../types/long.md) | Yes| -|results|Array of [CLICK ME InputBotInlineResult](../types/InputBotInlineResult.md) | Yes| -|cache\_time|[CLICK ME int](../types/int.md) | Yes| -|next\_offset|[CLICK ME string](../types/string.md) | Optional| -|switch\_pm|[CLICK ME InlineBotSwitchPM](../types/InlineBotSwitchPM.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|gallery|[CLICK ME Bool](../types/Bool.md) | Optional|Is this a gallery?| +|private|[CLICK ME Bool](../types/Bool.md) | Optional|Is this result private (not cached)?| +|query\_id|[CLICK ME long](../types/long.md) | Yes|Query ID| +|results|Array of [CLICK ME InputBotInlineResult](../types/InputBotInlineResult.md) | Yes|Results| +|cache\_time|[CLICK ME int](../types/int.md) | Yes|Cache time| +|next\_offset|[CLICK ME string](../types/string.md) | Optional|The next offset| +|switch\_pm|[CLICK ME InlineBotSwitchPM](../types/InlineBotSwitchPM.md) | Optional|Switch to PM?| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v65/methods/messages_setInlineGameScore.md b/old_docs/API_docs_v65/methods/messages_setInlineGameScore.md index 55e2c063..385c8308 100644 --- a/old_docs/API_docs_v65/methods/messages_setInlineGameScore.md +++ b/old_docs/API_docs_v65/methods/messages_setInlineGameScore.md @@ -1,20 +1,22 @@ --- title: messages.setInlineGameScore -description: messages.setInlineGameScore parameters, return type and example +description: Set the game score of an inline message --- ## Method: messages.setInlineGameScore [Back to methods index](index.md) +Set the game score of an inline message + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|edit\_message|[CLICK ME Bool](../types/Bool.md) | Optional| -|force|[CLICK ME Bool](../types/Bool.md) | Optional| -|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|score|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|edit\_message|[CLICK ME Bool](../types/Bool.md) | Optional|Should the message with the game be edited?| +|force|[CLICK ME Bool](../types/Bool.md) | Optional|Force setting the game score| +|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The ID of the inline message| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the score| +|score|[CLICK ME int](../types/int.md) | Yes|The score| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v65/methods/messages_startBot.md b/old_docs/API_docs_v65/methods/messages_startBot.md index 0de0f1a5..94a4d86a 100644 --- a/old_docs/API_docs_v65/methods/messages_startBot.md +++ b/old_docs/API_docs_v65/methods/messages_startBot.md @@ -1,18 +1,20 @@ --- title: messages.startBot -description: messages.startBot parameters, return type and example +description: Start a bot --- ## Method: messages.startBot [Back to methods index](index.md) +Start a bot + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|start\_param|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot's ID or username| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to start the bot (@me or group ID/username)| +|start\_param|[CLICK ME string](../types/string.md) | Yes|The bot's start parameter| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v65/methods/messages_toggleChatAdmins.md b/old_docs/API_docs_v65/methods/messages_toggleChatAdmins.md index d56e5753..ab591fd9 100644 --- a/old_docs/API_docs_v65/methods/messages_toggleChatAdmins.md +++ b/old_docs/API_docs_v65/methods/messages_toggleChatAdmins.md @@ -1,17 +1,19 @@ --- title: messages.toggleChatAdmins -description: messages.toggleChatAdmins parameters, return type and example +description: Enable all users are admins in normal groups (not supergroups) --- ## Method: messages.toggleChatAdmins [Back to methods index](index.md) +Enable all users are admins in normal groups (not supergroups) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Group ID| +|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Enable all users are admins| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v65/methods/messages_toggleDialogPin.md b/old_docs/API_docs_v65/methods/messages_toggleDialogPin.md index d6dc9692..2bd6a03d 100644 --- a/old_docs/API_docs_v65/methods/messages_toggleDialogPin.md +++ b/old_docs/API_docs_v65/methods/messages_toggleDialogPin.md @@ -1,17 +1,19 @@ --- title: messages.toggleDialogPin -description: messages.toggleDialogPin parameters, return type and example +description: Pin or unpin dialog --- ## Method: messages.toggleDialogPin [Back to methods index](index.md) +Pin or unpin dialog + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|pinned|[CLICK ME Bool](../types/Bool.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|pinned|[CLICK ME Bool](../types/Bool.md) | Optional|Pin or unpin the dialog?| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer to pin| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v65/methods/messages_uninstallStickerSet.md b/old_docs/API_docs_v65/methods/messages_uninstallStickerSet.md index 60b0ca0c..6d04e847 100644 --- a/old_docs/API_docs_v65/methods/messages_uninstallStickerSet.md +++ b/old_docs/API_docs_v65/methods/messages_uninstallStickerSet.md @@ -1,16 +1,18 @@ --- title: messages.uninstallStickerSet -description: messages.uninstallStickerSet parameters, return type and example +description: Remove a sticker set --- ## Method: messages.uninstallStickerSet [Back to methods index](index.md) +Remove a sticker set + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to remove| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v65/methods/payments_clearSavedInfo.md b/old_docs/API_docs_v65/methods/payments_clearSavedInfo.md index 53fab36f..44050dde 100644 --- a/old_docs/API_docs_v65/methods/payments_clearSavedInfo.md +++ b/old_docs/API_docs_v65/methods/payments_clearSavedInfo.md @@ -1,17 +1,19 @@ --- title: payments.clearSavedInfo -description: payments.clearSavedInfo parameters, return type and example +description: Clear saved payments info --- ## Method: payments.clearSavedInfo [Back to methods index](index.md) +Clear saved payments info + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|credentials|[CLICK ME Bool](../types/Bool.md) | Optional| -|info|[CLICK ME Bool](../types/Bool.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|credentials|[CLICK ME Bool](../types/Bool.md) | Optional|Clear credentials?| +|info|[CLICK ME Bool](../types/Bool.md) | Optional|Clear payment info?| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v65/methods/payments_getPaymentForm.md b/old_docs/API_docs_v65/methods/payments_getPaymentForm.md index 00b4bddc..16a32d11 100644 --- a/old_docs/API_docs_v65/methods/payments_getPaymentForm.md +++ b/old_docs/API_docs_v65/methods/payments_getPaymentForm.md @@ -1,16 +1,18 @@ --- title: payments.getPaymentForm -description: payments.getPaymentForm parameters, return type and example +description: Get payment form --- ## Method: payments.getPaymentForm [Back to methods index](index.md) +Get payment form + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|msg\_id|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|msg\_id|[CLICK ME int](../types/int.md) | Yes|Message ID| ### Return type: [payments\_PaymentForm](../types/payments_PaymentForm.md) diff --git a/old_docs/API_docs_v65/methods/payments_getPaymentReceipt.md b/old_docs/API_docs_v65/methods/payments_getPaymentReceipt.md index 40b73a4b..857585f6 100644 --- a/old_docs/API_docs_v65/methods/payments_getPaymentReceipt.md +++ b/old_docs/API_docs_v65/methods/payments_getPaymentReceipt.md @@ -1,16 +1,18 @@ --- title: payments.getPaymentReceipt -description: payments.getPaymentReceipt parameters, return type and example +description: Get payment receipt --- ## Method: payments.getPaymentReceipt [Back to methods index](index.md) +Get payment receipt + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|msg\_id|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|msg\_id|[CLICK ME int](../types/int.md) | Yes|The message ID| ### Return type: [payments\_PaymentReceipt](../types/payments_PaymentReceipt.md) diff --git a/old_docs/API_docs_v65/methods/payments_getSavedInfo.md b/old_docs/API_docs_v65/methods/payments_getSavedInfo.md index ccaaff75..04ac7374 100644 --- a/old_docs/API_docs_v65/methods/payments_getSavedInfo.md +++ b/old_docs/API_docs_v65/methods/payments_getSavedInfo.md @@ -1,11 +1,13 @@ --- title: payments.getSavedInfo -description: payments.getSavedInfo parameters, return type and example +description: Get saved payments info --- ## Method: payments.getSavedInfo [Back to methods index](index.md) +Get saved payments info + ### Return type: [payments\_SavedInfo](../types/payments_SavedInfo.md) diff --git a/old_docs/API_docs_v65/methods/payments_sendPaymentForm.md b/old_docs/API_docs_v65/methods/payments_sendPaymentForm.md index eb843715..0a9df99f 100644 --- a/old_docs/API_docs_v65/methods/payments_sendPaymentForm.md +++ b/old_docs/API_docs_v65/methods/payments_sendPaymentForm.md @@ -1,19 +1,21 @@ --- title: payments.sendPaymentForm -description: payments.sendPaymentForm parameters, return type and example +description: Bots only: send payment form --- ## Method: payments.sendPaymentForm [Back to methods index](index.md) +Bots only: send payment form + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|msg\_id|[CLICK ME int](../types/int.md) | Yes| -|requested\_info\_id|[CLICK ME string](../types/string.md) | Optional| -|shipping\_option\_id|[CLICK ME string](../types/string.md) | Optional| -|credentials|[CLICK ME InputPaymentCredentials](../types/InputPaymentCredentials.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|msg\_id|[CLICK ME int](../types/int.md) | Yes|Message ID| +|requested\_info\_id|[CLICK ME string](../types/string.md) | Optional|ID of requested info| +|shipping\_option\_id|[CLICK ME string](../types/string.md) | Optional|Shipping option ID| +|credentials|[CLICK ME InputPaymentCredentials](../types/InputPaymentCredentials.md) | Yes|Payment credentials| ### Return type: [payments\_PaymentResult](../types/payments_PaymentResult.md) diff --git a/old_docs/API_docs_v65/methods/payments_validateRequestedInfo.md b/old_docs/API_docs_v65/methods/payments_validateRequestedInfo.md index 32702965..e36f0e42 100644 --- a/old_docs/API_docs_v65/methods/payments_validateRequestedInfo.md +++ b/old_docs/API_docs_v65/methods/payments_validateRequestedInfo.md @@ -1,18 +1,20 @@ --- title: payments.validateRequestedInfo -description: payments.validateRequestedInfo parameters, return type and example +description: Validate requested payment info --- ## Method: payments.validateRequestedInfo [Back to methods index](index.md) +Validate requested payment info + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|save|[CLICK ME Bool](../types/Bool.md) | Optional| -|msg\_id|[CLICK ME int](../types/int.md) | Yes| -|info|[CLICK ME PaymentRequestedInfo](../types/PaymentRequestedInfo.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|save|[CLICK ME Bool](../types/Bool.md) | Optional|Save payment info?| +|msg\_id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|info|[CLICK ME PaymentRequestedInfo](../types/PaymentRequestedInfo.md) | Yes|The requested payment info| ### Return type: [payments\_ValidatedRequestedInfo](../types/payments_ValidatedRequestedInfo.md) diff --git a/old_docs/API_docs_v65/methods/photos_deletePhotos.md b/old_docs/API_docs_v65/methods/photos_deletePhotos.md index 104459b7..b9daca10 100644 --- a/old_docs/API_docs_v65/methods/photos_deletePhotos.md +++ b/old_docs/API_docs_v65/methods/photos_deletePhotos.md @@ -1,16 +1,18 @@ --- title: photos.deletePhotos -description: photos.deletePhotos parameters, return type and example +description: Delete profile photos --- ## Method: photos.deletePhotos [Back to methods index](index.md) +Delete profile photos + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Yes|The profile photos to delete| ### Return type: [Vector\_of\_long](../types/long.md) diff --git a/old_docs/API_docs_v65/methods/photos_getUserPhotos.md b/old_docs/API_docs_v65/methods/photos_getUserPhotos.md index 1a7515ba..ea27a44f 100644 --- a/old_docs/API_docs_v65/methods/photos_getUserPhotos.md +++ b/old_docs/API_docs_v65/methods/photos_getUserPhotos.md @@ -1,19 +1,21 @@ --- title: photos.getUserPhotos -description: photos.getUserPhotos parameters, return type and example +description: Get the profile photos of a user --- ## Method: photos.getUserPhotos [Back to methods index](index.md) +Get the profile photos of a user + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|offset|[CLICK ME int](../types/int.md) | Yes| -|max\_id|[CLICK ME long](../types/long.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| +|offset|[CLICK ME int](../types/int.md) | Yes|Offset| +|max\_id|[CLICK ME long](../types/long.md) | Yes|Maximum ID of photo to return| +|limit|[CLICK ME int](../types/int.md) | Yes|Number of photos to return| ### Return type: [photos\_Photos](../types/photos_Photos.md) diff --git a/old_docs/API_docs_v65/methods/photos_updateProfilePhoto.md b/old_docs/API_docs_v65/methods/photos_updateProfilePhoto.md index 28ab5fbf..7f0a4c69 100644 --- a/old_docs/API_docs_v65/methods/photos_updateProfilePhoto.md +++ b/old_docs/API_docs_v65/methods/photos_updateProfilePhoto.md @@ -1,16 +1,18 @@ --- title: photos.updateProfilePhoto -description: photos.updateProfilePhoto parameters, return type and example +description: Update the profile photo (use photos->uploadProfilePhoto to upload the photo) --- ## Method: photos.updateProfilePhoto [Back to methods index](index.md) +Update the profile photo (use photos->uploadProfilePhoto to upload the photo) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional|The photo to use| ### Return type: [UserProfilePhoto](../types/UserProfilePhoto.md) diff --git a/old_docs/API_docs_v65/methods/photos_uploadProfilePhoto.md b/old_docs/API_docs_v65/methods/photos_uploadProfilePhoto.md index 7cc9e9e5..efa08bb0 100644 --- a/old_docs/API_docs_v65/methods/photos_uploadProfilePhoto.md +++ b/old_docs/API_docs_v65/methods/photos_uploadProfilePhoto.md @@ -1,16 +1,18 @@ --- title: photos.uploadProfilePhoto -description: photos.uploadProfilePhoto parameters, return type and example +description: Upload profile photo --- ## Method: photos.uploadProfilePhoto [Back to methods index](index.md) +Upload profile photo + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|file|[File path or InputFile](../types/InputFile.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|file|[File path or InputFile](../types/InputFile.md) | Yes|The photo| ### Return type: [photos\_Photo](../types/photos_Photo.md) diff --git a/old_docs/API_docs_v65/methods/upload_getWebFile.md b/old_docs/API_docs_v65/methods/upload_getWebFile.md index 30bd3a1f..e864e4b7 100644 --- a/old_docs/API_docs_v65/methods/upload_getWebFile.md +++ b/old_docs/API_docs_v65/methods/upload_getWebFile.md @@ -1,18 +1,20 @@ --- title: upload.getWebFile -description: upload.getWebFile parameters, return type and example +description: Download a file through telegram --- ## Method: upload.getWebFile [Back to methods index](index.md) +Download a file through telegram + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|location|[CLICK ME InputWebFileLocation](../types/InputWebFileLocation.md) | Yes| -|offset|[CLICK ME int](../types/int.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|location|[CLICK ME InputWebFileLocation](../types/InputWebFileLocation.md) | Yes|The file| +|offset|[CLICK ME int](../types/int.md) | Yes|The offset in bytes| +|limit|[CLICK ME int](../types/int.md) | Yes|The number of bytes to fetch| ### Return type: [upload\_WebFile](../types/upload_WebFile.md) diff --git a/old_docs/API_docs_v66/methods/account_registerDevice.md b/old_docs/API_docs_v66/methods/account_registerDevice.md index cd28abcd..017b9af3 100644 --- a/old_docs/API_docs_v66/methods/account_registerDevice.md +++ b/old_docs/API_docs_v66/methods/account_registerDevice.md @@ -12,8 +12,8 @@ Register device for push notifications | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and oTher, see source code of official apps for more info| +|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and oTher, see source code of official apps for more info| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v66/methods/account_unregisterDevice.md b/old_docs/API_docs_v66/methods/account_unregisterDevice.md index 1d2b7670..32e44495 100644 --- a/old_docs/API_docs_v66/methods/account_unregisterDevice.md +++ b/old_docs/API_docs_v66/methods/account_unregisterDevice.md @@ -12,8 +12,8 @@ Stop sending PUSH notifications to app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and oTher, see source code of official apps for more info| +|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and oTher, see source code of official apps for more info| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v66/methods/bots_answerWebhookJSONQuery.md b/old_docs/API_docs_v66/methods/bots_answerWebhookJSONQuery.md index 205b30f9..61056bb4 100644 --- a/old_docs/API_docs_v66/methods/bots_answerWebhookJSONQuery.md +++ b/old_docs/API_docs_v66/methods/bots_answerWebhookJSONQuery.md @@ -1,17 +1,19 @@ --- title: bots.answerWebhookJSONQuery -description: bots.answerWebhookJSONQuery parameters, return type and example +description: Send webhook request via bot API --- ## Method: bots.answerWebhookJSONQuery [Back to methods index](index.md) +Send webhook request via bot API + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|query\_id|[CLICK ME long](../types/long.md) | Yes| -|data|[CLICK ME DataJSON](../types/DataJSON.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|query\_id|[CLICK ME long](../types/long.md) | Yes|The query ID| +|data|[CLICK ME DataJSON](../types/DataJSON.md) | Yes|The parameters| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v66/methods/bots_sendCustomRequest.md b/old_docs/API_docs_v66/methods/bots_sendCustomRequest.md index 590c47b6..fc8e764d 100644 --- a/old_docs/API_docs_v66/methods/bots_sendCustomRequest.md +++ b/old_docs/API_docs_v66/methods/bots_sendCustomRequest.md @@ -1,17 +1,19 @@ --- title: bots.sendCustomRequest -description: bots.sendCustomRequest parameters, return type and example +description: Send a custom request to the bot API --- ## Method: bots.sendCustomRequest [Back to methods index](index.md) +Send a custom request to the bot API + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|custom\_method|[CLICK ME string](../types/string.md) | Yes| -|params|[CLICK ME DataJSON](../types/DataJSON.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|custom\_method|[CLICK ME string](../types/string.md) | Yes|The method to call| +|params|[CLICK ME DataJSON](../types/DataJSON.md) | Yes|Method parameters| ### Return type: [DataJSON](../types/DataJSON.md) diff --git a/old_docs/API_docs_v66/methods/channels_checkUsername.md b/old_docs/API_docs_v66/methods/channels_checkUsername.md index 371f4cd3..7bc7c245 100644 --- a/old_docs/API_docs_v66/methods/channels_checkUsername.md +++ b/old_docs/API_docs_v66/methods/channels_checkUsername.md @@ -1,17 +1,19 @@ --- title: channels.checkUsername -description: channels.checkUsername parameters, return type and example +description: Check if this username is free and can be assigned to a channel/supergroup --- ## Method: channels.checkUsername [Back to methods index](index.md) +Check if this username is free and can be assigned to a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|username|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|username|[CLICK ME string](../types/string.md) | Yes|The new username for this channel/supergroup| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v66/methods/channels_createChannel.md b/old_docs/API_docs_v66/methods/channels_createChannel.md index c5d21585..1305e4fb 100644 --- a/old_docs/API_docs_v66/methods/channels_createChannel.md +++ b/old_docs/API_docs_v66/methods/channels_createChannel.md @@ -1,19 +1,21 @@ --- title: channels.createChannel -description: channels.createChannel parameters, return type and example +description: Create channel/supergroup --- ## Method: channels.createChannel [Back to methods index](index.md) +Create channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|broadcast|[CLICK ME Bool](../types/Bool.md) | Optional| -|megagroup|[CLICK ME Bool](../types/Bool.md) | Optional| -|title|[CLICK ME string](../types/string.md) | Yes| -|about|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|broadcast|[CLICK ME Bool](../types/Bool.md) | Optional|Set this to true to create a channel| +|megagroup|[CLICK ME Bool](../types/Bool.md) | Optional|Set this to true to create a supergroup| +|title|[CLICK ME string](../types/string.md) | Yes|Supergroup/channel title| +|about|[CLICK ME string](../types/string.md) | Yes|About text| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v66/methods/channels_deleteChannel.md b/old_docs/API_docs_v66/methods/channels_deleteChannel.md index 61b29eac..e660d25c 100644 --- a/old_docs/API_docs_v66/methods/channels_deleteChannel.md +++ b/old_docs/API_docs_v66/methods/channels_deleteChannel.md @@ -1,16 +1,18 @@ --- title: channels.deleteChannel -description: channels.deleteChannel parameters, return type and example +description: Delete a channel/supergroup --- ## Method: channels.deleteChannel [Back to methods index](index.md) +Delete a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup to delete| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v66/methods/channels_deleteMessages.md b/old_docs/API_docs_v66/methods/channels_deleteMessages.md index 87a968c5..fb9d3cc2 100644 --- a/old_docs/API_docs_v66/methods/channels_deleteMessages.md +++ b/old_docs/API_docs_v66/methods/channels_deleteMessages.md @@ -1,17 +1,19 @@ --- title: channels.deleteMessages -description: channels.deleteMessages parameters, return type and example +description: Delete channel/supergroup messages --- ## Method: channels.deleteMessages [Back to methods index](index.md) +Delete channel/supergroup messages + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|id|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to delete| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v66/methods/channels_deleteUserHistory.md b/old_docs/API_docs_v66/methods/channels_deleteUserHistory.md index ee828f45..fbe34341 100644 --- a/old_docs/API_docs_v66/methods/channels_deleteUserHistory.md +++ b/old_docs/API_docs_v66/methods/channels_deleteUserHistory.md @@ -1,17 +1,19 @@ --- title: channels.deleteUserHistory -description: channels.deleteUserHistory parameters, return type and example +description: Delete all messages of a user in a channel/supergroup --- ## Method: channels.deleteUserHistory [Back to methods index](index.md) +Delete all messages of a user in a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) diff --git a/old_docs/API_docs_v66/methods/channels_editAbout.md b/old_docs/API_docs_v66/methods/channels_editAbout.md index 94be2503..8908f29e 100644 --- a/old_docs/API_docs_v66/methods/channels_editAbout.md +++ b/old_docs/API_docs_v66/methods/channels_editAbout.md @@ -1,17 +1,19 @@ --- title: channels.editAbout -description: channels.editAbout parameters, return type and example +description: Edit the about text of a channel/supergroup --- ## Method: channels.editAbout [Back to methods index](index.md) +Edit the about text of a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|about|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|about|[CLICK ME string](../types/string.md) | Yes|The new about text| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v66/methods/channels_editAdmin.md b/old_docs/API_docs_v66/methods/channels_editAdmin.md index e1917c89..695c5294 100644 --- a/old_docs/API_docs_v66/methods/channels_editAdmin.md +++ b/old_docs/API_docs_v66/methods/channels_editAdmin.md @@ -1,18 +1,20 @@ --- title: channels.editAdmin -description: channels.editAdmin parameters, return type and example +description: Edit admin permissions of a user in a channel/supergroup --- ## Method: channels.editAdmin [Back to methods index](index.md) +Edit admin permissions of a user in a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|role|[CLICK ME ChannelParticipantRole](../types/ChannelParticipantRole.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| +|role|[CLICK ME ChannelParticipantRole](../types/ChannelParticipantRole.md) | Yes|| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v66/methods/channels_editPhoto.md b/old_docs/API_docs_v66/methods/channels_editPhoto.md index 3a2c794b..9ccd864f 100644 --- a/old_docs/API_docs_v66/methods/channels_editPhoto.md +++ b/old_docs/API_docs_v66/methods/channels_editPhoto.md @@ -1,17 +1,19 @@ --- title: channels.editPhoto -description: channels.editPhoto parameters, return type and example +description: Edit the photo of a supergroup/channel --- ## Method: channels.editPhoto [Back to methods index](index.md) +Edit the photo of a supergroup/channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new photo| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v66/methods/channels_editTitle.md b/old_docs/API_docs_v66/methods/channels_editTitle.md index ec60e10f..b1024faf 100644 --- a/old_docs/API_docs_v66/methods/channels_editTitle.md +++ b/old_docs/API_docs_v66/methods/channels_editTitle.md @@ -1,17 +1,19 @@ --- title: channels.editTitle -description: channels.editTitle parameters, return type and example +description: Edit the title of a supergroup/channel --- ## Method: channels.editTitle [Back to methods index](index.md) +Edit the title of a supergroup/channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|title|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|title|[CLICK ME string](../types/string.md) | Yes|The new channel/supergroup title| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v66/methods/channels_exportInvite.md b/old_docs/API_docs_v66/methods/channels_exportInvite.md index 3c10f832..f0c737d5 100644 --- a/old_docs/API_docs_v66/methods/channels_exportInvite.md +++ b/old_docs/API_docs_v66/methods/channels_exportInvite.md @@ -1,16 +1,18 @@ --- title: channels.exportInvite -description: channels.exportInvite parameters, return type and example +description: Export the invite link of a channel --- ## Method: channels.exportInvite [Back to methods index](index.md) +Export the invite link of a channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| ### Return type: [ExportedChatInvite](../types/ExportedChatInvite.md) diff --git a/old_docs/API_docs_v66/methods/channels_exportMessageLink.md b/old_docs/API_docs_v66/methods/channels_exportMessageLink.md index 924dc0d5..f910b594 100644 --- a/old_docs/API_docs_v66/methods/channels_exportMessageLink.md +++ b/old_docs/API_docs_v66/methods/channels_exportMessageLink.md @@ -1,17 +1,19 @@ --- title: channels.exportMessageLink -description: channels.exportMessageLink parameters, return type and example +description: Get the link of a message in a channel --- ## Method: channels.exportMessageLink [Back to methods index](index.md) +Get the link of a message in a channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|id|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|id|[CLICK ME int](../types/int.md) | Yes|The ID of the message| ### Return type: [ExportedMessageLink](../types/ExportedMessageLink.md) diff --git a/old_docs/API_docs_v66/methods/channels_getAdminedPublicChannels.md b/old_docs/API_docs_v66/methods/channels_getAdminedPublicChannels.md index f2b48050..9646f529 100644 --- a/old_docs/API_docs_v66/methods/channels_getAdminedPublicChannels.md +++ b/old_docs/API_docs_v66/methods/channels_getAdminedPublicChannels.md @@ -1,11 +1,13 @@ --- title: channels.getAdminedPublicChannels -description: channels.getAdminedPublicChannels parameters, return type and example +description: Get all supergroups/channels where you're admin --- ## Method: channels.getAdminedPublicChannels [Back to methods index](index.md) +Get all supergroups/channels where you're admin + ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v66/methods/channels_getChannels.md b/old_docs/API_docs_v66/methods/channels_getChannels.md index bd5958d6..9cd9e798 100644 --- a/old_docs/API_docs_v66/methods/channels_getChannels.md +++ b/old_docs/API_docs_v66/methods/channels_getChannels.md @@ -1,16 +1,18 @@ --- title: channels.getChannels -description: channels.getChannels parameters, return type and example +description: Get info about multiple channels/supergroups --- ## Method: channels.getChannels [Back to methods index](index.md) +Get info about multiple channels/supergroups + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|Array of [Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|Array of [Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Yes|The channel/supergroup MTProto IDs| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v66/methods/channels_getMessages.md b/old_docs/API_docs_v66/methods/channels_getMessages.md index 4440856c..cc944fe5 100644 --- a/old_docs/API_docs_v66/methods/channels_getMessages.md +++ b/old_docs/API_docs_v66/methods/channels_getMessages.md @@ -1,17 +1,19 @@ --- title: channels.getMessages -description: channels.getMessages parameters, return type and example +description: Get channel/supergroup messages --- ## Method: channels.getMessages [Back to methods index](index.md) +Get channel/supergroup messages + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|id|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The message IDs| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v66/methods/channels_getParticipant.md b/old_docs/API_docs_v66/methods/channels_getParticipant.md index c1819b6b..db9b1fc6 100644 --- a/old_docs/API_docs_v66/methods/channels_getParticipant.md +++ b/old_docs/API_docs_v66/methods/channels_getParticipant.md @@ -1,17 +1,19 @@ --- title: channels.getParticipant -description: channels.getParticipant parameters, return type and example +description: Get info about a certain channel/supergroup participant --- ## Method: channels.getParticipant [Back to methods index](index.md) +Get info about a certain channel/supergroup participant + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to fetch info about| ### Return type: [channels\_ChannelParticipant](../types/channels_ChannelParticipant.md) diff --git a/old_docs/API_docs_v66/methods/channels_getParticipants.md b/old_docs/API_docs_v66/methods/channels_getParticipants.md index 7ec8a980..96662466 100644 --- a/old_docs/API_docs_v66/methods/channels_getParticipants.md +++ b/old_docs/API_docs_v66/methods/channels_getParticipants.md @@ -1,19 +1,21 @@ --- title: channels.getParticipants -description: channels.getParticipants parameters, return type and example +description: Get channel/supergroup participants (you should use `$MadelineProto->get_pwr_chat($id)` instead) --- ## Method: channels.getParticipants [Back to methods index](index.md) +Get channel/supergroup participants (you should use `$MadelineProto->get_pwr_chat($id)` instead) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|filter|[CLICK ME ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) | Yes| -|offset|[CLICK ME int](../types/int.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|filter|[CLICK ME ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) | Yes|Member filter| +|offset|[CLICK ME int](../types/int.md) | Yes|Offset| +|limit|[CLICK ME int](../types/int.md) | Yes|Limit| ### Return type: [channels\_ChannelParticipants](../types/channels_ChannelParticipants.md) diff --git a/old_docs/API_docs_v66/methods/channels_inviteToChannel.md b/old_docs/API_docs_v66/methods/channels_inviteToChannel.md index 9bca2967..676f800c 100644 --- a/old_docs/API_docs_v66/methods/channels_inviteToChannel.md +++ b/old_docs/API_docs_v66/methods/channels_inviteToChannel.md @@ -1,17 +1,19 @@ --- title: channels.inviteToChannel -description: channels.inviteToChannel parameters, return type and example +description: Add users to channel/supergroup --- ## Method: channels.inviteToChannel [Back to methods index](index.md) +Add users to channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to add| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v66/methods/channels_joinChannel.md b/old_docs/API_docs_v66/methods/channels_joinChannel.md index 9ecdbe75..721f707c 100644 --- a/old_docs/API_docs_v66/methods/channels_joinChannel.md +++ b/old_docs/API_docs_v66/methods/channels_joinChannel.md @@ -1,16 +1,18 @@ --- title: channels.joinChannel -description: channels.joinChannel parameters, return type and example +description: Join a channel/supergroup --- ## Method: channels.joinChannel [Back to methods index](index.md) +Join a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup to join| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v66/methods/channels_leaveChannel.md b/old_docs/API_docs_v66/methods/channels_leaveChannel.md index 62c20a00..7f02e08c 100644 --- a/old_docs/API_docs_v66/methods/channels_leaveChannel.md +++ b/old_docs/API_docs_v66/methods/channels_leaveChannel.md @@ -1,16 +1,18 @@ --- title: channels.leaveChannel -description: channels.leaveChannel parameters, return type and example +description: Leave a channel/supergroup --- ## Method: channels.leaveChannel [Back to methods index](index.md) +Leave a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup to leave| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v66/methods/channels_readHistory.md b/old_docs/API_docs_v66/methods/channels_readHistory.md index 745893f6..cca891f0 100644 --- a/old_docs/API_docs_v66/methods/channels_readHistory.md +++ b/old_docs/API_docs_v66/methods/channels_readHistory.md @@ -1,17 +1,19 @@ --- title: channels.readHistory -description: channels.readHistory parameters, return type and example +description: Mark channel/supergroup history as read --- ## Method: channels.readHistory [Back to methods index](index.md) +Mark channel/supergroup history as read + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|max\_id|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to mark as read| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v66/methods/channels_reportSpam.md b/old_docs/API_docs_v66/methods/channels_reportSpam.md index 47dd7cff..09af14e0 100644 --- a/old_docs/API_docs_v66/methods/channels_reportSpam.md +++ b/old_docs/API_docs_v66/methods/channels_reportSpam.md @@ -1,18 +1,20 @@ --- title: channels.reportSpam -description: channels.reportSpam parameters, return type and example +description: Report a supergroup/channel for spam --- ## Method: channels.reportSpam [Back to methods index](index.md) +Report a supergroup/channel for spam + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|id|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that added you to this channel| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to report| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v66/methods/channels_toggleInvites.md b/old_docs/API_docs_v66/methods/channels_toggleInvites.md index b6771ed3..5b541f67 100644 --- a/old_docs/API_docs_v66/methods/channels_toggleInvites.md +++ b/old_docs/API_docs_v66/methods/channels_toggleInvites.md @@ -1,17 +1,19 @@ --- title: channels.toggleInvites -description: channels.toggleInvites parameters, return type and example +description: Allow or disallow any user to invite users to this channel/supergroup --- ## Method: channels.toggleInvites [Back to methods index](index.md) +Allow or disallow any user to invite users to this channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Allow or disallow| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v66/methods/channels_toggleSignatures.md b/old_docs/API_docs_v66/methods/channels_toggleSignatures.md index e8ff70a8..f233a8e1 100644 --- a/old_docs/API_docs_v66/methods/channels_toggleSignatures.md +++ b/old_docs/API_docs_v66/methods/channels_toggleSignatures.md @@ -1,17 +1,19 @@ --- title: channels.toggleSignatures -description: channels.toggleSignatures parameters, return type and example +description: Toggle channel signatures --- ## Method: channels.toggleSignatures [Back to methods index](index.md) +Toggle channel signatures + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Enable or disable channel signatures?| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v66/methods/channels_updatePinnedMessage.md b/old_docs/API_docs_v66/methods/channels_updatePinnedMessage.md index 7a14b68b..f06d1f0f 100644 --- a/old_docs/API_docs_v66/methods/channels_updatePinnedMessage.md +++ b/old_docs/API_docs_v66/methods/channels_updatePinnedMessage.md @@ -1,18 +1,20 @@ --- title: channels.updatePinnedMessage -description: channels.updatePinnedMessage parameters, return type and example +description: Set the pinned message of a channel/supergroup --- ## Method: channels.updatePinnedMessage [Back to methods index](index.md) +Set the pinned message of a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|id|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Pin silently| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|id|[CLICK ME int](../types/int.md) | Yes|The ID of the message to pin| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v66/methods/channels_updateUsername.md b/old_docs/API_docs_v66/methods/channels_updateUsername.md index 19647598..ad34490a 100644 --- a/old_docs/API_docs_v66/methods/channels_updateUsername.md +++ b/old_docs/API_docs_v66/methods/channels_updateUsername.md @@ -1,17 +1,19 @@ --- title: channels.updateUsername -description: channels.updateUsername parameters, return type and example +description: Update the username of a supergroup/channel --- ## Method: channels.updateUsername [Back to methods index](index.md) +Update the username of a supergroup/channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|username|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|username|[CLICK ME string](../types/string.md) | Yes|The new username| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v66/methods/contacts_getBlocked.md b/old_docs/API_docs_v66/methods/contacts_getBlocked.md index d7d8c5cc..300025af 100644 --- a/old_docs/API_docs_v66/methods/contacts_getBlocked.md +++ b/old_docs/API_docs_v66/methods/contacts_getBlocked.md @@ -12,7 +12,7 @@ Get blocked users | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, then set to the number of blocked contacts previously fetched| +|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, Then set to the number of blocked contacts previously fetched| |limit|[CLICK ME int](../types/int.md) | Yes|How many blocked contacts to fetch| diff --git a/old_docs/API_docs_v66/methods/contacts_getTopPeers.md b/old_docs/API_docs_v66/methods/contacts_getTopPeers.md index 2bad9a2a..b3f51975 100644 --- a/old_docs/API_docs_v66/methods/contacts_getTopPeers.md +++ b/old_docs/API_docs_v66/methods/contacts_getTopPeers.md @@ -17,7 +17,7 @@ Get most used chats |bots\_inline|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch inline bots?| |groups|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch groups?| |channels|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch channels and supergroups?| -|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, then `$offset += $contacts_TopPeers['categories']['count'];`| +|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, Then `$offset += $contacts_TopPeers['categories']['count'];`| |limit|[CLICK ME int](../types/int.md) | Yes|How many results to fetch| |hash|[CLICK ME int](../types/int.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched peer ids);| diff --git a/old_docs/API_docs_v66/methods/help_getAppChangelog.md b/old_docs/API_docs_v66/methods/help_getAppChangelog.md index ea7192f6..477df2f8 100644 --- a/old_docs/API_docs_v66/methods/help_getAppChangelog.md +++ b/old_docs/API_docs_v66/methods/help_getAppChangelog.md @@ -1,16 +1,18 @@ --- title: help.getAppChangelog -description: help.getAppChangelog parameters, return type and example +description: Get the changelog of this app --- ## Method: help.getAppChangelog [Back to methods index](index.md) +Get the changelog of this app + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|prev\_app\_version|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|prev\_app\_version|[CLICK ME string](../types/string.md) | Yes|Previous app version| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v66/methods/help_getAppUpdate.md b/old_docs/API_docs_v66/methods/help_getAppUpdate.md index ef72cce2..b88906ae 100644 --- a/old_docs/API_docs_v66/methods/help_getAppUpdate.md +++ b/old_docs/API_docs_v66/methods/help_getAppUpdate.md @@ -1,11 +1,13 @@ --- title: help.getAppUpdate -description: help.getAppUpdate parameters, return type and example +description: Get info about app updates --- ## Method: help.getAppUpdate [Back to methods index](index.md) +Get info about app updates + ### Return type: [help\_AppUpdate](../types/help_AppUpdate.md) diff --git a/old_docs/API_docs_v66/methods/help_getCdnConfig.md b/old_docs/API_docs_v66/methods/help_getCdnConfig.md index 55a6e6fd..809ea1fb 100644 --- a/old_docs/API_docs_v66/methods/help_getCdnConfig.md +++ b/old_docs/API_docs_v66/methods/help_getCdnConfig.md @@ -1,11 +1,13 @@ --- title: help.getCdnConfig -description: help.getCdnConfig parameters, return type and example +description: Get CDN configuration --- ## Method: help.getCdnConfig [Back to methods index](index.md) +Get CDN configuration + ### Return type: [CdnConfig](../types/CdnConfig.md) diff --git a/old_docs/API_docs_v66/methods/help_getConfig.md b/old_docs/API_docs_v66/methods/help_getConfig.md index 885ad5d3..16e25c68 100644 --- a/old_docs/API_docs_v66/methods/help_getConfig.md +++ b/old_docs/API_docs_v66/methods/help_getConfig.md @@ -1,11 +1,13 @@ --- title: help.getConfig -description: help.getConfig parameters, return type and example +description: Get server configuration --- ## Method: help.getConfig [Back to methods index](index.md) +Get server configuration + ### Return type: [Config](../types/Config.md) diff --git a/old_docs/API_docs_v66/methods/help_getInviteText.md b/old_docs/API_docs_v66/methods/help_getInviteText.md index 101ead40..6b226bff 100644 --- a/old_docs/API_docs_v66/methods/help_getInviteText.md +++ b/old_docs/API_docs_v66/methods/help_getInviteText.md @@ -1,11 +1,13 @@ --- title: help.getInviteText -description: help.getInviteText parameters, return type and example +description: Get invitation text --- ## Method: help.getInviteText [Back to methods index](index.md) +Get invitation text + ### Return type: [help\_InviteText](../types/help_InviteText.md) diff --git a/old_docs/API_docs_v66/methods/help_getNearestDc.md b/old_docs/API_docs_v66/methods/help_getNearestDc.md index 6196890b..35a8bf91 100644 --- a/old_docs/API_docs_v66/methods/help_getNearestDc.md +++ b/old_docs/API_docs_v66/methods/help_getNearestDc.md @@ -1,11 +1,13 @@ --- title: help.getNearestDc -description: help.getNearestDc parameters, return type and example +description: Get nearest datacenter --- ## Method: help.getNearestDc [Back to methods index](index.md) +Get nearest datacenter + ### Return type: [NearestDc](../types/NearestDc.md) diff --git a/old_docs/API_docs_v66/methods/help_getSupport.md b/old_docs/API_docs_v66/methods/help_getSupport.md index 9b269f78..a5bab0f2 100644 --- a/old_docs/API_docs_v66/methods/help_getSupport.md +++ b/old_docs/API_docs_v66/methods/help_getSupport.md @@ -1,11 +1,13 @@ --- title: help.getSupport -description: help.getSupport parameters, return type and example +description: Get info of support user --- ## Method: help.getSupport [Back to methods index](index.md) +Get info of support user + ### Return type: [help\_Support](../types/help_Support.md) diff --git a/old_docs/API_docs_v66/methods/help_getTermsOfService.md b/old_docs/API_docs_v66/methods/help_getTermsOfService.md index f63807ab..487cd83a 100644 --- a/old_docs/API_docs_v66/methods/help_getTermsOfService.md +++ b/old_docs/API_docs_v66/methods/help_getTermsOfService.md @@ -1,11 +1,13 @@ --- title: help.getTermsOfService -description: help.getTermsOfService parameters, return type and example +description: Get terms of service --- ## Method: help.getTermsOfService [Back to methods index](index.md) +Get terms of service + ### Return type: [help\_TermsOfService](../types/help_TermsOfService.md) diff --git a/old_docs/API_docs_v66/methods/help_saveAppLog.md b/old_docs/API_docs_v66/methods/help_saveAppLog.md index af6e94e2..0165b6e3 100644 --- a/old_docs/API_docs_v66/methods/help_saveAppLog.md +++ b/old_docs/API_docs_v66/methods/help_saveAppLog.md @@ -1,16 +1,18 @@ --- title: help.saveAppLog -description: help.saveAppLog parameters, return type and example +description: Log data for developer of this app --- ## Method: help.saveAppLog [Back to methods index](index.md) +Log data for developer of this app + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|events|Array of [CLICK ME InputAppEvent](../types/InputAppEvent.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|events|Array of [CLICK ME InputAppEvent](../types/InputAppEvent.md) | Yes|Event list| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v66/methods/help_setBotUpdatesStatus.md b/old_docs/API_docs_v66/methods/help_setBotUpdatesStatus.md index 3351fab4..ff314b5c 100644 --- a/old_docs/API_docs_v66/methods/help_setBotUpdatesStatus.md +++ b/old_docs/API_docs_v66/methods/help_setBotUpdatesStatus.md @@ -1,17 +1,19 @@ --- title: help.setBotUpdatesStatus -description: help.setBotUpdatesStatus parameters, return type and example +description: Set the update status of webhook --- ## Method: help.setBotUpdatesStatus [Back to methods index](index.md) +Set the update status of webhook + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|pending\_updates\_count|[CLICK ME int](../types/int.md) | Yes| -|message|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|pending\_updates\_count|[CLICK ME int](../types/int.md) | Yes|Pending update count| +|message|[CLICK ME string](../types/string.md) | Yes|Message| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v66/methods/messages_checkChatInvite.md b/old_docs/API_docs_v66/methods/messages_checkChatInvite.md index 4ddf5084..de1d9ff4 100644 --- a/old_docs/API_docs_v66/methods/messages_checkChatInvite.md +++ b/old_docs/API_docs_v66/methods/messages_checkChatInvite.md @@ -1,16 +1,18 @@ --- title: messages.checkChatInvite -description: messages.checkChatInvite parameters, return type and example +description: Check if an invitation link is valid --- ## Method: messages.checkChatInvite [Back to methods index](index.md) +Check if an invitation link is valid + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| ### Return type: [ChatInvite](../types/ChatInvite.md) diff --git a/old_docs/API_docs_v66/methods/messages_clearRecentStickers.md b/old_docs/API_docs_v66/methods/messages_clearRecentStickers.md index f017087f..9c1b3754 100644 --- a/old_docs/API_docs_v66/methods/messages_clearRecentStickers.md +++ b/old_docs/API_docs_v66/methods/messages_clearRecentStickers.md @@ -1,16 +1,18 @@ --- title: messages.clearRecentStickers -description: messages.clearRecentStickers parameters, return type and example +description: Clear all recent stickers --- ## Method: messages.clearRecentStickers [Back to methods index](index.md) +Clear all recent stickers + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|attached|[CLICK ME Bool](../types/Bool.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|attached|[CLICK ME Bool](../types/Bool.md) | Optional|Clear recent stickers attached to images?| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v66/methods/messages_deleteChatUser.md b/old_docs/API_docs_v66/methods/messages_deleteChatUser.md index a71f4aaf..0a6830de 100644 --- a/old_docs/API_docs_v66/methods/messages_deleteChatUser.md +++ b/old_docs/API_docs_v66/methods/messages_deleteChatUser.md @@ -12,7 +12,7 @@ Delete a user from a chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The MTProto ID of the chat| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to delete (pass @me to leave the chat)| diff --git a/old_docs/API_docs_v66/methods/messages_editChatAdmin.md b/old_docs/API_docs_v66/methods/messages_editChatAdmin.md index 6bc8f9ae..7916f8b1 100644 --- a/old_docs/API_docs_v66/methods/messages_editChatAdmin.md +++ b/old_docs/API_docs_v66/methods/messages_editChatAdmin.md @@ -1,18 +1,20 @@ --- title: messages.editChatAdmin -description: messages.editChatAdmin parameters, return type and example +description: Edit admin permissions --- ## Method: messages.editChatAdmin [Back to methods index](index.md) +Edit admin permissions + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|is\_admin|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat ID (no supergroups)| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user ID| +|is\_admin|[CLICK ME Bool](../types/Bool.md) | Yes|Should the user be admin?| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v66/methods/messages_editChatPhoto.md b/old_docs/API_docs_v66/methods/messages_editChatPhoto.md index 8848eca7..122913c4 100644 --- a/old_docs/API_docs_v66/methods/messages_editChatPhoto.md +++ b/old_docs/API_docs_v66/methods/messages_editChatPhoto.md @@ -12,7 +12,7 @@ Edit the photo of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The MTProto ID of the chat| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| |photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| diff --git a/old_docs/API_docs_v66/methods/messages_editChatTitle.md b/old_docs/API_docs_v66/methods/messages_editChatTitle.md index 1c1c7a16..3a1e974b 100644 --- a/old_docs/API_docs_v66/methods/messages_editChatTitle.md +++ b/old_docs/API_docs_v66/methods/messages_editChatTitle.md @@ -12,7 +12,7 @@ Edit the title of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The MTProto ID of the chat| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| |title|[CLICK ME string](../types/string.md) | Yes|The new title| diff --git a/old_docs/API_docs_v66/methods/messages_editInlineBotMessage.md b/old_docs/API_docs_v66/methods/messages_editInlineBotMessage.md index c0d06614..2237fb20 100644 --- a/old_docs/API_docs_v66/methods/messages_editInlineBotMessage.md +++ b/old_docs/API_docs_v66/methods/messages_editInlineBotMessage.md @@ -1,20 +1,22 @@ --- title: messages.editInlineBotMessage -description: messages.editInlineBotMessage parameters, return type and example +description: Edit a sent inline message --- ## Method: messages.editInlineBotMessage [Back to methods index](index.md) +Edit a sent inline message + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional| -|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes| -|message|[CLICK ME string](../types/string.md) | Optional| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview| +|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The message ID| +|message|[CLICK ME string](../types/string.md) | Optional|The new message| +|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| +|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/old_docs/API_docs_v66/methods/messages_editMessage.md b/old_docs/API_docs_v66/methods/messages_editMessage.md index 2e98318d..177438a5 100644 --- a/old_docs/API_docs_v66/methods/messages_editMessage.md +++ b/old_docs/API_docs_v66/methods/messages_editMessage.md @@ -1,21 +1,23 @@ --- title: messages.editMessage -description: messages.editMessage parameters, return type and example +description: Edit a message --- ## Method: messages.editMessage [Back to methods index](index.md) +Edit a message + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|id|[CLICK ME int](../types/int.md) | Yes| -|message|[CLICK ME string](../types/string.md) | Optional| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| +|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|message|[CLICK ME string](../types/string.md) | Optional|The new message| +|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| +|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/old_docs/API_docs_v66/methods/messages_exportChatInvite.md b/old_docs/API_docs_v66/methods/messages_exportChatInvite.md index 74d70c21..98685d96 100644 --- a/old_docs/API_docs_v66/methods/messages_exportChatInvite.md +++ b/old_docs/API_docs_v66/methods/messages_exportChatInvite.md @@ -1,16 +1,18 @@ --- title: messages.exportChatInvite -description: messages.exportChatInvite parameters, return type and example +description: Export chat invite --- ## Method: messages.exportChatInvite [Back to methods index](index.md) +Export chat invite + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat id | ### Return type: [ExportedChatInvite](../types/ExportedChatInvite.md) diff --git a/old_docs/API_docs_v66/methods/messages_getAllChats.md b/old_docs/API_docs_v66/methods/messages_getAllChats.md index 4b87df49..127456e4 100644 --- a/old_docs/API_docs_v66/methods/messages_getAllChats.md +++ b/old_docs/API_docs_v66/methods/messages_getAllChats.md @@ -1,16 +1,18 @@ --- title: messages.getAllChats -description: messages.getAllChats parameters, return type and example +description: Get all chats (not supergroups or channels) --- ## Method: messages.getAllChats [Back to methods index](index.md) +Get all chats (not supergroups or channels) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|except\_ids|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|except\_ids|Array of [CLICK ME int](../types/int.md) | Yes|Do not fetch these chats (MTProto id)| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v66/methods/messages_getAllDrafts.md b/old_docs/API_docs_v66/methods/messages_getAllDrafts.md index a5dd59f6..2c0ecd42 100644 --- a/old_docs/API_docs_v66/methods/messages_getAllDrafts.md +++ b/old_docs/API_docs_v66/methods/messages_getAllDrafts.md @@ -1,11 +1,13 @@ --- title: messages.getAllDrafts -description: messages.getAllDrafts parameters, return type and example +description: Get all message drafts --- ## Method: messages.getAllDrafts [Back to methods index](index.md) +Get all message drafts + ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v66/methods/messages_getAllStickers.md b/old_docs/API_docs_v66/methods/messages_getAllStickers.md index 575fcd49..16fdba6c 100644 --- a/old_docs/API_docs_v66/methods/messages_getAllStickers.md +++ b/old_docs/API_docs_v66/methods/messages_getAllStickers.md @@ -1,16 +1,18 @@ --- title: messages.getAllStickers -description: messages.getAllStickers parameters, return type and example +description: Get all stickerpacks --- ## Method: messages.getAllStickers [Back to methods index](index.md) +Get all stickerpacks + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v66/methods/messages_getArchivedStickers.md b/old_docs/API_docs_v66/methods/messages_getArchivedStickers.md index 1b4aaa93..f037e1bc 100644 --- a/old_docs/API_docs_v66/methods/messages_getArchivedStickers.md +++ b/old_docs/API_docs_v66/methods/messages_getArchivedStickers.md @@ -1,18 +1,20 @@ --- title: messages.getArchivedStickers -description: messages.getArchivedStickers parameters, return type and example +description: Get all archived stickers --- ## Method: messages.getArchivedStickers [Back to methods index](index.md) +Get all archived stickers + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|masks|[CLICK ME Bool](../types/Bool.md) | Optional| -|offset\_id|[CLICK ME long](../types/long.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|masks|[CLICK ME Bool](../types/Bool.md) | Optional|Get masks?| +|offset\_id|[CLICK ME long](../types/long.md) | Yes|Sticker ID offset| +|limit|[CLICK ME int](../types/int.md) | Yes|Number of stickers to fetch| ### Return type: [messages\_ArchivedStickers](../types/messages_ArchivedStickers.md) diff --git a/old_docs/API_docs_v66/methods/messages_getAttachedStickers.md b/old_docs/API_docs_v66/methods/messages_getAttachedStickers.md index a0d89b31..890680cd 100644 --- a/old_docs/API_docs_v66/methods/messages_getAttachedStickers.md +++ b/old_docs/API_docs_v66/methods/messages_getAttachedStickers.md @@ -1,16 +1,18 @@ --- title: messages.getAttachedStickers -description: messages.getAttachedStickers parameters, return type and example +description: Get stickers attachable to images --- ## Method: messages.getAttachedStickers [Back to methods index](index.md) +Get stickers attachable to images + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|media|[CLICK ME InputStickeredMedia](../types/InputStickeredMedia.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|media|[CLICK ME InputStickeredMedia](../types/InputStickeredMedia.md) | Yes|The stickered media| ### Return type: [Vector\_of\_StickerSetCovered](../types/StickerSetCovered.md) diff --git a/old_docs/API_docs_v66/methods/messages_getBotCallbackAnswer.md b/old_docs/API_docs_v66/methods/messages_getBotCallbackAnswer.md index 7ccd0d1b..09c283f5 100644 --- a/old_docs/API_docs_v66/methods/messages_getBotCallbackAnswer.md +++ b/old_docs/API_docs_v66/methods/messages_getBotCallbackAnswer.md @@ -1,19 +1,21 @@ --- title: messages.getBotCallbackAnswer -description: messages.getBotCallbackAnswer parameters, return type and example +description: Get the callback answer of a bot (after clicking a button) --- ## Method: messages.getBotCallbackAnswer [Back to methods index](index.md) +Get the callback answer of a bot (after clicking a button) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|game|[CLICK ME Bool](../types/Bool.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|msg\_id|[CLICK ME int](../types/int.md) | Yes| -|data|[CLICK ME bytes](../types/bytes.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|game|[CLICK ME Bool](../types/Bool.md) | Optional|Is this a game?| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| +|msg\_id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|data|[CLICK ME bytes](../types/bytes.md) | Optional|The data to send to the bot| ### Return type: [messages\_BotCallbackAnswer](../types/messages_BotCallbackAnswer.md) diff --git a/old_docs/API_docs_v66/methods/messages_getCommonChats.md b/old_docs/API_docs_v66/methods/messages_getCommonChats.md index a57d7f5a..e6eca283 100644 --- a/old_docs/API_docs_v66/methods/messages_getCommonChats.md +++ b/old_docs/API_docs_v66/methods/messages_getCommonChats.md @@ -1,18 +1,20 @@ --- title: messages.getCommonChats -description: messages.getCommonChats parameters, return type and example +description: Get chats in common with a user --- ## Method: messages.getCommonChats [Back to methods index](index.md) +Get chats in common with a user + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|max\_id|[CLICK ME int](../types/int.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| +|max\_id|[CLICK ME int](../types/int.md) | Yes|The maximum chat ID to fetch| +|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to fetch| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v66/methods/messages_getDocumentByHash.md b/old_docs/API_docs_v66/methods/messages_getDocumentByHash.md index b7c45398..1af5bad4 100644 --- a/old_docs/API_docs_v66/methods/messages_getDocumentByHash.md +++ b/old_docs/API_docs_v66/methods/messages_getDocumentByHash.md @@ -1,18 +1,20 @@ --- title: messages.getDocumentByHash -description: messages.getDocumentByHash parameters, return type and example +description: Get document by SHA256 hash --- ## Method: messages.getDocumentByHash [Back to methods index](index.md) +Get document by SHA256 hash + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|sha256|[CLICK ME bytes](../types/bytes.md) | Yes| -|size|[CLICK ME int](../types/int.md) | Yes| -|mime\_type|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|sha256|[CLICK ME bytes](../types/bytes.md) | Yes|`hash('sha256', $filename, true);`| +|size|[CLICK ME int](../types/int.md) | Yes|The file size| +|mime\_type|[CLICK ME string](../types/string.md) | Yes|The mime type of the file| ### Return type: [Document](../types/Document.md) diff --git a/old_docs/API_docs_v66/methods/messages_getFeaturedStickers.md b/old_docs/API_docs_v66/methods/messages_getFeaturedStickers.md index 88b5609c..512f2e85 100644 --- a/old_docs/API_docs_v66/methods/messages_getFeaturedStickers.md +++ b/old_docs/API_docs_v66/methods/messages_getFeaturedStickers.md @@ -1,16 +1,18 @@ --- title: messages.getFeaturedStickers -description: messages.getFeaturedStickers parameters, return type and example +description: Get featured stickers --- ## Method: messages.getFeaturedStickers [Back to methods index](index.md) +Get featured stickers + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_FeaturedStickers](../types/messages_FeaturedStickers.md) diff --git a/old_docs/API_docs_v66/methods/messages_getGameHighScores.md b/old_docs/API_docs_v66/methods/messages_getGameHighScores.md index 2c95af05..5137baea 100644 --- a/old_docs/API_docs_v66/methods/messages_getGameHighScores.md +++ b/old_docs/API_docs_v66/methods/messages_getGameHighScores.md @@ -1,18 +1,20 @@ --- title: messages.getGameHighScores -description: messages.getGameHighScores parameters, return type and example +description: Get high scores of a game --- ## Method: messages.getGameHighScores [Back to methods index](index.md) +Get high scores of a game + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|id|[CLICK ME int](../types/int.md) | Yes| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| +|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the high scores| ### Return type: [messages\_HighScores](../types/messages_HighScores.md) diff --git a/old_docs/API_docs_v66/methods/messages_getInlineBotResults.md b/old_docs/API_docs_v66/methods/messages_getInlineBotResults.md index 5b2bb254..8ab5bf78 100644 --- a/old_docs/API_docs_v66/methods/messages_getInlineBotResults.md +++ b/old_docs/API_docs_v66/methods/messages_getInlineBotResults.md @@ -1,20 +1,22 @@ --- title: messages.getInlineBotResults -description: messages.getInlineBotResults parameters, return type and example +description: Call inline bot --- ## Method: messages.getInlineBotResults [Back to methods index](index.md) +Call inline bot + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional| -|query|[CLICK ME string](../types/string.md) | Yes| -|offset|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot to call| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to call the bot| +|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional|The current location| +|query|[CLICK ME string](../types/string.md) | Yes|The query to send to the bot| +|offset|[CLICK ME string](../types/string.md) | Yes|The offset to send to the bot| ### Return type: [messages\_BotResults](../types/messages_BotResults.md) diff --git a/old_docs/API_docs_v66/methods/messages_getInlineGameHighScores.md b/old_docs/API_docs_v66/methods/messages_getInlineGameHighScores.md index 447a55dd..790bfdd9 100644 --- a/old_docs/API_docs_v66/methods/messages_getInlineGameHighScores.md +++ b/old_docs/API_docs_v66/methods/messages_getInlineGameHighScores.md @@ -1,17 +1,19 @@ --- title: messages.getInlineGameHighScores -description: messages.getInlineGameHighScores parameters, return type and example +description: Get high scores of a game sent in an inline message --- ## Method: messages.getInlineGameHighScores [Back to methods index](index.md) +Get high scores of a game sent in an inline message + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The inline message| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the high scores| ### Return type: [messages\_HighScores](../types/messages_HighScores.md) diff --git a/old_docs/API_docs_v66/methods/messages_getMaskStickers.md b/old_docs/API_docs_v66/methods/messages_getMaskStickers.md index 80c16471..f4ed9411 100644 --- a/old_docs/API_docs_v66/methods/messages_getMaskStickers.md +++ b/old_docs/API_docs_v66/methods/messages_getMaskStickers.md @@ -1,16 +1,18 @@ --- title: messages.getMaskStickers -description: messages.getMaskStickers parameters, return type and example +description: Get masks --- ## Method: messages.getMaskStickers [Back to methods index](index.md) +Get masks + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v66/methods/messages_getMessageEditData.md b/old_docs/API_docs_v66/methods/messages_getMessageEditData.md index 339678bd..12e71bee 100644 --- a/old_docs/API_docs_v66/methods/messages_getMessageEditData.md +++ b/old_docs/API_docs_v66/methods/messages_getMessageEditData.md @@ -1,17 +1,19 @@ --- title: messages.getMessageEditData -description: messages.getMessageEditData parameters, return type and example +description: Check if about to edit a message or a media caption --- ## Method: messages.getMessageEditData [Back to methods index](index.md) +Check if about to edit a message or a media caption + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|id|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| +|id|[CLICK ME int](../types/int.md) | Yes|The message ID| ### Return type: [messages\_MessageEditData](../types/messages_MessageEditData.md) diff --git a/old_docs/API_docs_v66/methods/messages_getMessagesViews.md b/old_docs/API_docs_v66/methods/messages_getMessagesViews.md index e3f4e4ea..b8d78c85 100644 --- a/old_docs/API_docs_v66/methods/messages_getMessagesViews.md +++ b/old_docs/API_docs_v66/methods/messages_getMessagesViews.md @@ -1,18 +1,20 @@ --- title: messages.getMessagesViews -description: messages.getMessagesViews parameters, return type and example +description: Get and increase message views --- ## Method: messages.getMessagesViews [Back to methods index](index.md) +Get and increase message views + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|id|Array of [CLICK ME int](../types/int.md) | Yes| -|increment|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the message is located| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs messages to get| +|increment|[CLICK ME Bool](../types/Bool.md) | Yes|Increase message views?| ### Return type: [Vector\_of\_int](../types/int.md) diff --git a/old_docs/API_docs_v66/methods/messages_getPeerDialogs.md b/old_docs/API_docs_v66/methods/messages_getPeerDialogs.md index fe8a821c..da82cfc6 100644 --- a/old_docs/API_docs_v66/methods/messages_getPeerDialogs.md +++ b/old_docs/API_docs_v66/methods/messages_getPeerDialogs.md @@ -1,16 +1,18 @@ --- title: messages.getPeerDialogs -description: messages.getPeerDialogs parameters, return type and example +description: Get dialog info of peers --- ## Method: messages.getPeerDialogs [Back to methods index](index.md) +Get dialog info of peers + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peers|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peers|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Yes|The peers| ### Return type: [messages\_PeerDialogs](../types/messages_PeerDialogs.md) diff --git a/old_docs/API_docs_v66/methods/messages_getPinnedDialogs.md b/old_docs/API_docs_v66/methods/messages_getPinnedDialogs.md index 99ff5651..d12779fe 100644 --- a/old_docs/API_docs_v66/methods/messages_getPinnedDialogs.md +++ b/old_docs/API_docs_v66/methods/messages_getPinnedDialogs.md @@ -1,11 +1,13 @@ --- title: messages.getPinnedDialogs -description: messages.getPinnedDialogs parameters, return type and example +description: Get pinned dialogs --- ## Method: messages.getPinnedDialogs [Back to methods index](index.md) +Get pinned dialogs + ### Return type: [messages\_PeerDialogs](../types/messages_PeerDialogs.md) diff --git a/old_docs/API_docs_v66/methods/messages_getRecentStickers.md b/old_docs/API_docs_v66/methods/messages_getRecentStickers.md index abab7f44..d76a2160 100644 --- a/old_docs/API_docs_v66/methods/messages_getRecentStickers.md +++ b/old_docs/API_docs_v66/methods/messages_getRecentStickers.md @@ -1,17 +1,19 @@ --- title: messages.getRecentStickers -description: messages.getRecentStickers parameters, return type and example +description: Get recent stickers --- ## Method: messages.getRecentStickers [Back to methods index](index.md) +Get recent stickers + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|attached|[CLICK ME Bool](../types/Bool.md) | Optional| -|hash|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|attached|[CLICK ME Bool](../types/Bool.md) | Optional|Get stickers attached to image?| +|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_RecentStickers](../types/messages_RecentStickers.md) diff --git a/old_docs/API_docs_v66/methods/messages_getSavedGifs.md b/old_docs/API_docs_v66/methods/messages_getSavedGifs.md index 08dc4be6..f61348ce 100644 --- a/old_docs/API_docs_v66/methods/messages_getSavedGifs.md +++ b/old_docs/API_docs_v66/methods/messages_getSavedGifs.md @@ -1,16 +1,18 @@ --- title: messages.getSavedGifs -description: messages.getSavedGifs parameters, return type and example +description: Get saved gifs --- ## Method: messages.getSavedGifs [Back to methods index](index.md) +Get saved gifs + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_SavedGifs](../types/messages_SavedGifs.md) diff --git a/old_docs/API_docs_v66/methods/messages_getStickerSet.md b/old_docs/API_docs_v66/methods/messages_getStickerSet.md index 70bdd9ba..c86807e4 100644 --- a/old_docs/API_docs_v66/methods/messages_getStickerSet.md +++ b/old_docs/API_docs_v66/methods/messages_getStickerSet.md @@ -1,16 +1,18 @@ --- title: messages.getStickerSet -description: messages.getStickerSet parameters, return type and example +description: Get a stickerset --- ## Method: messages.getStickerSet [Back to methods index](index.md) +Get a stickerset + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset to get| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/old_docs/API_docs_v66/methods/messages_getWebPage.md b/old_docs/API_docs_v66/methods/messages_getWebPage.md index b29e5d25..129f8f06 100644 --- a/old_docs/API_docs_v66/methods/messages_getWebPage.md +++ b/old_docs/API_docs_v66/methods/messages_getWebPage.md @@ -1,17 +1,19 @@ --- title: messages.getWebPage -description: messages.getWebPage parameters, return type and example +description: Get webpage preview --- ## Method: messages.getWebPage [Back to methods index](index.md) +Get webpage preview + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|url|[CLICK ME string](../types/string.md) | Yes| -|hash|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|url|[CLICK ME string](../types/string.md) | Yes|URL| +|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [WebPage](../types/WebPage.md) diff --git a/old_docs/API_docs_v66/methods/messages_getWebPagePreview.md b/old_docs/API_docs_v66/methods/messages_getWebPagePreview.md index 35243c9f..d01bdd32 100644 --- a/old_docs/API_docs_v66/methods/messages_getWebPagePreview.md +++ b/old_docs/API_docs_v66/methods/messages_getWebPagePreview.md @@ -1,16 +1,18 @@ --- title: messages.getWebPagePreview -description: messages.getWebPagePreview parameters, return type and example +description: Get webpage preview --- ## Method: messages.getWebPagePreview [Back to methods index](index.md) +Get webpage preview + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|message|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|message|[CLICK ME string](../types/string.md) | Yes|Extract preview from this message| ### Return type: [MessageMedia](../types/MessageMedia.md) diff --git a/old_docs/API_docs_v66/methods/messages_importChatInvite.md b/old_docs/API_docs_v66/methods/messages_importChatInvite.md index 2bea5247..0d6cd7c8 100644 --- a/old_docs/API_docs_v66/methods/messages_importChatInvite.md +++ b/old_docs/API_docs_v66/methods/messages_importChatInvite.md @@ -1,16 +1,18 @@ --- title: messages.importChatInvite -description: messages.importChatInvite parameters, return type and example +description: Import chat invite --- ## Method: messages.importChatInvite [Back to methods index](index.md) +Import chat invite + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v66/methods/messages_installStickerSet.md b/old_docs/API_docs_v66/methods/messages_installStickerSet.md index 61513182..9f6f098c 100644 --- a/old_docs/API_docs_v66/methods/messages_installStickerSet.md +++ b/old_docs/API_docs_v66/methods/messages_installStickerSet.md @@ -1,17 +1,19 @@ --- title: messages.installStickerSet -description: messages.installStickerSet parameters, return type and example +description: Add a sticker set --- ## Method: messages.installStickerSet [Back to methods index](index.md) +Add a sticker set + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional| -|archived|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to add| +|archived|[CLICK ME Bool](../types/Bool.md) | Yes|Archive this set?| ### Return type: [messages\_StickerSetInstallResult](../types/messages_StickerSetInstallResult.md) diff --git a/old_docs/API_docs_v66/methods/messages_migrateChat.md b/old_docs/API_docs_v66/methods/messages_migrateChat.md index 5021ad45..db57adfa 100644 --- a/old_docs/API_docs_v66/methods/messages_migrateChat.md +++ b/old_docs/API_docs_v66/methods/messages_migrateChat.md @@ -1,16 +1,18 @@ --- title: messages.migrateChat -description: messages.migrateChat parameters, return type and example +description: Convert chat to supergroup --- ## Method: messages.migrateChat [Back to methods index](index.md) +Convert chat to supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat to convert| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v66/methods/messages_readEncryptedHistory.md b/old_docs/API_docs_v66/methods/messages_readEncryptedHistory.md index 4d341809..39b110e3 100644 --- a/old_docs/API_docs_v66/methods/messages_readEncryptedHistory.md +++ b/old_docs/API_docs_v66/methods/messages_readEncryptedHistory.md @@ -1,17 +1,19 @@ --- title: messages.readEncryptedHistory -description: messages.readEncryptedHistory parameters, return type and example +description: Mark messages as read in secret chats --- ## Method: messages.readEncryptedHistory [Back to methods index](index.md) +Mark messages as read in secret chats + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|max\_date|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to mark messages as read| +|max\_date|[CLICK ME int](../types/int.md) | Yes|Maximum date of messages to mark| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v66/methods/messages_readFeaturedStickers.md b/old_docs/API_docs_v66/methods/messages_readFeaturedStickers.md index 0631ca5b..4035c76d 100644 --- a/old_docs/API_docs_v66/methods/messages_readFeaturedStickers.md +++ b/old_docs/API_docs_v66/methods/messages_readFeaturedStickers.md @@ -1,16 +1,18 @@ --- title: messages.readFeaturedStickers -description: messages.readFeaturedStickers parameters, return type and example +description: Mark new featured stickers as read --- ## Method: messages.readFeaturedStickers [Back to methods index](index.md) +Mark new featured stickers as read + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|Array of [CLICK ME long](../types/long.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|Array of [CLICK ME long](../types/long.md) | Yes|The stickers to mark as read| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v66/methods/messages_readMessageContents.md b/old_docs/API_docs_v66/methods/messages_readMessageContents.md index 0d27c209..9bb1bee8 100644 --- a/old_docs/API_docs_v66/methods/messages_readMessageContents.md +++ b/old_docs/API_docs_v66/methods/messages_readMessageContents.md @@ -1,16 +1,18 @@ --- title: messages.readMessageContents -description: messages.readMessageContents parameters, return type and example +description: Mark message as read --- ## Method: messages.readMessageContents [Back to methods index](index.md) +Mark message as read + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v66/methods/messages_receivedQueue.md b/old_docs/API_docs_v66/methods/messages_receivedQueue.md index c91caa37..4ad78ba2 100644 --- a/old_docs/API_docs_v66/methods/messages_receivedQueue.md +++ b/old_docs/API_docs_v66/methods/messages_receivedQueue.md @@ -1,77 +1,13 @@ --- title: messages.receivedQueue -description: messages.receivedQueue parameters, return type and example +description: You cannot use this method directly --- ## Method: messages.receivedQueue [Back to methods index](index.md) -### Parameters: - -| Name | Type | Required | -|----------|---------------|----------| -|max\_qts|[CLICK ME int](../types/int.md) | Yes| - - -### 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| - - -### MadelineProto Example: - - -``` -if (!file_exists('madeline.php')) { - copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); -} -include 'madeline.php'; - -// !!! This API id/API hash combination will not work !!! -// !!! You must get your own @ my.telegram.org !!! -$api_id = 0; -$api_hash = ''; - -$MadelineProto = new \danog\MadelineProto\API('session.madeline', ['app_info' => ['api_id' => $api_id, 'api_hash' => $api_hash]]); -$MadelineProto->start(); - -$Vector_of_long = $MadelineProto->messages->receivedQueue(['max_qts' => int, ]); -``` - -### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): - -### As a bot: - -POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` - -Parameters: - -* method - messages.receivedQueue -* params - `{"max_qts": int, }` - - - -### As a user: - -POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.receivedQueue` - -Parameters: - -max_qts - Json encoded int +**You cannot use this method directly** -Or, if you're into Lua: - -``` -Vector_of_long = messages.receivedQueue({max_qts=int, }) -``` - diff --git a/old_docs/API_docs_v66/methods/messages_reorderPinnedDialogs.md b/old_docs/API_docs_v66/methods/messages_reorderPinnedDialogs.md index 0bf5e073..710caf10 100644 --- a/old_docs/API_docs_v66/methods/messages_reorderPinnedDialogs.md +++ b/old_docs/API_docs_v66/methods/messages_reorderPinnedDialogs.md @@ -1,17 +1,19 @@ --- title: messages.reorderPinnedDialogs -description: messages.reorderPinnedDialogs parameters, return type and example +description: Reorder pinned dialogs --- ## Method: messages.reorderPinnedDialogs [Back to methods index](index.md) +Reorder pinned dialogs + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|force|[CLICK ME Bool](../types/Bool.md) | Optional| -|order|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|force|[CLICK ME Bool](../types/Bool.md) | Optional|Force reordering| +|order|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Yes|New order| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v66/methods/messages_reorderStickerSets.md b/old_docs/API_docs_v66/methods/messages_reorderStickerSets.md index e4f1623c..ddc78dd0 100644 --- a/old_docs/API_docs_v66/methods/messages_reorderStickerSets.md +++ b/old_docs/API_docs_v66/methods/messages_reorderStickerSets.md @@ -1,17 +1,19 @@ --- title: messages.reorderStickerSets -description: messages.reorderStickerSets parameters, return type and example +description: Reorder sticker sets --- ## Method: messages.reorderStickerSets [Back to methods index](index.md) +Reorder sticker sets + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|masks|[CLICK ME Bool](../types/Bool.md) | Optional| -|order|Array of [CLICK ME long](../types/long.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|masks|[CLICK ME Bool](../types/Bool.md) | Optional|Reorder masks?| +|order|Array of [CLICK ME long](../types/long.md) | Yes|The order| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v66/methods/messages_reportEncryptedSpam.md b/old_docs/API_docs_v66/methods/messages_reportEncryptedSpam.md index 44482c76..58b684d1 100644 --- a/old_docs/API_docs_v66/methods/messages_reportEncryptedSpam.md +++ b/old_docs/API_docs_v66/methods/messages_reportEncryptedSpam.md @@ -1,16 +1,18 @@ --- title: messages.reportEncryptedSpam -description: messages.reportEncryptedSpam parameters, return type and example +description: Report for spam a secret chat --- ## Method: messages.reportEncryptedSpam [Back to methods index](index.md) +Report for spam a secret chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat to report| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v66/methods/messages_saveDraft.md b/old_docs/API_docs_v66/methods/messages_saveDraft.md index 9104df33..bbeed707 100644 --- a/old_docs/API_docs_v66/methods/messages_saveDraft.md +++ b/old_docs/API_docs_v66/methods/messages_saveDraft.md @@ -1,20 +1,22 @@ --- title: messages.saveDraft -description: messages.saveDraft parameters, return type and example +description: Save a message draft --- ## Method: messages.saveDraft [Back to methods index](index.md) +Save a message draft + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|message|[CLICK ME string](../types/string.md) | Yes| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview| +|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| +|message|[CLICK ME string](../types/string.md) | Yes|The message| +|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|The entities (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/old_docs/API_docs_v66/methods/messages_saveGif.md b/old_docs/API_docs_v66/methods/messages_saveGif.md index 4a3b6166..6f608c4c 100644 --- a/old_docs/API_docs_v66/methods/messages_saveGif.md +++ b/old_docs/API_docs_v66/methods/messages_saveGif.md @@ -1,17 +1,19 @@ --- title: messages.saveGif -description: messages.saveGif parameters, return type and example +description: Save a GIF --- ## Method: messages.saveGif [Back to methods index](index.md) +Save a GIF + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional| -|unsave|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The GIF to save| +|unsave|[CLICK ME Bool](../types/Bool.md) | Yes|Remove the gif?| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v66/methods/messages_saveRecentSticker.md b/old_docs/API_docs_v66/methods/messages_saveRecentSticker.md index b4f43e13..81ad5d48 100644 --- a/old_docs/API_docs_v66/methods/messages_saveRecentSticker.md +++ b/old_docs/API_docs_v66/methods/messages_saveRecentSticker.md @@ -1,18 +1,20 @@ --- title: messages.saveRecentSticker -description: messages.saveRecentSticker parameters, return type and example +description: Add a sticker to recent stickers --- ## Method: messages.saveRecentSticker [Back to methods index](index.md) +Add a sticker to recent stickers + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|attached|[CLICK ME Bool](../types/Bool.md) | Optional| -|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional| -|unsave|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|attached|[CLICK ME Bool](../types/Bool.md) | Optional|Get stickers attached to image?| +|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker| +|unsave|[CLICK ME Bool](../types/Bool.md) | Yes|Remove the sticker from recent stickers?| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v66/methods/messages_searchGifs.md b/old_docs/API_docs_v66/methods/messages_searchGifs.md index fefef1d7..103ebfeb 100644 --- a/old_docs/API_docs_v66/methods/messages_searchGifs.md +++ b/old_docs/API_docs_v66/methods/messages_searchGifs.md @@ -1,17 +1,19 @@ --- title: messages.searchGifs -description: messages.searchGifs parameters, return type and example +description: Search gifs --- ## Method: messages.searchGifs [Back to methods index](index.md) +Search gifs + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|q|[CLICK ME string](../types/string.md) | Yes| -|offset|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|q|[CLICK ME string](../types/string.md) | Yes|The search query| +|offset|[CLICK ME int](../types/int.md) | Yes|The offset | ### Return type: [messages\_FoundGifs](../types/messages_FoundGifs.md) diff --git a/old_docs/API_docs_v66/methods/messages_searchGlobal.md b/old_docs/API_docs_v66/methods/messages_searchGlobal.md index 32ddd175..0edd1e40 100644 --- a/old_docs/API_docs_v66/methods/messages_searchGlobal.md +++ b/old_docs/API_docs_v66/methods/messages_searchGlobal.md @@ -1,20 +1,22 @@ --- title: messages.searchGlobal -description: messages.searchGlobal parameters, return type and example +description: Global message search --- ## Method: messages.searchGlobal [Back to methods index](index.md) +Global message search + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|q|[CLICK ME string](../types/string.md) | Yes| -|offset\_date|[CLICK ME int](../types/int.md) | Yes| -|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|offset\_id|[CLICK ME int](../types/int.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|q|[CLICK ME string](../types/string.md) | Yes|The query| +|offset\_date|[CLICK ME int](../types/int.md) | Yes|0 or the date offset| +|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|0 or the peer offset| +|offset\_id|[CLICK ME int](../types/int.md) | Yes|0 or the message ID offset| +|limit|[CLICK ME int](../types/int.md) | Yes|The number of results to return| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v66/methods/messages_sendEncrypted.md b/old_docs/API_docs_v66/methods/messages_sendEncrypted.md index 23461760..d48f88d7 100644 --- a/old_docs/API_docs_v66/methods/messages_sendEncrypted.md +++ b/old_docs/API_docs_v66/methods/messages_sendEncrypted.md @@ -1,17 +1,19 @@ --- title: messages.sendEncrypted -description: messages.sendEncrypted parameters, return type and example +description: Send message to secret chat --- ## Method: messages.sendEncrypted [Back to methods index](index.md) +Send message to secret chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the message| +|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v66/methods/messages_sendEncryptedFile.md b/old_docs/API_docs_v66/methods/messages_sendEncryptedFile.md index 64919abe..4fd0648e 100644 --- a/old_docs/API_docs_v66/methods/messages_sendEncryptedFile.md +++ b/old_docs/API_docs_v66/methods/messages_sendEncryptedFile.md @@ -1,18 +1,20 @@ --- title: messages.sendEncryptedFile -description: messages.sendEncryptedFile parameters, return type and example +description: Send a file to a secret chat --- ## Method: messages.sendEncryptedFile [Back to methods index](index.md) +Send a file to a secret chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes| -|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the file| +|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| +|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional|The file (optional)| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v66/methods/messages_sendEncryptedService.md b/old_docs/API_docs_v66/methods/messages_sendEncryptedService.md index 0a0eea8a..d66894bf 100644 --- a/old_docs/API_docs_v66/methods/messages_sendEncryptedService.md +++ b/old_docs/API_docs_v66/methods/messages_sendEncryptedService.md @@ -1,17 +1,19 @@ --- title: messages.sendEncryptedService -description: messages.sendEncryptedService parameters, return type and example +description: Send a service message to a secret chat --- ## Method: messages.sendEncryptedService [Back to methods index](index.md) +Send a service message to a secret chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the service message| +|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v66/methods/messages_sendInlineBotResult.md b/old_docs/API_docs_v66/methods/messages_sendInlineBotResult.md index 4cb9243e..386ac7e3 100644 --- a/old_docs/API_docs_v66/methods/messages_sendInlineBotResult.md +++ b/old_docs/API_docs_v66/methods/messages_sendInlineBotResult.md @@ -1,22 +1,24 @@ --- title: messages.sendInlineBotResult -description: messages.sendInlineBotResult parameters, return type and example +description: Send a received bot result to the chat --- ## Method: messages.sendInlineBotResult [Back to methods index](index.md) +Send a received bot result to the chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional| -|background|[CLICK ME Bool](../types/Bool.md) | Optional| -|clear\_draft|[CLICK ME Bool](../types/Bool.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional| -|query\_id|[CLICK ME long](../types/long.md) | Yes| -|id|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Disable notifications?| +|background|[CLICK ME Bool](../types/Bool.md) | Optional|Disable background notifications?| +|clear\_draft|[CLICK ME Bool](../types/Bool.md) | Optional|Clear the message draft?| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the message| +|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| +|query\_id|[CLICK ME long](../types/long.md) | Yes|The inline query ID| +|id|[CLICK ME string](../types/string.md) | Yes|The result ID| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v66/methods/messages_setBotCallbackAnswer.md b/old_docs/API_docs_v66/methods/messages_setBotCallbackAnswer.md index 5590828e..e6dc6b09 100644 --- a/old_docs/API_docs_v66/methods/messages_setBotCallbackAnswer.md +++ b/old_docs/API_docs_v66/methods/messages_setBotCallbackAnswer.md @@ -1,20 +1,22 @@ --- title: messages.setBotCallbackAnswer -description: messages.setBotCallbackAnswer parameters, return type and example +description: Bots only: set the callback answer (after a button was clicked) --- ## Method: messages.setBotCallbackAnswer [Back to methods index](index.md) +Bots only: set the callback answer (after a button was clicked) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|alert|[CLICK ME Bool](../types/Bool.md) | Optional| -|query\_id|[CLICK ME long](../types/long.md) | Yes| -|message|[CLICK ME string](../types/string.md) | Optional| -|url|[CLICK ME string](../types/string.md) | Optional| -|cache\_time|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|alert|[CLICK ME Bool](../types/Bool.md) | Optional|Is this an alert?| +|query\_id|[CLICK ME long](../types/long.md) | Yes|The query ID| +|message|[CLICK ME string](../types/string.md) | Optional|The message| +|url|[CLICK ME string](../types/string.md) | Optional|The URL| +|cache\_time|[CLICK ME int](../types/int.md) | Yes|Cache time| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v66/methods/messages_setBotPrecheckoutResults.md b/old_docs/API_docs_v66/methods/messages_setBotPrecheckoutResults.md index 5afa7789..722bff81 100644 --- a/old_docs/API_docs_v66/methods/messages_setBotPrecheckoutResults.md +++ b/old_docs/API_docs_v66/methods/messages_setBotPrecheckoutResults.md @@ -1,18 +1,20 @@ --- title: messages.setBotPrecheckoutResults -description: messages.setBotPrecheckoutResults parameters, return type and example +description: Bots only: set precheckout results --- ## Method: messages.setBotPrecheckoutResults [Back to methods index](index.md) +Bots only: set precheckout results + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|success|[CLICK ME Bool](../types/Bool.md) | Optional| -|query\_id|[CLICK ME long](../types/long.md) | Yes| -|error|[CLICK ME string](../types/string.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|success|[CLICK ME Bool](../types/Bool.md) | Optional|Success?| +|query\_id|[CLICK ME long](../types/long.md) | Yes|Query ID| +|error|[CLICK ME string](../types/string.md) | Optional|Error| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v66/methods/messages_setBotShippingResults.md b/old_docs/API_docs_v66/methods/messages_setBotShippingResults.md index b36dacce..d364a04d 100644 --- a/old_docs/API_docs_v66/methods/messages_setBotShippingResults.md +++ b/old_docs/API_docs_v66/methods/messages_setBotShippingResults.md @@ -1,18 +1,20 @@ --- title: messages.setBotShippingResults -description: messages.setBotShippingResults parameters, return type and example +description: Bots only: set shipping results --- ## Method: messages.setBotShippingResults [Back to methods index](index.md) +Bots only: set shipping results + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|query\_id|[CLICK ME long](../types/long.md) | Yes| -|error|[CLICK ME string](../types/string.md) | Optional| -|shipping\_options|Array of [CLICK ME ShippingOption](../types/ShippingOption.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|query\_id|[CLICK ME long](../types/long.md) | Yes|Query ID| +|error|[CLICK ME string](../types/string.md) | Optional|Error| +|shipping\_options|Array of [CLICK ME ShippingOption](../types/ShippingOption.md) | Optional|Shipping options| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v66/methods/messages_setEncryptedTyping.md b/old_docs/API_docs_v66/methods/messages_setEncryptedTyping.md index 3183fedf..e9afe99c 100644 --- a/old_docs/API_docs_v66/methods/messages_setEncryptedTyping.md +++ b/old_docs/API_docs_v66/methods/messages_setEncryptedTyping.md @@ -12,8 +12,8 @@ Send typing notification to secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|| -|typing|[CLICK ME Bool](../types/Bool.md) | Yes|| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to send the notification| +|typing|[CLICK ME Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v66/methods/messages_setGameScore.md b/old_docs/API_docs_v66/methods/messages_setGameScore.md index c44145c0..aa1f4f0c 100644 --- a/old_docs/API_docs_v66/methods/messages_setGameScore.md +++ b/old_docs/API_docs_v66/methods/messages_setGameScore.md @@ -1,21 +1,23 @@ --- title: messages.setGameScore -description: messages.setGameScore parameters, return type and example +description: Set the game score --- ## Method: messages.setGameScore [Back to methods index](index.md) +Set the game score + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|edit\_message|[CLICK ME Bool](../types/Bool.md) | Optional| -|force|[CLICK ME Bool](../types/Bool.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|id|[CLICK ME int](../types/int.md) | Yes| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|score|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|edit\_message|[CLICK ME Bool](../types/Bool.md) | Optional|Should the message with the game be edited?| +|force|[CLICK ME Bool](../types/Bool.md) | Optional|Force setting the game score| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the game was sent| +|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the score| +|score|[CLICK ME int](../types/int.md) | Yes|The score| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v66/methods/messages_setInlineBotResults.md b/old_docs/API_docs_v66/methods/messages_setInlineBotResults.md index 915e3a4e..79493009 100644 --- a/old_docs/API_docs_v66/methods/messages_setInlineBotResults.md +++ b/old_docs/API_docs_v66/methods/messages_setInlineBotResults.md @@ -1,22 +1,24 @@ --- title: messages.setInlineBotResults -description: messages.setInlineBotResults parameters, return type and example +description: Bots only: set the results of an inline query --- ## Method: messages.setInlineBotResults [Back to methods index](index.md) +Bots only: set the results of an inline query + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|gallery|[CLICK ME Bool](../types/Bool.md) | Optional| -|private|[CLICK ME Bool](../types/Bool.md) | Optional| -|query\_id|[CLICK ME long](../types/long.md) | Yes| -|results|Array of [CLICK ME InputBotInlineResult](../types/InputBotInlineResult.md) | Yes| -|cache\_time|[CLICK ME int](../types/int.md) | Yes| -|next\_offset|[CLICK ME string](../types/string.md) | Optional| -|switch\_pm|[CLICK ME InlineBotSwitchPM](../types/InlineBotSwitchPM.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|gallery|[CLICK ME Bool](../types/Bool.md) | Optional|Is this a gallery?| +|private|[CLICK ME Bool](../types/Bool.md) | Optional|Is this result private (not cached)?| +|query\_id|[CLICK ME long](../types/long.md) | Yes|Query ID| +|results|Array of [CLICK ME InputBotInlineResult](../types/InputBotInlineResult.md) | Yes|Results| +|cache\_time|[CLICK ME int](../types/int.md) | Yes|Cache time| +|next\_offset|[CLICK ME string](../types/string.md) | Optional|The next offset| +|switch\_pm|[CLICK ME InlineBotSwitchPM](../types/InlineBotSwitchPM.md) | Optional|Switch to PM?| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v66/methods/messages_setInlineGameScore.md b/old_docs/API_docs_v66/methods/messages_setInlineGameScore.md index 55e2c063..385c8308 100644 --- a/old_docs/API_docs_v66/methods/messages_setInlineGameScore.md +++ b/old_docs/API_docs_v66/methods/messages_setInlineGameScore.md @@ -1,20 +1,22 @@ --- title: messages.setInlineGameScore -description: messages.setInlineGameScore parameters, return type and example +description: Set the game score of an inline message --- ## Method: messages.setInlineGameScore [Back to methods index](index.md) +Set the game score of an inline message + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|edit\_message|[CLICK ME Bool](../types/Bool.md) | Optional| -|force|[CLICK ME Bool](../types/Bool.md) | Optional| -|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|score|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|edit\_message|[CLICK ME Bool](../types/Bool.md) | Optional|Should the message with the game be edited?| +|force|[CLICK ME Bool](../types/Bool.md) | Optional|Force setting the game score| +|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The ID of the inline message| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the score| +|score|[CLICK ME int](../types/int.md) | Yes|The score| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v66/methods/messages_startBot.md b/old_docs/API_docs_v66/methods/messages_startBot.md index 0de0f1a5..94a4d86a 100644 --- a/old_docs/API_docs_v66/methods/messages_startBot.md +++ b/old_docs/API_docs_v66/methods/messages_startBot.md @@ -1,18 +1,20 @@ --- title: messages.startBot -description: messages.startBot parameters, return type and example +description: Start a bot --- ## Method: messages.startBot [Back to methods index](index.md) +Start a bot + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|start\_param|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot's ID or username| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to start the bot (@me or group ID/username)| +|start\_param|[CLICK ME string](../types/string.md) | Yes|The bot's start parameter| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v66/methods/messages_toggleChatAdmins.md b/old_docs/API_docs_v66/methods/messages_toggleChatAdmins.md index d56e5753..ab591fd9 100644 --- a/old_docs/API_docs_v66/methods/messages_toggleChatAdmins.md +++ b/old_docs/API_docs_v66/methods/messages_toggleChatAdmins.md @@ -1,17 +1,19 @@ --- title: messages.toggleChatAdmins -description: messages.toggleChatAdmins parameters, return type and example +description: Enable all users are admins in normal groups (not supergroups) --- ## Method: messages.toggleChatAdmins [Back to methods index](index.md) +Enable all users are admins in normal groups (not supergroups) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Group ID| +|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Enable all users are admins| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v66/methods/messages_toggleDialogPin.md b/old_docs/API_docs_v66/methods/messages_toggleDialogPin.md index d6dc9692..2bd6a03d 100644 --- a/old_docs/API_docs_v66/methods/messages_toggleDialogPin.md +++ b/old_docs/API_docs_v66/methods/messages_toggleDialogPin.md @@ -1,17 +1,19 @@ --- title: messages.toggleDialogPin -description: messages.toggleDialogPin parameters, return type and example +description: Pin or unpin dialog --- ## Method: messages.toggleDialogPin [Back to methods index](index.md) +Pin or unpin dialog + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|pinned|[CLICK ME Bool](../types/Bool.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|pinned|[CLICK ME Bool](../types/Bool.md) | Optional|Pin or unpin the dialog?| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer to pin| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v66/methods/messages_uninstallStickerSet.md b/old_docs/API_docs_v66/methods/messages_uninstallStickerSet.md index 60b0ca0c..6d04e847 100644 --- a/old_docs/API_docs_v66/methods/messages_uninstallStickerSet.md +++ b/old_docs/API_docs_v66/methods/messages_uninstallStickerSet.md @@ -1,16 +1,18 @@ --- title: messages.uninstallStickerSet -description: messages.uninstallStickerSet parameters, return type and example +description: Remove a sticker set --- ## Method: messages.uninstallStickerSet [Back to methods index](index.md) +Remove a sticker set + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to remove| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v66/methods/payments_clearSavedInfo.md b/old_docs/API_docs_v66/methods/payments_clearSavedInfo.md index 53fab36f..44050dde 100644 --- a/old_docs/API_docs_v66/methods/payments_clearSavedInfo.md +++ b/old_docs/API_docs_v66/methods/payments_clearSavedInfo.md @@ -1,17 +1,19 @@ --- title: payments.clearSavedInfo -description: payments.clearSavedInfo parameters, return type and example +description: Clear saved payments info --- ## Method: payments.clearSavedInfo [Back to methods index](index.md) +Clear saved payments info + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|credentials|[CLICK ME Bool](../types/Bool.md) | Optional| -|info|[CLICK ME Bool](../types/Bool.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|credentials|[CLICK ME Bool](../types/Bool.md) | Optional|Clear credentials?| +|info|[CLICK ME Bool](../types/Bool.md) | Optional|Clear payment info?| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v66/methods/payments_getPaymentForm.md b/old_docs/API_docs_v66/methods/payments_getPaymentForm.md index 00b4bddc..16a32d11 100644 --- a/old_docs/API_docs_v66/methods/payments_getPaymentForm.md +++ b/old_docs/API_docs_v66/methods/payments_getPaymentForm.md @@ -1,16 +1,18 @@ --- title: payments.getPaymentForm -description: payments.getPaymentForm parameters, return type and example +description: Get payment form --- ## Method: payments.getPaymentForm [Back to methods index](index.md) +Get payment form + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|msg\_id|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|msg\_id|[CLICK ME int](../types/int.md) | Yes|Message ID| ### Return type: [payments\_PaymentForm](../types/payments_PaymentForm.md) diff --git a/old_docs/API_docs_v66/methods/payments_getPaymentReceipt.md b/old_docs/API_docs_v66/methods/payments_getPaymentReceipt.md index 40b73a4b..857585f6 100644 --- a/old_docs/API_docs_v66/methods/payments_getPaymentReceipt.md +++ b/old_docs/API_docs_v66/methods/payments_getPaymentReceipt.md @@ -1,16 +1,18 @@ --- title: payments.getPaymentReceipt -description: payments.getPaymentReceipt parameters, return type and example +description: Get payment receipt --- ## Method: payments.getPaymentReceipt [Back to methods index](index.md) +Get payment receipt + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|msg\_id|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|msg\_id|[CLICK ME int](../types/int.md) | Yes|The message ID| ### Return type: [payments\_PaymentReceipt](../types/payments_PaymentReceipt.md) diff --git a/old_docs/API_docs_v66/methods/payments_getSavedInfo.md b/old_docs/API_docs_v66/methods/payments_getSavedInfo.md index ccaaff75..04ac7374 100644 --- a/old_docs/API_docs_v66/methods/payments_getSavedInfo.md +++ b/old_docs/API_docs_v66/methods/payments_getSavedInfo.md @@ -1,11 +1,13 @@ --- title: payments.getSavedInfo -description: payments.getSavedInfo parameters, return type and example +description: Get saved payments info --- ## Method: payments.getSavedInfo [Back to methods index](index.md) +Get saved payments info + ### Return type: [payments\_SavedInfo](../types/payments_SavedInfo.md) diff --git a/old_docs/API_docs_v66/methods/payments_sendPaymentForm.md b/old_docs/API_docs_v66/methods/payments_sendPaymentForm.md index eb843715..0a9df99f 100644 --- a/old_docs/API_docs_v66/methods/payments_sendPaymentForm.md +++ b/old_docs/API_docs_v66/methods/payments_sendPaymentForm.md @@ -1,19 +1,21 @@ --- title: payments.sendPaymentForm -description: payments.sendPaymentForm parameters, return type and example +description: Bots only: send payment form --- ## Method: payments.sendPaymentForm [Back to methods index](index.md) +Bots only: send payment form + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|msg\_id|[CLICK ME int](../types/int.md) | Yes| -|requested\_info\_id|[CLICK ME string](../types/string.md) | Optional| -|shipping\_option\_id|[CLICK ME string](../types/string.md) | Optional| -|credentials|[CLICK ME InputPaymentCredentials](../types/InputPaymentCredentials.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|msg\_id|[CLICK ME int](../types/int.md) | Yes|Message ID| +|requested\_info\_id|[CLICK ME string](../types/string.md) | Optional|ID of requested info| +|shipping\_option\_id|[CLICK ME string](../types/string.md) | Optional|Shipping option ID| +|credentials|[CLICK ME InputPaymentCredentials](../types/InputPaymentCredentials.md) | Yes|Payment credentials| ### Return type: [payments\_PaymentResult](../types/payments_PaymentResult.md) diff --git a/old_docs/API_docs_v66/methods/payments_validateRequestedInfo.md b/old_docs/API_docs_v66/methods/payments_validateRequestedInfo.md index 32702965..e36f0e42 100644 --- a/old_docs/API_docs_v66/methods/payments_validateRequestedInfo.md +++ b/old_docs/API_docs_v66/methods/payments_validateRequestedInfo.md @@ -1,18 +1,20 @@ --- title: payments.validateRequestedInfo -description: payments.validateRequestedInfo parameters, return type and example +description: Validate requested payment info --- ## Method: payments.validateRequestedInfo [Back to methods index](index.md) +Validate requested payment info + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|save|[CLICK ME Bool](../types/Bool.md) | Optional| -|msg\_id|[CLICK ME int](../types/int.md) | Yes| -|info|[CLICK ME PaymentRequestedInfo](../types/PaymentRequestedInfo.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|save|[CLICK ME Bool](../types/Bool.md) | Optional|Save payment info?| +|msg\_id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|info|[CLICK ME PaymentRequestedInfo](../types/PaymentRequestedInfo.md) | Yes|The requested payment info| ### Return type: [payments\_ValidatedRequestedInfo](../types/payments_ValidatedRequestedInfo.md) diff --git a/old_docs/API_docs_v66/methods/photos_deletePhotos.md b/old_docs/API_docs_v66/methods/photos_deletePhotos.md index 104459b7..b9daca10 100644 --- a/old_docs/API_docs_v66/methods/photos_deletePhotos.md +++ b/old_docs/API_docs_v66/methods/photos_deletePhotos.md @@ -1,16 +1,18 @@ --- title: photos.deletePhotos -description: photos.deletePhotos parameters, return type and example +description: Delete profile photos --- ## Method: photos.deletePhotos [Back to methods index](index.md) +Delete profile photos + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Yes|The profile photos to delete| ### Return type: [Vector\_of\_long](../types/long.md) diff --git a/old_docs/API_docs_v66/methods/photos_getUserPhotos.md b/old_docs/API_docs_v66/methods/photos_getUserPhotos.md index 1a7515ba..ea27a44f 100644 --- a/old_docs/API_docs_v66/methods/photos_getUserPhotos.md +++ b/old_docs/API_docs_v66/methods/photos_getUserPhotos.md @@ -1,19 +1,21 @@ --- title: photos.getUserPhotos -description: photos.getUserPhotos parameters, return type and example +description: Get the profile photos of a user --- ## Method: photos.getUserPhotos [Back to methods index](index.md) +Get the profile photos of a user + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|offset|[CLICK ME int](../types/int.md) | Yes| -|max\_id|[CLICK ME long](../types/long.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| +|offset|[CLICK ME int](../types/int.md) | Yes|Offset| +|max\_id|[CLICK ME long](../types/long.md) | Yes|Maximum ID of photo to return| +|limit|[CLICK ME int](../types/int.md) | Yes|Number of photos to return| ### Return type: [photos\_Photos](../types/photos_Photos.md) diff --git a/old_docs/API_docs_v66/methods/photos_updateProfilePhoto.md b/old_docs/API_docs_v66/methods/photos_updateProfilePhoto.md index 28ab5fbf..7f0a4c69 100644 --- a/old_docs/API_docs_v66/methods/photos_updateProfilePhoto.md +++ b/old_docs/API_docs_v66/methods/photos_updateProfilePhoto.md @@ -1,16 +1,18 @@ --- title: photos.updateProfilePhoto -description: photos.updateProfilePhoto parameters, return type and example +description: Update the profile photo (use photos->uploadProfilePhoto to upload the photo) --- ## Method: photos.updateProfilePhoto [Back to methods index](index.md) +Update the profile photo (use photos->uploadProfilePhoto to upload the photo) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional|The photo to use| ### Return type: [UserProfilePhoto](../types/UserProfilePhoto.md) diff --git a/old_docs/API_docs_v66/methods/photos_uploadProfilePhoto.md b/old_docs/API_docs_v66/methods/photos_uploadProfilePhoto.md index 7cc9e9e5..efa08bb0 100644 --- a/old_docs/API_docs_v66/methods/photos_uploadProfilePhoto.md +++ b/old_docs/API_docs_v66/methods/photos_uploadProfilePhoto.md @@ -1,16 +1,18 @@ --- title: photos.uploadProfilePhoto -description: photos.uploadProfilePhoto parameters, return type and example +description: Upload profile photo --- ## Method: photos.uploadProfilePhoto [Back to methods index](index.md) +Upload profile photo + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|file|[File path or InputFile](../types/InputFile.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|file|[File path or InputFile](../types/InputFile.md) | Yes|The photo| ### Return type: [photos\_Photo](../types/photos_Photo.md) diff --git a/old_docs/API_docs_v66/methods/upload_getWebFile.md b/old_docs/API_docs_v66/methods/upload_getWebFile.md index 30bd3a1f..e864e4b7 100644 --- a/old_docs/API_docs_v66/methods/upload_getWebFile.md +++ b/old_docs/API_docs_v66/methods/upload_getWebFile.md @@ -1,18 +1,20 @@ --- title: upload.getWebFile -description: upload.getWebFile parameters, return type and example +description: Download a file through telegram --- ## Method: upload.getWebFile [Back to methods index](index.md) +Download a file through telegram + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|location|[CLICK ME InputWebFileLocation](../types/InputWebFileLocation.md) | Yes| -|offset|[CLICK ME int](../types/int.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|location|[CLICK ME InputWebFileLocation](../types/InputWebFileLocation.md) | Yes|The file| +|offset|[CLICK ME int](../types/int.md) | Yes|The offset in bytes| +|limit|[CLICK ME int](../types/int.md) | Yes|The number of bytes to fetch| ### Return type: [upload\_WebFile](../types/upload_WebFile.md) diff --git a/old_docs/API_docs_v68/methods/account_registerDevice.md b/old_docs/API_docs_v68/methods/account_registerDevice.md index cd28abcd..017b9af3 100644 --- a/old_docs/API_docs_v68/methods/account_registerDevice.md +++ b/old_docs/API_docs_v68/methods/account_registerDevice.md @@ -12,8 +12,8 @@ Register device for push notifications | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and oTher, see source code of official apps for more info| +|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and oTher, see source code of official apps for more info| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v68/methods/account_unregisterDevice.md b/old_docs/API_docs_v68/methods/account_unregisterDevice.md index 1d2b7670..32e44495 100644 --- a/old_docs/API_docs_v68/methods/account_unregisterDevice.md +++ b/old_docs/API_docs_v68/methods/account_unregisterDevice.md @@ -12,8 +12,8 @@ Stop sending PUSH notifications to app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and oTher, see source code of official apps for more info| +|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and oTher, see source code of official apps for more info| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v68/methods/bots_answerWebhookJSONQuery.md b/old_docs/API_docs_v68/methods/bots_answerWebhookJSONQuery.md index 205b30f9..61056bb4 100644 --- a/old_docs/API_docs_v68/methods/bots_answerWebhookJSONQuery.md +++ b/old_docs/API_docs_v68/methods/bots_answerWebhookJSONQuery.md @@ -1,17 +1,19 @@ --- title: bots.answerWebhookJSONQuery -description: bots.answerWebhookJSONQuery parameters, return type and example +description: Send webhook request via bot API --- ## Method: bots.answerWebhookJSONQuery [Back to methods index](index.md) +Send webhook request via bot API + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|query\_id|[CLICK ME long](../types/long.md) | Yes| -|data|[CLICK ME DataJSON](../types/DataJSON.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|query\_id|[CLICK ME long](../types/long.md) | Yes|The query ID| +|data|[CLICK ME DataJSON](../types/DataJSON.md) | Yes|The parameters| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v68/methods/bots_sendCustomRequest.md b/old_docs/API_docs_v68/methods/bots_sendCustomRequest.md index 590c47b6..fc8e764d 100644 --- a/old_docs/API_docs_v68/methods/bots_sendCustomRequest.md +++ b/old_docs/API_docs_v68/methods/bots_sendCustomRequest.md @@ -1,17 +1,19 @@ --- title: bots.sendCustomRequest -description: bots.sendCustomRequest parameters, return type and example +description: Send a custom request to the bot API --- ## Method: bots.sendCustomRequest [Back to methods index](index.md) +Send a custom request to the bot API + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|custom\_method|[CLICK ME string](../types/string.md) | Yes| -|params|[CLICK ME DataJSON](../types/DataJSON.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|custom\_method|[CLICK ME string](../types/string.md) | Yes|The method to call| +|params|[CLICK ME DataJSON](../types/DataJSON.md) | Yes|Method parameters| ### Return type: [DataJSON](../types/DataJSON.md) diff --git a/old_docs/API_docs_v68/methods/channels_checkUsername.md b/old_docs/API_docs_v68/methods/channels_checkUsername.md index 371f4cd3..7bc7c245 100644 --- a/old_docs/API_docs_v68/methods/channels_checkUsername.md +++ b/old_docs/API_docs_v68/methods/channels_checkUsername.md @@ -1,17 +1,19 @@ --- title: channels.checkUsername -description: channels.checkUsername parameters, return type and example +description: Check if this username is free and can be assigned to a channel/supergroup --- ## Method: channels.checkUsername [Back to methods index](index.md) +Check if this username is free and can be assigned to a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|username|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|username|[CLICK ME string](../types/string.md) | Yes|The new username for this channel/supergroup| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v68/methods/channels_createChannel.md b/old_docs/API_docs_v68/methods/channels_createChannel.md index c5d21585..1305e4fb 100644 --- a/old_docs/API_docs_v68/methods/channels_createChannel.md +++ b/old_docs/API_docs_v68/methods/channels_createChannel.md @@ -1,19 +1,21 @@ --- title: channels.createChannel -description: channels.createChannel parameters, return type and example +description: Create channel/supergroup --- ## Method: channels.createChannel [Back to methods index](index.md) +Create channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|broadcast|[CLICK ME Bool](../types/Bool.md) | Optional| -|megagroup|[CLICK ME Bool](../types/Bool.md) | Optional| -|title|[CLICK ME string](../types/string.md) | Yes| -|about|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|broadcast|[CLICK ME Bool](../types/Bool.md) | Optional|Set this to true to create a channel| +|megagroup|[CLICK ME Bool](../types/Bool.md) | Optional|Set this to true to create a supergroup| +|title|[CLICK ME string](../types/string.md) | Yes|Supergroup/channel title| +|about|[CLICK ME string](../types/string.md) | Yes|About text| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v68/methods/channels_deleteChannel.md b/old_docs/API_docs_v68/methods/channels_deleteChannel.md index 61b29eac..e660d25c 100644 --- a/old_docs/API_docs_v68/methods/channels_deleteChannel.md +++ b/old_docs/API_docs_v68/methods/channels_deleteChannel.md @@ -1,16 +1,18 @@ --- title: channels.deleteChannel -description: channels.deleteChannel parameters, return type and example +description: Delete a channel/supergroup --- ## Method: channels.deleteChannel [Back to methods index](index.md) +Delete a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup to delete| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v68/methods/channels_deleteMessages.md b/old_docs/API_docs_v68/methods/channels_deleteMessages.md index 87a968c5..fb9d3cc2 100644 --- a/old_docs/API_docs_v68/methods/channels_deleteMessages.md +++ b/old_docs/API_docs_v68/methods/channels_deleteMessages.md @@ -1,17 +1,19 @@ --- title: channels.deleteMessages -description: channels.deleteMessages parameters, return type and example +description: Delete channel/supergroup messages --- ## Method: channels.deleteMessages [Back to methods index](index.md) +Delete channel/supergroup messages + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|id|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to delete| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v68/methods/channels_deleteUserHistory.md b/old_docs/API_docs_v68/methods/channels_deleteUserHistory.md index ee828f45..fbe34341 100644 --- a/old_docs/API_docs_v68/methods/channels_deleteUserHistory.md +++ b/old_docs/API_docs_v68/methods/channels_deleteUserHistory.md @@ -1,17 +1,19 @@ --- title: channels.deleteUserHistory -description: channels.deleteUserHistory parameters, return type and example +description: Delete all messages of a user in a channel/supergroup --- ## Method: channels.deleteUserHistory [Back to methods index](index.md) +Delete all messages of a user in a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) diff --git a/old_docs/API_docs_v68/methods/channels_editAbout.md b/old_docs/API_docs_v68/methods/channels_editAbout.md index 94be2503..8908f29e 100644 --- a/old_docs/API_docs_v68/methods/channels_editAbout.md +++ b/old_docs/API_docs_v68/methods/channels_editAbout.md @@ -1,17 +1,19 @@ --- title: channels.editAbout -description: channels.editAbout parameters, return type and example +description: Edit the about text of a channel/supergroup --- ## Method: channels.editAbout [Back to methods index](index.md) +Edit the about text of a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|about|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|about|[CLICK ME string](../types/string.md) | Yes|The new about text| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v68/methods/channels_editAdmin.md b/old_docs/API_docs_v68/methods/channels_editAdmin.md index 08707ff4..dcec7d2f 100644 --- a/old_docs/API_docs_v68/methods/channels_editAdmin.md +++ b/old_docs/API_docs_v68/methods/channels_editAdmin.md @@ -1,18 +1,20 @@ --- title: channels.editAdmin -description: channels.editAdmin parameters, return type and example +description: Edit admin permissions of a user in a channel/supergroup --- ## Method: channels.editAdmin [Back to methods index](index.md) +Edit admin permissions of a user in a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|admin\_rights|[CLICK ME ChannelAdminRights](../types/ChannelAdminRights.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| +|admin\_rights|[CLICK ME ChannelAdminRights](../types/ChannelAdminRights.md) | Yes|The new admin rights| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v68/methods/channels_editBanned.md b/old_docs/API_docs_v68/methods/channels_editBanned.md index 1d896393..9859bcae 100644 --- a/old_docs/API_docs_v68/methods/channels_editBanned.md +++ b/old_docs/API_docs_v68/methods/channels_editBanned.md @@ -1,18 +1,20 @@ --- title: channels.editBanned -description: channels.editBanned parameters, return type and example +description: Kick or ban a user from a channel/supergroup --- ## Method: channels.editBanned [Back to methods index](index.md) +Kick or ban a user from a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|banned\_rights|[CLICK ME ChannelBannedRights](../types/ChannelBannedRights.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to kick/ban| +|banned\_rights|[CLICK ME ChannelBannedRights](../types/ChannelBannedRights.md) | Yes|Banned/kicked permissions| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v68/methods/channels_editPhoto.md b/old_docs/API_docs_v68/methods/channels_editPhoto.md index 3a2c794b..9ccd864f 100644 --- a/old_docs/API_docs_v68/methods/channels_editPhoto.md +++ b/old_docs/API_docs_v68/methods/channels_editPhoto.md @@ -1,17 +1,19 @@ --- title: channels.editPhoto -description: channels.editPhoto parameters, return type and example +description: Edit the photo of a supergroup/channel --- ## Method: channels.editPhoto [Back to methods index](index.md) +Edit the photo of a supergroup/channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new photo| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v68/methods/channels_editTitle.md b/old_docs/API_docs_v68/methods/channels_editTitle.md index ec60e10f..b1024faf 100644 --- a/old_docs/API_docs_v68/methods/channels_editTitle.md +++ b/old_docs/API_docs_v68/methods/channels_editTitle.md @@ -1,17 +1,19 @@ --- title: channels.editTitle -description: channels.editTitle parameters, return type and example +description: Edit the title of a supergroup/channel --- ## Method: channels.editTitle [Back to methods index](index.md) +Edit the title of a supergroup/channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|title|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|title|[CLICK ME string](../types/string.md) | Yes|The new channel/supergroup title| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v68/methods/channels_exportInvite.md b/old_docs/API_docs_v68/methods/channels_exportInvite.md index 3c10f832..f0c737d5 100644 --- a/old_docs/API_docs_v68/methods/channels_exportInvite.md +++ b/old_docs/API_docs_v68/methods/channels_exportInvite.md @@ -1,16 +1,18 @@ --- title: channels.exportInvite -description: channels.exportInvite parameters, return type and example +description: Export the invite link of a channel --- ## Method: channels.exportInvite [Back to methods index](index.md) +Export the invite link of a channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| ### Return type: [ExportedChatInvite](../types/ExportedChatInvite.md) diff --git a/old_docs/API_docs_v68/methods/channels_exportMessageLink.md b/old_docs/API_docs_v68/methods/channels_exportMessageLink.md index 924dc0d5..f910b594 100644 --- a/old_docs/API_docs_v68/methods/channels_exportMessageLink.md +++ b/old_docs/API_docs_v68/methods/channels_exportMessageLink.md @@ -1,17 +1,19 @@ --- title: channels.exportMessageLink -description: channels.exportMessageLink parameters, return type and example +description: Get the link of a message in a channel --- ## Method: channels.exportMessageLink [Back to methods index](index.md) +Get the link of a message in a channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|id|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|id|[CLICK ME int](../types/int.md) | Yes|The ID of the message| ### Return type: [ExportedMessageLink](../types/ExportedMessageLink.md) diff --git a/old_docs/API_docs_v68/methods/channels_getAdminLog.md b/old_docs/API_docs_v68/methods/channels_getAdminLog.md index 0585e157..5c1b805e 100644 --- a/old_docs/API_docs_v68/methods/channels_getAdminLog.md +++ b/old_docs/API_docs_v68/methods/channels_getAdminLog.md @@ -1,22 +1,24 @@ --- title: channels.getAdminLog -description: channels.getAdminLog parameters, return type and example +description: Get admin log of a channel/supergruop --- ## Method: channels.getAdminLog [Back to methods index](index.md) +Get admin log of a channel/supergruop + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|q|[CLICK ME string](../types/string.md) | Yes| -|events\_filter|[CLICK ME ChannelAdminLogEventsFilter](../types/ChannelAdminLogEventsFilter.md) | Optional| -|admins|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|max\_id|[CLICK ME long](../types/long.md) | Yes| -|min\_id|[CLICK ME long](../types/long.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|q|[CLICK ME string](../types/string.md) | Yes|Search query| +|events\_filter|[CLICK ME ChannelAdminLogEventsFilter](../types/ChannelAdminLogEventsFilter.md) | Optional|Event filter| +|admins|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|Fetch only actions from these admins| +|max\_id|[CLICK ME long](../types/long.md) | Yes|Maximum message ID to fetch| +|min\_id|[CLICK ME long](../types/long.md) | Yes|Minimum message ID to fetch| +|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to fetch| ### Return type: [channels\_AdminLogResults](../types/channels_AdminLogResults.md) diff --git a/old_docs/API_docs_v68/methods/channels_getAdminedPublicChannels.md b/old_docs/API_docs_v68/methods/channels_getAdminedPublicChannels.md index f2b48050..9646f529 100644 --- a/old_docs/API_docs_v68/methods/channels_getAdminedPublicChannels.md +++ b/old_docs/API_docs_v68/methods/channels_getAdminedPublicChannels.md @@ -1,11 +1,13 @@ --- title: channels.getAdminedPublicChannels -description: channels.getAdminedPublicChannels parameters, return type and example +description: Get all supergroups/channels where you're admin --- ## Method: channels.getAdminedPublicChannels [Back to methods index](index.md) +Get all supergroups/channels where you're admin + ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v68/methods/channels_getChannels.md b/old_docs/API_docs_v68/methods/channels_getChannels.md index bd5958d6..9cd9e798 100644 --- a/old_docs/API_docs_v68/methods/channels_getChannels.md +++ b/old_docs/API_docs_v68/methods/channels_getChannels.md @@ -1,16 +1,18 @@ --- title: channels.getChannels -description: channels.getChannels parameters, return type and example +description: Get info about multiple channels/supergroups --- ## Method: channels.getChannels [Back to methods index](index.md) +Get info about multiple channels/supergroups + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|Array of [Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|Array of [Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Yes|The channel/supergroup MTProto IDs| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v68/methods/channels_getMessages.md b/old_docs/API_docs_v68/methods/channels_getMessages.md index 4440856c..cc944fe5 100644 --- a/old_docs/API_docs_v68/methods/channels_getMessages.md +++ b/old_docs/API_docs_v68/methods/channels_getMessages.md @@ -1,17 +1,19 @@ --- title: channels.getMessages -description: channels.getMessages parameters, return type and example +description: Get channel/supergroup messages --- ## Method: channels.getMessages [Back to methods index](index.md) +Get channel/supergroup messages + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|id|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The message IDs| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v68/methods/channels_getParticipant.md b/old_docs/API_docs_v68/methods/channels_getParticipant.md index c1819b6b..db9b1fc6 100644 --- a/old_docs/API_docs_v68/methods/channels_getParticipant.md +++ b/old_docs/API_docs_v68/methods/channels_getParticipant.md @@ -1,17 +1,19 @@ --- title: channels.getParticipant -description: channels.getParticipant parameters, return type and example +description: Get info about a certain channel/supergroup participant --- ## Method: channels.getParticipant [Back to methods index](index.md) +Get info about a certain channel/supergroup participant + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to fetch info about| ### Return type: [channels\_ChannelParticipant](../types/channels_ChannelParticipant.md) diff --git a/old_docs/API_docs_v68/methods/channels_getParticipants.md b/old_docs/API_docs_v68/methods/channels_getParticipants.md index 7ec8a980..96662466 100644 --- a/old_docs/API_docs_v68/methods/channels_getParticipants.md +++ b/old_docs/API_docs_v68/methods/channels_getParticipants.md @@ -1,19 +1,21 @@ --- title: channels.getParticipants -description: channels.getParticipants parameters, return type and example +description: Get channel/supergroup participants (you should use `$MadelineProto->get_pwr_chat($id)` instead) --- ## Method: channels.getParticipants [Back to methods index](index.md) +Get channel/supergroup participants (you should use `$MadelineProto->get_pwr_chat($id)` instead) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|filter|[CLICK ME ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) | Yes| -|offset|[CLICK ME int](../types/int.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|filter|[CLICK ME ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) | Yes|Member filter| +|offset|[CLICK ME int](../types/int.md) | Yes|Offset| +|limit|[CLICK ME int](../types/int.md) | Yes|Limit| ### Return type: [channels\_ChannelParticipants](../types/channels_ChannelParticipants.md) diff --git a/old_docs/API_docs_v68/methods/channels_inviteToChannel.md b/old_docs/API_docs_v68/methods/channels_inviteToChannel.md index 9bca2967..676f800c 100644 --- a/old_docs/API_docs_v68/methods/channels_inviteToChannel.md +++ b/old_docs/API_docs_v68/methods/channels_inviteToChannel.md @@ -1,17 +1,19 @@ --- title: channels.inviteToChannel -description: channels.inviteToChannel parameters, return type and example +description: Add users to channel/supergroup --- ## Method: channels.inviteToChannel [Back to methods index](index.md) +Add users to channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to add| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v68/methods/channels_joinChannel.md b/old_docs/API_docs_v68/methods/channels_joinChannel.md index 9ecdbe75..721f707c 100644 --- a/old_docs/API_docs_v68/methods/channels_joinChannel.md +++ b/old_docs/API_docs_v68/methods/channels_joinChannel.md @@ -1,16 +1,18 @@ --- title: channels.joinChannel -description: channels.joinChannel parameters, return type and example +description: Join a channel/supergroup --- ## Method: channels.joinChannel [Back to methods index](index.md) +Join a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup to join| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v68/methods/channels_leaveChannel.md b/old_docs/API_docs_v68/methods/channels_leaveChannel.md index 62c20a00..7f02e08c 100644 --- a/old_docs/API_docs_v68/methods/channels_leaveChannel.md +++ b/old_docs/API_docs_v68/methods/channels_leaveChannel.md @@ -1,16 +1,18 @@ --- title: channels.leaveChannel -description: channels.leaveChannel parameters, return type and example +description: Leave a channel/supergroup --- ## Method: channels.leaveChannel [Back to methods index](index.md) +Leave a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup to leave| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v68/methods/channels_readHistory.md b/old_docs/API_docs_v68/methods/channels_readHistory.md index 745893f6..cca891f0 100644 --- a/old_docs/API_docs_v68/methods/channels_readHistory.md +++ b/old_docs/API_docs_v68/methods/channels_readHistory.md @@ -1,17 +1,19 @@ --- title: channels.readHistory -description: channels.readHistory parameters, return type and example +description: Mark channel/supergroup history as read --- ## Method: channels.readHistory [Back to methods index](index.md) +Mark channel/supergroup history as read + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|max\_id|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to mark as read| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v68/methods/channels_reportSpam.md b/old_docs/API_docs_v68/methods/channels_reportSpam.md index 47dd7cff..09af14e0 100644 --- a/old_docs/API_docs_v68/methods/channels_reportSpam.md +++ b/old_docs/API_docs_v68/methods/channels_reportSpam.md @@ -1,18 +1,20 @@ --- title: channels.reportSpam -description: channels.reportSpam parameters, return type and example +description: Report a supergroup/channel for spam --- ## Method: channels.reportSpam [Back to methods index](index.md) +Report a supergroup/channel for spam + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|id|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that added you to this channel| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to report| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v68/methods/channels_toggleInvites.md b/old_docs/API_docs_v68/methods/channels_toggleInvites.md index b6771ed3..5b541f67 100644 --- a/old_docs/API_docs_v68/methods/channels_toggleInvites.md +++ b/old_docs/API_docs_v68/methods/channels_toggleInvites.md @@ -1,17 +1,19 @@ --- title: channels.toggleInvites -description: channels.toggleInvites parameters, return type and example +description: Allow or disallow any user to invite users to this channel/supergroup --- ## Method: channels.toggleInvites [Back to methods index](index.md) +Allow or disallow any user to invite users to this channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Allow or disallow| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v68/methods/channels_toggleSignatures.md b/old_docs/API_docs_v68/methods/channels_toggleSignatures.md index e8ff70a8..f233a8e1 100644 --- a/old_docs/API_docs_v68/methods/channels_toggleSignatures.md +++ b/old_docs/API_docs_v68/methods/channels_toggleSignatures.md @@ -1,17 +1,19 @@ --- title: channels.toggleSignatures -description: channels.toggleSignatures parameters, return type and example +description: Toggle channel signatures --- ## Method: channels.toggleSignatures [Back to methods index](index.md) +Toggle channel signatures + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Enable or disable channel signatures?| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v68/methods/channels_updatePinnedMessage.md b/old_docs/API_docs_v68/methods/channels_updatePinnedMessage.md index 7a14b68b..f06d1f0f 100644 --- a/old_docs/API_docs_v68/methods/channels_updatePinnedMessage.md +++ b/old_docs/API_docs_v68/methods/channels_updatePinnedMessage.md @@ -1,18 +1,20 @@ --- title: channels.updatePinnedMessage -description: channels.updatePinnedMessage parameters, return type and example +description: Set the pinned message of a channel/supergroup --- ## Method: channels.updatePinnedMessage [Back to methods index](index.md) +Set the pinned message of a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|id|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Pin silently| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|id|[CLICK ME int](../types/int.md) | Yes|The ID of the message to pin| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v68/methods/channels_updateUsername.md b/old_docs/API_docs_v68/methods/channels_updateUsername.md index 19647598..ad34490a 100644 --- a/old_docs/API_docs_v68/methods/channels_updateUsername.md +++ b/old_docs/API_docs_v68/methods/channels_updateUsername.md @@ -1,17 +1,19 @@ --- title: channels.updateUsername -description: channels.updateUsername parameters, return type and example +description: Update the username of a supergroup/channel --- ## Method: channels.updateUsername [Back to methods index](index.md) +Update the username of a supergroup/channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|username|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|username|[CLICK ME string](../types/string.md) | Yes|The new username| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v68/methods/contacts_getBlocked.md b/old_docs/API_docs_v68/methods/contacts_getBlocked.md index d7d8c5cc..300025af 100644 --- a/old_docs/API_docs_v68/methods/contacts_getBlocked.md +++ b/old_docs/API_docs_v68/methods/contacts_getBlocked.md @@ -12,7 +12,7 @@ Get blocked users | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, then set to the number of blocked contacts previously fetched| +|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, Then set to the number of blocked contacts previously fetched| |limit|[CLICK ME int](../types/int.md) | Yes|How many blocked contacts to fetch| diff --git a/old_docs/API_docs_v68/methods/contacts_getTopPeers.md b/old_docs/API_docs_v68/methods/contacts_getTopPeers.md index 226d3aa0..d7b21757 100644 --- a/old_docs/API_docs_v68/methods/contacts_getTopPeers.md +++ b/old_docs/API_docs_v68/methods/contacts_getTopPeers.md @@ -18,7 +18,7 @@ Get most used chats |phone\_calls|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch phone calls?| |groups|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch groups?| |channels|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch channels and supergroups?| -|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, then `$offset += $contacts_TopPeers['categories']['count'];`| +|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, Then `$offset += $contacts_TopPeers['categories']['count'];`| |limit|[CLICK ME int](../types/int.md) | Yes|How many results to fetch| |hash|[CLICK ME int](../types/int.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched peer ids);| diff --git a/old_docs/API_docs_v68/methods/help_getAppChangelog.md b/old_docs/API_docs_v68/methods/help_getAppChangelog.md index ea7192f6..477df2f8 100644 --- a/old_docs/API_docs_v68/methods/help_getAppChangelog.md +++ b/old_docs/API_docs_v68/methods/help_getAppChangelog.md @@ -1,16 +1,18 @@ --- title: help.getAppChangelog -description: help.getAppChangelog parameters, return type and example +description: Get the changelog of this app --- ## Method: help.getAppChangelog [Back to methods index](index.md) +Get the changelog of this app + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|prev\_app\_version|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|prev\_app\_version|[CLICK ME string](../types/string.md) | Yes|Previous app version| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v68/methods/help_getAppUpdate.md b/old_docs/API_docs_v68/methods/help_getAppUpdate.md index ef72cce2..b88906ae 100644 --- a/old_docs/API_docs_v68/methods/help_getAppUpdate.md +++ b/old_docs/API_docs_v68/methods/help_getAppUpdate.md @@ -1,11 +1,13 @@ --- title: help.getAppUpdate -description: help.getAppUpdate parameters, return type and example +description: Get info about app updates --- ## Method: help.getAppUpdate [Back to methods index](index.md) +Get info about app updates + ### Return type: [help\_AppUpdate](../types/help_AppUpdate.md) diff --git a/old_docs/API_docs_v68/methods/help_getCdnConfig.md b/old_docs/API_docs_v68/methods/help_getCdnConfig.md index 55a6e6fd..809ea1fb 100644 --- a/old_docs/API_docs_v68/methods/help_getCdnConfig.md +++ b/old_docs/API_docs_v68/methods/help_getCdnConfig.md @@ -1,11 +1,13 @@ --- title: help.getCdnConfig -description: help.getCdnConfig parameters, return type and example +description: Get CDN configuration --- ## Method: help.getCdnConfig [Back to methods index](index.md) +Get CDN configuration + ### Return type: [CdnConfig](../types/CdnConfig.md) diff --git a/old_docs/API_docs_v68/methods/help_getConfig.md b/old_docs/API_docs_v68/methods/help_getConfig.md index 885ad5d3..16e25c68 100644 --- a/old_docs/API_docs_v68/methods/help_getConfig.md +++ b/old_docs/API_docs_v68/methods/help_getConfig.md @@ -1,11 +1,13 @@ --- title: help.getConfig -description: help.getConfig parameters, return type and example +description: Get server configuration --- ## Method: help.getConfig [Back to methods index](index.md) +Get server configuration + ### Return type: [Config](../types/Config.md) diff --git a/old_docs/API_docs_v68/methods/help_getInviteText.md b/old_docs/API_docs_v68/methods/help_getInviteText.md index 101ead40..6b226bff 100644 --- a/old_docs/API_docs_v68/methods/help_getInviteText.md +++ b/old_docs/API_docs_v68/methods/help_getInviteText.md @@ -1,11 +1,13 @@ --- title: help.getInviteText -description: help.getInviteText parameters, return type and example +description: Get invitation text --- ## Method: help.getInviteText [Back to methods index](index.md) +Get invitation text + ### Return type: [help\_InviteText](../types/help_InviteText.md) diff --git a/old_docs/API_docs_v68/methods/help_getNearestDc.md b/old_docs/API_docs_v68/methods/help_getNearestDc.md index 6196890b..35a8bf91 100644 --- a/old_docs/API_docs_v68/methods/help_getNearestDc.md +++ b/old_docs/API_docs_v68/methods/help_getNearestDc.md @@ -1,11 +1,13 @@ --- title: help.getNearestDc -description: help.getNearestDc parameters, return type and example +description: Get nearest datacenter --- ## Method: help.getNearestDc [Back to methods index](index.md) +Get nearest datacenter + ### Return type: [NearestDc](../types/NearestDc.md) diff --git a/old_docs/API_docs_v68/methods/help_getSupport.md b/old_docs/API_docs_v68/methods/help_getSupport.md index 9b269f78..a5bab0f2 100644 --- a/old_docs/API_docs_v68/methods/help_getSupport.md +++ b/old_docs/API_docs_v68/methods/help_getSupport.md @@ -1,11 +1,13 @@ --- title: help.getSupport -description: help.getSupport parameters, return type and example +description: Get info of support user --- ## Method: help.getSupport [Back to methods index](index.md) +Get info of support user + ### Return type: [help\_Support](../types/help_Support.md) diff --git a/old_docs/API_docs_v68/methods/help_getTermsOfService.md b/old_docs/API_docs_v68/methods/help_getTermsOfService.md index f63807ab..487cd83a 100644 --- a/old_docs/API_docs_v68/methods/help_getTermsOfService.md +++ b/old_docs/API_docs_v68/methods/help_getTermsOfService.md @@ -1,11 +1,13 @@ --- title: help.getTermsOfService -description: help.getTermsOfService parameters, return type and example +description: Get terms of service --- ## Method: help.getTermsOfService [Back to methods index](index.md) +Get terms of service + ### Return type: [help\_TermsOfService](../types/help_TermsOfService.md) diff --git a/old_docs/API_docs_v68/methods/help_saveAppLog.md b/old_docs/API_docs_v68/methods/help_saveAppLog.md index af6e94e2..0165b6e3 100644 --- a/old_docs/API_docs_v68/methods/help_saveAppLog.md +++ b/old_docs/API_docs_v68/methods/help_saveAppLog.md @@ -1,16 +1,18 @@ --- title: help.saveAppLog -description: help.saveAppLog parameters, return type and example +description: Log data for developer of this app --- ## Method: help.saveAppLog [Back to methods index](index.md) +Log data for developer of this app + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|events|Array of [CLICK ME InputAppEvent](../types/InputAppEvent.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|events|Array of [CLICK ME InputAppEvent](../types/InputAppEvent.md) | Yes|Event list| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v68/methods/help_setBotUpdatesStatus.md b/old_docs/API_docs_v68/methods/help_setBotUpdatesStatus.md index 3351fab4..ff314b5c 100644 --- a/old_docs/API_docs_v68/methods/help_setBotUpdatesStatus.md +++ b/old_docs/API_docs_v68/methods/help_setBotUpdatesStatus.md @@ -1,17 +1,19 @@ --- title: help.setBotUpdatesStatus -description: help.setBotUpdatesStatus parameters, return type and example +description: Set the update status of webhook --- ## Method: help.setBotUpdatesStatus [Back to methods index](index.md) +Set the update status of webhook + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|pending\_updates\_count|[CLICK ME int](../types/int.md) | Yes| -|message|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|pending\_updates\_count|[CLICK ME int](../types/int.md) | Yes|Pending update count| +|message|[CLICK ME string](../types/string.md) | Yes|Message| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v68/methods/messages_checkChatInvite.md b/old_docs/API_docs_v68/methods/messages_checkChatInvite.md index 4ddf5084..de1d9ff4 100644 --- a/old_docs/API_docs_v68/methods/messages_checkChatInvite.md +++ b/old_docs/API_docs_v68/methods/messages_checkChatInvite.md @@ -1,16 +1,18 @@ --- title: messages.checkChatInvite -description: messages.checkChatInvite parameters, return type and example +description: Check if an invitation link is valid --- ## Method: messages.checkChatInvite [Back to methods index](index.md) +Check if an invitation link is valid + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| ### Return type: [ChatInvite](../types/ChatInvite.md) diff --git a/old_docs/API_docs_v68/methods/messages_clearRecentStickers.md b/old_docs/API_docs_v68/methods/messages_clearRecentStickers.md index f017087f..9c1b3754 100644 --- a/old_docs/API_docs_v68/methods/messages_clearRecentStickers.md +++ b/old_docs/API_docs_v68/methods/messages_clearRecentStickers.md @@ -1,16 +1,18 @@ --- title: messages.clearRecentStickers -description: messages.clearRecentStickers parameters, return type and example +description: Clear all recent stickers --- ## Method: messages.clearRecentStickers [Back to methods index](index.md) +Clear all recent stickers + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|attached|[CLICK ME Bool](../types/Bool.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|attached|[CLICK ME Bool](../types/Bool.md) | Optional|Clear recent stickers attached to images?| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v68/methods/messages_deleteChatUser.md b/old_docs/API_docs_v68/methods/messages_deleteChatUser.md index a71f4aaf..0a6830de 100644 --- a/old_docs/API_docs_v68/methods/messages_deleteChatUser.md +++ b/old_docs/API_docs_v68/methods/messages_deleteChatUser.md @@ -12,7 +12,7 @@ Delete a user from a chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The MTProto ID of the chat| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to delete (pass @me to leave the chat)| diff --git a/old_docs/API_docs_v68/methods/messages_editChatAdmin.md b/old_docs/API_docs_v68/methods/messages_editChatAdmin.md index 6bc8f9ae..7916f8b1 100644 --- a/old_docs/API_docs_v68/methods/messages_editChatAdmin.md +++ b/old_docs/API_docs_v68/methods/messages_editChatAdmin.md @@ -1,18 +1,20 @@ --- title: messages.editChatAdmin -description: messages.editChatAdmin parameters, return type and example +description: Edit admin permissions --- ## Method: messages.editChatAdmin [Back to methods index](index.md) +Edit admin permissions + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|is\_admin|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat ID (no supergroups)| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user ID| +|is\_admin|[CLICK ME Bool](../types/Bool.md) | Yes|Should the user be admin?| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v68/methods/messages_editChatPhoto.md b/old_docs/API_docs_v68/methods/messages_editChatPhoto.md index 8848eca7..122913c4 100644 --- a/old_docs/API_docs_v68/methods/messages_editChatPhoto.md +++ b/old_docs/API_docs_v68/methods/messages_editChatPhoto.md @@ -12,7 +12,7 @@ Edit the photo of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The MTProto ID of the chat| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| |photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| diff --git a/old_docs/API_docs_v68/methods/messages_editChatTitle.md b/old_docs/API_docs_v68/methods/messages_editChatTitle.md index 1c1c7a16..3a1e974b 100644 --- a/old_docs/API_docs_v68/methods/messages_editChatTitle.md +++ b/old_docs/API_docs_v68/methods/messages_editChatTitle.md @@ -12,7 +12,7 @@ Edit the title of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The MTProto ID of the chat| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| |title|[CLICK ME string](../types/string.md) | Yes|The new title| diff --git a/old_docs/API_docs_v68/methods/messages_editInlineBotMessage.md b/old_docs/API_docs_v68/methods/messages_editInlineBotMessage.md index c0d06614..2237fb20 100644 --- a/old_docs/API_docs_v68/methods/messages_editInlineBotMessage.md +++ b/old_docs/API_docs_v68/methods/messages_editInlineBotMessage.md @@ -1,20 +1,22 @@ --- title: messages.editInlineBotMessage -description: messages.editInlineBotMessage parameters, return type and example +description: Edit a sent inline message --- ## Method: messages.editInlineBotMessage [Back to methods index](index.md) +Edit a sent inline message + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional| -|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes| -|message|[CLICK ME string](../types/string.md) | Optional| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview| +|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The message ID| +|message|[CLICK ME string](../types/string.md) | Optional|The new message| +|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| +|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/old_docs/API_docs_v68/methods/messages_editMessage.md b/old_docs/API_docs_v68/methods/messages_editMessage.md index 2e98318d..177438a5 100644 --- a/old_docs/API_docs_v68/methods/messages_editMessage.md +++ b/old_docs/API_docs_v68/methods/messages_editMessage.md @@ -1,21 +1,23 @@ --- title: messages.editMessage -description: messages.editMessage parameters, return type and example +description: Edit a message --- ## Method: messages.editMessage [Back to methods index](index.md) +Edit a message + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|id|[CLICK ME int](../types/int.md) | Yes| -|message|[CLICK ME string](../types/string.md) | Optional| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| +|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|message|[CLICK ME string](../types/string.md) | Optional|The new message| +|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| +|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/old_docs/API_docs_v68/methods/messages_exportChatInvite.md b/old_docs/API_docs_v68/methods/messages_exportChatInvite.md index 74d70c21..98685d96 100644 --- a/old_docs/API_docs_v68/methods/messages_exportChatInvite.md +++ b/old_docs/API_docs_v68/methods/messages_exportChatInvite.md @@ -1,16 +1,18 @@ --- title: messages.exportChatInvite -description: messages.exportChatInvite parameters, return type and example +description: Export chat invite --- ## Method: messages.exportChatInvite [Back to methods index](index.md) +Export chat invite + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat id | ### Return type: [ExportedChatInvite](../types/ExportedChatInvite.md) diff --git a/old_docs/API_docs_v68/methods/messages_getAllChats.md b/old_docs/API_docs_v68/methods/messages_getAllChats.md index 4b87df49..127456e4 100644 --- a/old_docs/API_docs_v68/methods/messages_getAllChats.md +++ b/old_docs/API_docs_v68/methods/messages_getAllChats.md @@ -1,16 +1,18 @@ --- title: messages.getAllChats -description: messages.getAllChats parameters, return type and example +description: Get all chats (not supergroups or channels) --- ## Method: messages.getAllChats [Back to methods index](index.md) +Get all chats (not supergroups or channels) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|except\_ids|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|except\_ids|Array of [CLICK ME int](../types/int.md) | Yes|Do not fetch these chats (MTProto id)| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v68/methods/messages_getAllDrafts.md b/old_docs/API_docs_v68/methods/messages_getAllDrafts.md index a5dd59f6..2c0ecd42 100644 --- a/old_docs/API_docs_v68/methods/messages_getAllDrafts.md +++ b/old_docs/API_docs_v68/methods/messages_getAllDrafts.md @@ -1,11 +1,13 @@ --- title: messages.getAllDrafts -description: messages.getAllDrafts parameters, return type and example +description: Get all message drafts --- ## Method: messages.getAllDrafts [Back to methods index](index.md) +Get all message drafts + ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v68/methods/messages_getAllStickers.md b/old_docs/API_docs_v68/methods/messages_getAllStickers.md index 575fcd49..16fdba6c 100644 --- a/old_docs/API_docs_v68/methods/messages_getAllStickers.md +++ b/old_docs/API_docs_v68/methods/messages_getAllStickers.md @@ -1,16 +1,18 @@ --- title: messages.getAllStickers -description: messages.getAllStickers parameters, return type and example +description: Get all stickerpacks --- ## Method: messages.getAllStickers [Back to methods index](index.md) +Get all stickerpacks + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v68/methods/messages_getArchivedStickers.md b/old_docs/API_docs_v68/methods/messages_getArchivedStickers.md index 1b4aaa93..f037e1bc 100644 --- a/old_docs/API_docs_v68/methods/messages_getArchivedStickers.md +++ b/old_docs/API_docs_v68/methods/messages_getArchivedStickers.md @@ -1,18 +1,20 @@ --- title: messages.getArchivedStickers -description: messages.getArchivedStickers parameters, return type and example +description: Get all archived stickers --- ## Method: messages.getArchivedStickers [Back to methods index](index.md) +Get all archived stickers + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|masks|[CLICK ME Bool](../types/Bool.md) | Optional| -|offset\_id|[CLICK ME long](../types/long.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|masks|[CLICK ME Bool](../types/Bool.md) | Optional|Get masks?| +|offset\_id|[CLICK ME long](../types/long.md) | Yes|Sticker ID offset| +|limit|[CLICK ME int](../types/int.md) | Yes|Number of stickers to fetch| ### Return type: [messages\_ArchivedStickers](../types/messages_ArchivedStickers.md) diff --git a/old_docs/API_docs_v68/methods/messages_getAttachedStickers.md b/old_docs/API_docs_v68/methods/messages_getAttachedStickers.md index a0d89b31..890680cd 100644 --- a/old_docs/API_docs_v68/methods/messages_getAttachedStickers.md +++ b/old_docs/API_docs_v68/methods/messages_getAttachedStickers.md @@ -1,16 +1,18 @@ --- title: messages.getAttachedStickers -description: messages.getAttachedStickers parameters, return type and example +description: Get stickers attachable to images --- ## Method: messages.getAttachedStickers [Back to methods index](index.md) +Get stickers attachable to images + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|media|[CLICK ME InputStickeredMedia](../types/InputStickeredMedia.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|media|[CLICK ME InputStickeredMedia](../types/InputStickeredMedia.md) | Yes|The stickered media| ### Return type: [Vector\_of\_StickerSetCovered](../types/StickerSetCovered.md) diff --git a/old_docs/API_docs_v68/methods/messages_getBotCallbackAnswer.md b/old_docs/API_docs_v68/methods/messages_getBotCallbackAnswer.md index 7ccd0d1b..09c283f5 100644 --- a/old_docs/API_docs_v68/methods/messages_getBotCallbackAnswer.md +++ b/old_docs/API_docs_v68/methods/messages_getBotCallbackAnswer.md @@ -1,19 +1,21 @@ --- title: messages.getBotCallbackAnswer -description: messages.getBotCallbackAnswer parameters, return type and example +description: Get the callback answer of a bot (after clicking a button) --- ## Method: messages.getBotCallbackAnswer [Back to methods index](index.md) +Get the callback answer of a bot (after clicking a button) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|game|[CLICK ME Bool](../types/Bool.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|msg\_id|[CLICK ME int](../types/int.md) | Yes| -|data|[CLICK ME bytes](../types/bytes.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|game|[CLICK ME Bool](../types/Bool.md) | Optional|Is this a game?| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| +|msg\_id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|data|[CLICK ME bytes](../types/bytes.md) | Optional|The data to send to the bot| ### Return type: [messages\_BotCallbackAnswer](../types/messages_BotCallbackAnswer.md) diff --git a/old_docs/API_docs_v68/methods/messages_getCommonChats.md b/old_docs/API_docs_v68/methods/messages_getCommonChats.md index a57d7f5a..e6eca283 100644 --- a/old_docs/API_docs_v68/methods/messages_getCommonChats.md +++ b/old_docs/API_docs_v68/methods/messages_getCommonChats.md @@ -1,18 +1,20 @@ --- title: messages.getCommonChats -description: messages.getCommonChats parameters, return type and example +description: Get chats in common with a user --- ## Method: messages.getCommonChats [Back to methods index](index.md) +Get chats in common with a user + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|max\_id|[CLICK ME int](../types/int.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| +|max\_id|[CLICK ME int](../types/int.md) | Yes|The maximum chat ID to fetch| +|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to fetch| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v68/methods/messages_getDocumentByHash.md b/old_docs/API_docs_v68/methods/messages_getDocumentByHash.md index b7c45398..1af5bad4 100644 --- a/old_docs/API_docs_v68/methods/messages_getDocumentByHash.md +++ b/old_docs/API_docs_v68/methods/messages_getDocumentByHash.md @@ -1,18 +1,20 @@ --- title: messages.getDocumentByHash -description: messages.getDocumentByHash parameters, return type and example +description: Get document by SHA256 hash --- ## Method: messages.getDocumentByHash [Back to methods index](index.md) +Get document by SHA256 hash + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|sha256|[CLICK ME bytes](../types/bytes.md) | Yes| -|size|[CLICK ME int](../types/int.md) | Yes| -|mime\_type|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|sha256|[CLICK ME bytes](../types/bytes.md) | Yes|`hash('sha256', $filename, true);`| +|size|[CLICK ME int](../types/int.md) | Yes|The file size| +|mime\_type|[CLICK ME string](../types/string.md) | Yes|The mime type of the file| ### Return type: [Document](../types/Document.md) diff --git a/old_docs/API_docs_v68/methods/messages_getFeaturedStickers.md b/old_docs/API_docs_v68/methods/messages_getFeaturedStickers.md index 88b5609c..512f2e85 100644 --- a/old_docs/API_docs_v68/methods/messages_getFeaturedStickers.md +++ b/old_docs/API_docs_v68/methods/messages_getFeaturedStickers.md @@ -1,16 +1,18 @@ --- title: messages.getFeaturedStickers -description: messages.getFeaturedStickers parameters, return type and example +description: Get featured stickers --- ## Method: messages.getFeaturedStickers [Back to methods index](index.md) +Get featured stickers + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_FeaturedStickers](../types/messages_FeaturedStickers.md) diff --git a/old_docs/API_docs_v68/methods/messages_getGameHighScores.md b/old_docs/API_docs_v68/methods/messages_getGameHighScores.md index 2c95af05..5137baea 100644 --- a/old_docs/API_docs_v68/methods/messages_getGameHighScores.md +++ b/old_docs/API_docs_v68/methods/messages_getGameHighScores.md @@ -1,18 +1,20 @@ --- title: messages.getGameHighScores -description: messages.getGameHighScores parameters, return type and example +description: Get high scores of a game --- ## Method: messages.getGameHighScores [Back to methods index](index.md) +Get high scores of a game + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|id|[CLICK ME int](../types/int.md) | Yes| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| +|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the high scores| ### Return type: [messages\_HighScores](../types/messages_HighScores.md) diff --git a/old_docs/API_docs_v68/methods/messages_getInlineBotResults.md b/old_docs/API_docs_v68/methods/messages_getInlineBotResults.md index 5b2bb254..8ab5bf78 100644 --- a/old_docs/API_docs_v68/methods/messages_getInlineBotResults.md +++ b/old_docs/API_docs_v68/methods/messages_getInlineBotResults.md @@ -1,20 +1,22 @@ --- title: messages.getInlineBotResults -description: messages.getInlineBotResults parameters, return type and example +description: Call inline bot --- ## Method: messages.getInlineBotResults [Back to methods index](index.md) +Call inline bot + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional| -|query|[CLICK ME string](../types/string.md) | Yes| -|offset|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot to call| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to call the bot| +|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional|The current location| +|query|[CLICK ME string](../types/string.md) | Yes|The query to send to the bot| +|offset|[CLICK ME string](../types/string.md) | Yes|The offset to send to the bot| ### Return type: [messages\_BotResults](../types/messages_BotResults.md) diff --git a/old_docs/API_docs_v68/methods/messages_getInlineGameHighScores.md b/old_docs/API_docs_v68/methods/messages_getInlineGameHighScores.md index 447a55dd..790bfdd9 100644 --- a/old_docs/API_docs_v68/methods/messages_getInlineGameHighScores.md +++ b/old_docs/API_docs_v68/methods/messages_getInlineGameHighScores.md @@ -1,17 +1,19 @@ --- title: messages.getInlineGameHighScores -description: messages.getInlineGameHighScores parameters, return type and example +description: Get high scores of a game sent in an inline message --- ## Method: messages.getInlineGameHighScores [Back to methods index](index.md) +Get high scores of a game sent in an inline message + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The inline message| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the high scores| ### Return type: [messages\_HighScores](../types/messages_HighScores.md) diff --git a/old_docs/API_docs_v68/methods/messages_getMaskStickers.md b/old_docs/API_docs_v68/methods/messages_getMaskStickers.md index 80c16471..f4ed9411 100644 --- a/old_docs/API_docs_v68/methods/messages_getMaskStickers.md +++ b/old_docs/API_docs_v68/methods/messages_getMaskStickers.md @@ -1,16 +1,18 @@ --- title: messages.getMaskStickers -description: messages.getMaskStickers parameters, return type and example +description: Get masks --- ## Method: messages.getMaskStickers [Back to methods index](index.md) +Get masks + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v68/methods/messages_getMessageEditData.md b/old_docs/API_docs_v68/methods/messages_getMessageEditData.md index 339678bd..12e71bee 100644 --- a/old_docs/API_docs_v68/methods/messages_getMessageEditData.md +++ b/old_docs/API_docs_v68/methods/messages_getMessageEditData.md @@ -1,17 +1,19 @@ --- title: messages.getMessageEditData -description: messages.getMessageEditData parameters, return type and example +description: Check if about to edit a message or a media caption --- ## Method: messages.getMessageEditData [Back to methods index](index.md) +Check if about to edit a message or a media caption + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|id|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| +|id|[CLICK ME int](../types/int.md) | Yes|The message ID| ### Return type: [messages\_MessageEditData](../types/messages_MessageEditData.md) diff --git a/old_docs/API_docs_v68/methods/messages_getMessagesViews.md b/old_docs/API_docs_v68/methods/messages_getMessagesViews.md index e3f4e4ea..b8d78c85 100644 --- a/old_docs/API_docs_v68/methods/messages_getMessagesViews.md +++ b/old_docs/API_docs_v68/methods/messages_getMessagesViews.md @@ -1,18 +1,20 @@ --- title: messages.getMessagesViews -description: messages.getMessagesViews parameters, return type and example +description: Get and increase message views --- ## Method: messages.getMessagesViews [Back to methods index](index.md) +Get and increase message views + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|id|Array of [CLICK ME int](../types/int.md) | Yes| -|increment|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the message is located| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs messages to get| +|increment|[CLICK ME Bool](../types/Bool.md) | Yes|Increase message views?| ### Return type: [Vector\_of\_int](../types/int.md) diff --git a/old_docs/API_docs_v68/methods/messages_getPeerDialogs.md b/old_docs/API_docs_v68/methods/messages_getPeerDialogs.md index fe8a821c..da82cfc6 100644 --- a/old_docs/API_docs_v68/methods/messages_getPeerDialogs.md +++ b/old_docs/API_docs_v68/methods/messages_getPeerDialogs.md @@ -1,16 +1,18 @@ --- title: messages.getPeerDialogs -description: messages.getPeerDialogs parameters, return type and example +description: Get dialog info of peers --- ## Method: messages.getPeerDialogs [Back to methods index](index.md) +Get dialog info of peers + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peers|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peers|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Yes|The peers| ### Return type: [messages\_PeerDialogs](../types/messages_PeerDialogs.md) diff --git a/old_docs/API_docs_v68/methods/messages_getPinnedDialogs.md b/old_docs/API_docs_v68/methods/messages_getPinnedDialogs.md index 99ff5651..d12779fe 100644 --- a/old_docs/API_docs_v68/methods/messages_getPinnedDialogs.md +++ b/old_docs/API_docs_v68/methods/messages_getPinnedDialogs.md @@ -1,11 +1,13 @@ --- title: messages.getPinnedDialogs -description: messages.getPinnedDialogs parameters, return type and example +description: Get pinned dialogs --- ## Method: messages.getPinnedDialogs [Back to methods index](index.md) +Get pinned dialogs + ### Return type: [messages\_PeerDialogs](../types/messages_PeerDialogs.md) diff --git a/old_docs/API_docs_v68/methods/messages_getRecentStickers.md b/old_docs/API_docs_v68/methods/messages_getRecentStickers.md index abab7f44..d76a2160 100644 --- a/old_docs/API_docs_v68/methods/messages_getRecentStickers.md +++ b/old_docs/API_docs_v68/methods/messages_getRecentStickers.md @@ -1,17 +1,19 @@ --- title: messages.getRecentStickers -description: messages.getRecentStickers parameters, return type and example +description: Get recent stickers --- ## Method: messages.getRecentStickers [Back to methods index](index.md) +Get recent stickers + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|attached|[CLICK ME Bool](../types/Bool.md) | Optional| -|hash|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|attached|[CLICK ME Bool](../types/Bool.md) | Optional|Get stickers attached to image?| +|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_RecentStickers](../types/messages_RecentStickers.md) diff --git a/old_docs/API_docs_v68/methods/messages_getSavedGifs.md b/old_docs/API_docs_v68/methods/messages_getSavedGifs.md index 08dc4be6..f61348ce 100644 --- a/old_docs/API_docs_v68/methods/messages_getSavedGifs.md +++ b/old_docs/API_docs_v68/methods/messages_getSavedGifs.md @@ -1,16 +1,18 @@ --- title: messages.getSavedGifs -description: messages.getSavedGifs parameters, return type and example +description: Get saved gifs --- ## Method: messages.getSavedGifs [Back to methods index](index.md) +Get saved gifs + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_SavedGifs](../types/messages_SavedGifs.md) diff --git a/old_docs/API_docs_v68/methods/messages_getStickerSet.md b/old_docs/API_docs_v68/methods/messages_getStickerSet.md index 70bdd9ba..c86807e4 100644 --- a/old_docs/API_docs_v68/methods/messages_getStickerSet.md +++ b/old_docs/API_docs_v68/methods/messages_getStickerSet.md @@ -1,16 +1,18 @@ --- title: messages.getStickerSet -description: messages.getStickerSet parameters, return type and example +description: Get a stickerset --- ## Method: messages.getStickerSet [Back to methods index](index.md) +Get a stickerset + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset to get| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/old_docs/API_docs_v68/methods/messages_getWebPage.md b/old_docs/API_docs_v68/methods/messages_getWebPage.md index b29e5d25..129f8f06 100644 --- a/old_docs/API_docs_v68/methods/messages_getWebPage.md +++ b/old_docs/API_docs_v68/methods/messages_getWebPage.md @@ -1,17 +1,19 @@ --- title: messages.getWebPage -description: messages.getWebPage parameters, return type and example +description: Get webpage preview --- ## Method: messages.getWebPage [Back to methods index](index.md) +Get webpage preview + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|url|[CLICK ME string](../types/string.md) | Yes| -|hash|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|url|[CLICK ME string](../types/string.md) | Yes|URL| +|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [WebPage](../types/WebPage.md) diff --git a/old_docs/API_docs_v68/methods/messages_getWebPagePreview.md b/old_docs/API_docs_v68/methods/messages_getWebPagePreview.md index 35243c9f..d01bdd32 100644 --- a/old_docs/API_docs_v68/methods/messages_getWebPagePreview.md +++ b/old_docs/API_docs_v68/methods/messages_getWebPagePreview.md @@ -1,16 +1,18 @@ --- title: messages.getWebPagePreview -description: messages.getWebPagePreview parameters, return type and example +description: Get webpage preview --- ## Method: messages.getWebPagePreview [Back to methods index](index.md) +Get webpage preview + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|message|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|message|[CLICK ME string](../types/string.md) | Yes|Extract preview from this message| ### Return type: [MessageMedia](../types/MessageMedia.md) diff --git a/old_docs/API_docs_v68/methods/messages_importChatInvite.md b/old_docs/API_docs_v68/methods/messages_importChatInvite.md index 2bea5247..0d6cd7c8 100644 --- a/old_docs/API_docs_v68/methods/messages_importChatInvite.md +++ b/old_docs/API_docs_v68/methods/messages_importChatInvite.md @@ -1,16 +1,18 @@ --- title: messages.importChatInvite -description: messages.importChatInvite parameters, return type and example +description: Import chat invite --- ## Method: messages.importChatInvite [Back to methods index](index.md) +Import chat invite + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v68/methods/messages_installStickerSet.md b/old_docs/API_docs_v68/methods/messages_installStickerSet.md index 61513182..9f6f098c 100644 --- a/old_docs/API_docs_v68/methods/messages_installStickerSet.md +++ b/old_docs/API_docs_v68/methods/messages_installStickerSet.md @@ -1,17 +1,19 @@ --- title: messages.installStickerSet -description: messages.installStickerSet parameters, return type and example +description: Add a sticker set --- ## Method: messages.installStickerSet [Back to methods index](index.md) +Add a sticker set + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional| -|archived|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to add| +|archived|[CLICK ME Bool](../types/Bool.md) | Yes|Archive this set?| ### Return type: [messages\_StickerSetInstallResult](../types/messages_StickerSetInstallResult.md) diff --git a/old_docs/API_docs_v68/methods/messages_migrateChat.md b/old_docs/API_docs_v68/methods/messages_migrateChat.md index 5021ad45..db57adfa 100644 --- a/old_docs/API_docs_v68/methods/messages_migrateChat.md +++ b/old_docs/API_docs_v68/methods/messages_migrateChat.md @@ -1,16 +1,18 @@ --- title: messages.migrateChat -description: messages.migrateChat parameters, return type and example +description: Convert chat to supergroup --- ## Method: messages.migrateChat [Back to methods index](index.md) +Convert chat to supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat to convert| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v68/methods/messages_readEncryptedHistory.md b/old_docs/API_docs_v68/methods/messages_readEncryptedHistory.md index 4d341809..39b110e3 100644 --- a/old_docs/API_docs_v68/methods/messages_readEncryptedHistory.md +++ b/old_docs/API_docs_v68/methods/messages_readEncryptedHistory.md @@ -1,17 +1,19 @@ --- title: messages.readEncryptedHistory -description: messages.readEncryptedHistory parameters, return type and example +description: Mark messages as read in secret chats --- ## Method: messages.readEncryptedHistory [Back to methods index](index.md) +Mark messages as read in secret chats + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|max\_date|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to mark messages as read| +|max\_date|[CLICK ME int](../types/int.md) | Yes|Maximum date of messages to mark| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v68/methods/messages_readFeaturedStickers.md b/old_docs/API_docs_v68/methods/messages_readFeaturedStickers.md index 0631ca5b..4035c76d 100644 --- a/old_docs/API_docs_v68/methods/messages_readFeaturedStickers.md +++ b/old_docs/API_docs_v68/methods/messages_readFeaturedStickers.md @@ -1,16 +1,18 @@ --- title: messages.readFeaturedStickers -description: messages.readFeaturedStickers parameters, return type and example +description: Mark new featured stickers as read --- ## Method: messages.readFeaturedStickers [Back to methods index](index.md) +Mark new featured stickers as read + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|Array of [CLICK ME long](../types/long.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|Array of [CLICK ME long](../types/long.md) | Yes|The stickers to mark as read| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v68/methods/messages_readMessageContents.md b/old_docs/API_docs_v68/methods/messages_readMessageContents.md index 0d27c209..9bb1bee8 100644 --- a/old_docs/API_docs_v68/methods/messages_readMessageContents.md +++ b/old_docs/API_docs_v68/methods/messages_readMessageContents.md @@ -1,16 +1,18 @@ --- title: messages.readMessageContents -description: messages.readMessageContents parameters, return type and example +description: Mark message as read --- ## Method: messages.readMessageContents [Back to methods index](index.md) +Mark message as read + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v68/methods/messages_receivedQueue.md b/old_docs/API_docs_v68/methods/messages_receivedQueue.md index c91caa37..4ad78ba2 100644 --- a/old_docs/API_docs_v68/methods/messages_receivedQueue.md +++ b/old_docs/API_docs_v68/methods/messages_receivedQueue.md @@ -1,77 +1,13 @@ --- title: messages.receivedQueue -description: messages.receivedQueue parameters, return type and example +description: You cannot use this method directly --- ## Method: messages.receivedQueue [Back to methods index](index.md) -### Parameters: - -| Name | Type | Required | -|----------|---------------|----------| -|max\_qts|[CLICK ME int](../types/int.md) | Yes| - - -### 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| - - -### MadelineProto Example: - - -``` -if (!file_exists('madeline.php')) { - copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); -} -include 'madeline.php'; - -// !!! This API id/API hash combination will not work !!! -// !!! You must get your own @ my.telegram.org !!! -$api_id = 0; -$api_hash = ''; - -$MadelineProto = new \danog\MadelineProto\API('session.madeline', ['app_info' => ['api_id' => $api_id, 'api_hash' => $api_hash]]); -$MadelineProto->start(); - -$Vector_of_long = $MadelineProto->messages->receivedQueue(['max_qts' => int, ]); -``` - -### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): - -### As a bot: - -POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` - -Parameters: - -* method - messages.receivedQueue -* params - `{"max_qts": int, }` - - - -### As a user: - -POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.receivedQueue` - -Parameters: - -max_qts - Json encoded int +**You cannot use this method directly** -Or, if you're into Lua: - -``` -Vector_of_long = messages.receivedQueue({max_qts=int, }) -``` - diff --git a/old_docs/API_docs_v68/methods/messages_reorderPinnedDialogs.md b/old_docs/API_docs_v68/methods/messages_reorderPinnedDialogs.md index 0bf5e073..710caf10 100644 --- a/old_docs/API_docs_v68/methods/messages_reorderPinnedDialogs.md +++ b/old_docs/API_docs_v68/methods/messages_reorderPinnedDialogs.md @@ -1,17 +1,19 @@ --- title: messages.reorderPinnedDialogs -description: messages.reorderPinnedDialogs parameters, return type and example +description: Reorder pinned dialogs --- ## Method: messages.reorderPinnedDialogs [Back to methods index](index.md) +Reorder pinned dialogs + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|force|[CLICK ME Bool](../types/Bool.md) | Optional| -|order|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|force|[CLICK ME Bool](../types/Bool.md) | Optional|Force reordering| +|order|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Yes|New order| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v68/methods/messages_reorderStickerSets.md b/old_docs/API_docs_v68/methods/messages_reorderStickerSets.md index e4f1623c..ddc78dd0 100644 --- a/old_docs/API_docs_v68/methods/messages_reorderStickerSets.md +++ b/old_docs/API_docs_v68/methods/messages_reorderStickerSets.md @@ -1,17 +1,19 @@ --- title: messages.reorderStickerSets -description: messages.reorderStickerSets parameters, return type and example +description: Reorder sticker sets --- ## Method: messages.reorderStickerSets [Back to methods index](index.md) +Reorder sticker sets + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|masks|[CLICK ME Bool](../types/Bool.md) | Optional| -|order|Array of [CLICK ME long](../types/long.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|masks|[CLICK ME Bool](../types/Bool.md) | Optional|Reorder masks?| +|order|Array of [CLICK ME long](../types/long.md) | Yes|The order| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v68/methods/messages_reportEncryptedSpam.md b/old_docs/API_docs_v68/methods/messages_reportEncryptedSpam.md index 44482c76..58b684d1 100644 --- a/old_docs/API_docs_v68/methods/messages_reportEncryptedSpam.md +++ b/old_docs/API_docs_v68/methods/messages_reportEncryptedSpam.md @@ -1,16 +1,18 @@ --- title: messages.reportEncryptedSpam -description: messages.reportEncryptedSpam parameters, return type and example +description: Report for spam a secret chat --- ## Method: messages.reportEncryptedSpam [Back to methods index](index.md) +Report for spam a secret chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat to report| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v68/methods/messages_saveDraft.md b/old_docs/API_docs_v68/methods/messages_saveDraft.md index 9104df33..bbeed707 100644 --- a/old_docs/API_docs_v68/methods/messages_saveDraft.md +++ b/old_docs/API_docs_v68/methods/messages_saveDraft.md @@ -1,20 +1,22 @@ --- title: messages.saveDraft -description: messages.saveDraft parameters, return type and example +description: Save a message draft --- ## Method: messages.saveDraft [Back to methods index](index.md) +Save a message draft + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|message|[CLICK ME string](../types/string.md) | Yes| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview| +|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| +|message|[CLICK ME string](../types/string.md) | Yes|The message| +|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|The entities (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/old_docs/API_docs_v68/methods/messages_saveGif.md b/old_docs/API_docs_v68/methods/messages_saveGif.md index 4a3b6166..6f608c4c 100644 --- a/old_docs/API_docs_v68/methods/messages_saveGif.md +++ b/old_docs/API_docs_v68/methods/messages_saveGif.md @@ -1,17 +1,19 @@ --- title: messages.saveGif -description: messages.saveGif parameters, return type and example +description: Save a GIF --- ## Method: messages.saveGif [Back to methods index](index.md) +Save a GIF + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional| -|unsave|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The GIF to save| +|unsave|[CLICK ME Bool](../types/Bool.md) | Yes|Remove the gif?| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v68/methods/messages_saveRecentSticker.md b/old_docs/API_docs_v68/methods/messages_saveRecentSticker.md index b4f43e13..81ad5d48 100644 --- a/old_docs/API_docs_v68/methods/messages_saveRecentSticker.md +++ b/old_docs/API_docs_v68/methods/messages_saveRecentSticker.md @@ -1,18 +1,20 @@ --- title: messages.saveRecentSticker -description: messages.saveRecentSticker parameters, return type and example +description: Add a sticker to recent stickers --- ## Method: messages.saveRecentSticker [Back to methods index](index.md) +Add a sticker to recent stickers + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|attached|[CLICK ME Bool](../types/Bool.md) | Optional| -|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional| -|unsave|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|attached|[CLICK ME Bool](../types/Bool.md) | Optional|Get stickers attached to image?| +|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker| +|unsave|[CLICK ME Bool](../types/Bool.md) | Yes|Remove the sticker from recent stickers?| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v68/methods/messages_searchGifs.md b/old_docs/API_docs_v68/methods/messages_searchGifs.md index fefef1d7..103ebfeb 100644 --- a/old_docs/API_docs_v68/methods/messages_searchGifs.md +++ b/old_docs/API_docs_v68/methods/messages_searchGifs.md @@ -1,17 +1,19 @@ --- title: messages.searchGifs -description: messages.searchGifs parameters, return type and example +description: Search gifs --- ## Method: messages.searchGifs [Back to methods index](index.md) +Search gifs + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|q|[CLICK ME string](../types/string.md) | Yes| -|offset|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|q|[CLICK ME string](../types/string.md) | Yes|The search query| +|offset|[CLICK ME int](../types/int.md) | Yes|The offset | ### Return type: [messages\_FoundGifs](../types/messages_FoundGifs.md) diff --git a/old_docs/API_docs_v68/methods/messages_searchGlobal.md b/old_docs/API_docs_v68/methods/messages_searchGlobal.md index 32ddd175..0edd1e40 100644 --- a/old_docs/API_docs_v68/methods/messages_searchGlobal.md +++ b/old_docs/API_docs_v68/methods/messages_searchGlobal.md @@ -1,20 +1,22 @@ --- title: messages.searchGlobal -description: messages.searchGlobal parameters, return type and example +description: Global message search --- ## Method: messages.searchGlobal [Back to methods index](index.md) +Global message search + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|q|[CLICK ME string](../types/string.md) | Yes| -|offset\_date|[CLICK ME int](../types/int.md) | Yes| -|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|offset\_id|[CLICK ME int](../types/int.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|q|[CLICK ME string](../types/string.md) | Yes|The query| +|offset\_date|[CLICK ME int](../types/int.md) | Yes|0 or the date offset| +|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|0 or the peer offset| +|offset\_id|[CLICK ME int](../types/int.md) | Yes|0 or the message ID offset| +|limit|[CLICK ME int](../types/int.md) | Yes|The number of results to return| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v68/methods/messages_sendEncrypted.md b/old_docs/API_docs_v68/methods/messages_sendEncrypted.md index 23461760..d48f88d7 100644 --- a/old_docs/API_docs_v68/methods/messages_sendEncrypted.md +++ b/old_docs/API_docs_v68/methods/messages_sendEncrypted.md @@ -1,17 +1,19 @@ --- title: messages.sendEncrypted -description: messages.sendEncrypted parameters, return type and example +description: Send message to secret chat --- ## Method: messages.sendEncrypted [Back to methods index](index.md) +Send message to secret chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the message| +|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v68/methods/messages_sendEncryptedFile.md b/old_docs/API_docs_v68/methods/messages_sendEncryptedFile.md index 64919abe..4fd0648e 100644 --- a/old_docs/API_docs_v68/methods/messages_sendEncryptedFile.md +++ b/old_docs/API_docs_v68/methods/messages_sendEncryptedFile.md @@ -1,18 +1,20 @@ --- title: messages.sendEncryptedFile -description: messages.sendEncryptedFile parameters, return type and example +description: Send a file to a secret chat --- ## Method: messages.sendEncryptedFile [Back to methods index](index.md) +Send a file to a secret chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes| -|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the file| +|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| +|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional|The file (optional)| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v68/methods/messages_sendEncryptedService.md b/old_docs/API_docs_v68/methods/messages_sendEncryptedService.md index 0a0eea8a..d66894bf 100644 --- a/old_docs/API_docs_v68/methods/messages_sendEncryptedService.md +++ b/old_docs/API_docs_v68/methods/messages_sendEncryptedService.md @@ -1,17 +1,19 @@ --- title: messages.sendEncryptedService -description: messages.sendEncryptedService parameters, return type and example +description: Send a service message to a secret chat --- ## Method: messages.sendEncryptedService [Back to methods index](index.md) +Send a service message to a secret chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the service message| +|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v68/methods/messages_sendInlineBotResult.md b/old_docs/API_docs_v68/methods/messages_sendInlineBotResult.md index 4cb9243e..386ac7e3 100644 --- a/old_docs/API_docs_v68/methods/messages_sendInlineBotResult.md +++ b/old_docs/API_docs_v68/methods/messages_sendInlineBotResult.md @@ -1,22 +1,24 @@ --- title: messages.sendInlineBotResult -description: messages.sendInlineBotResult parameters, return type and example +description: Send a received bot result to the chat --- ## Method: messages.sendInlineBotResult [Back to methods index](index.md) +Send a received bot result to the chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional| -|background|[CLICK ME Bool](../types/Bool.md) | Optional| -|clear\_draft|[CLICK ME Bool](../types/Bool.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional| -|query\_id|[CLICK ME long](../types/long.md) | Yes| -|id|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Disable notifications?| +|background|[CLICK ME Bool](../types/Bool.md) | Optional|Disable background notifications?| +|clear\_draft|[CLICK ME Bool](../types/Bool.md) | Optional|Clear the message draft?| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the message| +|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| +|query\_id|[CLICK ME long](../types/long.md) | Yes|The inline query ID| +|id|[CLICK ME string](../types/string.md) | Yes|The result ID| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v68/methods/messages_setBotCallbackAnswer.md b/old_docs/API_docs_v68/methods/messages_setBotCallbackAnswer.md index 5590828e..e6dc6b09 100644 --- a/old_docs/API_docs_v68/methods/messages_setBotCallbackAnswer.md +++ b/old_docs/API_docs_v68/methods/messages_setBotCallbackAnswer.md @@ -1,20 +1,22 @@ --- title: messages.setBotCallbackAnswer -description: messages.setBotCallbackAnswer parameters, return type and example +description: Bots only: set the callback answer (after a button was clicked) --- ## Method: messages.setBotCallbackAnswer [Back to methods index](index.md) +Bots only: set the callback answer (after a button was clicked) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|alert|[CLICK ME Bool](../types/Bool.md) | Optional| -|query\_id|[CLICK ME long](../types/long.md) | Yes| -|message|[CLICK ME string](../types/string.md) | Optional| -|url|[CLICK ME string](../types/string.md) | Optional| -|cache\_time|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|alert|[CLICK ME Bool](../types/Bool.md) | Optional|Is this an alert?| +|query\_id|[CLICK ME long](../types/long.md) | Yes|The query ID| +|message|[CLICK ME string](../types/string.md) | Optional|The message| +|url|[CLICK ME string](../types/string.md) | Optional|The URL| +|cache\_time|[CLICK ME int](../types/int.md) | Yes|Cache time| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v68/methods/messages_setBotPrecheckoutResults.md b/old_docs/API_docs_v68/methods/messages_setBotPrecheckoutResults.md index 5afa7789..722bff81 100644 --- a/old_docs/API_docs_v68/methods/messages_setBotPrecheckoutResults.md +++ b/old_docs/API_docs_v68/methods/messages_setBotPrecheckoutResults.md @@ -1,18 +1,20 @@ --- title: messages.setBotPrecheckoutResults -description: messages.setBotPrecheckoutResults parameters, return type and example +description: Bots only: set precheckout results --- ## Method: messages.setBotPrecheckoutResults [Back to methods index](index.md) +Bots only: set precheckout results + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|success|[CLICK ME Bool](../types/Bool.md) | Optional| -|query\_id|[CLICK ME long](../types/long.md) | Yes| -|error|[CLICK ME string](../types/string.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|success|[CLICK ME Bool](../types/Bool.md) | Optional|Success?| +|query\_id|[CLICK ME long](../types/long.md) | Yes|Query ID| +|error|[CLICK ME string](../types/string.md) | Optional|Error| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v68/methods/messages_setBotShippingResults.md b/old_docs/API_docs_v68/methods/messages_setBotShippingResults.md index b36dacce..d364a04d 100644 --- a/old_docs/API_docs_v68/methods/messages_setBotShippingResults.md +++ b/old_docs/API_docs_v68/methods/messages_setBotShippingResults.md @@ -1,18 +1,20 @@ --- title: messages.setBotShippingResults -description: messages.setBotShippingResults parameters, return type and example +description: Bots only: set shipping results --- ## Method: messages.setBotShippingResults [Back to methods index](index.md) +Bots only: set shipping results + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|query\_id|[CLICK ME long](../types/long.md) | Yes| -|error|[CLICK ME string](../types/string.md) | Optional| -|shipping\_options|Array of [CLICK ME ShippingOption](../types/ShippingOption.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|query\_id|[CLICK ME long](../types/long.md) | Yes|Query ID| +|error|[CLICK ME string](../types/string.md) | Optional|Error| +|shipping\_options|Array of [CLICK ME ShippingOption](../types/ShippingOption.md) | Optional|Shipping options| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v68/methods/messages_setEncryptedTyping.md b/old_docs/API_docs_v68/methods/messages_setEncryptedTyping.md index 3183fedf..e9afe99c 100644 --- a/old_docs/API_docs_v68/methods/messages_setEncryptedTyping.md +++ b/old_docs/API_docs_v68/methods/messages_setEncryptedTyping.md @@ -12,8 +12,8 @@ Send typing notification to secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|| -|typing|[CLICK ME Bool](../types/Bool.md) | Yes|| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to send the notification| +|typing|[CLICK ME Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v68/methods/messages_setGameScore.md b/old_docs/API_docs_v68/methods/messages_setGameScore.md index c44145c0..aa1f4f0c 100644 --- a/old_docs/API_docs_v68/methods/messages_setGameScore.md +++ b/old_docs/API_docs_v68/methods/messages_setGameScore.md @@ -1,21 +1,23 @@ --- title: messages.setGameScore -description: messages.setGameScore parameters, return type and example +description: Set the game score --- ## Method: messages.setGameScore [Back to methods index](index.md) +Set the game score + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|edit\_message|[CLICK ME Bool](../types/Bool.md) | Optional| -|force|[CLICK ME Bool](../types/Bool.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|id|[CLICK ME int](../types/int.md) | Yes| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|score|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|edit\_message|[CLICK ME Bool](../types/Bool.md) | Optional|Should the message with the game be edited?| +|force|[CLICK ME Bool](../types/Bool.md) | Optional|Force setting the game score| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the game was sent| +|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the score| +|score|[CLICK ME int](../types/int.md) | Yes|The score| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v68/methods/messages_setInlineBotResults.md b/old_docs/API_docs_v68/methods/messages_setInlineBotResults.md index 915e3a4e..79493009 100644 --- a/old_docs/API_docs_v68/methods/messages_setInlineBotResults.md +++ b/old_docs/API_docs_v68/methods/messages_setInlineBotResults.md @@ -1,22 +1,24 @@ --- title: messages.setInlineBotResults -description: messages.setInlineBotResults parameters, return type and example +description: Bots only: set the results of an inline query --- ## Method: messages.setInlineBotResults [Back to methods index](index.md) +Bots only: set the results of an inline query + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|gallery|[CLICK ME Bool](../types/Bool.md) | Optional| -|private|[CLICK ME Bool](../types/Bool.md) | Optional| -|query\_id|[CLICK ME long](../types/long.md) | Yes| -|results|Array of [CLICK ME InputBotInlineResult](../types/InputBotInlineResult.md) | Yes| -|cache\_time|[CLICK ME int](../types/int.md) | Yes| -|next\_offset|[CLICK ME string](../types/string.md) | Optional| -|switch\_pm|[CLICK ME InlineBotSwitchPM](../types/InlineBotSwitchPM.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|gallery|[CLICK ME Bool](../types/Bool.md) | Optional|Is this a gallery?| +|private|[CLICK ME Bool](../types/Bool.md) | Optional|Is this result private (not cached)?| +|query\_id|[CLICK ME long](../types/long.md) | Yes|Query ID| +|results|Array of [CLICK ME InputBotInlineResult](../types/InputBotInlineResult.md) | Yes|Results| +|cache\_time|[CLICK ME int](../types/int.md) | Yes|Cache time| +|next\_offset|[CLICK ME string](../types/string.md) | Optional|The next offset| +|switch\_pm|[CLICK ME InlineBotSwitchPM](../types/InlineBotSwitchPM.md) | Optional|Switch to PM?| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v68/methods/messages_setInlineGameScore.md b/old_docs/API_docs_v68/methods/messages_setInlineGameScore.md index 55e2c063..385c8308 100644 --- a/old_docs/API_docs_v68/methods/messages_setInlineGameScore.md +++ b/old_docs/API_docs_v68/methods/messages_setInlineGameScore.md @@ -1,20 +1,22 @@ --- title: messages.setInlineGameScore -description: messages.setInlineGameScore parameters, return type and example +description: Set the game score of an inline message --- ## Method: messages.setInlineGameScore [Back to methods index](index.md) +Set the game score of an inline message + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|edit\_message|[CLICK ME Bool](../types/Bool.md) | Optional| -|force|[CLICK ME Bool](../types/Bool.md) | Optional| -|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|score|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|edit\_message|[CLICK ME Bool](../types/Bool.md) | Optional|Should the message with the game be edited?| +|force|[CLICK ME Bool](../types/Bool.md) | Optional|Force setting the game score| +|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The ID of the inline message| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the score| +|score|[CLICK ME int](../types/int.md) | Yes|The score| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v68/methods/messages_startBot.md b/old_docs/API_docs_v68/methods/messages_startBot.md index 0de0f1a5..94a4d86a 100644 --- a/old_docs/API_docs_v68/methods/messages_startBot.md +++ b/old_docs/API_docs_v68/methods/messages_startBot.md @@ -1,18 +1,20 @@ --- title: messages.startBot -description: messages.startBot parameters, return type and example +description: Start a bot --- ## Method: messages.startBot [Back to methods index](index.md) +Start a bot + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|start\_param|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot's ID or username| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to start the bot (@me or group ID/username)| +|start\_param|[CLICK ME string](../types/string.md) | Yes|The bot's start parameter| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v68/methods/messages_toggleChatAdmins.md b/old_docs/API_docs_v68/methods/messages_toggleChatAdmins.md index d56e5753..ab591fd9 100644 --- a/old_docs/API_docs_v68/methods/messages_toggleChatAdmins.md +++ b/old_docs/API_docs_v68/methods/messages_toggleChatAdmins.md @@ -1,17 +1,19 @@ --- title: messages.toggleChatAdmins -description: messages.toggleChatAdmins parameters, return type and example +description: Enable all users are admins in normal groups (not supergroups) --- ## Method: messages.toggleChatAdmins [Back to methods index](index.md) +Enable all users are admins in normal groups (not supergroups) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Group ID| +|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Enable all users are admins| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v68/methods/messages_toggleDialogPin.md b/old_docs/API_docs_v68/methods/messages_toggleDialogPin.md index d6dc9692..2bd6a03d 100644 --- a/old_docs/API_docs_v68/methods/messages_toggleDialogPin.md +++ b/old_docs/API_docs_v68/methods/messages_toggleDialogPin.md @@ -1,17 +1,19 @@ --- title: messages.toggleDialogPin -description: messages.toggleDialogPin parameters, return type and example +description: Pin or unpin dialog --- ## Method: messages.toggleDialogPin [Back to methods index](index.md) +Pin or unpin dialog + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|pinned|[CLICK ME Bool](../types/Bool.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|pinned|[CLICK ME Bool](../types/Bool.md) | Optional|Pin or unpin the dialog?| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer to pin| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v68/methods/messages_uninstallStickerSet.md b/old_docs/API_docs_v68/methods/messages_uninstallStickerSet.md index 60b0ca0c..6d04e847 100644 --- a/old_docs/API_docs_v68/methods/messages_uninstallStickerSet.md +++ b/old_docs/API_docs_v68/methods/messages_uninstallStickerSet.md @@ -1,16 +1,18 @@ --- title: messages.uninstallStickerSet -description: messages.uninstallStickerSet parameters, return type and example +description: Remove a sticker set --- ## Method: messages.uninstallStickerSet [Back to methods index](index.md) +Remove a sticker set + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to remove| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v68/methods/messages_uploadMedia.md b/old_docs/API_docs_v68/methods/messages_uploadMedia.md index 5c25333d..c982a860 100644 --- a/old_docs/API_docs_v68/methods/messages_uploadMedia.md +++ b/old_docs/API_docs_v68/methods/messages_uploadMedia.md @@ -1,17 +1,19 @@ --- title: messages.uploadMedia -description: messages.uploadMedia parameters, return type and example +description: Upload a file without sending it to anyone --- ## Method: messages.uploadMedia [Back to methods index](index.md) +Upload a file without sending it to anyone + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Nothing| +|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media to upload| ### Return type: [MessageMedia](../types/MessageMedia.md) diff --git a/old_docs/API_docs_v68/methods/payments_clearSavedInfo.md b/old_docs/API_docs_v68/methods/payments_clearSavedInfo.md index 53fab36f..44050dde 100644 --- a/old_docs/API_docs_v68/methods/payments_clearSavedInfo.md +++ b/old_docs/API_docs_v68/methods/payments_clearSavedInfo.md @@ -1,17 +1,19 @@ --- title: payments.clearSavedInfo -description: payments.clearSavedInfo parameters, return type and example +description: Clear saved payments info --- ## Method: payments.clearSavedInfo [Back to methods index](index.md) +Clear saved payments info + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|credentials|[CLICK ME Bool](../types/Bool.md) | Optional| -|info|[CLICK ME Bool](../types/Bool.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|credentials|[CLICK ME Bool](../types/Bool.md) | Optional|Clear credentials?| +|info|[CLICK ME Bool](../types/Bool.md) | Optional|Clear payment info?| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v68/methods/payments_getPaymentForm.md b/old_docs/API_docs_v68/methods/payments_getPaymentForm.md index 00b4bddc..16a32d11 100644 --- a/old_docs/API_docs_v68/methods/payments_getPaymentForm.md +++ b/old_docs/API_docs_v68/methods/payments_getPaymentForm.md @@ -1,16 +1,18 @@ --- title: payments.getPaymentForm -description: payments.getPaymentForm parameters, return type and example +description: Get payment form --- ## Method: payments.getPaymentForm [Back to methods index](index.md) +Get payment form + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|msg\_id|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|msg\_id|[CLICK ME int](../types/int.md) | Yes|Message ID| ### Return type: [payments\_PaymentForm](../types/payments_PaymentForm.md) diff --git a/old_docs/API_docs_v68/methods/payments_getPaymentReceipt.md b/old_docs/API_docs_v68/methods/payments_getPaymentReceipt.md index 40b73a4b..857585f6 100644 --- a/old_docs/API_docs_v68/methods/payments_getPaymentReceipt.md +++ b/old_docs/API_docs_v68/methods/payments_getPaymentReceipt.md @@ -1,16 +1,18 @@ --- title: payments.getPaymentReceipt -description: payments.getPaymentReceipt parameters, return type and example +description: Get payment receipt --- ## Method: payments.getPaymentReceipt [Back to methods index](index.md) +Get payment receipt + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|msg\_id|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|msg\_id|[CLICK ME int](../types/int.md) | Yes|The message ID| ### Return type: [payments\_PaymentReceipt](../types/payments_PaymentReceipt.md) diff --git a/old_docs/API_docs_v68/methods/payments_getSavedInfo.md b/old_docs/API_docs_v68/methods/payments_getSavedInfo.md index ccaaff75..04ac7374 100644 --- a/old_docs/API_docs_v68/methods/payments_getSavedInfo.md +++ b/old_docs/API_docs_v68/methods/payments_getSavedInfo.md @@ -1,11 +1,13 @@ --- title: payments.getSavedInfo -description: payments.getSavedInfo parameters, return type and example +description: Get saved payments info --- ## Method: payments.getSavedInfo [Back to methods index](index.md) +Get saved payments info + ### Return type: [payments\_SavedInfo](../types/payments_SavedInfo.md) diff --git a/old_docs/API_docs_v68/methods/payments_sendPaymentForm.md b/old_docs/API_docs_v68/methods/payments_sendPaymentForm.md index eb843715..0a9df99f 100644 --- a/old_docs/API_docs_v68/methods/payments_sendPaymentForm.md +++ b/old_docs/API_docs_v68/methods/payments_sendPaymentForm.md @@ -1,19 +1,21 @@ --- title: payments.sendPaymentForm -description: payments.sendPaymentForm parameters, return type and example +description: Bots only: send payment form --- ## Method: payments.sendPaymentForm [Back to methods index](index.md) +Bots only: send payment form + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|msg\_id|[CLICK ME int](../types/int.md) | Yes| -|requested\_info\_id|[CLICK ME string](../types/string.md) | Optional| -|shipping\_option\_id|[CLICK ME string](../types/string.md) | Optional| -|credentials|[CLICK ME InputPaymentCredentials](../types/InputPaymentCredentials.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|msg\_id|[CLICK ME int](../types/int.md) | Yes|Message ID| +|requested\_info\_id|[CLICK ME string](../types/string.md) | Optional|ID of requested info| +|shipping\_option\_id|[CLICK ME string](../types/string.md) | Optional|Shipping option ID| +|credentials|[CLICK ME InputPaymentCredentials](../types/InputPaymentCredentials.md) | Yes|Payment credentials| ### Return type: [payments\_PaymentResult](../types/payments_PaymentResult.md) diff --git a/old_docs/API_docs_v68/methods/payments_validateRequestedInfo.md b/old_docs/API_docs_v68/methods/payments_validateRequestedInfo.md index 32702965..e36f0e42 100644 --- a/old_docs/API_docs_v68/methods/payments_validateRequestedInfo.md +++ b/old_docs/API_docs_v68/methods/payments_validateRequestedInfo.md @@ -1,18 +1,20 @@ --- title: payments.validateRequestedInfo -description: payments.validateRequestedInfo parameters, return type and example +description: Validate requested payment info --- ## Method: payments.validateRequestedInfo [Back to methods index](index.md) +Validate requested payment info + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|save|[CLICK ME Bool](../types/Bool.md) | Optional| -|msg\_id|[CLICK ME int](../types/int.md) | Yes| -|info|[CLICK ME PaymentRequestedInfo](../types/PaymentRequestedInfo.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|save|[CLICK ME Bool](../types/Bool.md) | Optional|Save payment info?| +|msg\_id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|info|[CLICK ME PaymentRequestedInfo](../types/PaymentRequestedInfo.md) | Yes|The requested payment info| ### Return type: [payments\_ValidatedRequestedInfo](../types/payments_ValidatedRequestedInfo.md) diff --git a/old_docs/API_docs_v68/methods/photos_deletePhotos.md b/old_docs/API_docs_v68/methods/photos_deletePhotos.md index 104459b7..b9daca10 100644 --- a/old_docs/API_docs_v68/methods/photos_deletePhotos.md +++ b/old_docs/API_docs_v68/methods/photos_deletePhotos.md @@ -1,16 +1,18 @@ --- title: photos.deletePhotos -description: photos.deletePhotos parameters, return type and example +description: Delete profile photos --- ## Method: photos.deletePhotos [Back to methods index](index.md) +Delete profile photos + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Yes|The profile photos to delete| ### Return type: [Vector\_of\_long](../types/long.md) diff --git a/old_docs/API_docs_v68/methods/photos_getUserPhotos.md b/old_docs/API_docs_v68/methods/photos_getUserPhotos.md index 1a7515ba..ea27a44f 100644 --- a/old_docs/API_docs_v68/methods/photos_getUserPhotos.md +++ b/old_docs/API_docs_v68/methods/photos_getUserPhotos.md @@ -1,19 +1,21 @@ --- title: photos.getUserPhotos -description: photos.getUserPhotos parameters, return type and example +description: Get the profile photos of a user --- ## Method: photos.getUserPhotos [Back to methods index](index.md) +Get the profile photos of a user + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|offset|[CLICK ME int](../types/int.md) | Yes| -|max\_id|[CLICK ME long](../types/long.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| +|offset|[CLICK ME int](../types/int.md) | Yes|Offset| +|max\_id|[CLICK ME long](../types/long.md) | Yes|Maximum ID of photo to return| +|limit|[CLICK ME int](../types/int.md) | Yes|Number of photos to return| ### Return type: [photos\_Photos](../types/photos_Photos.md) diff --git a/old_docs/API_docs_v68/methods/photos_updateProfilePhoto.md b/old_docs/API_docs_v68/methods/photos_updateProfilePhoto.md index 28ab5fbf..7f0a4c69 100644 --- a/old_docs/API_docs_v68/methods/photos_updateProfilePhoto.md +++ b/old_docs/API_docs_v68/methods/photos_updateProfilePhoto.md @@ -1,16 +1,18 @@ --- title: photos.updateProfilePhoto -description: photos.updateProfilePhoto parameters, return type and example +description: Update the profile photo (use photos->uploadProfilePhoto to upload the photo) --- ## Method: photos.updateProfilePhoto [Back to methods index](index.md) +Update the profile photo (use photos->uploadProfilePhoto to upload the photo) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional|The photo to use| ### Return type: [UserProfilePhoto](../types/UserProfilePhoto.md) diff --git a/old_docs/API_docs_v68/methods/photos_uploadProfilePhoto.md b/old_docs/API_docs_v68/methods/photos_uploadProfilePhoto.md index 7cc9e9e5..efa08bb0 100644 --- a/old_docs/API_docs_v68/methods/photos_uploadProfilePhoto.md +++ b/old_docs/API_docs_v68/methods/photos_uploadProfilePhoto.md @@ -1,16 +1,18 @@ --- title: photos.uploadProfilePhoto -description: photos.uploadProfilePhoto parameters, return type and example +description: Upload profile photo --- ## Method: photos.uploadProfilePhoto [Back to methods index](index.md) +Upload profile photo + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|file|[File path or InputFile](../types/InputFile.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|file|[File path or InputFile](../types/InputFile.md) | Yes|The photo| ### Return type: [photos\_Photo](../types/photos_Photo.md) diff --git a/old_docs/API_docs_v68/methods/stickers_addStickerToSet.md b/old_docs/API_docs_v68/methods/stickers_addStickerToSet.md index 82a9dbd7..1f90028c 100644 --- a/old_docs/API_docs_v68/methods/stickers_addStickerToSet.md +++ b/old_docs/API_docs_v68/methods/stickers_addStickerToSet.md @@ -1,17 +1,19 @@ --- title: stickers.addStickerToSet -description: stickers.addStickerToSet parameters, return type and example +description: Add sticker to stickerset --- ## Method: stickers.addStickerToSet [Back to methods index](index.md) +Add sticker to stickerset + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional| -|sticker|[CLICK ME InputStickerSetItem](../types/InputStickerSetItem.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset| +|sticker|[CLICK ME InputStickerSetItem](../types/InputStickerSetItem.md) | Yes|The sticker| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/old_docs/API_docs_v68/methods/stickers_changeStickerPosition.md b/old_docs/API_docs_v68/methods/stickers_changeStickerPosition.md index 197e2d19..7e2c5b53 100644 --- a/old_docs/API_docs_v68/methods/stickers_changeStickerPosition.md +++ b/old_docs/API_docs_v68/methods/stickers_changeStickerPosition.md @@ -1,17 +1,19 @@ --- title: stickers.changeStickerPosition -description: stickers.changeStickerPosition parameters, return type and example +description: Change sticker position in photo --- ## Method: stickers.changeStickerPosition [Back to methods index](index.md) +Change sticker position in photo + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|sticker|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional| -|position|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|sticker|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker| +|position|[CLICK ME int](../types/int.md) | Yes|New position| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v68/methods/stickers_createStickerSet.md b/old_docs/API_docs_v68/methods/stickers_createStickerSet.md index b99874a0..c4e85852 100644 --- a/old_docs/API_docs_v68/methods/stickers_createStickerSet.md +++ b/old_docs/API_docs_v68/methods/stickers_createStickerSet.md @@ -1,20 +1,22 @@ --- title: stickers.createStickerSet -description: stickers.createStickerSet parameters, return type and example +description: Create stickerset --- ## Method: stickers.createStickerSet [Back to methods index](index.md) +Create stickerset + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|masks|[CLICK ME Bool](../types/Bool.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|title|[CLICK ME string](../types/string.md) | Yes| -|short\_name|[CLICK ME string](../types/string.md) | Yes| -|stickers|Array of [CLICK ME InputStickerSetItem](../types/InputStickerSetItem.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|masks|[CLICK ME Bool](../types/Bool.md) | Optional|Masks?| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user ID associated to this stickerset| +|title|[CLICK ME string](../types/string.md) | Yes|The stickerset title| +|short\_name|[CLICK ME string](../types/string.md) | Yes|The stickerset short name| +|stickers|Array of [CLICK ME InputStickerSetItem](../types/InputStickerSetItem.md) | Yes|The stickers to add| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/old_docs/API_docs_v68/methods/stickers_removeStickerFromSet.md b/old_docs/API_docs_v68/methods/stickers_removeStickerFromSet.md index 8dbbd1f3..55b2dab0 100644 --- a/old_docs/API_docs_v68/methods/stickers_removeStickerFromSet.md +++ b/old_docs/API_docs_v68/methods/stickers_removeStickerFromSet.md @@ -1,16 +1,18 @@ --- title: stickers.removeStickerFromSet -description: stickers.removeStickerFromSet parameters, return type and example +description: Remove sticker from stickerset --- ## Method: stickers.removeStickerFromSet [Back to methods index](index.md) +Remove sticker from stickerset + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|sticker|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|sticker|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker to remove| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v68/methods/upload_getWebFile.md b/old_docs/API_docs_v68/methods/upload_getWebFile.md index 30bd3a1f..e864e4b7 100644 --- a/old_docs/API_docs_v68/methods/upload_getWebFile.md +++ b/old_docs/API_docs_v68/methods/upload_getWebFile.md @@ -1,18 +1,20 @@ --- title: upload.getWebFile -description: upload.getWebFile parameters, return type and example +description: Download a file through telegram --- ## Method: upload.getWebFile [Back to methods index](index.md) +Download a file through telegram + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|location|[CLICK ME InputWebFileLocation](../types/InputWebFileLocation.md) | Yes| -|offset|[CLICK ME int](../types/int.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|location|[CLICK ME InputWebFileLocation](../types/InputWebFileLocation.md) | Yes|The file| +|offset|[CLICK ME int](../types/int.md) | Yes|The offset in bytes| +|limit|[CLICK ME int](../types/int.md) | Yes|The number of bytes to fetch| ### Return type: [upload\_WebFile](../types/upload_WebFile.md) diff --git a/old_docs/API_docs_v70/methods/account_registerDevice.md b/old_docs/API_docs_v70/methods/account_registerDevice.md index cd28abcd..017b9af3 100644 --- a/old_docs/API_docs_v70/methods/account_registerDevice.md +++ b/old_docs/API_docs_v70/methods/account_registerDevice.md @@ -12,8 +12,8 @@ Register device for push notifications | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and oTher, see source code of official apps for more info| +|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and oTher, see source code of official apps for more info| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v70/methods/account_unregisterDevice.md b/old_docs/API_docs_v70/methods/account_unregisterDevice.md index 1d2b7670..32e44495 100644 --- a/old_docs/API_docs_v70/methods/account_unregisterDevice.md +++ b/old_docs/API_docs_v70/methods/account_unregisterDevice.md @@ -12,8 +12,8 @@ Stop sending PUSH notifications to app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and oTher, see source code of official apps for more info| +|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and oTher, see source code of official apps for more info| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v70/methods/bots_answerWebhookJSONQuery.md b/old_docs/API_docs_v70/methods/bots_answerWebhookJSONQuery.md index 205b30f9..61056bb4 100644 --- a/old_docs/API_docs_v70/methods/bots_answerWebhookJSONQuery.md +++ b/old_docs/API_docs_v70/methods/bots_answerWebhookJSONQuery.md @@ -1,17 +1,19 @@ --- title: bots.answerWebhookJSONQuery -description: bots.answerWebhookJSONQuery parameters, return type and example +description: Send webhook request via bot API --- ## Method: bots.answerWebhookJSONQuery [Back to methods index](index.md) +Send webhook request via bot API + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|query\_id|[CLICK ME long](../types/long.md) | Yes| -|data|[CLICK ME DataJSON](../types/DataJSON.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|query\_id|[CLICK ME long](../types/long.md) | Yes|The query ID| +|data|[CLICK ME DataJSON](../types/DataJSON.md) | Yes|The parameters| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v70/methods/bots_sendCustomRequest.md b/old_docs/API_docs_v70/methods/bots_sendCustomRequest.md index 590c47b6..fc8e764d 100644 --- a/old_docs/API_docs_v70/methods/bots_sendCustomRequest.md +++ b/old_docs/API_docs_v70/methods/bots_sendCustomRequest.md @@ -1,17 +1,19 @@ --- title: bots.sendCustomRequest -description: bots.sendCustomRequest parameters, return type and example +description: Send a custom request to the bot API --- ## Method: bots.sendCustomRequest [Back to methods index](index.md) +Send a custom request to the bot API + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|custom\_method|[CLICK ME string](../types/string.md) | Yes| -|params|[CLICK ME DataJSON](../types/DataJSON.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|custom\_method|[CLICK ME string](../types/string.md) | Yes|The method to call| +|params|[CLICK ME DataJSON](../types/DataJSON.md) | Yes|Method parameters| ### Return type: [DataJSON](../types/DataJSON.md) diff --git a/old_docs/API_docs_v70/methods/channels_checkUsername.md b/old_docs/API_docs_v70/methods/channels_checkUsername.md index 371f4cd3..7bc7c245 100644 --- a/old_docs/API_docs_v70/methods/channels_checkUsername.md +++ b/old_docs/API_docs_v70/methods/channels_checkUsername.md @@ -1,17 +1,19 @@ --- title: channels.checkUsername -description: channels.checkUsername parameters, return type and example +description: Check if this username is free and can be assigned to a channel/supergroup --- ## Method: channels.checkUsername [Back to methods index](index.md) +Check if this username is free and can be assigned to a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|username|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|username|[CLICK ME string](../types/string.md) | Yes|The new username for this channel/supergroup| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v70/methods/channels_createChannel.md b/old_docs/API_docs_v70/methods/channels_createChannel.md index c5d21585..1305e4fb 100644 --- a/old_docs/API_docs_v70/methods/channels_createChannel.md +++ b/old_docs/API_docs_v70/methods/channels_createChannel.md @@ -1,19 +1,21 @@ --- title: channels.createChannel -description: channels.createChannel parameters, return type and example +description: Create channel/supergroup --- ## Method: channels.createChannel [Back to methods index](index.md) +Create channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|broadcast|[CLICK ME Bool](../types/Bool.md) | Optional| -|megagroup|[CLICK ME Bool](../types/Bool.md) | Optional| -|title|[CLICK ME string](../types/string.md) | Yes| -|about|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|broadcast|[CLICK ME Bool](../types/Bool.md) | Optional|Set this to true to create a channel| +|megagroup|[CLICK ME Bool](../types/Bool.md) | Optional|Set this to true to create a supergroup| +|title|[CLICK ME string](../types/string.md) | Yes|Supergroup/channel title| +|about|[CLICK ME string](../types/string.md) | Yes|About text| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v70/methods/channels_deleteChannel.md b/old_docs/API_docs_v70/methods/channels_deleteChannel.md index 61b29eac..e660d25c 100644 --- a/old_docs/API_docs_v70/methods/channels_deleteChannel.md +++ b/old_docs/API_docs_v70/methods/channels_deleteChannel.md @@ -1,16 +1,18 @@ --- title: channels.deleteChannel -description: channels.deleteChannel parameters, return type and example +description: Delete a channel/supergroup --- ## Method: channels.deleteChannel [Back to methods index](index.md) +Delete a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup to delete| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v70/methods/channels_deleteMessages.md b/old_docs/API_docs_v70/methods/channels_deleteMessages.md index 87a968c5..fb9d3cc2 100644 --- a/old_docs/API_docs_v70/methods/channels_deleteMessages.md +++ b/old_docs/API_docs_v70/methods/channels_deleteMessages.md @@ -1,17 +1,19 @@ --- title: channels.deleteMessages -description: channels.deleteMessages parameters, return type and example +description: Delete channel/supergroup messages --- ## Method: channels.deleteMessages [Back to methods index](index.md) +Delete channel/supergroup messages + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|id|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to delete| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v70/methods/channels_deleteUserHistory.md b/old_docs/API_docs_v70/methods/channels_deleteUserHistory.md index ee828f45..fbe34341 100644 --- a/old_docs/API_docs_v70/methods/channels_deleteUserHistory.md +++ b/old_docs/API_docs_v70/methods/channels_deleteUserHistory.md @@ -1,17 +1,19 @@ --- title: channels.deleteUserHistory -description: channels.deleteUserHistory parameters, return type and example +description: Delete all messages of a user in a channel/supergroup --- ## Method: channels.deleteUserHistory [Back to methods index](index.md) +Delete all messages of a user in a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) diff --git a/old_docs/API_docs_v70/methods/channels_editAbout.md b/old_docs/API_docs_v70/methods/channels_editAbout.md index 94be2503..8908f29e 100644 --- a/old_docs/API_docs_v70/methods/channels_editAbout.md +++ b/old_docs/API_docs_v70/methods/channels_editAbout.md @@ -1,17 +1,19 @@ --- title: channels.editAbout -description: channels.editAbout parameters, return type and example +description: Edit the about text of a channel/supergroup --- ## Method: channels.editAbout [Back to methods index](index.md) +Edit the about text of a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|about|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|about|[CLICK ME string](../types/string.md) | Yes|The new about text| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v70/methods/channels_editAdmin.md b/old_docs/API_docs_v70/methods/channels_editAdmin.md index 08707ff4..dcec7d2f 100644 --- a/old_docs/API_docs_v70/methods/channels_editAdmin.md +++ b/old_docs/API_docs_v70/methods/channels_editAdmin.md @@ -1,18 +1,20 @@ --- title: channels.editAdmin -description: channels.editAdmin parameters, return type and example +description: Edit admin permissions of a user in a channel/supergroup --- ## Method: channels.editAdmin [Back to methods index](index.md) +Edit admin permissions of a user in a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|admin\_rights|[CLICK ME ChannelAdminRights](../types/ChannelAdminRights.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| +|admin\_rights|[CLICK ME ChannelAdminRights](../types/ChannelAdminRights.md) | Yes|The new admin rights| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v70/methods/channels_editBanned.md b/old_docs/API_docs_v70/methods/channels_editBanned.md index 1d896393..9859bcae 100644 --- a/old_docs/API_docs_v70/methods/channels_editBanned.md +++ b/old_docs/API_docs_v70/methods/channels_editBanned.md @@ -1,18 +1,20 @@ --- title: channels.editBanned -description: channels.editBanned parameters, return type and example +description: Kick or ban a user from a channel/supergroup --- ## Method: channels.editBanned [Back to methods index](index.md) +Kick or ban a user from a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|banned\_rights|[CLICK ME ChannelBannedRights](../types/ChannelBannedRights.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to kick/ban| +|banned\_rights|[CLICK ME ChannelBannedRights](../types/ChannelBannedRights.md) | Yes|Banned/kicked permissions| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v70/methods/channels_editPhoto.md b/old_docs/API_docs_v70/methods/channels_editPhoto.md index 3a2c794b..9ccd864f 100644 --- a/old_docs/API_docs_v70/methods/channels_editPhoto.md +++ b/old_docs/API_docs_v70/methods/channels_editPhoto.md @@ -1,17 +1,19 @@ --- title: channels.editPhoto -description: channels.editPhoto parameters, return type and example +description: Edit the photo of a supergroup/channel --- ## Method: channels.editPhoto [Back to methods index](index.md) +Edit the photo of a supergroup/channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new photo| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v70/methods/channels_editTitle.md b/old_docs/API_docs_v70/methods/channels_editTitle.md index ec60e10f..b1024faf 100644 --- a/old_docs/API_docs_v70/methods/channels_editTitle.md +++ b/old_docs/API_docs_v70/methods/channels_editTitle.md @@ -1,17 +1,19 @@ --- title: channels.editTitle -description: channels.editTitle parameters, return type and example +description: Edit the title of a supergroup/channel --- ## Method: channels.editTitle [Back to methods index](index.md) +Edit the title of a supergroup/channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|title|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|title|[CLICK ME string](../types/string.md) | Yes|The new channel/supergroup title| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v70/methods/channels_exportInvite.md b/old_docs/API_docs_v70/methods/channels_exportInvite.md index 3c10f832..f0c737d5 100644 --- a/old_docs/API_docs_v70/methods/channels_exportInvite.md +++ b/old_docs/API_docs_v70/methods/channels_exportInvite.md @@ -1,16 +1,18 @@ --- title: channels.exportInvite -description: channels.exportInvite parameters, return type and example +description: Export the invite link of a channel --- ## Method: channels.exportInvite [Back to methods index](index.md) +Export the invite link of a channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| ### Return type: [ExportedChatInvite](../types/ExportedChatInvite.md) diff --git a/old_docs/API_docs_v70/methods/channels_exportMessageLink.md b/old_docs/API_docs_v70/methods/channels_exportMessageLink.md index 924dc0d5..f910b594 100644 --- a/old_docs/API_docs_v70/methods/channels_exportMessageLink.md +++ b/old_docs/API_docs_v70/methods/channels_exportMessageLink.md @@ -1,17 +1,19 @@ --- title: channels.exportMessageLink -description: channels.exportMessageLink parameters, return type and example +description: Get the link of a message in a channel --- ## Method: channels.exportMessageLink [Back to methods index](index.md) +Get the link of a message in a channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|id|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|id|[CLICK ME int](../types/int.md) | Yes|The ID of the message| ### Return type: [ExportedMessageLink](../types/ExportedMessageLink.md) diff --git a/old_docs/API_docs_v70/methods/channels_getAdminLog.md b/old_docs/API_docs_v70/methods/channels_getAdminLog.md index 0585e157..5c1b805e 100644 --- a/old_docs/API_docs_v70/methods/channels_getAdminLog.md +++ b/old_docs/API_docs_v70/methods/channels_getAdminLog.md @@ -1,22 +1,24 @@ --- title: channels.getAdminLog -description: channels.getAdminLog parameters, return type and example +description: Get admin log of a channel/supergruop --- ## Method: channels.getAdminLog [Back to methods index](index.md) +Get admin log of a channel/supergruop + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|q|[CLICK ME string](../types/string.md) | Yes| -|events\_filter|[CLICK ME ChannelAdminLogEventsFilter](../types/ChannelAdminLogEventsFilter.md) | Optional| -|admins|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|max\_id|[CLICK ME long](../types/long.md) | Yes| -|min\_id|[CLICK ME long](../types/long.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|q|[CLICK ME string](../types/string.md) | Yes|Search query| +|events\_filter|[CLICK ME ChannelAdminLogEventsFilter](../types/ChannelAdminLogEventsFilter.md) | Optional|Event filter| +|admins|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|Fetch only actions from these admins| +|max\_id|[CLICK ME long](../types/long.md) | Yes|Maximum message ID to fetch| +|min\_id|[CLICK ME long](../types/long.md) | Yes|Minimum message ID to fetch| +|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to fetch| ### Return type: [channels\_AdminLogResults](../types/channels_AdminLogResults.md) diff --git a/old_docs/API_docs_v70/methods/channels_getAdminedPublicChannels.md b/old_docs/API_docs_v70/methods/channels_getAdminedPublicChannels.md index f2b48050..9646f529 100644 --- a/old_docs/API_docs_v70/methods/channels_getAdminedPublicChannels.md +++ b/old_docs/API_docs_v70/methods/channels_getAdminedPublicChannels.md @@ -1,11 +1,13 @@ --- title: channels.getAdminedPublicChannels -description: channels.getAdminedPublicChannels parameters, return type and example +description: Get all supergroups/channels where you're admin --- ## Method: channels.getAdminedPublicChannels [Back to methods index](index.md) +Get all supergroups/channels where you're admin + ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v70/methods/channels_getChannels.md b/old_docs/API_docs_v70/methods/channels_getChannels.md index bd5958d6..9cd9e798 100644 --- a/old_docs/API_docs_v70/methods/channels_getChannels.md +++ b/old_docs/API_docs_v70/methods/channels_getChannels.md @@ -1,16 +1,18 @@ --- title: channels.getChannels -description: channels.getChannels parameters, return type and example +description: Get info about multiple channels/supergroups --- ## Method: channels.getChannels [Back to methods index](index.md) +Get info about multiple channels/supergroups + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|Array of [Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|Array of [Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Yes|The channel/supergroup MTProto IDs| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v70/methods/channels_getMessages.md b/old_docs/API_docs_v70/methods/channels_getMessages.md index 4440856c..cc944fe5 100644 --- a/old_docs/API_docs_v70/methods/channels_getMessages.md +++ b/old_docs/API_docs_v70/methods/channels_getMessages.md @@ -1,17 +1,19 @@ --- title: channels.getMessages -description: channels.getMessages parameters, return type and example +description: Get channel/supergroup messages --- ## Method: channels.getMessages [Back to methods index](index.md) +Get channel/supergroup messages + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|id|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The message IDs| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v70/methods/channels_getParticipant.md b/old_docs/API_docs_v70/methods/channels_getParticipant.md index c1819b6b..db9b1fc6 100644 --- a/old_docs/API_docs_v70/methods/channels_getParticipant.md +++ b/old_docs/API_docs_v70/methods/channels_getParticipant.md @@ -1,17 +1,19 @@ --- title: channels.getParticipant -description: channels.getParticipant parameters, return type and example +description: Get info about a certain channel/supergroup participant --- ## Method: channels.getParticipant [Back to methods index](index.md) +Get info about a certain channel/supergroup participant + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to fetch info about| ### Return type: [channels\_ChannelParticipant](../types/channels_ChannelParticipant.md) diff --git a/old_docs/API_docs_v70/methods/channels_getParticipants.md b/old_docs/API_docs_v70/methods/channels_getParticipants.md index 7ec8a980..96662466 100644 --- a/old_docs/API_docs_v70/methods/channels_getParticipants.md +++ b/old_docs/API_docs_v70/methods/channels_getParticipants.md @@ -1,19 +1,21 @@ --- title: channels.getParticipants -description: channels.getParticipants parameters, return type and example +description: Get channel/supergroup participants (you should use `$MadelineProto->get_pwr_chat($id)` instead) --- ## Method: channels.getParticipants [Back to methods index](index.md) +Get channel/supergroup participants (you should use `$MadelineProto->get_pwr_chat($id)` instead) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|filter|[CLICK ME ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) | Yes| -|offset|[CLICK ME int](../types/int.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|filter|[CLICK ME ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) | Yes|Member filter| +|offset|[CLICK ME int](../types/int.md) | Yes|Offset| +|limit|[CLICK ME int](../types/int.md) | Yes|Limit| ### Return type: [channels\_ChannelParticipants](../types/channels_ChannelParticipants.md) diff --git a/old_docs/API_docs_v70/methods/channels_inviteToChannel.md b/old_docs/API_docs_v70/methods/channels_inviteToChannel.md index 9bca2967..676f800c 100644 --- a/old_docs/API_docs_v70/methods/channels_inviteToChannel.md +++ b/old_docs/API_docs_v70/methods/channels_inviteToChannel.md @@ -1,17 +1,19 @@ --- title: channels.inviteToChannel -description: channels.inviteToChannel parameters, return type and example +description: Add users to channel/supergroup --- ## Method: channels.inviteToChannel [Back to methods index](index.md) +Add users to channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to add| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v70/methods/channels_joinChannel.md b/old_docs/API_docs_v70/methods/channels_joinChannel.md index 9ecdbe75..721f707c 100644 --- a/old_docs/API_docs_v70/methods/channels_joinChannel.md +++ b/old_docs/API_docs_v70/methods/channels_joinChannel.md @@ -1,16 +1,18 @@ --- title: channels.joinChannel -description: channels.joinChannel parameters, return type and example +description: Join a channel/supergroup --- ## Method: channels.joinChannel [Back to methods index](index.md) +Join a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup to join| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v70/methods/channels_leaveChannel.md b/old_docs/API_docs_v70/methods/channels_leaveChannel.md index 62c20a00..7f02e08c 100644 --- a/old_docs/API_docs_v70/methods/channels_leaveChannel.md +++ b/old_docs/API_docs_v70/methods/channels_leaveChannel.md @@ -1,16 +1,18 @@ --- title: channels.leaveChannel -description: channels.leaveChannel parameters, return type and example +description: Leave a channel/supergroup --- ## Method: channels.leaveChannel [Back to methods index](index.md) +Leave a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup to leave| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v70/methods/channels_readHistory.md b/old_docs/API_docs_v70/methods/channels_readHistory.md index 745893f6..cca891f0 100644 --- a/old_docs/API_docs_v70/methods/channels_readHistory.md +++ b/old_docs/API_docs_v70/methods/channels_readHistory.md @@ -1,17 +1,19 @@ --- title: channels.readHistory -description: channels.readHistory parameters, return type and example +description: Mark channel/supergroup history as read --- ## Method: channels.readHistory [Back to methods index](index.md) +Mark channel/supergroup history as read + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|max\_id|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to mark as read| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v70/methods/channels_reportSpam.md b/old_docs/API_docs_v70/methods/channels_reportSpam.md index 47dd7cff..09af14e0 100644 --- a/old_docs/API_docs_v70/methods/channels_reportSpam.md +++ b/old_docs/API_docs_v70/methods/channels_reportSpam.md @@ -1,18 +1,20 @@ --- title: channels.reportSpam -description: channels.reportSpam parameters, return type and example +description: Report a supergroup/channel for spam --- ## Method: channels.reportSpam [Back to methods index](index.md) +Report a supergroup/channel for spam + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|id|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that added you to this channel| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to report| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v70/methods/channels_toggleInvites.md b/old_docs/API_docs_v70/methods/channels_toggleInvites.md index b6771ed3..5b541f67 100644 --- a/old_docs/API_docs_v70/methods/channels_toggleInvites.md +++ b/old_docs/API_docs_v70/methods/channels_toggleInvites.md @@ -1,17 +1,19 @@ --- title: channels.toggleInvites -description: channels.toggleInvites parameters, return type and example +description: Allow or disallow any user to invite users to this channel/supergroup --- ## Method: channels.toggleInvites [Back to methods index](index.md) +Allow or disallow any user to invite users to this channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Allow or disallow| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v70/methods/channels_toggleSignatures.md b/old_docs/API_docs_v70/methods/channels_toggleSignatures.md index e8ff70a8..f233a8e1 100644 --- a/old_docs/API_docs_v70/methods/channels_toggleSignatures.md +++ b/old_docs/API_docs_v70/methods/channels_toggleSignatures.md @@ -1,17 +1,19 @@ --- title: channels.toggleSignatures -description: channels.toggleSignatures parameters, return type and example +description: Toggle channel signatures --- ## Method: channels.toggleSignatures [Back to methods index](index.md) +Toggle channel signatures + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Enable or disable channel signatures?| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v70/methods/channels_updatePinnedMessage.md b/old_docs/API_docs_v70/methods/channels_updatePinnedMessage.md index 7a14b68b..f06d1f0f 100644 --- a/old_docs/API_docs_v70/methods/channels_updatePinnedMessage.md +++ b/old_docs/API_docs_v70/methods/channels_updatePinnedMessage.md @@ -1,18 +1,20 @@ --- title: channels.updatePinnedMessage -description: channels.updatePinnedMessage parameters, return type and example +description: Set the pinned message of a channel/supergroup --- ## Method: channels.updatePinnedMessage [Back to methods index](index.md) +Set the pinned message of a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|id|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Pin silently| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|id|[CLICK ME int](../types/int.md) | Yes|The ID of the message to pin| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v70/methods/channels_updateUsername.md b/old_docs/API_docs_v70/methods/channels_updateUsername.md index 19647598..ad34490a 100644 --- a/old_docs/API_docs_v70/methods/channels_updateUsername.md +++ b/old_docs/API_docs_v70/methods/channels_updateUsername.md @@ -1,17 +1,19 @@ --- title: channels.updateUsername -description: channels.updateUsername parameters, return type and example +description: Update the username of a supergroup/channel --- ## Method: channels.updateUsername [Back to methods index](index.md) +Update the username of a supergroup/channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|username|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|username|[CLICK ME string](../types/string.md) | Yes|The new username| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v70/methods/contacts_getBlocked.md b/old_docs/API_docs_v70/methods/contacts_getBlocked.md index d7d8c5cc..300025af 100644 --- a/old_docs/API_docs_v70/methods/contacts_getBlocked.md +++ b/old_docs/API_docs_v70/methods/contacts_getBlocked.md @@ -12,7 +12,7 @@ Get blocked users | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, then set to the number of blocked contacts previously fetched| +|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, Then set to the number of blocked contacts previously fetched| |limit|[CLICK ME int](../types/int.md) | Yes|How many blocked contacts to fetch| diff --git a/old_docs/API_docs_v70/methods/contacts_getTopPeers.md b/old_docs/API_docs_v70/methods/contacts_getTopPeers.md index 226d3aa0..d7b21757 100644 --- a/old_docs/API_docs_v70/methods/contacts_getTopPeers.md +++ b/old_docs/API_docs_v70/methods/contacts_getTopPeers.md @@ -18,7 +18,7 @@ Get most used chats |phone\_calls|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch phone calls?| |groups|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch groups?| |channels|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch channels and supergroups?| -|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, then `$offset += $contacts_TopPeers['categories']['count'];`| +|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, Then `$offset += $contacts_TopPeers['categories']['count'];`| |limit|[CLICK ME int](../types/int.md) | Yes|How many results to fetch| |hash|[CLICK ME int](../types/int.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched peer ids);| diff --git a/old_docs/API_docs_v70/methods/help_getAppChangelog.md b/old_docs/API_docs_v70/methods/help_getAppChangelog.md index ea7192f6..477df2f8 100644 --- a/old_docs/API_docs_v70/methods/help_getAppChangelog.md +++ b/old_docs/API_docs_v70/methods/help_getAppChangelog.md @@ -1,16 +1,18 @@ --- title: help.getAppChangelog -description: help.getAppChangelog parameters, return type and example +description: Get the changelog of this app --- ## Method: help.getAppChangelog [Back to methods index](index.md) +Get the changelog of this app + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|prev\_app\_version|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|prev\_app\_version|[CLICK ME string](../types/string.md) | Yes|Previous app version| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v70/methods/help_getAppUpdate.md b/old_docs/API_docs_v70/methods/help_getAppUpdate.md index ef72cce2..b88906ae 100644 --- a/old_docs/API_docs_v70/methods/help_getAppUpdate.md +++ b/old_docs/API_docs_v70/methods/help_getAppUpdate.md @@ -1,11 +1,13 @@ --- title: help.getAppUpdate -description: help.getAppUpdate parameters, return type and example +description: Get info about app updates --- ## Method: help.getAppUpdate [Back to methods index](index.md) +Get info about app updates + ### Return type: [help\_AppUpdate](../types/help_AppUpdate.md) diff --git a/old_docs/API_docs_v70/methods/help_getCdnConfig.md b/old_docs/API_docs_v70/methods/help_getCdnConfig.md index 55a6e6fd..809ea1fb 100644 --- a/old_docs/API_docs_v70/methods/help_getCdnConfig.md +++ b/old_docs/API_docs_v70/methods/help_getCdnConfig.md @@ -1,11 +1,13 @@ --- title: help.getCdnConfig -description: help.getCdnConfig parameters, return type and example +description: Get CDN configuration --- ## Method: help.getCdnConfig [Back to methods index](index.md) +Get CDN configuration + ### Return type: [CdnConfig](../types/CdnConfig.md) diff --git a/old_docs/API_docs_v70/methods/help_getConfig.md b/old_docs/API_docs_v70/methods/help_getConfig.md index 885ad5d3..16e25c68 100644 --- a/old_docs/API_docs_v70/methods/help_getConfig.md +++ b/old_docs/API_docs_v70/methods/help_getConfig.md @@ -1,11 +1,13 @@ --- title: help.getConfig -description: help.getConfig parameters, return type and example +description: Get server configuration --- ## Method: help.getConfig [Back to methods index](index.md) +Get server configuration + ### Return type: [Config](../types/Config.md) diff --git a/old_docs/API_docs_v70/methods/help_getInviteText.md b/old_docs/API_docs_v70/methods/help_getInviteText.md index 101ead40..6b226bff 100644 --- a/old_docs/API_docs_v70/methods/help_getInviteText.md +++ b/old_docs/API_docs_v70/methods/help_getInviteText.md @@ -1,11 +1,13 @@ --- title: help.getInviteText -description: help.getInviteText parameters, return type and example +description: Get invitation text --- ## Method: help.getInviteText [Back to methods index](index.md) +Get invitation text + ### Return type: [help\_InviteText](../types/help_InviteText.md) diff --git a/old_docs/API_docs_v70/methods/help_getNearestDc.md b/old_docs/API_docs_v70/methods/help_getNearestDc.md index 6196890b..35a8bf91 100644 --- a/old_docs/API_docs_v70/methods/help_getNearestDc.md +++ b/old_docs/API_docs_v70/methods/help_getNearestDc.md @@ -1,11 +1,13 @@ --- title: help.getNearestDc -description: help.getNearestDc parameters, return type and example +description: Get nearest datacenter --- ## Method: help.getNearestDc [Back to methods index](index.md) +Get nearest datacenter + ### Return type: [NearestDc](../types/NearestDc.md) diff --git a/old_docs/API_docs_v70/methods/help_getSupport.md b/old_docs/API_docs_v70/methods/help_getSupport.md index 9b269f78..a5bab0f2 100644 --- a/old_docs/API_docs_v70/methods/help_getSupport.md +++ b/old_docs/API_docs_v70/methods/help_getSupport.md @@ -1,11 +1,13 @@ --- title: help.getSupport -description: help.getSupport parameters, return type and example +description: Get info of support user --- ## Method: help.getSupport [Back to methods index](index.md) +Get info of support user + ### Return type: [help\_Support](../types/help_Support.md) diff --git a/old_docs/API_docs_v70/methods/help_getTermsOfService.md b/old_docs/API_docs_v70/methods/help_getTermsOfService.md index f63807ab..487cd83a 100644 --- a/old_docs/API_docs_v70/methods/help_getTermsOfService.md +++ b/old_docs/API_docs_v70/methods/help_getTermsOfService.md @@ -1,11 +1,13 @@ --- title: help.getTermsOfService -description: help.getTermsOfService parameters, return type and example +description: Get terms of service --- ## Method: help.getTermsOfService [Back to methods index](index.md) +Get terms of service + ### Return type: [help\_TermsOfService](../types/help_TermsOfService.md) diff --git a/old_docs/API_docs_v70/methods/help_saveAppLog.md b/old_docs/API_docs_v70/methods/help_saveAppLog.md index af6e94e2..0165b6e3 100644 --- a/old_docs/API_docs_v70/methods/help_saveAppLog.md +++ b/old_docs/API_docs_v70/methods/help_saveAppLog.md @@ -1,16 +1,18 @@ --- title: help.saveAppLog -description: help.saveAppLog parameters, return type and example +description: Log data for developer of this app --- ## Method: help.saveAppLog [Back to methods index](index.md) +Log data for developer of this app + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|events|Array of [CLICK ME InputAppEvent](../types/InputAppEvent.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|events|Array of [CLICK ME InputAppEvent](../types/InputAppEvent.md) | Yes|Event list| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v70/methods/help_setBotUpdatesStatus.md b/old_docs/API_docs_v70/methods/help_setBotUpdatesStatus.md index 3351fab4..ff314b5c 100644 --- a/old_docs/API_docs_v70/methods/help_setBotUpdatesStatus.md +++ b/old_docs/API_docs_v70/methods/help_setBotUpdatesStatus.md @@ -1,17 +1,19 @@ --- title: help.setBotUpdatesStatus -description: help.setBotUpdatesStatus parameters, return type and example +description: Set the update status of webhook --- ## Method: help.setBotUpdatesStatus [Back to methods index](index.md) +Set the update status of webhook + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|pending\_updates\_count|[CLICK ME int](../types/int.md) | Yes| -|message|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|pending\_updates\_count|[CLICK ME int](../types/int.md) | Yes|Pending update count| +|message|[CLICK ME string](../types/string.md) | Yes|Message| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v70/methods/messages_checkChatInvite.md b/old_docs/API_docs_v70/methods/messages_checkChatInvite.md index 4ddf5084..de1d9ff4 100644 --- a/old_docs/API_docs_v70/methods/messages_checkChatInvite.md +++ b/old_docs/API_docs_v70/methods/messages_checkChatInvite.md @@ -1,16 +1,18 @@ --- title: messages.checkChatInvite -description: messages.checkChatInvite parameters, return type and example +description: Check if an invitation link is valid --- ## Method: messages.checkChatInvite [Back to methods index](index.md) +Check if an invitation link is valid + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| ### Return type: [ChatInvite](../types/ChatInvite.md) diff --git a/old_docs/API_docs_v70/methods/messages_clearRecentStickers.md b/old_docs/API_docs_v70/methods/messages_clearRecentStickers.md index f017087f..9c1b3754 100644 --- a/old_docs/API_docs_v70/methods/messages_clearRecentStickers.md +++ b/old_docs/API_docs_v70/methods/messages_clearRecentStickers.md @@ -1,16 +1,18 @@ --- title: messages.clearRecentStickers -description: messages.clearRecentStickers parameters, return type and example +description: Clear all recent stickers --- ## Method: messages.clearRecentStickers [Back to methods index](index.md) +Clear all recent stickers + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|attached|[CLICK ME Bool](../types/Bool.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|attached|[CLICK ME Bool](../types/Bool.md) | Optional|Clear recent stickers attached to images?| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v70/methods/messages_deleteChatUser.md b/old_docs/API_docs_v70/methods/messages_deleteChatUser.md index a71f4aaf..0a6830de 100644 --- a/old_docs/API_docs_v70/methods/messages_deleteChatUser.md +++ b/old_docs/API_docs_v70/methods/messages_deleteChatUser.md @@ -12,7 +12,7 @@ Delete a user from a chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The MTProto ID of the chat| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to delete (pass @me to leave the chat)| diff --git a/old_docs/API_docs_v70/methods/messages_editChatAdmin.md b/old_docs/API_docs_v70/methods/messages_editChatAdmin.md index 6bc8f9ae..7916f8b1 100644 --- a/old_docs/API_docs_v70/methods/messages_editChatAdmin.md +++ b/old_docs/API_docs_v70/methods/messages_editChatAdmin.md @@ -1,18 +1,20 @@ --- title: messages.editChatAdmin -description: messages.editChatAdmin parameters, return type and example +description: Edit admin permissions --- ## Method: messages.editChatAdmin [Back to methods index](index.md) +Edit admin permissions + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|is\_admin|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat ID (no supergroups)| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user ID| +|is\_admin|[CLICK ME Bool](../types/Bool.md) | Yes|Should the user be admin?| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v70/methods/messages_editChatPhoto.md b/old_docs/API_docs_v70/methods/messages_editChatPhoto.md index 8848eca7..122913c4 100644 --- a/old_docs/API_docs_v70/methods/messages_editChatPhoto.md +++ b/old_docs/API_docs_v70/methods/messages_editChatPhoto.md @@ -12,7 +12,7 @@ Edit the photo of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The MTProto ID of the chat| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| |photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| diff --git a/old_docs/API_docs_v70/methods/messages_editChatTitle.md b/old_docs/API_docs_v70/methods/messages_editChatTitle.md index 1c1c7a16..3a1e974b 100644 --- a/old_docs/API_docs_v70/methods/messages_editChatTitle.md +++ b/old_docs/API_docs_v70/methods/messages_editChatTitle.md @@ -12,7 +12,7 @@ Edit the title of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The MTProto ID of the chat| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| |title|[CLICK ME string](../types/string.md) | Yes|The new title| diff --git a/old_docs/API_docs_v70/methods/messages_editInlineBotMessage.md b/old_docs/API_docs_v70/methods/messages_editInlineBotMessage.md index c0d06614..2237fb20 100644 --- a/old_docs/API_docs_v70/methods/messages_editInlineBotMessage.md +++ b/old_docs/API_docs_v70/methods/messages_editInlineBotMessage.md @@ -1,20 +1,22 @@ --- title: messages.editInlineBotMessage -description: messages.editInlineBotMessage parameters, return type and example +description: Edit a sent inline message --- ## Method: messages.editInlineBotMessage [Back to methods index](index.md) +Edit a sent inline message + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional| -|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes| -|message|[CLICK ME string](../types/string.md) | Optional| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview| +|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The message ID| +|message|[CLICK ME string](../types/string.md) | Optional|The new message| +|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| +|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/old_docs/API_docs_v70/methods/messages_editMessage.md b/old_docs/API_docs_v70/methods/messages_editMessage.md index 2e98318d..177438a5 100644 --- a/old_docs/API_docs_v70/methods/messages_editMessage.md +++ b/old_docs/API_docs_v70/methods/messages_editMessage.md @@ -1,21 +1,23 @@ --- title: messages.editMessage -description: messages.editMessage parameters, return type and example +description: Edit a message --- ## Method: messages.editMessage [Back to methods index](index.md) +Edit a message + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|id|[CLICK ME int](../types/int.md) | Yes| -|message|[CLICK ME string](../types/string.md) | Optional| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| +|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|message|[CLICK ME string](../types/string.md) | Optional|The new message| +|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| +|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/old_docs/API_docs_v70/methods/messages_exportChatInvite.md b/old_docs/API_docs_v70/methods/messages_exportChatInvite.md index 74d70c21..98685d96 100644 --- a/old_docs/API_docs_v70/methods/messages_exportChatInvite.md +++ b/old_docs/API_docs_v70/methods/messages_exportChatInvite.md @@ -1,16 +1,18 @@ --- title: messages.exportChatInvite -description: messages.exportChatInvite parameters, return type and example +description: Export chat invite --- ## Method: messages.exportChatInvite [Back to methods index](index.md) +Export chat invite + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat id | ### Return type: [ExportedChatInvite](../types/ExportedChatInvite.md) diff --git a/old_docs/API_docs_v70/methods/messages_getAllChats.md b/old_docs/API_docs_v70/methods/messages_getAllChats.md index 4b87df49..127456e4 100644 --- a/old_docs/API_docs_v70/methods/messages_getAllChats.md +++ b/old_docs/API_docs_v70/methods/messages_getAllChats.md @@ -1,16 +1,18 @@ --- title: messages.getAllChats -description: messages.getAllChats parameters, return type and example +description: Get all chats (not supergroups or channels) --- ## Method: messages.getAllChats [Back to methods index](index.md) +Get all chats (not supergroups or channels) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|except\_ids|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|except\_ids|Array of [CLICK ME int](../types/int.md) | Yes|Do not fetch these chats (MTProto id)| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v70/methods/messages_getAllDrafts.md b/old_docs/API_docs_v70/methods/messages_getAllDrafts.md index a5dd59f6..2c0ecd42 100644 --- a/old_docs/API_docs_v70/methods/messages_getAllDrafts.md +++ b/old_docs/API_docs_v70/methods/messages_getAllDrafts.md @@ -1,11 +1,13 @@ --- title: messages.getAllDrafts -description: messages.getAllDrafts parameters, return type and example +description: Get all message drafts --- ## Method: messages.getAllDrafts [Back to methods index](index.md) +Get all message drafts + ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v70/methods/messages_getAllStickers.md b/old_docs/API_docs_v70/methods/messages_getAllStickers.md index 575fcd49..16fdba6c 100644 --- a/old_docs/API_docs_v70/methods/messages_getAllStickers.md +++ b/old_docs/API_docs_v70/methods/messages_getAllStickers.md @@ -1,16 +1,18 @@ --- title: messages.getAllStickers -description: messages.getAllStickers parameters, return type and example +description: Get all stickerpacks --- ## Method: messages.getAllStickers [Back to methods index](index.md) +Get all stickerpacks + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v70/methods/messages_getArchivedStickers.md b/old_docs/API_docs_v70/methods/messages_getArchivedStickers.md index 1b4aaa93..f037e1bc 100644 --- a/old_docs/API_docs_v70/methods/messages_getArchivedStickers.md +++ b/old_docs/API_docs_v70/methods/messages_getArchivedStickers.md @@ -1,18 +1,20 @@ --- title: messages.getArchivedStickers -description: messages.getArchivedStickers parameters, return type and example +description: Get all archived stickers --- ## Method: messages.getArchivedStickers [Back to methods index](index.md) +Get all archived stickers + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|masks|[CLICK ME Bool](../types/Bool.md) | Optional| -|offset\_id|[CLICK ME long](../types/long.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|masks|[CLICK ME Bool](../types/Bool.md) | Optional|Get masks?| +|offset\_id|[CLICK ME long](../types/long.md) | Yes|Sticker ID offset| +|limit|[CLICK ME int](../types/int.md) | Yes|Number of stickers to fetch| ### Return type: [messages\_ArchivedStickers](../types/messages_ArchivedStickers.md) diff --git a/old_docs/API_docs_v70/methods/messages_getAttachedStickers.md b/old_docs/API_docs_v70/methods/messages_getAttachedStickers.md index a0d89b31..890680cd 100644 --- a/old_docs/API_docs_v70/methods/messages_getAttachedStickers.md +++ b/old_docs/API_docs_v70/methods/messages_getAttachedStickers.md @@ -1,16 +1,18 @@ --- title: messages.getAttachedStickers -description: messages.getAttachedStickers parameters, return type and example +description: Get stickers attachable to images --- ## Method: messages.getAttachedStickers [Back to methods index](index.md) +Get stickers attachable to images + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|media|[CLICK ME InputStickeredMedia](../types/InputStickeredMedia.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|media|[CLICK ME InputStickeredMedia](../types/InputStickeredMedia.md) | Yes|The stickered media| ### Return type: [Vector\_of\_StickerSetCovered](../types/StickerSetCovered.md) diff --git a/old_docs/API_docs_v70/methods/messages_getBotCallbackAnswer.md b/old_docs/API_docs_v70/methods/messages_getBotCallbackAnswer.md index 7ccd0d1b..09c283f5 100644 --- a/old_docs/API_docs_v70/methods/messages_getBotCallbackAnswer.md +++ b/old_docs/API_docs_v70/methods/messages_getBotCallbackAnswer.md @@ -1,19 +1,21 @@ --- title: messages.getBotCallbackAnswer -description: messages.getBotCallbackAnswer parameters, return type and example +description: Get the callback answer of a bot (after clicking a button) --- ## Method: messages.getBotCallbackAnswer [Back to methods index](index.md) +Get the callback answer of a bot (after clicking a button) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|game|[CLICK ME Bool](../types/Bool.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|msg\_id|[CLICK ME int](../types/int.md) | Yes| -|data|[CLICK ME bytes](../types/bytes.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|game|[CLICK ME Bool](../types/Bool.md) | Optional|Is this a game?| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| +|msg\_id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|data|[CLICK ME bytes](../types/bytes.md) | Optional|The data to send to the bot| ### Return type: [messages\_BotCallbackAnswer](../types/messages_BotCallbackAnswer.md) diff --git a/old_docs/API_docs_v70/methods/messages_getCommonChats.md b/old_docs/API_docs_v70/methods/messages_getCommonChats.md index a57d7f5a..e6eca283 100644 --- a/old_docs/API_docs_v70/methods/messages_getCommonChats.md +++ b/old_docs/API_docs_v70/methods/messages_getCommonChats.md @@ -1,18 +1,20 @@ --- title: messages.getCommonChats -description: messages.getCommonChats parameters, return type and example +description: Get chats in common with a user --- ## Method: messages.getCommonChats [Back to methods index](index.md) +Get chats in common with a user + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|max\_id|[CLICK ME int](../types/int.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| +|max\_id|[CLICK ME int](../types/int.md) | Yes|The maximum chat ID to fetch| +|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to fetch| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v70/methods/messages_getDocumentByHash.md b/old_docs/API_docs_v70/methods/messages_getDocumentByHash.md index b7c45398..1af5bad4 100644 --- a/old_docs/API_docs_v70/methods/messages_getDocumentByHash.md +++ b/old_docs/API_docs_v70/methods/messages_getDocumentByHash.md @@ -1,18 +1,20 @@ --- title: messages.getDocumentByHash -description: messages.getDocumentByHash parameters, return type and example +description: Get document by SHA256 hash --- ## Method: messages.getDocumentByHash [Back to methods index](index.md) +Get document by SHA256 hash + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|sha256|[CLICK ME bytes](../types/bytes.md) | Yes| -|size|[CLICK ME int](../types/int.md) | Yes| -|mime\_type|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|sha256|[CLICK ME bytes](../types/bytes.md) | Yes|`hash('sha256', $filename, true);`| +|size|[CLICK ME int](../types/int.md) | Yes|The file size| +|mime\_type|[CLICK ME string](../types/string.md) | Yes|The mime type of the file| ### Return type: [Document](../types/Document.md) diff --git a/old_docs/API_docs_v70/methods/messages_getFeaturedStickers.md b/old_docs/API_docs_v70/methods/messages_getFeaturedStickers.md index 88b5609c..512f2e85 100644 --- a/old_docs/API_docs_v70/methods/messages_getFeaturedStickers.md +++ b/old_docs/API_docs_v70/methods/messages_getFeaturedStickers.md @@ -1,16 +1,18 @@ --- title: messages.getFeaturedStickers -description: messages.getFeaturedStickers parameters, return type and example +description: Get featured stickers --- ## Method: messages.getFeaturedStickers [Back to methods index](index.md) +Get featured stickers + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_FeaturedStickers](../types/messages_FeaturedStickers.md) diff --git a/old_docs/API_docs_v70/methods/messages_getGameHighScores.md b/old_docs/API_docs_v70/methods/messages_getGameHighScores.md index 2c95af05..5137baea 100644 --- a/old_docs/API_docs_v70/methods/messages_getGameHighScores.md +++ b/old_docs/API_docs_v70/methods/messages_getGameHighScores.md @@ -1,18 +1,20 @@ --- title: messages.getGameHighScores -description: messages.getGameHighScores parameters, return type and example +description: Get high scores of a game --- ## Method: messages.getGameHighScores [Back to methods index](index.md) +Get high scores of a game + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|id|[CLICK ME int](../types/int.md) | Yes| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| +|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the high scores| ### Return type: [messages\_HighScores](../types/messages_HighScores.md) diff --git a/old_docs/API_docs_v70/methods/messages_getInlineBotResults.md b/old_docs/API_docs_v70/methods/messages_getInlineBotResults.md index 5b2bb254..8ab5bf78 100644 --- a/old_docs/API_docs_v70/methods/messages_getInlineBotResults.md +++ b/old_docs/API_docs_v70/methods/messages_getInlineBotResults.md @@ -1,20 +1,22 @@ --- title: messages.getInlineBotResults -description: messages.getInlineBotResults parameters, return type and example +description: Call inline bot --- ## Method: messages.getInlineBotResults [Back to methods index](index.md) +Call inline bot + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional| -|query|[CLICK ME string](../types/string.md) | Yes| -|offset|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot to call| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to call the bot| +|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional|The current location| +|query|[CLICK ME string](../types/string.md) | Yes|The query to send to the bot| +|offset|[CLICK ME string](../types/string.md) | Yes|The offset to send to the bot| ### Return type: [messages\_BotResults](../types/messages_BotResults.md) diff --git a/old_docs/API_docs_v70/methods/messages_getInlineGameHighScores.md b/old_docs/API_docs_v70/methods/messages_getInlineGameHighScores.md index 447a55dd..790bfdd9 100644 --- a/old_docs/API_docs_v70/methods/messages_getInlineGameHighScores.md +++ b/old_docs/API_docs_v70/methods/messages_getInlineGameHighScores.md @@ -1,17 +1,19 @@ --- title: messages.getInlineGameHighScores -description: messages.getInlineGameHighScores parameters, return type and example +description: Get high scores of a game sent in an inline message --- ## Method: messages.getInlineGameHighScores [Back to methods index](index.md) +Get high scores of a game sent in an inline message + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The inline message| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the high scores| ### Return type: [messages\_HighScores](../types/messages_HighScores.md) diff --git a/old_docs/API_docs_v70/methods/messages_getMaskStickers.md b/old_docs/API_docs_v70/methods/messages_getMaskStickers.md index 80c16471..f4ed9411 100644 --- a/old_docs/API_docs_v70/methods/messages_getMaskStickers.md +++ b/old_docs/API_docs_v70/methods/messages_getMaskStickers.md @@ -1,16 +1,18 @@ --- title: messages.getMaskStickers -description: messages.getMaskStickers parameters, return type and example +description: Get masks --- ## Method: messages.getMaskStickers [Back to methods index](index.md) +Get masks + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v70/methods/messages_getMessageEditData.md b/old_docs/API_docs_v70/methods/messages_getMessageEditData.md index 339678bd..12e71bee 100644 --- a/old_docs/API_docs_v70/methods/messages_getMessageEditData.md +++ b/old_docs/API_docs_v70/methods/messages_getMessageEditData.md @@ -1,17 +1,19 @@ --- title: messages.getMessageEditData -description: messages.getMessageEditData parameters, return type and example +description: Check if about to edit a message or a media caption --- ## Method: messages.getMessageEditData [Back to methods index](index.md) +Check if about to edit a message or a media caption + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|id|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| +|id|[CLICK ME int](../types/int.md) | Yes|The message ID| ### Return type: [messages\_MessageEditData](../types/messages_MessageEditData.md) diff --git a/old_docs/API_docs_v70/methods/messages_getMessagesViews.md b/old_docs/API_docs_v70/methods/messages_getMessagesViews.md index e3f4e4ea..b8d78c85 100644 --- a/old_docs/API_docs_v70/methods/messages_getMessagesViews.md +++ b/old_docs/API_docs_v70/methods/messages_getMessagesViews.md @@ -1,18 +1,20 @@ --- title: messages.getMessagesViews -description: messages.getMessagesViews parameters, return type and example +description: Get and increase message views --- ## Method: messages.getMessagesViews [Back to methods index](index.md) +Get and increase message views + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|id|Array of [CLICK ME int](../types/int.md) | Yes| -|increment|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the message is located| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs messages to get| +|increment|[CLICK ME Bool](../types/Bool.md) | Yes|Increase message views?| ### Return type: [Vector\_of\_int](../types/int.md) diff --git a/old_docs/API_docs_v70/methods/messages_getPeerDialogs.md b/old_docs/API_docs_v70/methods/messages_getPeerDialogs.md index fe8a821c..da82cfc6 100644 --- a/old_docs/API_docs_v70/methods/messages_getPeerDialogs.md +++ b/old_docs/API_docs_v70/methods/messages_getPeerDialogs.md @@ -1,16 +1,18 @@ --- title: messages.getPeerDialogs -description: messages.getPeerDialogs parameters, return type and example +description: Get dialog info of peers --- ## Method: messages.getPeerDialogs [Back to methods index](index.md) +Get dialog info of peers + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peers|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peers|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Yes|The peers| ### Return type: [messages\_PeerDialogs](../types/messages_PeerDialogs.md) diff --git a/old_docs/API_docs_v70/methods/messages_getPinnedDialogs.md b/old_docs/API_docs_v70/methods/messages_getPinnedDialogs.md index 99ff5651..d12779fe 100644 --- a/old_docs/API_docs_v70/methods/messages_getPinnedDialogs.md +++ b/old_docs/API_docs_v70/methods/messages_getPinnedDialogs.md @@ -1,11 +1,13 @@ --- title: messages.getPinnedDialogs -description: messages.getPinnedDialogs parameters, return type and example +description: Get pinned dialogs --- ## Method: messages.getPinnedDialogs [Back to methods index](index.md) +Get pinned dialogs + ### Return type: [messages\_PeerDialogs](../types/messages_PeerDialogs.md) diff --git a/old_docs/API_docs_v70/methods/messages_getRecentStickers.md b/old_docs/API_docs_v70/methods/messages_getRecentStickers.md index abab7f44..d76a2160 100644 --- a/old_docs/API_docs_v70/methods/messages_getRecentStickers.md +++ b/old_docs/API_docs_v70/methods/messages_getRecentStickers.md @@ -1,17 +1,19 @@ --- title: messages.getRecentStickers -description: messages.getRecentStickers parameters, return type and example +description: Get recent stickers --- ## Method: messages.getRecentStickers [Back to methods index](index.md) +Get recent stickers + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|attached|[CLICK ME Bool](../types/Bool.md) | Optional| -|hash|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|attached|[CLICK ME Bool](../types/Bool.md) | Optional|Get stickers attached to image?| +|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_RecentStickers](../types/messages_RecentStickers.md) diff --git a/old_docs/API_docs_v70/methods/messages_getSavedGifs.md b/old_docs/API_docs_v70/methods/messages_getSavedGifs.md index 08dc4be6..f61348ce 100644 --- a/old_docs/API_docs_v70/methods/messages_getSavedGifs.md +++ b/old_docs/API_docs_v70/methods/messages_getSavedGifs.md @@ -1,16 +1,18 @@ --- title: messages.getSavedGifs -description: messages.getSavedGifs parameters, return type and example +description: Get saved gifs --- ## Method: messages.getSavedGifs [Back to methods index](index.md) +Get saved gifs + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_SavedGifs](../types/messages_SavedGifs.md) diff --git a/old_docs/API_docs_v70/methods/messages_getStickerSet.md b/old_docs/API_docs_v70/methods/messages_getStickerSet.md index 70bdd9ba..c86807e4 100644 --- a/old_docs/API_docs_v70/methods/messages_getStickerSet.md +++ b/old_docs/API_docs_v70/methods/messages_getStickerSet.md @@ -1,16 +1,18 @@ --- title: messages.getStickerSet -description: messages.getStickerSet parameters, return type and example +description: Get a stickerset --- ## Method: messages.getStickerSet [Back to methods index](index.md) +Get a stickerset + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset to get| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/old_docs/API_docs_v70/methods/messages_getWebPage.md b/old_docs/API_docs_v70/methods/messages_getWebPage.md index b29e5d25..129f8f06 100644 --- a/old_docs/API_docs_v70/methods/messages_getWebPage.md +++ b/old_docs/API_docs_v70/methods/messages_getWebPage.md @@ -1,17 +1,19 @@ --- title: messages.getWebPage -description: messages.getWebPage parameters, return type and example +description: Get webpage preview --- ## Method: messages.getWebPage [Back to methods index](index.md) +Get webpage preview + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|url|[CLICK ME string](../types/string.md) | Yes| -|hash|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|url|[CLICK ME string](../types/string.md) | Yes|URL| +|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [WebPage](../types/WebPage.md) diff --git a/old_docs/API_docs_v70/methods/messages_getWebPagePreview.md b/old_docs/API_docs_v70/methods/messages_getWebPagePreview.md index 35243c9f..d01bdd32 100644 --- a/old_docs/API_docs_v70/methods/messages_getWebPagePreview.md +++ b/old_docs/API_docs_v70/methods/messages_getWebPagePreview.md @@ -1,16 +1,18 @@ --- title: messages.getWebPagePreview -description: messages.getWebPagePreview parameters, return type and example +description: Get webpage preview --- ## Method: messages.getWebPagePreview [Back to methods index](index.md) +Get webpage preview + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|message|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|message|[CLICK ME string](../types/string.md) | Yes|Extract preview from this message| ### Return type: [MessageMedia](../types/MessageMedia.md) diff --git a/old_docs/API_docs_v70/methods/messages_importChatInvite.md b/old_docs/API_docs_v70/methods/messages_importChatInvite.md index 2bea5247..0d6cd7c8 100644 --- a/old_docs/API_docs_v70/methods/messages_importChatInvite.md +++ b/old_docs/API_docs_v70/methods/messages_importChatInvite.md @@ -1,16 +1,18 @@ --- title: messages.importChatInvite -description: messages.importChatInvite parameters, return type and example +description: Import chat invite --- ## Method: messages.importChatInvite [Back to methods index](index.md) +Import chat invite + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v70/methods/messages_installStickerSet.md b/old_docs/API_docs_v70/methods/messages_installStickerSet.md index 61513182..9f6f098c 100644 --- a/old_docs/API_docs_v70/methods/messages_installStickerSet.md +++ b/old_docs/API_docs_v70/methods/messages_installStickerSet.md @@ -1,17 +1,19 @@ --- title: messages.installStickerSet -description: messages.installStickerSet parameters, return type and example +description: Add a sticker set --- ## Method: messages.installStickerSet [Back to methods index](index.md) +Add a sticker set + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional| -|archived|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to add| +|archived|[CLICK ME Bool](../types/Bool.md) | Yes|Archive this set?| ### Return type: [messages\_StickerSetInstallResult](../types/messages_StickerSetInstallResult.md) diff --git a/old_docs/API_docs_v70/methods/messages_migrateChat.md b/old_docs/API_docs_v70/methods/messages_migrateChat.md index 5021ad45..db57adfa 100644 --- a/old_docs/API_docs_v70/methods/messages_migrateChat.md +++ b/old_docs/API_docs_v70/methods/messages_migrateChat.md @@ -1,16 +1,18 @@ --- title: messages.migrateChat -description: messages.migrateChat parameters, return type and example +description: Convert chat to supergroup --- ## Method: messages.migrateChat [Back to methods index](index.md) +Convert chat to supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat to convert| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v70/methods/messages_readEncryptedHistory.md b/old_docs/API_docs_v70/methods/messages_readEncryptedHistory.md index 4d341809..39b110e3 100644 --- a/old_docs/API_docs_v70/methods/messages_readEncryptedHistory.md +++ b/old_docs/API_docs_v70/methods/messages_readEncryptedHistory.md @@ -1,17 +1,19 @@ --- title: messages.readEncryptedHistory -description: messages.readEncryptedHistory parameters, return type and example +description: Mark messages as read in secret chats --- ## Method: messages.readEncryptedHistory [Back to methods index](index.md) +Mark messages as read in secret chats + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|max\_date|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to mark messages as read| +|max\_date|[CLICK ME int](../types/int.md) | Yes|Maximum date of messages to mark| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v70/methods/messages_readFeaturedStickers.md b/old_docs/API_docs_v70/methods/messages_readFeaturedStickers.md index 0631ca5b..4035c76d 100644 --- a/old_docs/API_docs_v70/methods/messages_readFeaturedStickers.md +++ b/old_docs/API_docs_v70/methods/messages_readFeaturedStickers.md @@ -1,16 +1,18 @@ --- title: messages.readFeaturedStickers -description: messages.readFeaturedStickers parameters, return type and example +description: Mark new featured stickers as read --- ## Method: messages.readFeaturedStickers [Back to methods index](index.md) +Mark new featured stickers as read + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|Array of [CLICK ME long](../types/long.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|Array of [CLICK ME long](../types/long.md) | Yes|The stickers to mark as read| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v70/methods/messages_readMessageContents.md b/old_docs/API_docs_v70/methods/messages_readMessageContents.md index 0d27c209..9bb1bee8 100644 --- a/old_docs/API_docs_v70/methods/messages_readMessageContents.md +++ b/old_docs/API_docs_v70/methods/messages_readMessageContents.md @@ -1,16 +1,18 @@ --- title: messages.readMessageContents -description: messages.readMessageContents parameters, return type and example +description: Mark message as read --- ## Method: messages.readMessageContents [Back to methods index](index.md) +Mark message as read + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v70/methods/messages_receivedQueue.md b/old_docs/API_docs_v70/methods/messages_receivedQueue.md index c91caa37..4ad78ba2 100644 --- a/old_docs/API_docs_v70/methods/messages_receivedQueue.md +++ b/old_docs/API_docs_v70/methods/messages_receivedQueue.md @@ -1,77 +1,13 @@ --- title: messages.receivedQueue -description: messages.receivedQueue parameters, return type and example +description: You cannot use this method directly --- ## Method: messages.receivedQueue [Back to methods index](index.md) -### Parameters: - -| Name | Type | Required | -|----------|---------------|----------| -|max\_qts|[CLICK ME int](../types/int.md) | Yes| - - -### 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| - - -### MadelineProto Example: - - -``` -if (!file_exists('madeline.php')) { - copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); -} -include 'madeline.php'; - -// !!! This API id/API hash combination will not work !!! -// !!! You must get your own @ my.telegram.org !!! -$api_id = 0; -$api_hash = ''; - -$MadelineProto = new \danog\MadelineProto\API('session.madeline', ['app_info' => ['api_id' => $api_id, 'api_hash' => $api_hash]]); -$MadelineProto->start(); - -$Vector_of_long = $MadelineProto->messages->receivedQueue(['max_qts' => int, ]); -``` - -### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): - -### As a bot: - -POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` - -Parameters: - -* method - messages.receivedQueue -* params - `{"max_qts": int, }` - - - -### As a user: - -POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.receivedQueue` - -Parameters: - -max_qts - Json encoded int +**You cannot use this method directly** -Or, if you're into Lua: - -``` -Vector_of_long = messages.receivedQueue({max_qts=int, }) -``` - diff --git a/old_docs/API_docs_v70/methods/messages_reorderPinnedDialogs.md b/old_docs/API_docs_v70/methods/messages_reorderPinnedDialogs.md index 0bf5e073..710caf10 100644 --- a/old_docs/API_docs_v70/methods/messages_reorderPinnedDialogs.md +++ b/old_docs/API_docs_v70/methods/messages_reorderPinnedDialogs.md @@ -1,17 +1,19 @@ --- title: messages.reorderPinnedDialogs -description: messages.reorderPinnedDialogs parameters, return type and example +description: Reorder pinned dialogs --- ## Method: messages.reorderPinnedDialogs [Back to methods index](index.md) +Reorder pinned dialogs + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|force|[CLICK ME Bool](../types/Bool.md) | Optional| -|order|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|force|[CLICK ME Bool](../types/Bool.md) | Optional|Force reordering| +|order|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Yes|New order| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v70/methods/messages_reorderStickerSets.md b/old_docs/API_docs_v70/methods/messages_reorderStickerSets.md index e4f1623c..ddc78dd0 100644 --- a/old_docs/API_docs_v70/methods/messages_reorderStickerSets.md +++ b/old_docs/API_docs_v70/methods/messages_reorderStickerSets.md @@ -1,17 +1,19 @@ --- title: messages.reorderStickerSets -description: messages.reorderStickerSets parameters, return type and example +description: Reorder sticker sets --- ## Method: messages.reorderStickerSets [Back to methods index](index.md) +Reorder sticker sets + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|masks|[CLICK ME Bool](../types/Bool.md) | Optional| -|order|Array of [CLICK ME long](../types/long.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|masks|[CLICK ME Bool](../types/Bool.md) | Optional|Reorder masks?| +|order|Array of [CLICK ME long](../types/long.md) | Yes|The order| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v70/methods/messages_reportEncryptedSpam.md b/old_docs/API_docs_v70/methods/messages_reportEncryptedSpam.md index 44482c76..58b684d1 100644 --- a/old_docs/API_docs_v70/methods/messages_reportEncryptedSpam.md +++ b/old_docs/API_docs_v70/methods/messages_reportEncryptedSpam.md @@ -1,16 +1,18 @@ --- title: messages.reportEncryptedSpam -description: messages.reportEncryptedSpam parameters, return type and example +description: Report for spam a secret chat --- ## Method: messages.reportEncryptedSpam [Back to methods index](index.md) +Report for spam a secret chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat to report| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v70/methods/messages_saveDraft.md b/old_docs/API_docs_v70/methods/messages_saveDraft.md index 9104df33..bbeed707 100644 --- a/old_docs/API_docs_v70/methods/messages_saveDraft.md +++ b/old_docs/API_docs_v70/methods/messages_saveDraft.md @@ -1,20 +1,22 @@ --- title: messages.saveDraft -description: messages.saveDraft parameters, return type and example +description: Save a message draft --- ## Method: messages.saveDraft [Back to methods index](index.md) +Save a message draft + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|message|[CLICK ME string](../types/string.md) | Yes| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview| +|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| +|message|[CLICK ME string](../types/string.md) | Yes|The message| +|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|The entities (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/old_docs/API_docs_v70/methods/messages_saveGif.md b/old_docs/API_docs_v70/methods/messages_saveGif.md index 4a3b6166..6f608c4c 100644 --- a/old_docs/API_docs_v70/methods/messages_saveGif.md +++ b/old_docs/API_docs_v70/methods/messages_saveGif.md @@ -1,17 +1,19 @@ --- title: messages.saveGif -description: messages.saveGif parameters, return type and example +description: Save a GIF --- ## Method: messages.saveGif [Back to methods index](index.md) +Save a GIF + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional| -|unsave|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The GIF to save| +|unsave|[CLICK ME Bool](../types/Bool.md) | Yes|Remove the gif?| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v70/methods/messages_saveRecentSticker.md b/old_docs/API_docs_v70/methods/messages_saveRecentSticker.md index b4f43e13..81ad5d48 100644 --- a/old_docs/API_docs_v70/methods/messages_saveRecentSticker.md +++ b/old_docs/API_docs_v70/methods/messages_saveRecentSticker.md @@ -1,18 +1,20 @@ --- title: messages.saveRecentSticker -description: messages.saveRecentSticker parameters, return type and example +description: Add a sticker to recent stickers --- ## Method: messages.saveRecentSticker [Back to methods index](index.md) +Add a sticker to recent stickers + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|attached|[CLICK ME Bool](../types/Bool.md) | Optional| -|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional| -|unsave|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|attached|[CLICK ME Bool](../types/Bool.md) | Optional|Get stickers attached to image?| +|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker| +|unsave|[CLICK ME Bool](../types/Bool.md) | Yes|Remove the sticker from recent stickers?| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v70/methods/messages_searchGifs.md b/old_docs/API_docs_v70/methods/messages_searchGifs.md index fefef1d7..103ebfeb 100644 --- a/old_docs/API_docs_v70/methods/messages_searchGifs.md +++ b/old_docs/API_docs_v70/methods/messages_searchGifs.md @@ -1,17 +1,19 @@ --- title: messages.searchGifs -description: messages.searchGifs parameters, return type and example +description: Search gifs --- ## Method: messages.searchGifs [Back to methods index](index.md) +Search gifs + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|q|[CLICK ME string](../types/string.md) | Yes| -|offset|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|q|[CLICK ME string](../types/string.md) | Yes|The search query| +|offset|[CLICK ME int](../types/int.md) | Yes|The offset | ### Return type: [messages\_FoundGifs](../types/messages_FoundGifs.md) diff --git a/old_docs/API_docs_v70/methods/messages_searchGlobal.md b/old_docs/API_docs_v70/methods/messages_searchGlobal.md index 32ddd175..0edd1e40 100644 --- a/old_docs/API_docs_v70/methods/messages_searchGlobal.md +++ b/old_docs/API_docs_v70/methods/messages_searchGlobal.md @@ -1,20 +1,22 @@ --- title: messages.searchGlobal -description: messages.searchGlobal parameters, return type and example +description: Global message search --- ## Method: messages.searchGlobal [Back to methods index](index.md) +Global message search + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|q|[CLICK ME string](../types/string.md) | Yes| -|offset\_date|[CLICK ME int](../types/int.md) | Yes| -|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|offset\_id|[CLICK ME int](../types/int.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|q|[CLICK ME string](../types/string.md) | Yes|The query| +|offset\_date|[CLICK ME int](../types/int.md) | Yes|0 or the date offset| +|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|0 or the peer offset| +|offset\_id|[CLICK ME int](../types/int.md) | Yes|0 or the message ID offset| +|limit|[CLICK ME int](../types/int.md) | Yes|The number of results to return| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v70/methods/messages_sendEncrypted.md b/old_docs/API_docs_v70/methods/messages_sendEncrypted.md index 23461760..d48f88d7 100644 --- a/old_docs/API_docs_v70/methods/messages_sendEncrypted.md +++ b/old_docs/API_docs_v70/methods/messages_sendEncrypted.md @@ -1,17 +1,19 @@ --- title: messages.sendEncrypted -description: messages.sendEncrypted parameters, return type and example +description: Send message to secret chat --- ## Method: messages.sendEncrypted [Back to methods index](index.md) +Send message to secret chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the message| +|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v70/methods/messages_sendEncryptedFile.md b/old_docs/API_docs_v70/methods/messages_sendEncryptedFile.md index 64919abe..4fd0648e 100644 --- a/old_docs/API_docs_v70/methods/messages_sendEncryptedFile.md +++ b/old_docs/API_docs_v70/methods/messages_sendEncryptedFile.md @@ -1,18 +1,20 @@ --- title: messages.sendEncryptedFile -description: messages.sendEncryptedFile parameters, return type and example +description: Send a file to a secret chat --- ## Method: messages.sendEncryptedFile [Back to methods index](index.md) +Send a file to a secret chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes| -|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the file| +|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| +|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional|The file (optional)| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v70/methods/messages_sendEncryptedService.md b/old_docs/API_docs_v70/methods/messages_sendEncryptedService.md index 0a0eea8a..d66894bf 100644 --- a/old_docs/API_docs_v70/methods/messages_sendEncryptedService.md +++ b/old_docs/API_docs_v70/methods/messages_sendEncryptedService.md @@ -1,17 +1,19 @@ --- title: messages.sendEncryptedService -description: messages.sendEncryptedService parameters, return type and example +description: Send a service message to a secret chat --- ## Method: messages.sendEncryptedService [Back to methods index](index.md) +Send a service message to a secret chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the service message| +|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v70/methods/messages_sendInlineBotResult.md b/old_docs/API_docs_v70/methods/messages_sendInlineBotResult.md index 4cb9243e..386ac7e3 100644 --- a/old_docs/API_docs_v70/methods/messages_sendInlineBotResult.md +++ b/old_docs/API_docs_v70/methods/messages_sendInlineBotResult.md @@ -1,22 +1,24 @@ --- title: messages.sendInlineBotResult -description: messages.sendInlineBotResult parameters, return type and example +description: Send a received bot result to the chat --- ## Method: messages.sendInlineBotResult [Back to methods index](index.md) +Send a received bot result to the chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional| -|background|[CLICK ME Bool](../types/Bool.md) | Optional| -|clear\_draft|[CLICK ME Bool](../types/Bool.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional| -|query\_id|[CLICK ME long](../types/long.md) | Yes| -|id|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Disable notifications?| +|background|[CLICK ME Bool](../types/Bool.md) | Optional|Disable background notifications?| +|clear\_draft|[CLICK ME Bool](../types/Bool.md) | Optional|Clear the message draft?| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the message| +|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| +|query\_id|[CLICK ME long](../types/long.md) | Yes|The inline query ID| +|id|[CLICK ME string](../types/string.md) | Yes|The result ID| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v70/methods/messages_sendScreenshotNotification.md b/old_docs/API_docs_v70/methods/messages_sendScreenshotNotification.md index c9d1d555..f64f1682 100644 --- a/old_docs/API_docs_v70/methods/messages_sendScreenshotNotification.md +++ b/old_docs/API_docs_v70/methods/messages_sendScreenshotNotification.md @@ -1,17 +1,19 @@ --- title: messages.sendScreenshotNotification -description: messages.sendScreenshotNotification parameters, return type and example +description: Send screenshot notification --- ## Method: messages.sendScreenshotNotification [Back to methods index](index.md) +Send screenshot notification + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the notification| +|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Yes|Reply to message by ID| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v70/methods/messages_setBotCallbackAnswer.md b/old_docs/API_docs_v70/methods/messages_setBotCallbackAnswer.md index 5590828e..e6dc6b09 100644 --- a/old_docs/API_docs_v70/methods/messages_setBotCallbackAnswer.md +++ b/old_docs/API_docs_v70/methods/messages_setBotCallbackAnswer.md @@ -1,20 +1,22 @@ --- title: messages.setBotCallbackAnswer -description: messages.setBotCallbackAnswer parameters, return type and example +description: Bots only: set the callback answer (after a button was clicked) --- ## Method: messages.setBotCallbackAnswer [Back to methods index](index.md) +Bots only: set the callback answer (after a button was clicked) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|alert|[CLICK ME Bool](../types/Bool.md) | Optional| -|query\_id|[CLICK ME long](../types/long.md) | Yes| -|message|[CLICK ME string](../types/string.md) | Optional| -|url|[CLICK ME string](../types/string.md) | Optional| -|cache\_time|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|alert|[CLICK ME Bool](../types/Bool.md) | Optional|Is this an alert?| +|query\_id|[CLICK ME long](../types/long.md) | Yes|The query ID| +|message|[CLICK ME string](../types/string.md) | Optional|The message| +|url|[CLICK ME string](../types/string.md) | Optional|The URL| +|cache\_time|[CLICK ME int](../types/int.md) | Yes|Cache time| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v70/methods/messages_setBotPrecheckoutResults.md b/old_docs/API_docs_v70/methods/messages_setBotPrecheckoutResults.md index 5afa7789..722bff81 100644 --- a/old_docs/API_docs_v70/methods/messages_setBotPrecheckoutResults.md +++ b/old_docs/API_docs_v70/methods/messages_setBotPrecheckoutResults.md @@ -1,18 +1,20 @@ --- title: messages.setBotPrecheckoutResults -description: messages.setBotPrecheckoutResults parameters, return type and example +description: Bots only: set precheckout results --- ## Method: messages.setBotPrecheckoutResults [Back to methods index](index.md) +Bots only: set precheckout results + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|success|[CLICK ME Bool](../types/Bool.md) | Optional| -|query\_id|[CLICK ME long](../types/long.md) | Yes| -|error|[CLICK ME string](../types/string.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|success|[CLICK ME Bool](../types/Bool.md) | Optional|Success?| +|query\_id|[CLICK ME long](../types/long.md) | Yes|Query ID| +|error|[CLICK ME string](../types/string.md) | Optional|Error| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v70/methods/messages_setBotShippingResults.md b/old_docs/API_docs_v70/methods/messages_setBotShippingResults.md index b36dacce..d364a04d 100644 --- a/old_docs/API_docs_v70/methods/messages_setBotShippingResults.md +++ b/old_docs/API_docs_v70/methods/messages_setBotShippingResults.md @@ -1,18 +1,20 @@ --- title: messages.setBotShippingResults -description: messages.setBotShippingResults parameters, return type and example +description: Bots only: set shipping results --- ## Method: messages.setBotShippingResults [Back to methods index](index.md) +Bots only: set shipping results + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|query\_id|[CLICK ME long](../types/long.md) | Yes| -|error|[CLICK ME string](../types/string.md) | Optional| -|shipping\_options|Array of [CLICK ME ShippingOption](../types/ShippingOption.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|query\_id|[CLICK ME long](../types/long.md) | Yes|Query ID| +|error|[CLICK ME string](../types/string.md) | Optional|Error| +|shipping\_options|Array of [CLICK ME ShippingOption](../types/ShippingOption.md) | Optional|Shipping options| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v70/methods/messages_setEncryptedTyping.md b/old_docs/API_docs_v70/methods/messages_setEncryptedTyping.md index 3183fedf..e9afe99c 100644 --- a/old_docs/API_docs_v70/methods/messages_setEncryptedTyping.md +++ b/old_docs/API_docs_v70/methods/messages_setEncryptedTyping.md @@ -12,8 +12,8 @@ Send typing notification to secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|| -|typing|[CLICK ME Bool](../types/Bool.md) | Yes|| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to send the notification| +|typing|[CLICK ME Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v70/methods/messages_setGameScore.md b/old_docs/API_docs_v70/methods/messages_setGameScore.md index c44145c0..aa1f4f0c 100644 --- a/old_docs/API_docs_v70/methods/messages_setGameScore.md +++ b/old_docs/API_docs_v70/methods/messages_setGameScore.md @@ -1,21 +1,23 @@ --- title: messages.setGameScore -description: messages.setGameScore parameters, return type and example +description: Set the game score --- ## Method: messages.setGameScore [Back to methods index](index.md) +Set the game score + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|edit\_message|[CLICK ME Bool](../types/Bool.md) | Optional| -|force|[CLICK ME Bool](../types/Bool.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|id|[CLICK ME int](../types/int.md) | Yes| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|score|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|edit\_message|[CLICK ME Bool](../types/Bool.md) | Optional|Should the message with the game be edited?| +|force|[CLICK ME Bool](../types/Bool.md) | Optional|Force setting the game score| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the game was sent| +|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the score| +|score|[CLICK ME int](../types/int.md) | Yes|The score| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v70/methods/messages_setInlineBotResults.md b/old_docs/API_docs_v70/methods/messages_setInlineBotResults.md index 915e3a4e..79493009 100644 --- a/old_docs/API_docs_v70/methods/messages_setInlineBotResults.md +++ b/old_docs/API_docs_v70/methods/messages_setInlineBotResults.md @@ -1,22 +1,24 @@ --- title: messages.setInlineBotResults -description: messages.setInlineBotResults parameters, return type and example +description: Bots only: set the results of an inline query --- ## Method: messages.setInlineBotResults [Back to methods index](index.md) +Bots only: set the results of an inline query + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|gallery|[CLICK ME Bool](../types/Bool.md) | Optional| -|private|[CLICK ME Bool](../types/Bool.md) | Optional| -|query\_id|[CLICK ME long](../types/long.md) | Yes| -|results|Array of [CLICK ME InputBotInlineResult](../types/InputBotInlineResult.md) | Yes| -|cache\_time|[CLICK ME int](../types/int.md) | Yes| -|next\_offset|[CLICK ME string](../types/string.md) | Optional| -|switch\_pm|[CLICK ME InlineBotSwitchPM](../types/InlineBotSwitchPM.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|gallery|[CLICK ME Bool](../types/Bool.md) | Optional|Is this a gallery?| +|private|[CLICK ME Bool](../types/Bool.md) | Optional|Is this result private (not cached)?| +|query\_id|[CLICK ME long](../types/long.md) | Yes|Query ID| +|results|Array of [CLICK ME InputBotInlineResult](../types/InputBotInlineResult.md) | Yes|Results| +|cache\_time|[CLICK ME int](../types/int.md) | Yes|Cache time| +|next\_offset|[CLICK ME string](../types/string.md) | Optional|The next offset| +|switch\_pm|[CLICK ME InlineBotSwitchPM](../types/InlineBotSwitchPM.md) | Optional|Switch to PM?| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v70/methods/messages_setInlineGameScore.md b/old_docs/API_docs_v70/methods/messages_setInlineGameScore.md index 55e2c063..385c8308 100644 --- a/old_docs/API_docs_v70/methods/messages_setInlineGameScore.md +++ b/old_docs/API_docs_v70/methods/messages_setInlineGameScore.md @@ -1,20 +1,22 @@ --- title: messages.setInlineGameScore -description: messages.setInlineGameScore parameters, return type and example +description: Set the game score of an inline message --- ## Method: messages.setInlineGameScore [Back to methods index](index.md) +Set the game score of an inline message + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|edit\_message|[CLICK ME Bool](../types/Bool.md) | Optional| -|force|[CLICK ME Bool](../types/Bool.md) | Optional| -|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|score|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|edit\_message|[CLICK ME Bool](../types/Bool.md) | Optional|Should the message with the game be edited?| +|force|[CLICK ME Bool](../types/Bool.md) | Optional|Force setting the game score| +|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The ID of the inline message| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the score| +|score|[CLICK ME int](../types/int.md) | Yes|The score| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v70/methods/messages_startBot.md b/old_docs/API_docs_v70/methods/messages_startBot.md index 0de0f1a5..94a4d86a 100644 --- a/old_docs/API_docs_v70/methods/messages_startBot.md +++ b/old_docs/API_docs_v70/methods/messages_startBot.md @@ -1,18 +1,20 @@ --- title: messages.startBot -description: messages.startBot parameters, return type and example +description: Start a bot --- ## Method: messages.startBot [Back to methods index](index.md) +Start a bot + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|start\_param|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot's ID or username| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to start the bot (@me or group ID/username)| +|start\_param|[CLICK ME string](../types/string.md) | Yes|The bot's start parameter| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v70/methods/messages_toggleChatAdmins.md b/old_docs/API_docs_v70/methods/messages_toggleChatAdmins.md index d56e5753..ab591fd9 100644 --- a/old_docs/API_docs_v70/methods/messages_toggleChatAdmins.md +++ b/old_docs/API_docs_v70/methods/messages_toggleChatAdmins.md @@ -1,17 +1,19 @@ --- title: messages.toggleChatAdmins -description: messages.toggleChatAdmins parameters, return type and example +description: Enable all users are admins in normal groups (not supergroups) --- ## Method: messages.toggleChatAdmins [Back to methods index](index.md) +Enable all users are admins in normal groups (not supergroups) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Group ID| +|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Enable all users are admins| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v70/methods/messages_toggleDialogPin.md b/old_docs/API_docs_v70/methods/messages_toggleDialogPin.md index d6dc9692..2bd6a03d 100644 --- a/old_docs/API_docs_v70/methods/messages_toggleDialogPin.md +++ b/old_docs/API_docs_v70/methods/messages_toggleDialogPin.md @@ -1,17 +1,19 @@ --- title: messages.toggleDialogPin -description: messages.toggleDialogPin parameters, return type and example +description: Pin or unpin dialog --- ## Method: messages.toggleDialogPin [Back to methods index](index.md) +Pin or unpin dialog + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|pinned|[CLICK ME Bool](../types/Bool.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|pinned|[CLICK ME Bool](../types/Bool.md) | Optional|Pin or unpin the dialog?| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer to pin| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v70/methods/messages_uninstallStickerSet.md b/old_docs/API_docs_v70/methods/messages_uninstallStickerSet.md index 60b0ca0c..6d04e847 100644 --- a/old_docs/API_docs_v70/methods/messages_uninstallStickerSet.md +++ b/old_docs/API_docs_v70/methods/messages_uninstallStickerSet.md @@ -1,16 +1,18 @@ --- title: messages.uninstallStickerSet -description: messages.uninstallStickerSet parameters, return type and example +description: Remove a sticker set --- ## Method: messages.uninstallStickerSet [Back to methods index](index.md) +Remove a sticker set + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to remove| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v70/methods/messages_uploadMedia.md b/old_docs/API_docs_v70/methods/messages_uploadMedia.md index 5c25333d..c982a860 100644 --- a/old_docs/API_docs_v70/methods/messages_uploadMedia.md +++ b/old_docs/API_docs_v70/methods/messages_uploadMedia.md @@ -1,17 +1,19 @@ --- title: messages.uploadMedia -description: messages.uploadMedia parameters, return type and example +description: Upload a file without sending it to anyone --- ## Method: messages.uploadMedia [Back to methods index](index.md) +Upload a file without sending it to anyone + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Nothing| +|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media to upload| ### Return type: [MessageMedia](../types/MessageMedia.md) diff --git a/old_docs/API_docs_v70/methods/payments_clearSavedInfo.md b/old_docs/API_docs_v70/methods/payments_clearSavedInfo.md index 53fab36f..44050dde 100644 --- a/old_docs/API_docs_v70/methods/payments_clearSavedInfo.md +++ b/old_docs/API_docs_v70/methods/payments_clearSavedInfo.md @@ -1,17 +1,19 @@ --- title: payments.clearSavedInfo -description: payments.clearSavedInfo parameters, return type and example +description: Clear saved payments info --- ## Method: payments.clearSavedInfo [Back to methods index](index.md) +Clear saved payments info + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|credentials|[CLICK ME Bool](../types/Bool.md) | Optional| -|info|[CLICK ME Bool](../types/Bool.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|credentials|[CLICK ME Bool](../types/Bool.md) | Optional|Clear credentials?| +|info|[CLICK ME Bool](../types/Bool.md) | Optional|Clear payment info?| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v70/methods/payments_getPaymentForm.md b/old_docs/API_docs_v70/methods/payments_getPaymentForm.md index 00b4bddc..16a32d11 100644 --- a/old_docs/API_docs_v70/methods/payments_getPaymentForm.md +++ b/old_docs/API_docs_v70/methods/payments_getPaymentForm.md @@ -1,16 +1,18 @@ --- title: payments.getPaymentForm -description: payments.getPaymentForm parameters, return type and example +description: Get payment form --- ## Method: payments.getPaymentForm [Back to methods index](index.md) +Get payment form + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|msg\_id|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|msg\_id|[CLICK ME int](../types/int.md) | Yes|Message ID| ### Return type: [payments\_PaymentForm](../types/payments_PaymentForm.md) diff --git a/old_docs/API_docs_v70/methods/payments_getPaymentReceipt.md b/old_docs/API_docs_v70/methods/payments_getPaymentReceipt.md index 40b73a4b..857585f6 100644 --- a/old_docs/API_docs_v70/methods/payments_getPaymentReceipt.md +++ b/old_docs/API_docs_v70/methods/payments_getPaymentReceipt.md @@ -1,16 +1,18 @@ --- title: payments.getPaymentReceipt -description: payments.getPaymentReceipt parameters, return type and example +description: Get payment receipt --- ## Method: payments.getPaymentReceipt [Back to methods index](index.md) +Get payment receipt + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|msg\_id|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|msg\_id|[CLICK ME int](../types/int.md) | Yes|The message ID| ### Return type: [payments\_PaymentReceipt](../types/payments_PaymentReceipt.md) diff --git a/old_docs/API_docs_v70/methods/payments_getSavedInfo.md b/old_docs/API_docs_v70/methods/payments_getSavedInfo.md index ccaaff75..04ac7374 100644 --- a/old_docs/API_docs_v70/methods/payments_getSavedInfo.md +++ b/old_docs/API_docs_v70/methods/payments_getSavedInfo.md @@ -1,11 +1,13 @@ --- title: payments.getSavedInfo -description: payments.getSavedInfo parameters, return type and example +description: Get saved payments info --- ## Method: payments.getSavedInfo [Back to methods index](index.md) +Get saved payments info + ### Return type: [payments\_SavedInfo](../types/payments_SavedInfo.md) diff --git a/old_docs/API_docs_v70/methods/payments_sendPaymentForm.md b/old_docs/API_docs_v70/methods/payments_sendPaymentForm.md index eb843715..0a9df99f 100644 --- a/old_docs/API_docs_v70/methods/payments_sendPaymentForm.md +++ b/old_docs/API_docs_v70/methods/payments_sendPaymentForm.md @@ -1,19 +1,21 @@ --- title: payments.sendPaymentForm -description: payments.sendPaymentForm parameters, return type and example +description: Bots only: send payment form --- ## Method: payments.sendPaymentForm [Back to methods index](index.md) +Bots only: send payment form + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|msg\_id|[CLICK ME int](../types/int.md) | Yes| -|requested\_info\_id|[CLICK ME string](../types/string.md) | Optional| -|shipping\_option\_id|[CLICK ME string](../types/string.md) | Optional| -|credentials|[CLICK ME InputPaymentCredentials](../types/InputPaymentCredentials.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|msg\_id|[CLICK ME int](../types/int.md) | Yes|Message ID| +|requested\_info\_id|[CLICK ME string](../types/string.md) | Optional|ID of requested info| +|shipping\_option\_id|[CLICK ME string](../types/string.md) | Optional|Shipping option ID| +|credentials|[CLICK ME InputPaymentCredentials](../types/InputPaymentCredentials.md) | Yes|Payment credentials| ### Return type: [payments\_PaymentResult](../types/payments_PaymentResult.md) diff --git a/old_docs/API_docs_v70/methods/payments_validateRequestedInfo.md b/old_docs/API_docs_v70/methods/payments_validateRequestedInfo.md index 32702965..e36f0e42 100644 --- a/old_docs/API_docs_v70/methods/payments_validateRequestedInfo.md +++ b/old_docs/API_docs_v70/methods/payments_validateRequestedInfo.md @@ -1,18 +1,20 @@ --- title: payments.validateRequestedInfo -description: payments.validateRequestedInfo parameters, return type and example +description: Validate requested payment info --- ## Method: payments.validateRequestedInfo [Back to methods index](index.md) +Validate requested payment info + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|save|[CLICK ME Bool](../types/Bool.md) | Optional| -|msg\_id|[CLICK ME int](../types/int.md) | Yes| -|info|[CLICK ME PaymentRequestedInfo](../types/PaymentRequestedInfo.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|save|[CLICK ME Bool](../types/Bool.md) | Optional|Save payment info?| +|msg\_id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|info|[CLICK ME PaymentRequestedInfo](../types/PaymentRequestedInfo.md) | Yes|The requested payment info| ### Return type: [payments\_ValidatedRequestedInfo](../types/payments_ValidatedRequestedInfo.md) diff --git a/old_docs/API_docs_v70/methods/photos_deletePhotos.md b/old_docs/API_docs_v70/methods/photos_deletePhotos.md index 104459b7..b9daca10 100644 --- a/old_docs/API_docs_v70/methods/photos_deletePhotos.md +++ b/old_docs/API_docs_v70/methods/photos_deletePhotos.md @@ -1,16 +1,18 @@ --- title: photos.deletePhotos -description: photos.deletePhotos parameters, return type and example +description: Delete profile photos --- ## Method: photos.deletePhotos [Back to methods index](index.md) +Delete profile photos + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Yes|The profile photos to delete| ### Return type: [Vector\_of\_long](../types/long.md) diff --git a/old_docs/API_docs_v70/methods/photos_getUserPhotos.md b/old_docs/API_docs_v70/methods/photos_getUserPhotos.md index 1a7515ba..ea27a44f 100644 --- a/old_docs/API_docs_v70/methods/photos_getUserPhotos.md +++ b/old_docs/API_docs_v70/methods/photos_getUserPhotos.md @@ -1,19 +1,21 @@ --- title: photos.getUserPhotos -description: photos.getUserPhotos parameters, return type and example +description: Get the profile photos of a user --- ## Method: photos.getUserPhotos [Back to methods index](index.md) +Get the profile photos of a user + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|offset|[CLICK ME int](../types/int.md) | Yes| -|max\_id|[CLICK ME long](../types/long.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| +|offset|[CLICK ME int](../types/int.md) | Yes|Offset| +|max\_id|[CLICK ME long](../types/long.md) | Yes|Maximum ID of photo to return| +|limit|[CLICK ME int](../types/int.md) | Yes|Number of photos to return| ### Return type: [photos\_Photos](../types/photos_Photos.md) diff --git a/old_docs/API_docs_v70/methods/photos_updateProfilePhoto.md b/old_docs/API_docs_v70/methods/photos_updateProfilePhoto.md index 28ab5fbf..7f0a4c69 100644 --- a/old_docs/API_docs_v70/methods/photos_updateProfilePhoto.md +++ b/old_docs/API_docs_v70/methods/photos_updateProfilePhoto.md @@ -1,16 +1,18 @@ --- title: photos.updateProfilePhoto -description: photos.updateProfilePhoto parameters, return type and example +description: Update the profile photo (use photos->uploadProfilePhoto to upload the photo) --- ## Method: photos.updateProfilePhoto [Back to methods index](index.md) +Update the profile photo (use photos->uploadProfilePhoto to upload the photo) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional|The photo to use| ### Return type: [UserProfilePhoto](../types/UserProfilePhoto.md) diff --git a/old_docs/API_docs_v70/methods/photos_uploadProfilePhoto.md b/old_docs/API_docs_v70/methods/photos_uploadProfilePhoto.md index 7cc9e9e5..efa08bb0 100644 --- a/old_docs/API_docs_v70/methods/photos_uploadProfilePhoto.md +++ b/old_docs/API_docs_v70/methods/photos_uploadProfilePhoto.md @@ -1,16 +1,18 @@ --- title: photos.uploadProfilePhoto -description: photos.uploadProfilePhoto parameters, return type and example +description: Upload profile photo --- ## Method: photos.uploadProfilePhoto [Back to methods index](index.md) +Upload profile photo + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|file|[File path or InputFile](../types/InputFile.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|file|[File path or InputFile](../types/InputFile.md) | Yes|The photo| ### Return type: [photos\_Photo](../types/photos_Photo.md) diff --git a/old_docs/API_docs_v70/methods/stickers_addStickerToSet.md b/old_docs/API_docs_v70/methods/stickers_addStickerToSet.md index 82a9dbd7..1f90028c 100644 --- a/old_docs/API_docs_v70/methods/stickers_addStickerToSet.md +++ b/old_docs/API_docs_v70/methods/stickers_addStickerToSet.md @@ -1,17 +1,19 @@ --- title: stickers.addStickerToSet -description: stickers.addStickerToSet parameters, return type and example +description: Add sticker to stickerset --- ## Method: stickers.addStickerToSet [Back to methods index](index.md) +Add sticker to stickerset + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional| -|sticker|[CLICK ME InputStickerSetItem](../types/InputStickerSetItem.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset| +|sticker|[CLICK ME InputStickerSetItem](../types/InputStickerSetItem.md) | Yes|The sticker| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/old_docs/API_docs_v70/methods/stickers_changeStickerPosition.md b/old_docs/API_docs_v70/methods/stickers_changeStickerPosition.md index a1a663f7..45552df9 100644 --- a/old_docs/API_docs_v70/methods/stickers_changeStickerPosition.md +++ b/old_docs/API_docs_v70/methods/stickers_changeStickerPosition.md @@ -1,17 +1,19 @@ --- title: stickers.changeStickerPosition -description: stickers.changeStickerPosition parameters, return type and example +description: Change sticker position in photo --- ## Method: stickers.changeStickerPosition [Back to methods index](index.md) +Change sticker position in photo + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|sticker|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional| -|position|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|sticker|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker| +|position|[CLICK ME int](../types/int.md) | Yes|New position| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/old_docs/API_docs_v70/methods/stickers_createStickerSet.md b/old_docs/API_docs_v70/methods/stickers_createStickerSet.md index b99874a0..c4e85852 100644 --- a/old_docs/API_docs_v70/methods/stickers_createStickerSet.md +++ b/old_docs/API_docs_v70/methods/stickers_createStickerSet.md @@ -1,20 +1,22 @@ --- title: stickers.createStickerSet -description: stickers.createStickerSet parameters, return type and example +description: Create stickerset --- ## Method: stickers.createStickerSet [Back to methods index](index.md) +Create stickerset + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|masks|[CLICK ME Bool](../types/Bool.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|title|[CLICK ME string](../types/string.md) | Yes| -|short\_name|[CLICK ME string](../types/string.md) | Yes| -|stickers|Array of [CLICK ME InputStickerSetItem](../types/InputStickerSetItem.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|masks|[CLICK ME Bool](../types/Bool.md) | Optional|Masks?| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user ID associated to this stickerset| +|title|[CLICK ME string](../types/string.md) | Yes|The stickerset title| +|short\_name|[CLICK ME string](../types/string.md) | Yes|The stickerset short name| +|stickers|Array of [CLICK ME InputStickerSetItem](../types/InputStickerSetItem.md) | Yes|The stickers to add| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/old_docs/API_docs_v70/methods/stickers_removeStickerFromSet.md b/old_docs/API_docs_v70/methods/stickers_removeStickerFromSet.md index 34f85cb0..4ae30345 100644 --- a/old_docs/API_docs_v70/methods/stickers_removeStickerFromSet.md +++ b/old_docs/API_docs_v70/methods/stickers_removeStickerFromSet.md @@ -1,16 +1,18 @@ --- title: stickers.removeStickerFromSet -description: stickers.removeStickerFromSet parameters, return type and example +description: Remove sticker from stickerset --- ## Method: stickers.removeStickerFromSet [Back to methods index](index.md) +Remove sticker from stickerset + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|sticker|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|sticker|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker to remove| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/old_docs/API_docs_v70/methods/upload_getWebFile.md b/old_docs/API_docs_v70/methods/upload_getWebFile.md index 30bd3a1f..e864e4b7 100644 --- a/old_docs/API_docs_v70/methods/upload_getWebFile.md +++ b/old_docs/API_docs_v70/methods/upload_getWebFile.md @@ -1,18 +1,20 @@ --- title: upload.getWebFile -description: upload.getWebFile parameters, return type and example +description: Download a file through telegram --- ## Method: upload.getWebFile [Back to methods index](index.md) +Download a file through telegram + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|location|[CLICK ME InputWebFileLocation](../types/InputWebFileLocation.md) | Yes| -|offset|[CLICK ME int](../types/int.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|location|[CLICK ME InputWebFileLocation](../types/InputWebFileLocation.md) | Yes|The file| +|offset|[CLICK ME int](../types/int.md) | Yes|The offset in bytes| +|limit|[CLICK ME int](../types/int.md) | Yes|The number of bytes to fetch| ### Return type: [upload\_WebFile](../types/upload_WebFile.md) diff --git a/old_docs/API_docs_v71/methods/account_registerDevice.md b/old_docs/API_docs_v71/methods/account_registerDevice.md index cd28abcd..017b9af3 100644 --- a/old_docs/API_docs_v71/methods/account_registerDevice.md +++ b/old_docs/API_docs_v71/methods/account_registerDevice.md @@ -12,8 +12,8 @@ Register device for push notifications | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and oTher, see source code of official apps for more info| +|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and oTher, see source code of official apps for more info| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v71/methods/account_unregisterDevice.md b/old_docs/API_docs_v71/methods/account_unregisterDevice.md index 1d2b7670..32e44495 100644 --- a/old_docs/API_docs_v71/methods/account_unregisterDevice.md +++ b/old_docs/API_docs_v71/methods/account_unregisterDevice.md @@ -12,8 +12,8 @@ Stop sending PUSH notifications to app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and oTher, see source code of official apps for more info| +|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and oTher, see source code of official apps for more info| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v71/methods/bots_answerWebhookJSONQuery.md b/old_docs/API_docs_v71/methods/bots_answerWebhookJSONQuery.md index 205b30f9..61056bb4 100644 --- a/old_docs/API_docs_v71/methods/bots_answerWebhookJSONQuery.md +++ b/old_docs/API_docs_v71/methods/bots_answerWebhookJSONQuery.md @@ -1,17 +1,19 @@ --- title: bots.answerWebhookJSONQuery -description: bots.answerWebhookJSONQuery parameters, return type and example +description: Send webhook request via bot API --- ## Method: bots.answerWebhookJSONQuery [Back to methods index](index.md) +Send webhook request via bot API + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|query\_id|[CLICK ME long](../types/long.md) | Yes| -|data|[CLICK ME DataJSON](../types/DataJSON.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|query\_id|[CLICK ME long](../types/long.md) | Yes|The query ID| +|data|[CLICK ME DataJSON](../types/DataJSON.md) | Yes|The parameters| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v71/methods/bots_sendCustomRequest.md b/old_docs/API_docs_v71/methods/bots_sendCustomRequest.md index 590c47b6..fc8e764d 100644 --- a/old_docs/API_docs_v71/methods/bots_sendCustomRequest.md +++ b/old_docs/API_docs_v71/methods/bots_sendCustomRequest.md @@ -1,17 +1,19 @@ --- title: bots.sendCustomRequest -description: bots.sendCustomRequest parameters, return type and example +description: Send a custom request to the bot API --- ## Method: bots.sendCustomRequest [Back to methods index](index.md) +Send a custom request to the bot API + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|custom\_method|[CLICK ME string](../types/string.md) | Yes| -|params|[CLICK ME DataJSON](../types/DataJSON.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|custom\_method|[CLICK ME string](../types/string.md) | Yes|The method to call| +|params|[CLICK ME DataJSON](../types/DataJSON.md) | Yes|Method parameters| ### Return type: [DataJSON](../types/DataJSON.md) diff --git a/old_docs/API_docs_v71/methods/channels_checkUsername.md b/old_docs/API_docs_v71/methods/channels_checkUsername.md index 371f4cd3..7bc7c245 100644 --- a/old_docs/API_docs_v71/methods/channels_checkUsername.md +++ b/old_docs/API_docs_v71/methods/channels_checkUsername.md @@ -1,17 +1,19 @@ --- title: channels.checkUsername -description: channels.checkUsername parameters, return type and example +description: Check if this username is free and can be assigned to a channel/supergroup --- ## Method: channels.checkUsername [Back to methods index](index.md) +Check if this username is free and can be assigned to a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|username|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|username|[CLICK ME string](../types/string.md) | Yes|The new username for this channel/supergroup| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v71/methods/channels_createChannel.md b/old_docs/API_docs_v71/methods/channels_createChannel.md index c5d21585..1305e4fb 100644 --- a/old_docs/API_docs_v71/methods/channels_createChannel.md +++ b/old_docs/API_docs_v71/methods/channels_createChannel.md @@ -1,19 +1,21 @@ --- title: channels.createChannel -description: channels.createChannel parameters, return type and example +description: Create channel/supergroup --- ## Method: channels.createChannel [Back to methods index](index.md) +Create channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|broadcast|[CLICK ME Bool](../types/Bool.md) | Optional| -|megagroup|[CLICK ME Bool](../types/Bool.md) | Optional| -|title|[CLICK ME string](../types/string.md) | Yes| -|about|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|broadcast|[CLICK ME Bool](../types/Bool.md) | Optional|Set this to true to create a channel| +|megagroup|[CLICK ME Bool](../types/Bool.md) | Optional|Set this to true to create a supergroup| +|title|[CLICK ME string](../types/string.md) | Yes|Supergroup/channel title| +|about|[CLICK ME string](../types/string.md) | Yes|About text| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v71/methods/channels_deleteChannel.md b/old_docs/API_docs_v71/methods/channels_deleteChannel.md index 61b29eac..e660d25c 100644 --- a/old_docs/API_docs_v71/methods/channels_deleteChannel.md +++ b/old_docs/API_docs_v71/methods/channels_deleteChannel.md @@ -1,16 +1,18 @@ --- title: channels.deleteChannel -description: channels.deleteChannel parameters, return type and example +description: Delete a channel/supergroup --- ## Method: channels.deleteChannel [Back to methods index](index.md) +Delete a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup to delete| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v71/methods/channels_deleteMessages.md b/old_docs/API_docs_v71/methods/channels_deleteMessages.md index 87a968c5..fb9d3cc2 100644 --- a/old_docs/API_docs_v71/methods/channels_deleteMessages.md +++ b/old_docs/API_docs_v71/methods/channels_deleteMessages.md @@ -1,17 +1,19 @@ --- title: channels.deleteMessages -description: channels.deleteMessages parameters, return type and example +description: Delete channel/supergroup messages --- ## Method: channels.deleteMessages [Back to methods index](index.md) +Delete channel/supergroup messages + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|id|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to delete| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v71/methods/channels_deleteUserHistory.md b/old_docs/API_docs_v71/methods/channels_deleteUserHistory.md index ee828f45..fbe34341 100644 --- a/old_docs/API_docs_v71/methods/channels_deleteUserHistory.md +++ b/old_docs/API_docs_v71/methods/channels_deleteUserHistory.md @@ -1,17 +1,19 @@ --- title: channels.deleteUserHistory -description: channels.deleteUserHistory parameters, return type and example +description: Delete all messages of a user in a channel/supergroup --- ## Method: channels.deleteUserHistory [Back to methods index](index.md) +Delete all messages of a user in a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) diff --git a/old_docs/API_docs_v71/methods/channels_editAbout.md b/old_docs/API_docs_v71/methods/channels_editAbout.md index 94be2503..8908f29e 100644 --- a/old_docs/API_docs_v71/methods/channels_editAbout.md +++ b/old_docs/API_docs_v71/methods/channels_editAbout.md @@ -1,17 +1,19 @@ --- title: channels.editAbout -description: channels.editAbout parameters, return type and example +description: Edit the about text of a channel/supergroup --- ## Method: channels.editAbout [Back to methods index](index.md) +Edit the about text of a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|about|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|about|[CLICK ME string](../types/string.md) | Yes|The new about text| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v71/methods/channels_editAdmin.md b/old_docs/API_docs_v71/methods/channels_editAdmin.md index 08707ff4..dcec7d2f 100644 --- a/old_docs/API_docs_v71/methods/channels_editAdmin.md +++ b/old_docs/API_docs_v71/methods/channels_editAdmin.md @@ -1,18 +1,20 @@ --- title: channels.editAdmin -description: channels.editAdmin parameters, return type and example +description: Edit admin permissions of a user in a channel/supergroup --- ## Method: channels.editAdmin [Back to methods index](index.md) +Edit admin permissions of a user in a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|admin\_rights|[CLICK ME ChannelAdminRights](../types/ChannelAdminRights.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| +|admin\_rights|[CLICK ME ChannelAdminRights](../types/ChannelAdminRights.md) | Yes|The new admin rights| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v71/methods/channels_editBanned.md b/old_docs/API_docs_v71/methods/channels_editBanned.md index 1d896393..9859bcae 100644 --- a/old_docs/API_docs_v71/methods/channels_editBanned.md +++ b/old_docs/API_docs_v71/methods/channels_editBanned.md @@ -1,18 +1,20 @@ --- title: channels.editBanned -description: channels.editBanned parameters, return type and example +description: Kick or ban a user from a channel/supergroup --- ## Method: channels.editBanned [Back to methods index](index.md) +Kick or ban a user from a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|banned\_rights|[CLICK ME ChannelBannedRights](../types/ChannelBannedRights.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to kick/ban| +|banned\_rights|[CLICK ME ChannelBannedRights](../types/ChannelBannedRights.md) | Yes|Banned/kicked permissions| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v71/methods/channels_editPhoto.md b/old_docs/API_docs_v71/methods/channels_editPhoto.md index 3a2c794b..9ccd864f 100644 --- a/old_docs/API_docs_v71/methods/channels_editPhoto.md +++ b/old_docs/API_docs_v71/methods/channels_editPhoto.md @@ -1,17 +1,19 @@ --- title: channels.editPhoto -description: channels.editPhoto parameters, return type and example +description: Edit the photo of a supergroup/channel --- ## Method: channels.editPhoto [Back to methods index](index.md) +Edit the photo of a supergroup/channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new photo| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v71/methods/channels_editTitle.md b/old_docs/API_docs_v71/methods/channels_editTitle.md index ec60e10f..b1024faf 100644 --- a/old_docs/API_docs_v71/methods/channels_editTitle.md +++ b/old_docs/API_docs_v71/methods/channels_editTitle.md @@ -1,17 +1,19 @@ --- title: channels.editTitle -description: channels.editTitle parameters, return type and example +description: Edit the title of a supergroup/channel --- ## Method: channels.editTitle [Back to methods index](index.md) +Edit the title of a supergroup/channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|title|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|title|[CLICK ME string](../types/string.md) | Yes|The new channel/supergroup title| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v71/methods/channels_exportInvite.md b/old_docs/API_docs_v71/methods/channels_exportInvite.md index 3c10f832..f0c737d5 100644 --- a/old_docs/API_docs_v71/methods/channels_exportInvite.md +++ b/old_docs/API_docs_v71/methods/channels_exportInvite.md @@ -1,16 +1,18 @@ --- title: channels.exportInvite -description: channels.exportInvite parameters, return type and example +description: Export the invite link of a channel --- ## Method: channels.exportInvite [Back to methods index](index.md) +Export the invite link of a channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| ### Return type: [ExportedChatInvite](../types/ExportedChatInvite.md) diff --git a/old_docs/API_docs_v71/methods/channels_exportMessageLink.md b/old_docs/API_docs_v71/methods/channels_exportMessageLink.md index 924dc0d5..f910b594 100644 --- a/old_docs/API_docs_v71/methods/channels_exportMessageLink.md +++ b/old_docs/API_docs_v71/methods/channels_exportMessageLink.md @@ -1,17 +1,19 @@ --- title: channels.exportMessageLink -description: channels.exportMessageLink parameters, return type and example +description: Get the link of a message in a channel --- ## Method: channels.exportMessageLink [Back to methods index](index.md) +Get the link of a message in a channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|id|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|id|[CLICK ME int](../types/int.md) | Yes|The ID of the message| ### Return type: [ExportedMessageLink](../types/ExportedMessageLink.md) diff --git a/old_docs/API_docs_v71/methods/channels_getAdminLog.md b/old_docs/API_docs_v71/methods/channels_getAdminLog.md index 0585e157..5c1b805e 100644 --- a/old_docs/API_docs_v71/methods/channels_getAdminLog.md +++ b/old_docs/API_docs_v71/methods/channels_getAdminLog.md @@ -1,22 +1,24 @@ --- title: channels.getAdminLog -description: channels.getAdminLog parameters, return type and example +description: Get admin log of a channel/supergruop --- ## Method: channels.getAdminLog [Back to methods index](index.md) +Get admin log of a channel/supergruop + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|q|[CLICK ME string](../types/string.md) | Yes| -|events\_filter|[CLICK ME ChannelAdminLogEventsFilter](../types/ChannelAdminLogEventsFilter.md) | Optional| -|admins|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|max\_id|[CLICK ME long](../types/long.md) | Yes| -|min\_id|[CLICK ME long](../types/long.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|q|[CLICK ME string](../types/string.md) | Yes|Search query| +|events\_filter|[CLICK ME ChannelAdminLogEventsFilter](../types/ChannelAdminLogEventsFilter.md) | Optional|Event filter| +|admins|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|Fetch only actions from these admins| +|max\_id|[CLICK ME long](../types/long.md) | Yes|Maximum message ID to fetch| +|min\_id|[CLICK ME long](../types/long.md) | Yes|Minimum message ID to fetch| +|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to fetch| ### Return type: [channels\_AdminLogResults](../types/channels_AdminLogResults.md) diff --git a/old_docs/API_docs_v71/methods/channels_getAdminedPublicChannels.md b/old_docs/API_docs_v71/methods/channels_getAdminedPublicChannels.md index f2b48050..9646f529 100644 --- a/old_docs/API_docs_v71/methods/channels_getAdminedPublicChannels.md +++ b/old_docs/API_docs_v71/methods/channels_getAdminedPublicChannels.md @@ -1,11 +1,13 @@ --- title: channels.getAdminedPublicChannels -description: channels.getAdminedPublicChannels parameters, return type and example +description: Get all supergroups/channels where you're admin --- ## Method: channels.getAdminedPublicChannels [Back to methods index](index.md) +Get all supergroups/channels where you're admin + ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v71/methods/channels_getChannels.md b/old_docs/API_docs_v71/methods/channels_getChannels.md index bd5958d6..9cd9e798 100644 --- a/old_docs/API_docs_v71/methods/channels_getChannels.md +++ b/old_docs/API_docs_v71/methods/channels_getChannels.md @@ -1,16 +1,18 @@ --- title: channels.getChannels -description: channels.getChannels parameters, return type and example +description: Get info about multiple channels/supergroups --- ## Method: channels.getChannels [Back to methods index](index.md) +Get info about multiple channels/supergroups + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|Array of [Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|Array of [Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Yes|The channel/supergroup MTProto IDs| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v71/methods/channels_getMessages.md b/old_docs/API_docs_v71/methods/channels_getMessages.md index 4440856c..cc944fe5 100644 --- a/old_docs/API_docs_v71/methods/channels_getMessages.md +++ b/old_docs/API_docs_v71/methods/channels_getMessages.md @@ -1,17 +1,19 @@ --- title: channels.getMessages -description: channels.getMessages parameters, return type and example +description: Get channel/supergroup messages --- ## Method: channels.getMessages [Back to methods index](index.md) +Get channel/supergroup messages + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|id|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The message IDs| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v71/methods/channels_getParticipant.md b/old_docs/API_docs_v71/methods/channels_getParticipant.md index c1819b6b..db9b1fc6 100644 --- a/old_docs/API_docs_v71/methods/channels_getParticipant.md +++ b/old_docs/API_docs_v71/methods/channels_getParticipant.md @@ -1,17 +1,19 @@ --- title: channels.getParticipant -description: channels.getParticipant parameters, return type and example +description: Get info about a certain channel/supergroup participant --- ## Method: channels.getParticipant [Back to methods index](index.md) +Get info about a certain channel/supergroup participant + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to fetch info about| ### Return type: [channels\_ChannelParticipant](../types/channels_ChannelParticipant.md) diff --git a/old_docs/API_docs_v71/methods/channels_getParticipants.md b/old_docs/API_docs_v71/methods/channels_getParticipants.md index 7ec8a980..96662466 100644 --- a/old_docs/API_docs_v71/methods/channels_getParticipants.md +++ b/old_docs/API_docs_v71/methods/channels_getParticipants.md @@ -1,19 +1,21 @@ --- title: channels.getParticipants -description: channels.getParticipants parameters, return type and example +description: Get channel/supergroup participants (you should use `$MadelineProto->get_pwr_chat($id)` instead) --- ## Method: channels.getParticipants [Back to methods index](index.md) +Get channel/supergroup participants (you should use `$MadelineProto->get_pwr_chat($id)` instead) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|filter|[CLICK ME ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) | Yes| -|offset|[CLICK ME int](../types/int.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|filter|[CLICK ME ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) | Yes|Member filter| +|offset|[CLICK ME int](../types/int.md) | Yes|Offset| +|limit|[CLICK ME int](../types/int.md) | Yes|Limit| ### Return type: [channels\_ChannelParticipants](../types/channels_ChannelParticipants.md) diff --git a/old_docs/API_docs_v71/methods/channels_inviteToChannel.md b/old_docs/API_docs_v71/methods/channels_inviteToChannel.md index 9bca2967..676f800c 100644 --- a/old_docs/API_docs_v71/methods/channels_inviteToChannel.md +++ b/old_docs/API_docs_v71/methods/channels_inviteToChannel.md @@ -1,17 +1,19 @@ --- title: channels.inviteToChannel -description: channels.inviteToChannel parameters, return type and example +description: Add users to channel/supergroup --- ## Method: channels.inviteToChannel [Back to methods index](index.md) +Add users to channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to add| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v71/methods/channels_joinChannel.md b/old_docs/API_docs_v71/methods/channels_joinChannel.md index 9ecdbe75..721f707c 100644 --- a/old_docs/API_docs_v71/methods/channels_joinChannel.md +++ b/old_docs/API_docs_v71/methods/channels_joinChannel.md @@ -1,16 +1,18 @@ --- title: channels.joinChannel -description: channels.joinChannel parameters, return type and example +description: Join a channel/supergroup --- ## Method: channels.joinChannel [Back to methods index](index.md) +Join a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup to join| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v71/methods/channels_leaveChannel.md b/old_docs/API_docs_v71/methods/channels_leaveChannel.md index 62c20a00..7f02e08c 100644 --- a/old_docs/API_docs_v71/methods/channels_leaveChannel.md +++ b/old_docs/API_docs_v71/methods/channels_leaveChannel.md @@ -1,16 +1,18 @@ --- title: channels.leaveChannel -description: channels.leaveChannel parameters, return type and example +description: Leave a channel/supergroup --- ## Method: channels.leaveChannel [Back to methods index](index.md) +Leave a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup to leave| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v71/methods/channels_readHistory.md b/old_docs/API_docs_v71/methods/channels_readHistory.md index 745893f6..cca891f0 100644 --- a/old_docs/API_docs_v71/methods/channels_readHistory.md +++ b/old_docs/API_docs_v71/methods/channels_readHistory.md @@ -1,17 +1,19 @@ --- title: channels.readHistory -description: channels.readHistory parameters, return type and example +description: Mark channel/supergroup history as read --- ## Method: channels.readHistory [Back to methods index](index.md) +Mark channel/supergroup history as read + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|max\_id|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to mark as read| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v71/methods/channels_readMessageContents.md b/old_docs/API_docs_v71/methods/channels_readMessageContents.md index 8d1d6891..861844c4 100644 --- a/old_docs/API_docs_v71/methods/channels_readMessageContents.md +++ b/old_docs/API_docs_v71/methods/channels_readMessageContents.md @@ -1,17 +1,19 @@ --- title: channels.readMessageContents -description: channels.readMessageContents parameters, return type and example +description: Mark channel/supergroup messages as read --- ## Method: channels.readMessageContents [Back to methods index](index.md) +Mark channel/supergroup messages as read + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|id|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|id|Array of [CLICK ME int](../types/int.md) | Yes|List of message IDs| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v71/methods/channels_reportSpam.md b/old_docs/API_docs_v71/methods/channels_reportSpam.md index 47dd7cff..09af14e0 100644 --- a/old_docs/API_docs_v71/methods/channels_reportSpam.md +++ b/old_docs/API_docs_v71/methods/channels_reportSpam.md @@ -1,18 +1,20 @@ --- title: channels.reportSpam -description: channels.reportSpam parameters, return type and example +description: Report a supergroup/channel for spam --- ## Method: channels.reportSpam [Back to methods index](index.md) +Report a supergroup/channel for spam + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|id|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that added you to this channel| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to report| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v71/methods/channels_setStickers.md b/old_docs/API_docs_v71/methods/channels_setStickers.md index 1b900e48..9ed5bd55 100644 --- a/old_docs/API_docs_v71/methods/channels_setStickers.md +++ b/old_docs/API_docs_v71/methods/channels_setStickers.md @@ -1,17 +1,19 @@ --- title: channels.setStickers -description: channels.setStickers parameters, return type and example +description: Set the supergroup/channel stickerpack --- ## Method: channels.setStickers [Back to methods index](index.md) +Set the supergroup/channel stickerpack + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergoup| +|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v71/methods/channels_toggleInvites.md b/old_docs/API_docs_v71/methods/channels_toggleInvites.md index b6771ed3..5b541f67 100644 --- a/old_docs/API_docs_v71/methods/channels_toggleInvites.md +++ b/old_docs/API_docs_v71/methods/channels_toggleInvites.md @@ -1,17 +1,19 @@ --- title: channels.toggleInvites -description: channels.toggleInvites parameters, return type and example +description: Allow or disallow any user to invite users to this channel/supergroup --- ## Method: channels.toggleInvites [Back to methods index](index.md) +Allow or disallow any user to invite users to this channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Allow or disallow| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v71/methods/channels_toggleSignatures.md b/old_docs/API_docs_v71/methods/channels_toggleSignatures.md index e8ff70a8..f233a8e1 100644 --- a/old_docs/API_docs_v71/methods/channels_toggleSignatures.md +++ b/old_docs/API_docs_v71/methods/channels_toggleSignatures.md @@ -1,17 +1,19 @@ --- title: channels.toggleSignatures -description: channels.toggleSignatures parameters, return type and example +description: Toggle channel signatures --- ## Method: channels.toggleSignatures [Back to methods index](index.md) +Toggle channel signatures + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Enable or disable channel signatures?| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v71/methods/channels_updatePinnedMessage.md b/old_docs/API_docs_v71/methods/channels_updatePinnedMessage.md index 7a14b68b..f06d1f0f 100644 --- a/old_docs/API_docs_v71/methods/channels_updatePinnedMessage.md +++ b/old_docs/API_docs_v71/methods/channels_updatePinnedMessage.md @@ -1,18 +1,20 @@ --- title: channels.updatePinnedMessage -description: channels.updatePinnedMessage parameters, return type and example +description: Set the pinned message of a channel/supergroup --- ## Method: channels.updatePinnedMessage [Back to methods index](index.md) +Set the pinned message of a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|id|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Pin silently| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|id|[CLICK ME int](../types/int.md) | Yes|The ID of the message to pin| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v71/methods/channels_updateUsername.md b/old_docs/API_docs_v71/methods/channels_updateUsername.md index 19647598..ad34490a 100644 --- a/old_docs/API_docs_v71/methods/channels_updateUsername.md +++ b/old_docs/API_docs_v71/methods/channels_updateUsername.md @@ -1,17 +1,19 @@ --- title: channels.updateUsername -description: channels.updateUsername parameters, return type and example +description: Update the username of a supergroup/channel --- ## Method: channels.updateUsername [Back to methods index](index.md) +Update the username of a supergroup/channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|username|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|username|[CLICK ME string](../types/string.md) | Yes|The new username| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v71/methods/contacts_getBlocked.md b/old_docs/API_docs_v71/methods/contacts_getBlocked.md index d7d8c5cc..300025af 100644 --- a/old_docs/API_docs_v71/methods/contacts_getBlocked.md +++ b/old_docs/API_docs_v71/methods/contacts_getBlocked.md @@ -12,7 +12,7 @@ Get blocked users | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, then set to the number of blocked contacts previously fetched| +|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, Then set to the number of blocked contacts previously fetched| |limit|[CLICK ME int](../types/int.md) | Yes|How many blocked contacts to fetch| diff --git a/old_docs/API_docs_v71/methods/contacts_getTopPeers.md b/old_docs/API_docs_v71/methods/contacts_getTopPeers.md index 226d3aa0..d7b21757 100644 --- a/old_docs/API_docs_v71/methods/contacts_getTopPeers.md +++ b/old_docs/API_docs_v71/methods/contacts_getTopPeers.md @@ -18,7 +18,7 @@ Get most used chats |phone\_calls|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch phone calls?| |groups|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch groups?| |channels|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch channels and supergroups?| -|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, then `$offset += $contacts_TopPeers['categories']['count'];`| +|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, Then `$offset += $contacts_TopPeers['categories']['count'];`| |limit|[CLICK ME int](../types/int.md) | Yes|How many results to fetch| |hash|[CLICK ME int](../types/int.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched peer ids);| diff --git a/old_docs/API_docs_v71/methods/help_getAppChangelog.md b/old_docs/API_docs_v71/methods/help_getAppChangelog.md index ea7192f6..477df2f8 100644 --- a/old_docs/API_docs_v71/methods/help_getAppChangelog.md +++ b/old_docs/API_docs_v71/methods/help_getAppChangelog.md @@ -1,16 +1,18 @@ --- title: help.getAppChangelog -description: help.getAppChangelog parameters, return type and example +description: Get the changelog of this app --- ## Method: help.getAppChangelog [Back to methods index](index.md) +Get the changelog of this app + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|prev\_app\_version|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|prev\_app\_version|[CLICK ME string](../types/string.md) | Yes|Previous app version| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v71/methods/help_getAppUpdate.md b/old_docs/API_docs_v71/methods/help_getAppUpdate.md index ef72cce2..b88906ae 100644 --- a/old_docs/API_docs_v71/methods/help_getAppUpdate.md +++ b/old_docs/API_docs_v71/methods/help_getAppUpdate.md @@ -1,11 +1,13 @@ --- title: help.getAppUpdate -description: help.getAppUpdate parameters, return type and example +description: Get info about app updates --- ## Method: help.getAppUpdate [Back to methods index](index.md) +Get info about app updates + ### Return type: [help\_AppUpdate](../types/help_AppUpdate.md) diff --git a/old_docs/API_docs_v71/methods/help_getCdnConfig.md b/old_docs/API_docs_v71/methods/help_getCdnConfig.md index 55a6e6fd..809ea1fb 100644 --- a/old_docs/API_docs_v71/methods/help_getCdnConfig.md +++ b/old_docs/API_docs_v71/methods/help_getCdnConfig.md @@ -1,11 +1,13 @@ --- title: help.getCdnConfig -description: help.getCdnConfig parameters, return type and example +description: Get CDN configuration --- ## Method: help.getCdnConfig [Back to methods index](index.md) +Get CDN configuration + ### Return type: [CdnConfig](../types/CdnConfig.md) diff --git a/old_docs/API_docs_v71/methods/help_getConfig.md b/old_docs/API_docs_v71/methods/help_getConfig.md index 885ad5d3..16e25c68 100644 --- a/old_docs/API_docs_v71/methods/help_getConfig.md +++ b/old_docs/API_docs_v71/methods/help_getConfig.md @@ -1,11 +1,13 @@ --- title: help.getConfig -description: help.getConfig parameters, return type and example +description: Get server configuration --- ## Method: help.getConfig [Back to methods index](index.md) +Get server configuration + ### Return type: [Config](../types/Config.md) diff --git a/old_docs/API_docs_v71/methods/help_getInviteText.md b/old_docs/API_docs_v71/methods/help_getInviteText.md index 101ead40..6b226bff 100644 --- a/old_docs/API_docs_v71/methods/help_getInviteText.md +++ b/old_docs/API_docs_v71/methods/help_getInviteText.md @@ -1,11 +1,13 @@ --- title: help.getInviteText -description: help.getInviteText parameters, return type and example +description: Get invitation text --- ## Method: help.getInviteText [Back to methods index](index.md) +Get invitation text + ### Return type: [help\_InviteText](../types/help_InviteText.md) diff --git a/old_docs/API_docs_v71/methods/help_getNearestDc.md b/old_docs/API_docs_v71/methods/help_getNearestDc.md index 6196890b..35a8bf91 100644 --- a/old_docs/API_docs_v71/methods/help_getNearestDc.md +++ b/old_docs/API_docs_v71/methods/help_getNearestDc.md @@ -1,11 +1,13 @@ --- title: help.getNearestDc -description: help.getNearestDc parameters, return type and example +description: Get nearest datacenter --- ## Method: help.getNearestDc [Back to methods index](index.md) +Get nearest datacenter + ### Return type: [NearestDc](../types/NearestDc.md) diff --git a/old_docs/API_docs_v71/methods/help_getSupport.md b/old_docs/API_docs_v71/methods/help_getSupport.md index 9b269f78..a5bab0f2 100644 --- a/old_docs/API_docs_v71/methods/help_getSupport.md +++ b/old_docs/API_docs_v71/methods/help_getSupport.md @@ -1,11 +1,13 @@ --- title: help.getSupport -description: help.getSupport parameters, return type and example +description: Get info of support user --- ## Method: help.getSupport [Back to methods index](index.md) +Get info of support user + ### Return type: [help\_Support](../types/help_Support.md) diff --git a/old_docs/API_docs_v71/methods/help_getTermsOfService.md b/old_docs/API_docs_v71/methods/help_getTermsOfService.md index f63807ab..487cd83a 100644 --- a/old_docs/API_docs_v71/methods/help_getTermsOfService.md +++ b/old_docs/API_docs_v71/methods/help_getTermsOfService.md @@ -1,11 +1,13 @@ --- title: help.getTermsOfService -description: help.getTermsOfService parameters, return type and example +description: Get terms of service --- ## Method: help.getTermsOfService [Back to methods index](index.md) +Get terms of service + ### Return type: [help\_TermsOfService](../types/help_TermsOfService.md) diff --git a/old_docs/API_docs_v71/methods/help_saveAppLog.md b/old_docs/API_docs_v71/methods/help_saveAppLog.md index af6e94e2..0165b6e3 100644 --- a/old_docs/API_docs_v71/methods/help_saveAppLog.md +++ b/old_docs/API_docs_v71/methods/help_saveAppLog.md @@ -1,16 +1,18 @@ --- title: help.saveAppLog -description: help.saveAppLog parameters, return type and example +description: Log data for developer of this app --- ## Method: help.saveAppLog [Back to methods index](index.md) +Log data for developer of this app + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|events|Array of [CLICK ME InputAppEvent](../types/InputAppEvent.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|events|Array of [CLICK ME InputAppEvent](../types/InputAppEvent.md) | Yes|Event list| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v71/methods/help_setBotUpdatesStatus.md b/old_docs/API_docs_v71/methods/help_setBotUpdatesStatus.md index 3351fab4..ff314b5c 100644 --- a/old_docs/API_docs_v71/methods/help_setBotUpdatesStatus.md +++ b/old_docs/API_docs_v71/methods/help_setBotUpdatesStatus.md @@ -1,17 +1,19 @@ --- title: help.setBotUpdatesStatus -description: help.setBotUpdatesStatus parameters, return type and example +description: Set the update status of webhook --- ## Method: help.setBotUpdatesStatus [Back to methods index](index.md) +Set the update status of webhook + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|pending\_updates\_count|[CLICK ME int](../types/int.md) | Yes| -|message|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|pending\_updates\_count|[CLICK ME int](../types/int.md) | Yes|Pending update count| +|message|[CLICK ME string](../types/string.md) | Yes|Message| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v71/methods/messages_checkChatInvite.md b/old_docs/API_docs_v71/methods/messages_checkChatInvite.md index 4ddf5084..de1d9ff4 100644 --- a/old_docs/API_docs_v71/methods/messages_checkChatInvite.md +++ b/old_docs/API_docs_v71/methods/messages_checkChatInvite.md @@ -1,16 +1,18 @@ --- title: messages.checkChatInvite -description: messages.checkChatInvite parameters, return type and example +description: Check if an invitation link is valid --- ## Method: messages.checkChatInvite [Back to methods index](index.md) +Check if an invitation link is valid + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| ### Return type: [ChatInvite](../types/ChatInvite.md) diff --git a/old_docs/API_docs_v71/methods/messages_clearRecentStickers.md b/old_docs/API_docs_v71/methods/messages_clearRecentStickers.md index f017087f..9c1b3754 100644 --- a/old_docs/API_docs_v71/methods/messages_clearRecentStickers.md +++ b/old_docs/API_docs_v71/methods/messages_clearRecentStickers.md @@ -1,16 +1,18 @@ --- title: messages.clearRecentStickers -description: messages.clearRecentStickers parameters, return type and example +description: Clear all recent stickers --- ## Method: messages.clearRecentStickers [Back to methods index](index.md) +Clear all recent stickers + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|attached|[CLICK ME Bool](../types/Bool.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|attached|[CLICK ME Bool](../types/Bool.md) | Optional|Clear recent stickers attached to images?| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v71/methods/messages_deleteChatUser.md b/old_docs/API_docs_v71/methods/messages_deleteChatUser.md index a71f4aaf..0a6830de 100644 --- a/old_docs/API_docs_v71/methods/messages_deleteChatUser.md +++ b/old_docs/API_docs_v71/methods/messages_deleteChatUser.md @@ -12,7 +12,7 @@ Delete a user from a chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The MTProto ID of the chat| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to delete (pass @me to leave the chat)| diff --git a/old_docs/API_docs_v71/methods/messages_editChatAdmin.md b/old_docs/API_docs_v71/methods/messages_editChatAdmin.md index 6bc8f9ae..7916f8b1 100644 --- a/old_docs/API_docs_v71/methods/messages_editChatAdmin.md +++ b/old_docs/API_docs_v71/methods/messages_editChatAdmin.md @@ -1,18 +1,20 @@ --- title: messages.editChatAdmin -description: messages.editChatAdmin parameters, return type and example +description: Edit admin permissions --- ## Method: messages.editChatAdmin [Back to methods index](index.md) +Edit admin permissions + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|is\_admin|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat ID (no supergroups)| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user ID| +|is\_admin|[CLICK ME Bool](../types/Bool.md) | Yes|Should the user be admin?| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v71/methods/messages_editChatPhoto.md b/old_docs/API_docs_v71/methods/messages_editChatPhoto.md index 8848eca7..122913c4 100644 --- a/old_docs/API_docs_v71/methods/messages_editChatPhoto.md +++ b/old_docs/API_docs_v71/methods/messages_editChatPhoto.md @@ -12,7 +12,7 @@ Edit the photo of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The MTProto ID of the chat| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| |photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| diff --git a/old_docs/API_docs_v71/methods/messages_editChatTitle.md b/old_docs/API_docs_v71/methods/messages_editChatTitle.md index 1c1c7a16..3a1e974b 100644 --- a/old_docs/API_docs_v71/methods/messages_editChatTitle.md +++ b/old_docs/API_docs_v71/methods/messages_editChatTitle.md @@ -12,7 +12,7 @@ Edit the title of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The MTProto ID of the chat| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| |title|[CLICK ME string](../types/string.md) | Yes|The new title| diff --git a/old_docs/API_docs_v71/methods/messages_editInlineBotMessage.md b/old_docs/API_docs_v71/methods/messages_editInlineBotMessage.md index c0d06614..2237fb20 100644 --- a/old_docs/API_docs_v71/methods/messages_editInlineBotMessage.md +++ b/old_docs/API_docs_v71/methods/messages_editInlineBotMessage.md @@ -1,20 +1,22 @@ --- title: messages.editInlineBotMessage -description: messages.editInlineBotMessage parameters, return type and example +description: Edit a sent inline message --- ## Method: messages.editInlineBotMessage [Back to methods index](index.md) +Edit a sent inline message + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional| -|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes| -|message|[CLICK ME string](../types/string.md) | Optional| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview| +|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The message ID| +|message|[CLICK ME string](../types/string.md) | Optional|The new message| +|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| +|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/old_docs/API_docs_v71/methods/messages_editMessage.md b/old_docs/API_docs_v71/methods/messages_editMessage.md index 2e98318d..177438a5 100644 --- a/old_docs/API_docs_v71/methods/messages_editMessage.md +++ b/old_docs/API_docs_v71/methods/messages_editMessage.md @@ -1,21 +1,23 @@ --- title: messages.editMessage -description: messages.editMessage parameters, return type and example +description: Edit a message --- ## Method: messages.editMessage [Back to methods index](index.md) +Edit a message + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|id|[CLICK ME int](../types/int.md) | Yes| -|message|[CLICK ME string](../types/string.md) | Optional| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| +|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|message|[CLICK ME string](../types/string.md) | Optional|The new message| +|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| +|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/old_docs/API_docs_v71/methods/messages_exportChatInvite.md b/old_docs/API_docs_v71/methods/messages_exportChatInvite.md index 74d70c21..98685d96 100644 --- a/old_docs/API_docs_v71/methods/messages_exportChatInvite.md +++ b/old_docs/API_docs_v71/methods/messages_exportChatInvite.md @@ -1,16 +1,18 @@ --- title: messages.exportChatInvite -description: messages.exportChatInvite parameters, return type and example +description: Export chat invite --- ## Method: messages.exportChatInvite [Back to methods index](index.md) +Export chat invite + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat id | ### Return type: [ExportedChatInvite](../types/ExportedChatInvite.md) diff --git a/old_docs/API_docs_v71/methods/messages_faveSticker.md b/old_docs/API_docs_v71/methods/messages_faveSticker.md index b9d9a033..c1ffb16a 100644 --- a/old_docs/API_docs_v71/methods/messages_faveSticker.md +++ b/old_docs/API_docs_v71/methods/messages_faveSticker.md @@ -1,17 +1,19 @@ --- title: messages.faveSticker -description: messages.faveSticker parameters, return type and example +description: Add a sticker to favorites --- ## Method: messages.faveSticker [Back to methods index](index.md) +Add a sticker to favorites + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional| -|unfave|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker to add to favorites| +|unfave|[CLICK ME Bool](../types/Bool.md) | Yes|Remove it from favorites?| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v71/methods/messages_getAllChats.md b/old_docs/API_docs_v71/methods/messages_getAllChats.md index 4b87df49..127456e4 100644 --- a/old_docs/API_docs_v71/methods/messages_getAllChats.md +++ b/old_docs/API_docs_v71/methods/messages_getAllChats.md @@ -1,16 +1,18 @@ --- title: messages.getAllChats -description: messages.getAllChats parameters, return type and example +description: Get all chats (not supergroups or channels) --- ## Method: messages.getAllChats [Back to methods index](index.md) +Get all chats (not supergroups or channels) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|except\_ids|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|except\_ids|Array of [CLICK ME int](../types/int.md) | Yes|Do not fetch these chats (MTProto id)| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v71/methods/messages_getAllDrafts.md b/old_docs/API_docs_v71/methods/messages_getAllDrafts.md index a5dd59f6..2c0ecd42 100644 --- a/old_docs/API_docs_v71/methods/messages_getAllDrafts.md +++ b/old_docs/API_docs_v71/methods/messages_getAllDrafts.md @@ -1,11 +1,13 @@ --- title: messages.getAllDrafts -description: messages.getAllDrafts parameters, return type and example +description: Get all message drafts --- ## Method: messages.getAllDrafts [Back to methods index](index.md) +Get all message drafts + ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v71/methods/messages_getAllStickers.md b/old_docs/API_docs_v71/methods/messages_getAllStickers.md index 575fcd49..16fdba6c 100644 --- a/old_docs/API_docs_v71/methods/messages_getAllStickers.md +++ b/old_docs/API_docs_v71/methods/messages_getAllStickers.md @@ -1,16 +1,18 @@ --- title: messages.getAllStickers -description: messages.getAllStickers parameters, return type and example +description: Get all stickerpacks --- ## Method: messages.getAllStickers [Back to methods index](index.md) +Get all stickerpacks + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v71/methods/messages_getArchivedStickers.md b/old_docs/API_docs_v71/methods/messages_getArchivedStickers.md index 1b4aaa93..f037e1bc 100644 --- a/old_docs/API_docs_v71/methods/messages_getArchivedStickers.md +++ b/old_docs/API_docs_v71/methods/messages_getArchivedStickers.md @@ -1,18 +1,20 @@ --- title: messages.getArchivedStickers -description: messages.getArchivedStickers parameters, return type and example +description: Get all archived stickers --- ## Method: messages.getArchivedStickers [Back to methods index](index.md) +Get all archived stickers + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|masks|[CLICK ME Bool](../types/Bool.md) | Optional| -|offset\_id|[CLICK ME long](../types/long.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|masks|[CLICK ME Bool](../types/Bool.md) | Optional|Get masks?| +|offset\_id|[CLICK ME long](../types/long.md) | Yes|Sticker ID offset| +|limit|[CLICK ME int](../types/int.md) | Yes|Number of stickers to fetch| ### Return type: [messages\_ArchivedStickers](../types/messages_ArchivedStickers.md) diff --git a/old_docs/API_docs_v71/methods/messages_getAttachedStickers.md b/old_docs/API_docs_v71/methods/messages_getAttachedStickers.md index a0d89b31..890680cd 100644 --- a/old_docs/API_docs_v71/methods/messages_getAttachedStickers.md +++ b/old_docs/API_docs_v71/methods/messages_getAttachedStickers.md @@ -1,16 +1,18 @@ --- title: messages.getAttachedStickers -description: messages.getAttachedStickers parameters, return type and example +description: Get stickers attachable to images --- ## Method: messages.getAttachedStickers [Back to methods index](index.md) +Get stickers attachable to images + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|media|[CLICK ME InputStickeredMedia](../types/InputStickeredMedia.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|media|[CLICK ME InputStickeredMedia](../types/InputStickeredMedia.md) | Yes|The stickered media| ### Return type: [Vector\_of\_StickerSetCovered](../types/StickerSetCovered.md) diff --git a/old_docs/API_docs_v71/methods/messages_getBotCallbackAnswer.md b/old_docs/API_docs_v71/methods/messages_getBotCallbackAnswer.md index 7ccd0d1b..09c283f5 100644 --- a/old_docs/API_docs_v71/methods/messages_getBotCallbackAnswer.md +++ b/old_docs/API_docs_v71/methods/messages_getBotCallbackAnswer.md @@ -1,19 +1,21 @@ --- title: messages.getBotCallbackAnswer -description: messages.getBotCallbackAnswer parameters, return type and example +description: Get the callback answer of a bot (after clicking a button) --- ## Method: messages.getBotCallbackAnswer [Back to methods index](index.md) +Get the callback answer of a bot (after clicking a button) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|game|[CLICK ME Bool](../types/Bool.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|msg\_id|[CLICK ME int](../types/int.md) | Yes| -|data|[CLICK ME bytes](../types/bytes.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|game|[CLICK ME Bool](../types/Bool.md) | Optional|Is this a game?| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| +|msg\_id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|data|[CLICK ME bytes](../types/bytes.md) | Optional|The data to send to the bot| ### Return type: [messages\_BotCallbackAnswer](../types/messages_BotCallbackAnswer.md) diff --git a/old_docs/API_docs_v71/methods/messages_getCommonChats.md b/old_docs/API_docs_v71/methods/messages_getCommonChats.md index a57d7f5a..e6eca283 100644 --- a/old_docs/API_docs_v71/methods/messages_getCommonChats.md +++ b/old_docs/API_docs_v71/methods/messages_getCommonChats.md @@ -1,18 +1,20 @@ --- title: messages.getCommonChats -description: messages.getCommonChats parameters, return type and example +description: Get chats in common with a user --- ## Method: messages.getCommonChats [Back to methods index](index.md) +Get chats in common with a user + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|max\_id|[CLICK ME int](../types/int.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| +|max\_id|[CLICK ME int](../types/int.md) | Yes|The maximum chat ID to fetch| +|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to fetch| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v71/methods/messages_getDocumentByHash.md b/old_docs/API_docs_v71/methods/messages_getDocumentByHash.md index b7c45398..1af5bad4 100644 --- a/old_docs/API_docs_v71/methods/messages_getDocumentByHash.md +++ b/old_docs/API_docs_v71/methods/messages_getDocumentByHash.md @@ -1,18 +1,20 @@ --- title: messages.getDocumentByHash -description: messages.getDocumentByHash parameters, return type and example +description: Get document by SHA256 hash --- ## Method: messages.getDocumentByHash [Back to methods index](index.md) +Get document by SHA256 hash + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|sha256|[CLICK ME bytes](../types/bytes.md) | Yes| -|size|[CLICK ME int](../types/int.md) | Yes| -|mime\_type|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|sha256|[CLICK ME bytes](../types/bytes.md) | Yes|`hash('sha256', $filename, true);`| +|size|[CLICK ME int](../types/int.md) | Yes|The file size| +|mime\_type|[CLICK ME string](../types/string.md) | Yes|The mime type of the file| ### Return type: [Document](../types/Document.md) diff --git a/old_docs/API_docs_v71/methods/messages_getFavedStickers.md b/old_docs/API_docs_v71/methods/messages_getFavedStickers.md index e95d0133..1be542be 100644 --- a/old_docs/API_docs_v71/methods/messages_getFavedStickers.md +++ b/old_docs/API_docs_v71/methods/messages_getFavedStickers.md @@ -1,16 +1,18 @@ --- title: messages.getFavedStickers -description: messages.getFavedStickers parameters, return type and example +description: Get favorite stickers --- ## Method: messages.getFavedStickers [Back to methods index](index.md) +Get favorite stickers + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_FavedStickers](../types/messages_FavedStickers.md) diff --git a/old_docs/API_docs_v71/methods/messages_getFeaturedStickers.md b/old_docs/API_docs_v71/methods/messages_getFeaturedStickers.md index 88b5609c..512f2e85 100644 --- a/old_docs/API_docs_v71/methods/messages_getFeaturedStickers.md +++ b/old_docs/API_docs_v71/methods/messages_getFeaturedStickers.md @@ -1,16 +1,18 @@ --- title: messages.getFeaturedStickers -description: messages.getFeaturedStickers parameters, return type and example +description: Get featured stickers --- ## Method: messages.getFeaturedStickers [Back to methods index](index.md) +Get featured stickers + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_FeaturedStickers](../types/messages_FeaturedStickers.md) diff --git a/old_docs/API_docs_v71/methods/messages_getGameHighScores.md b/old_docs/API_docs_v71/methods/messages_getGameHighScores.md index 2c95af05..5137baea 100644 --- a/old_docs/API_docs_v71/methods/messages_getGameHighScores.md +++ b/old_docs/API_docs_v71/methods/messages_getGameHighScores.md @@ -1,18 +1,20 @@ --- title: messages.getGameHighScores -description: messages.getGameHighScores parameters, return type and example +description: Get high scores of a game --- ## Method: messages.getGameHighScores [Back to methods index](index.md) +Get high scores of a game + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|id|[CLICK ME int](../types/int.md) | Yes| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| +|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the high scores| ### Return type: [messages\_HighScores](../types/messages_HighScores.md) diff --git a/old_docs/API_docs_v71/methods/messages_getInlineBotResults.md b/old_docs/API_docs_v71/methods/messages_getInlineBotResults.md index 5b2bb254..8ab5bf78 100644 --- a/old_docs/API_docs_v71/methods/messages_getInlineBotResults.md +++ b/old_docs/API_docs_v71/methods/messages_getInlineBotResults.md @@ -1,20 +1,22 @@ --- title: messages.getInlineBotResults -description: messages.getInlineBotResults parameters, return type and example +description: Call inline bot --- ## Method: messages.getInlineBotResults [Back to methods index](index.md) +Call inline bot + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional| -|query|[CLICK ME string](../types/string.md) | Yes| -|offset|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot to call| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to call the bot| +|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional|The current location| +|query|[CLICK ME string](../types/string.md) | Yes|The query to send to the bot| +|offset|[CLICK ME string](../types/string.md) | Yes|The offset to send to the bot| ### Return type: [messages\_BotResults](../types/messages_BotResults.md) diff --git a/old_docs/API_docs_v71/methods/messages_getInlineGameHighScores.md b/old_docs/API_docs_v71/methods/messages_getInlineGameHighScores.md index 447a55dd..790bfdd9 100644 --- a/old_docs/API_docs_v71/methods/messages_getInlineGameHighScores.md +++ b/old_docs/API_docs_v71/methods/messages_getInlineGameHighScores.md @@ -1,17 +1,19 @@ --- title: messages.getInlineGameHighScores -description: messages.getInlineGameHighScores parameters, return type and example +description: Get high scores of a game sent in an inline message --- ## Method: messages.getInlineGameHighScores [Back to methods index](index.md) +Get high scores of a game sent in an inline message + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The inline message| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the high scores| ### Return type: [messages\_HighScores](../types/messages_HighScores.md) diff --git a/old_docs/API_docs_v71/methods/messages_getMaskStickers.md b/old_docs/API_docs_v71/methods/messages_getMaskStickers.md index 80c16471..f4ed9411 100644 --- a/old_docs/API_docs_v71/methods/messages_getMaskStickers.md +++ b/old_docs/API_docs_v71/methods/messages_getMaskStickers.md @@ -1,16 +1,18 @@ --- title: messages.getMaskStickers -description: messages.getMaskStickers parameters, return type and example +description: Get masks --- ## Method: messages.getMaskStickers [Back to methods index](index.md) +Get masks + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v71/methods/messages_getMessageEditData.md b/old_docs/API_docs_v71/methods/messages_getMessageEditData.md index 339678bd..12e71bee 100644 --- a/old_docs/API_docs_v71/methods/messages_getMessageEditData.md +++ b/old_docs/API_docs_v71/methods/messages_getMessageEditData.md @@ -1,17 +1,19 @@ --- title: messages.getMessageEditData -description: messages.getMessageEditData parameters, return type and example +description: Check if about to edit a message or a media caption --- ## Method: messages.getMessageEditData [Back to methods index](index.md) +Check if about to edit a message or a media caption + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|id|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| +|id|[CLICK ME int](../types/int.md) | Yes|The message ID| ### Return type: [messages\_MessageEditData](../types/messages_MessageEditData.md) diff --git a/old_docs/API_docs_v71/methods/messages_getMessagesViews.md b/old_docs/API_docs_v71/methods/messages_getMessagesViews.md index e3f4e4ea..b8d78c85 100644 --- a/old_docs/API_docs_v71/methods/messages_getMessagesViews.md +++ b/old_docs/API_docs_v71/methods/messages_getMessagesViews.md @@ -1,18 +1,20 @@ --- title: messages.getMessagesViews -description: messages.getMessagesViews parameters, return type and example +description: Get and increase message views --- ## Method: messages.getMessagesViews [Back to methods index](index.md) +Get and increase message views + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|id|Array of [CLICK ME int](../types/int.md) | Yes| -|increment|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the message is located| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs messages to get| +|increment|[CLICK ME Bool](../types/Bool.md) | Yes|Increase message views?| ### Return type: [Vector\_of\_int](../types/int.md) diff --git a/old_docs/API_docs_v71/methods/messages_getPeerDialogs.md b/old_docs/API_docs_v71/methods/messages_getPeerDialogs.md index fe8a821c..da82cfc6 100644 --- a/old_docs/API_docs_v71/methods/messages_getPeerDialogs.md +++ b/old_docs/API_docs_v71/methods/messages_getPeerDialogs.md @@ -1,16 +1,18 @@ --- title: messages.getPeerDialogs -description: messages.getPeerDialogs parameters, return type and example +description: Get dialog info of peers --- ## Method: messages.getPeerDialogs [Back to methods index](index.md) +Get dialog info of peers + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peers|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peers|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Yes|The peers| ### Return type: [messages\_PeerDialogs](../types/messages_PeerDialogs.md) diff --git a/old_docs/API_docs_v71/methods/messages_getPinnedDialogs.md b/old_docs/API_docs_v71/methods/messages_getPinnedDialogs.md index 99ff5651..d12779fe 100644 --- a/old_docs/API_docs_v71/methods/messages_getPinnedDialogs.md +++ b/old_docs/API_docs_v71/methods/messages_getPinnedDialogs.md @@ -1,11 +1,13 @@ --- title: messages.getPinnedDialogs -description: messages.getPinnedDialogs parameters, return type and example +description: Get pinned dialogs --- ## Method: messages.getPinnedDialogs [Back to methods index](index.md) +Get pinned dialogs + ### Return type: [messages\_PeerDialogs](../types/messages_PeerDialogs.md) diff --git a/old_docs/API_docs_v71/methods/messages_getRecentStickers.md b/old_docs/API_docs_v71/methods/messages_getRecentStickers.md index abab7f44..d76a2160 100644 --- a/old_docs/API_docs_v71/methods/messages_getRecentStickers.md +++ b/old_docs/API_docs_v71/methods/messages_getRecentStickers.md @@ -1,17 +1,19 @@ --- title: messages.getRecentStickers -description: messages.getRecentStickers parameters, return type and example +description: Get recent stickers --- ## Method: messages.getRecentStickers [Back to methods index](index.md) +Get recent stickers + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|attached|[CLICK ME Bool](../types/Bool.md) | Optional| -|hash|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|attached|[CLICK ME Bool](../types/Bool.md) | Optional|Get stickers attached to image?| +|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_RecentStickers](../types/messages_RecentStickers.md) diff --git a/old_docs/API_docs_v71/methods/messages_getSavedGifs.md b/old_docs/API_docs_v71/methods/messages_getSavedGifs.md index 08dc4be6..f61348ce 100644 --- a/old_docs/API_docs_v71/methods/messages_getSavedGifs.md +++ b/old_docs/API_docs_v71/methods/messages_getSavedGifs.md @@ -1,16 +1,18 @@ --- title: messages.getSavedGifs -description: messages.getSavedGifs parameters, return type and example +description: Get saved gifs --- ## Method: messages.getSavedGifs [Back to methods index](index.md) +Get saved gifs + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_SavedGifs](../types/messages_SavedGifs.md) diff --git a/old_docs/API_docs_v71/methods/messages_getStickerSet.md b/old_docs/API_docs_v71/methods/messages_getStickerSet.md index 70bdd9ba..c86807e4 100644 --- a/old_docs/API_docs_v71/methods/messages_getStickerSet.md +++ b/old_docs/API_docs_v71/methods/messages_getStickerSet.md @@ -1,16 +1,18 @@ --- title: messages.getStickerSet -description: messages.getStickerSet parameters, return type and example +description: Get a stickerset --- ## Method: messages.getStickerSet [Back to methods index](index.md) +Get a stickerset + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset to get| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/old_docs/API_docs_v71/methods/messages_getUnreadMentions.md b/old_docs/API_docs_v71/methods/messages_getUnreadMentions.md index 959c52fc..d318506c 100644 --- a/old_docs/API_docs_v71/methods/messages_getUnreadMentions.md +++ b/old_docs/API_docs_v71/methods/messages_getUnreadMentions.md @@ -1,21 +1,23 @@ --- title: messages.getUnreadMentions -description: messages.getUnreadMentions parameters, return type and example +description: Get unread mentions --- ## Method: messages.getUnreadMentions [Back to methods index](index.md) +Get unread mentions + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|offset\_id|[CLICK ME int](../types/int.md) | Yes| -|add\_offset|[CLICK ME int](../types/int.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| -|max\_id|[CLICK ME int](../types/int.md) | Yes| -|min\_id|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to get unread mentions| +|offset\_id|[CLICK ME int](../types/int.md) | Yes|The offset| +|add\_offset|[CLICK ME int](../types/int.md) | Yes|The additional offset| +|limit|[CLICK ME int](../types/int.md) | Yes|The number of results to fetch| +|max\_id|[CLICK ME int](../types/int.md) | Yes|The maximum message ID to fetch| +|min\_id|[CLICK ME int](../types/int.md) | Yes|The minumum message ID to fetch| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v71/methods/messages_getWebPage.md b/old_docs/API_docs_v71/methods/messages_getWebPage.md index b29e5d25..129f8f06 100644 --- a/old_docs/API_docs_v71/methods/messages_getWebPage.md +++ b/old_docs/API_docs_v71/methods/messages_getWebPage.md @@ -1,17 +1,19 @@ --- title: messages.getWebPage -description: messages.getWebPage parameters, return type and example +description: Get webpage preview --- ## Method: messages.getWebPage [Back to methods index](index.md) +Get webpage preview + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|url|[CLICK ME string](../types/string.md) | Yes| -|hash|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|url|[CLICK ME string](../types/string.md) | Yes|URL| +|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [WebPage](../types/WebPage.md) diff --git a/old_docs/API_docs_v71/methods/messages_getWebPagePreview.md b/old_docs/API_docs_v71/methods/messages_getWebPagePreview.md index 35243c9f..d01bdd32 100644 --- a/old_docs/API_docs_v71/methods/messages_getWebPagePreview.md +++ b/old_docs/API_docs_v71/methods/messages_getWebPagePreview.md @@ -1,16 +1,18 @@ --- title: messages.getWebPagePreview -description: messages.getWebPagePreview parameters, return type and example +description: Get webpage preview --- ## Method: messages.getWebPagePreview [Back to methods index](index.md) +Get webpage preview + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|message|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|message|[CLICK ME string](../types/string.md) | Yes|Extract preview from this message| ### Return type: [MessageMedia](../types/MessageMedia.md) diff --git a/old_docs/API_docs_v71/methods/messages_importChatInvite.md b/old_docs/API_docs_v71/methods/messages_importChatInvite.md index 2bea5247..0d6cd7c8 100644 --- a/old_docs/API_docs_v71/methods/messages_importChatInvite.md +++ b/old_docs/API_docs_v71/methods/messages_importChatInvite.md @@ -1,16 +1,18 @@ --- title: messages.importChatInvite -description: messages.importChatInvite parameters, return type and example +description: Import chat invite --- ## Method: messages.importChatInvite [Back to methods index](index.md) +Import chat invite + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v71/methods/messages_installStickerSet.md b/old_docs/API_docs_v71/methods/messages_installStickerSet.md index 61513182..9f6f098c 100644 --- a/old_docs/API_docs_v71/methods/messages_installStickerSet.md +++ b/old_docs/API_docs_v71/methods/messages_installStickerSet.md @@ -1,17 +1,19 @@ --- title: messages.installStickerSet -description: messages.installStickerSet parameters, return type and example +description: Add a sticker set --- ## Method: messages.installStickerSet [Back to methods index](index.md) +Add a sticker set + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional| -|archived|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to add| +|archived|[CLICK ME Bool](../types/Bool.md) | Yes|Archive this set?| ### Return type: [messages\_StickerSetInstallResult](../types/messages_StickerSetInstallResult.md) diff --git a/old_docs/API_docs_v71/methods/messages_migrateChat.md b/old_docs/API_docs_v71/methods/messages_migrateChat.md index 5021ad45..db57adfa 100644 --- a/old_docs/API_docs_v71/methods/messages_migrateChat.md +++ b/old_docs/API_docs_v71/methods/messages_migrateChat.md @@ -1,16 +1,18 @@ --- title: messages.migrateChat -description: messages.migrateChat parameters, return type and example +description: Convert chat to supergroup --- ## Method: messages.migrateChat [Back to methods index](index.md) +Convert chat to supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat to convert| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v71/methods/messages_readEncryptedHistory.md b/old_docs/API_docs_v71/methods/messages_readEncryptedHistory.md index 4d341809..39b110e3 100644 --- a/old_docs/API_docs_v71/methods/messages_readEncryptedHistory.md +++ b/old_docs/API_docs_v71/methods/messages_readEncryptedHistory.md @@ -1,17 +1,19 @@ --- title: messages.readEncryptedHistory -description: messages.readEncryptedHistory parameters, return type and example +description: Mark messages as read in secret chats --- ## Method: messages.readEncryptedHistory [Back to methods index](index.md) +Mark messages as read in secret chats + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|max\_date|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to mark messages as read| +|max\_date|[CLICK ME int](../types/int.md) | Yes|Maximum date of messages to mark| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v71/methods/messages_readFeaturedStickers.md b/old_docs/API_docs_v71/methods/messages_readFeaturedStickers.md index 0631ca5b..4035c76d 100644 --- a/old_docs/API_docs_v71/methods/messages_readFeaturedStickers.md +++ b/old_docs/API_docs_v71/methods/messages_readFeaturedStickers.md @@ -1,16 +1,18 @@ --- title: messages.readFeaturedStickers -description: messages.readFeaturedStickers parameters, return type and example +description: Mark new featured stickers as read --- ## Method: messages.readFeaturedStickers [Back to methods index](index.md) +Mark new featured stickers as read + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|Array of [CLICK ME long](../types/long.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|Array of [CLICK ME long](../types/long.md) | Yes|The stickers to mark as read| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v71/methods/messages_readMessageContents.md b/old_docs/API_docs_v71/methods/messages_readMessageContents.md index 0d27c209..9bb1bee8 100644 --- a/old_docs/API_docs_v71/methods/messages_readMessageContents.md +++ b/old_docs/API_docs_v71/methods/messages_readMessageContents.md @@ -1,16 +1,18 @@ --- title: messages.readMessageContents -description: messages.readMessageContents parameters, return type and example +description: Mark message as read --- ## Method: messages.readMessageContents [Back to methods index](index.md) +Mark message as read + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v71/methods/messages_receivedQueue.md b/old_docs/API_docs_v71/methods/messages_receivedQueue.md index c91caa37..4ad78ba2 100644 --- a/old_docs/API_docs_v71/methods/messages_receivedQueue.md +++ b/old_docs/API_docs_v71/methods/messages_receivedQueue.md @@ -1,77 +1,13 @@ --- title: messages.receivedQueue -description: messages.receivedQueue parameters, return type and example +description: You cannot use this method directly --- ## Method: messages.receivedQueue [Back to methods index](index.md) -### Parameters: - -| Name | Type | Required | -|----------|---------------|----------| -|max\_qts|[CLICK ME int](../types/int.md) | Yes| - - -### 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| - - -### MadelineProto Example: - - -``` -if (!file_exists('madeline.php')) { - copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); -} -include 'madeline.php'; - -// !!! This API id/API hash combination will not work !!! -// !!! You must get your own @ my.telegram.org !!! -$api_id = 0; -$api_hash = ''; - -$MadelineProto = new \danog\MadelineProto\API('session.madeline', ['app_info' => ['api_id' => $api_id, 'api_hash' => $api_hash]]); -$MadelineProto->start(); - -$Vector_of_long = $MadelineProto->messages->receivedQueue(['max_qts' => int, ]); -``` - -### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): - -### As a bot: - -POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` - -Parameters: - -* method - messages.receivedQueue -* params - `{"max_qts": int, }` - - - -### As a user: - -POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.receivedQueue` - -Parameters: - -max_qts - Json encoded int +**You cannot use this method directly** -Or, if you're into Lua: - -``` -Vector_of_long = messages.receivedQueue({max_qts=int, }) -``` - diff --git a/old_docs/API_docs_v71/methods/messages_reorderPinnedDialogs.md b/old_docs/API_docs_v71/methods/messages_reorderPinnedDialogs.md index 0bf5e073..710caf10 100644 --- a/old_docs/API_docs_v71/methods/messages_reorderPinnedDialogs.md +++ b/old_docs/API_docs_v71/methods/messages_reorderPinnedDialogs.md @@ -1,17 +1,19 @@ --- title: messages.reorderPinnedDialogs -description: messages.reorderPinnedDialogs parameters, return type and example +description: Reorder pinned dialogs --- ## Method: messages.reorderPinnedDialogs [Back to methods index](index.md) +Reorder pinned dialogs + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|force|[CLICK ME Bool](../types/Bool.md) | Optional| -|order|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|force|[CLICK ME Bool](../types/Bool.md) | Optional|Force reordering| +|order|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Yes|New order| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v71/methods/messages_reorderStickerSets.md b/old_docs/API_docs_v71/methods/messages_reorderStickerSets.md index e4f1623c..ddc78dd0 100644 --- a/old_docs/API_docs_v71/methods/messages_reorderStickerSets.md +++ b/old_docs/API_docs_v71/methods/messages_reorderStickerSets.md @@ -1,17 +1,19 @@ --- title: messages.reorderStickerSets -description: messages.reorderStickerSets parameters, return type and example +description: Reorder sticker sets --- ## Method: messages.reorderStickerSets [Back to methods index](index.md) +Reorder sticker sets + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|masks|[CLICK ME Bool](../types/Bool.md) | Optional| -|order|Array of [CLICK ME long](../types/long.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|masks|[CLICK ME Bool](../types/Bool.md) | Optional|Reorder masks?| +|order|Array of [CLICK ME long](../types/long.md) | Yes|The order| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v71/methods/messages_reportEncryptedSpam.md b/old_docs/API_docs_v71/methods/messages_reportEncryptedSpam.md index 44482c76..58b684d1 100644 --- a/old_docs/API_docs_v71/methods/messages_reportEncryptedSpam.md +++ b/old_docs/API_docs_v71/methods/messages_reportEncryptedSpam.md @@ -1,16 +1,18 @@ --- title: messages.reportEncryptedSpam -description: messages.reportEncryptedSpam parameters, return type and example +description: Report for spam a secret chat --- ## Method: messages.reportEncryptedSpam [Back to methods index](index.md) +Report for spam a secret chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat to report| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v71/methods/messages_saveDraft.md b/old_docs/API_docs_v71/methods/messages_saveDraft.md index 9104df33..bbeed707 100644 --- a/old_docs/API_docs_v71/methods/messages_saveDraft.md +++ b/old_docs/API_docs_v71/methods/messages_saveDraft.md @@ -1,20 +1,22 @@ --- title: messages.saveDraft -description: messages.saveDraft parameters, return type and example +description: Save a message draft --- ## Method: messages.saveDraft [Back to methods index](index.md) +Save a message draft + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|message|[CLICK ME string](../types/string.md) | Yes| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview| +|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| +|message|[CLICK ME string](../types/string.md) | Yes|The message| +|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|The entities (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/old_docs/API_docs_v71/methods/messages_saveGif.md b/old_docs/API_docs_v71/methods/messages_saveGif.md index 4a3b6166..6f608c4c 100644 --- a/old_docs/API_docs_v71/methods/messages_saveGif.md +++ b/old_docs/API_docs_v71/methods/messages_saveGif.md @@ -1,17 +1,19 @@ --- title: messages.saveGif -description: messages.saveGif parameters, return type and example +description: Save a GIF --- ## Method: messages.saveGif [Back to methods index](index.md) +Save a GIF + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional| -|unsave|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The GIF to save| +|unsave|[CLICK ME Bool](../types/Bool.md) | Yes|Remove the gif?| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v71/methods/messages_saveRecentSticker.md b/old_docs/API_docs_v71/methods/messages_saveRecentSticker.md index b4f43e13..81ad5d48 100644 --- a/old_docs/API_docs_v71/methods/messages_saveRecentSticker.md +++ b/old_docs/API_docs_v71/methods/messages_saveRecentSticker.md @@ -1,18 +1,20 @@ --- title: messages.saveRecentSticker -description: messages.saveRecentSticker parameters, return type and example +description: Add a sticker to recent stickers --- ## Method: messages.saveRecentSticker [Back to methods index](index.md) +Add a sticker to recent stickers + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|attached|[CLICK ME Bool](../types/Bool.md) | Optional| -|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional| -|unsave|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|attached|[CLICK ME Bool](../types/Bool.md) | Optional|Get stickers attached to image?| +|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker| +|unsave|[CLICK ME Bool](../types/Bool.md) | Yes|Remove the sticker from recent stickers?| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v71/methods/messages_searchGifs.md b/old_docs/API_docs_v71/methods/messages_searchGifs.md index fefef1d7..103ebfeb 100644 --- a/old_docs/API_docs_v71/methods/messages_searchGifs.md +++ b/old_docs/API_docs_v71/methods/messages_searchGifs.md @@ -1,17 +1,19 @@ --- title: messages.searchGifs -description: messages.searchGifs parameters, return type and example +description: Search gifs --- ## Method: messages.searchGifs [Back to methods index](index.md) +Search gifs + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|q|[CLICK ME string](../types/string.md) | Yes| -|offset|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|q|[CLICK ME string](../types/string.md) | Yes|The search query| +|offset|[CLICK ME int](../types/int.md) | Yes|The offset | ### Return type: [messages\_FoundGifs](../types/messages_FoundGifs.md) diff --git a/old_docs/API_docs_v71/methods/messages_searchGlobal.md b/old_docs/API_docs_v71/methods/messages_searchGlobal.md index 32ddd175..0edd1e40 100644 --- a/old_docs/API_docs_v71/methods/messages_searchGlobal.md +++ b/old_docs/API_docs_v71/methods/messages_searchGlobal.md @@ -1,20 +1,22 @@ --- title: messages.searchGlobal -description: messages.searchGlobal parameters, return type and example +description: Global message search --- ## Method: messages.searchGlobal [Back to methods index](index.md) +Global message search + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|q|[CLICK ME string](../types/string.md) | Yes| -|offset\_date|[CLICK ME int](../types/int.md) | Yes| -|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|offset\_id|[CLICK ME int](../types/int.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|q|[CLICK ME string](../types/string.md) | Yes|The query| +|offset\_date|[CLICK ME int](../types/int.md) | Yes|0 or the date offset| +|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|0 or the peer offset| +|offset\_id|[CLICK ME int](../types/int.md) | Yes|0 or the message ID offset| +|limit|[CLICK ME int](../types/int.md) | Yes|The number of results to return| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v71/methods/messages_sendEncrypted.md b/old_docs/API_docs_v71/methods/messages_sendEncrypted.md index 23461760..d48f88d7 100644 --- a/old_docs/API_docs_v71/methods/messages_sendEncrypted.md +++ b/old_docs/API_docs_v71/methods/messages_sendEncrypted.md @@ -1,17 +1,19 @@ --- title: messages.sendEncrypted -description: messages.sendEncrypted parameters, return type and example +description: Send message to secret chat --- ## Method: messages.sendEncrypted [Back to methods index](index.md) +Send message to secret chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the message| +|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v71/methods/messages_sendEncryptedFile.md b/old_docs/API_docs_v71/methods/messages_sendEncryptedFile.md index 64919abe..4fd0648e 100644 --- a/old_docs/API_docs_v71/methods/messages_sendEncryptedFile.md +++ b/old_docs/API_docs_v71/methods/messages_sendEncryptedFile.md @@ -1,18 +1,20 @@ --- title: messages.sendEncryptedFile -description: messages.sendEncryptedFile parameters, return type and example +description: Send a file to a secret chat --- ## Method: messages.sendEncryptedFile [Back to methods index](index.md) +Send a file to a secret chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes| -|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the file| +|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| +|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional|The file (optional)| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v71/methods/messages_sendEncryptedService.md b/old_docs/API_docs_v71/methods/messages_sendEncryptedService.md index 0a0eea8a..d66894bf 100644 --- a/old_docs/API_docs_v71/methods/messages_sendEncryptedService.md +++ b/old_docs/API_docs_v71/methods/messages_sendEncryptedService.md @@ -1,17 +1,19 @@ --- title: messages.sendEncryptedService -description: messages.sendEncryptedService parameters, return type and example +description: Send a service message to a secret chat --- ## Method: messages.sendEncryptedService [Back to methods index](index.md) +Send a service message to a secret chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the service message| +|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v71/methods/messages_sendInlineBotResult.md b/old_docs/API_docs_v71/methods/messages_sendInlineBotResult.md index 4cb9243e..386ac7e3 100644 --- a/old_docs/API_docs_v71/methods/messages_sendInlineBotResult.md +++ b/old_docs/API_docs_v71/methods/messages_sendInlineBotResult.md @@ -1,22 +1,24 @@ --- title: messages.sendInlineBotResult -description: messages.sendInlineBotResult parameters, return type and example +description: Send a received bot result to the chat --- ## Method: messages.sendInlineBotResult [Back to methods index](index.md) +Send a received bot result to the chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional| -|background|[CLICK ME Bool](../types/Bool.md) | Optional| -|clear\_draft|[CLICK ME Bool](../types/Bool.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional| -|query\_id|[CLICK ME long](../types/long.md) | Yes| -|id|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Disable notifications?| +|background|[CLICK ME Bool](../types/Bool.md) | Optional|Disable background notifications?| +|clear\_draft|[CLICK ME Bool](../types/Bool.md) | Optional|Clear the message draft?| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the message| +|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| +|query\_id|[CLICK ME long](../types/long.md) | Yes|The inline query ID| +|id|[CLICK ME string](../types/string.md) | Yes|The result ID| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v71/methods/messages_sendScreenshotNotification.md b/old_docs/API_docs_v71/methods/messages_sendScreenshotNotification.md index c9d1d555..f64f1682 100644 --- a/old_docs/API_docs_v71/methods/messages_sendScreenshotNotification.md +++ b/old_docs/API_docs_v71/methods/messages_sendScreenshotNotification.md @@ -1,17 +1,19 @@ --- title: messages.sendScreenshotNotification -description: messages.sendScreenshotNotification parameters, return type and example +description: Send screenshot notification --- ## Method: messages.sendScreenshotNotification [Back to methods index](index.md) +Send screenshot notification + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the notification| +|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Yes|Reply to message by ID| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v71/methods/messages_setBotCallbackAnswer.md b/old_docs/API_docs_v71/methods/messages_setBotCallbackAnswer.md index 5590828e..e6dc6b09 100644 --- a/old_docs/API_docs_v71/methods/messages_setBotCallbackAnswer.md +++ b/old_docs/API_docs_v71/methods/messages_setBotCallbackAnswer.md @@ -1,20 +1,22 @@ --- title: messages.setBotCallbackAnswer -description: messages.setBotCallbackAnswer parameters, return type and example +description: Bots only: set the callback answer (after a button was clicked) --- ## Method: messages.setBotCallbackAnswer [Back to methods index](index.md) +Bots only: set the callback answer (after a button was clicked) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|alert|[CLICK ME Bool](../types/Bool.md) | Optional| -|query\_id|[CLICK ME long](../types/long.md) | Yes| -|message|[CLICK ME string](../types/string.md) | Optional| -|url|[CLICK ME string](../types/string.md) | Optional| -|cache\_time|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|alert|[CLICK ME Bool](../types/Bool.md) | Optional|Is this an alert?| +|query\_id|[CLICK ME long](../types/long.md) | Yes|The query ID| +|message|[CLICK ME string](../types/string.md) | Optional|The message| +|url|[CLICK ME string](../types/string.md) | Optional|The URL| +|cache\_time|[CLICK ME int](../types/int.md) | Yes|Cache time| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v71/methods/messages_setBotPrecheckoutResults.md b/old_docs/API_docs_v71/methods/messages_setBotPrecheckoutResults.md index 5afa7789..722bff81 100644 --- a/old_docs/API_docs_v71/methods/messages_setBotPrecheckoutResults.md +++ b/old_docs/API_docs_v71/methods/messages_setBotPrecheckoutResults.md @@ -1,18 +1,20 @@ --- title: messages.setBotPrecheckoutResults -description: messages.setBotPrecheckoutResults parameters, return type and example +description: Bots only: set precheckout results --- ## Method: messages.setBotPrecheckoutResults [Back to methods index](index.md) +Bots only: set precheckout results + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|success|[CLICK ME Bool](../types/Bool.md) | Optional| -|query\_id|[CLICK ME long](../types/long.md) | Yes| -|error|[CLICK ME string](../types/string.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|success|[CLICK ME Bool](../types/Bool.md) | Optional|Success?| +|query\_id|[CLICK ME long](../types/long.md) | Yes|Query ID| +|error|[CLICK ME string](../types/string.md) | Optional|Error| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v71/methods/messages_setBotShippingResults.md b/old_docs/API_docs_v71/methods/messages_setBotShippingResults.md index b36dacce..d364a04d 100644 --- a/old_docs/API_docs_v71/methods/messages_setBotShippingResults.md +++ b/old_docs/API_docs_v71/methods/messages_setBotShippingResults.md @@ -1,18 +1,20 @@ --- title: messages.setBotShippingResults -description: messages.setBotShippingResults parameters, return type and example +description: Bots only: set shipping results --- ## Method: messages.setBotShippingResults [Back to methods index](index.md) +Bots only: set shipping results + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|query\_id|[CLICK ME long](../types/long.md) | Yes| -|error|[CLICK ME string](../types/string.md) | Optional| -|shipping\_options|Array of [CLICK ME ShippingOption](../types/ShippingOption.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|query\_id|[CLICK ME long](../types/long.md) | Yes|Query ID| +|error|[CLICK ME string](../types/string.md) | Optional|Error| +|shipping\_options|Array of [CLICK ME ShippingOption](../types/ShippingOption.md) | Optional|Shipping options| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v71/methods/messages_setEncryptedTyping.md b/old_docs/API_docs_v71/methods/messages_setEncryptedTyping.md index 3183fedf..e9afe99c 100644 --- a/old_docs/API_docs_v71/methods/messages_setEncryptedTyping.md +++ b/old_docs/API_docs_v71/methods/messages_setEncryptedTyping.md @@ -12,8 +12,8 @@ Send typing notification to secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|| -|typing|[CLICK ME Bool](../types/Bool.md) | Yes|| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to send the notification| +|typing|[CLICK ME Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v71/methods/messages_setGameScore.md b/old_docs/API_docs_v71/methods/messages_setGameScore.md index c44145c0..aa1f4f0c 100644 --- a/old_docs/API_docs_v71/methods/messages_setGameScore.md +++ b/old_docs/API_docs_v71/methods/messages_setGameScore.md @@ -1,21 +1,23 @@ --- title: messages.setGameScore -description: messages.setGameScore parameters, return type and example +description: Set the game score --- ## Method: messages.setGameScore [Back to methods index](index.md) +Set the game score + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|edit\_message|[CLICK ME Bool](../types/Bool.md) | Optional| -|force|[CLICK ME Bool](../types/Bool.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|id|[CLICK ME int](../types/int.md) | Yes| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|score|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|edit\_message|[CLICK ME Bool](../types/Bool.md) | Optional|Should the message with the game be edited?| +|force|[CLICK ME Bool](../types/Bool.md) | Optional|Force setting the game score| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the game was sent| +|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the score| +|score|[CLICK ME int](../types/int.md) | Yes|The score| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v71/methods/messages_setInlineBotResults.md b/old_docs/API_docs_v71/methods/messages_setInlineBotResults.md index 915e3a4e..79493009 100644 --- a/old_docs/API_docs_v71/methods/messages_setInlineBotResults.md +++ b/old_docs/API_docs_v71/methods/messages_setInlineBotResults.md @@ -1,22 +1,24 @@ --- title: messages.setInlineBotResults -description: messages.setInlineBotResults parameters, return type and example +description: Bots only: set the results of an inline query --- ## Method: messages.setInlineBotResults [Back to methods index](index.md) +Bots only: set the results of an inline query + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|gallery|[CLICK ME Bool](../types/Bool.md) | Optional| -|private|[CLICK ME Bool](../types/Bool.md) | Optional| -|query\_id|[CLICK ME long](../types/long.md) | Yes| -|results|Array of [CLICK ME InputBotInlineResult](../types/InputBotInlineResult.md) | Yes| -|cache\_time|[CLICK ME int](../types/int.md) | Yes| -|next\_offset|[CLICK ME string](../types/string.md) | Optional| -|switch\_pm|[CLICK ME InlineBotSwitchPM](../types/InlineBotSwitchPM.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|gallery|[CLICK ME Bool](../types/Bool.md) | Optional|Is this a gallery?| +|private|[CLICK ME Bool](../types/Bool.md) | Optional|Is this result private (not cached)?| +|query\_id|[CLICK ME long](../types/long.md) | Yes|Query ID| +|results|Array of [CLICK ME InputBotInlineResult](../types/InputBotInlineResult.md) | Yes|Results| +|cache\_time|[CLICK ME int](../types/int.md) | Yes|Cache time| +|next\_offset|[CLICK ME string](../types/string.md) | Optional|The next offset| +|switch\_pm|[CLICK ME InlineBotSwitchPM](../types/InlineBotSwitchPM.md) | Optional|Switch to PM?| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v71/methods/messages_setInlineGameScore.md b/old_docs/API_docs_v71/methods/messages_setInlineGameScore.md index 55e2c063..385c8308 100644 --- a/old_docs/API_docs_v71/methods/messages_setInlineGameScore.md +++ b/old_docs/API_docs_v71/methods/messages_setInlineGameScore.md @@ -1,20 +1,22 @@ --- title: messages.setInlineGameScore -description: messages.setInlineGameScore parameters, return type and example +description: Set the game score of an inline message --- ## Method: messages.setInlineGameScore [Back to methods index](index.md) +Set the game score of an inline message + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|edit\_message|[CLICK ME Bool](../types/Bool.md) | Optional| -|force|[CLICK ME Bool](../types/Bool.md) | Optional| -|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|score|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|edit\_message|[CLICK ME Bool](../types/Bool.md) | Optional|Should the message with the game be edited?| +|force|[CLICK ME Bool](../types/Bool.md) | Optional|Force setting the game score| +|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The ID of the inline message| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the score| +|score|[CLICK ME int](../types/int.md) | Yes|The score| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v71/methods/messages_startBot.md b/old_docs/API_docs_v71/methods/messages_startBot.md index 0de0f1a5..94a4d86a 100644 --- a/old_docs/API_docs_v71/methods/messages_startBot.md +++ b/old_docs/API_docs_v71/methods/messages_startBot.md @@ -1,18 +1,20 @@ --- title: messages.startBot -description: messages.startBot parameters, return type and example +description: Start a bot --- ## Method: messages.startBot [Back to methods index](index.md) +Start a bot + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|start\_param|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot's ID or username| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to start the bot (@me or group ID/username)| +|start\_param|[CLICK ME string](../types/string.md) | Yes|The bot's start parameter| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v71/methods/messages_toggleChatAdmins.md b/old_docs/API_docs_v71/methods/messages_toggleChatAdmins.md index d56e5753..ab591fd9 100644 --- a/old_docs/API_docs_v71/methods/messages_toggleChatAdmins.md +++ b/old_docs/API_docs_v71/methods/messages_toggleChatAdmins.md @@ -1,17 +1,19 @@ --- title: messages.toggleChatAdmins -description: messages.toggleChatAdmins parameters, return type and example +description: Enable all users are admins in normal groups (not supergroups) --- ## Method: messages.toggleChatAdmins [Back to methods index](index.md) +Enable all users are admins in normal groups (not supergroups) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Group ID| +|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Enable all users are admins| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v71/methods/messages_toggleDialogPin.md b/old_docs/API_docs_v71/methods/messages_toggleDialogPin.md index d6dc9692..2bd6a03d 100644 --- a/old_docs/API_docs_v71/methods/messages_toggleDialogPin.md +++ b/old_docs/API_docs_v71/methods/messages_toggleDialogPin.md @@ -1,17 +1,19 @@ --- title: messages.toggleDialogPin -description: messages.toggleDialogPin parameters, return type and example +description: Pin or unpin dialog --- ## Method: messages.toggleDialogPin [Back to methods index](index.md) +Pin or unpin dialog + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|pinned|[CLICK ME Bool](../types/Bool.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|pinned|[CLICK ME Bool](../types/Bool.md) | Optional|Pin or unpin the dialog?| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer to pin| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v71/methods/messages_uninstallStickerSet.md b/old_docs/API_docs_v71/methods/messages_uninstallStickerSet.md index 60b0ca0c..6d04e847 100644 --- a/old_docs/API_docs_v71/methods/messages_uninstallStickerSet.md +++ b/old_docs/API_docs_v71/methods/messages_uninstallStickerSet.md @@ -1,16 +1,18 @@ --- title: messages.uninstallStickerSet -description: messages.uninstallStickerSet parameters, return type and example +description: Remove a sticker set --- ## Method: messages.uninstallStickerSet [Back to methods index](index.md) +Remove a sticker set + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to remove| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v71/methods/messages_uploadMedia.md b/old_docs/API_docs_v71/methods/messages_uploadMedia.md index 5c25333d..c982a860 100644 --- a/old_docs/API_docs_v71/methods/messages_uploadMedia.md +++ b/old_docs/API_docs_v71/methods/messages_uploadMedia.md @@ -1,17 +1,19 @@ --- title: messages.uploadMedia -description: messages.uploadMedia parameters, return type and example +description: Upload a file without sending it to anyone --- ## Method: messages.uploadMedia [Back to methods index](index.md) +Upload a file without sending it to anyone + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Nothing| +|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media to upload| ### Return type: [MessageMedia](../types/MessageMedia.md) diff --git a/old_docs/API_docs_v71/methods/payments_clearSavedInfo.md b/old_docs/API_docs_v71/methods/payments_clearSavedInfo.md index 53fab36f..44050dde 100644 --- a/old_docs/API_docs_v71/methods/payments_clearSavedInfo.md +++ b/old_docs/API_docs_v71/methods/payments_clearSavedInfo.md @@ -1,17 +1,19 @@ --- title: payments.clearSavedInfo -description: payments.clearSavedInfo parameters, return type and example +description: Clear saved payments info --- ## Method: payments.clearSavedInfo [Back to methods index](index.md) +Clear saved payments info + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|credentials|[CLICK ME Bool](../types/Bool.md) | Optional| -|info|[CLICK ME Bool](../types/Bool.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|credentials|[CLICK ME Bool](../types/Bool.md) | Optional|Clear credentials?| +|info|[CLICK ME Bool](../types/Bool.md) | Optional|Clear payment info?| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v71/methods/payments_getPaymentForm.md b/old_docs/API_docs_v71/methods/payments_getPaymentForm.md index 00b4bddc..16a32d11 100644 --- a/old_docs/API_docs_v71/methods/payments_getPaymentForm.md +++ b/old_docs/API_docs_v71/methods/payments_getPaymentForm.md @@ -1,16 +1,18 @@ --- title: payments.getPaymentForm -description: payments.getPaymentForm parameters, return type and example +description: Get payment form --- ## Method: payments.getPaymentForm [Back to methods index](index.md) +Get payment form + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|msg\_id|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|msg\_id|[CLICK ME int](../types/int.md) | Yes|Message ID| ### Return type: [payments\_PaymentForm](../types/payments_PaymentForm.md) diff --git a/old_docs/API_docs_v71/methods/payments_getPaymentReceipt.md b/old_docs/API_docs_v71/methods/payments_getPaymentReceipt.md index 40b73a4b..857585f6 100644 --- a/old_docs/API_docs_v71/methods/payments_getPaymentReceipt.md +++ b/old_docs/API_docs_v71/methods/payments_getPaymentReceipt.md @@ -1,16 +1,18 @@ --- title: payments.getPaymentReceipt -description: payments.getPaymentReceipt parameters, return type and example +description: Get payment receipt --- ## Method: payments.getPaymentReceipt [Back to methods index](index.md) +Get payment receipt + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|msg\_id|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|msg\_id|[CLICK ME int](../types/int.md) | Yes|The message ID| ### Return type: [payments\_PaymentReceipt](../types/payments_PaymentReceipt.md) diff --git a/old_docs/API_docs_v71/methods/payments_getSavedInfo.md b/old_docs/API_docs_v71/methods/payments_getSavedInfo.md index ccaaff75..04ac7374 100644 --- a/old_docs/API_docs_v71/methods/payments_getSavedInfo.md +++ b/old_docs/API_docs_v71/methods/payments_getSavedInfo.md @@ -1,11 +1,13 @@ --- title: payments.getSavedInfo -description: payments.getSavedInfo parameters, return type and example +description: Get saved payments info --- ## Method: payments.getSavedInfo [Back to methods index](index.md) +Get saved payments info + ### Return type: [payments\_SavedInfo](../types/payments_SavedInfo.md) diff --git a/old_docs/API_docs_v71/methods/payments_sendPaymentForm.md b/old_docs/API_docs_v71/methods/payments_sendPaymentForm.md index eb843715..0a9df99f 100644 --- a/old_docs/API_docs_v71/methods/payments_sendPaymentForm.md +++ b/old_docs/API_docs_v71/methods/payments_sendPaymentForm.md @@ -1,19 +1,21 @@ --- title: payments.sendPaymentForm -description: payments.sendPaymentForm parameters, return type and example +description: Bots only: send payment form --- ## Method: payments.sendPaymentForm [Back to methods index](index.md) +Bots only: send payment form + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|msg\_id|[CLICK ME int](../types/int.md) | Yes| -|requested\_info\_id|[CLICK ME string](../types/string.md) | Optional| -|shipping\_option\_id|[CLICK ME string](../types/string.md) | Optional| -|credentials|[CLICK ME InputPaymentCredentials](../types/InputPaymentCredentials.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|msg\_id|[CLICK ME int](../types/int.md) | Yes|Message ID| +|requested\_info\_id|[CLICK ME string](../types/string.md) | Optional|ID of requested info| +|shipping\_option\_id|[CLICK ME string](../types/string.md) | Optional|Shipping option ID| +|credentials|[CLICK ME InputPaymentCredentials](../types/InputPaymentCredentials.md) | Yes|Payment credentials| ### Return type: [payments\_PaymentResult](../types/payments_PaymentResult.md) diff --git a/old_docs/API_docs_v71/methods/payments_validateRequestedInfo.md b/old_docs/API_docs_v71/methods/payments_validateRequestedInfo.md index 32702965..e36f0e42 100644 --- a/old_docs/API_docs_v71/methods/payments_validateRequestedInfo.md +++ b/old_docs/API_docs_v71/methods/payments_validateRequestedInfo.md @@ -1,18 +1,20 @@ --- title: payments.validateRequestedInfo -description: payments.validateRequestedInfo parameters, return type and example +description: Validate requested payment info --- ## Method: payments.validateRequestedInfo [Back to methods index](index.md) +Validate requested payment info + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|save|[CLICK ME Bool](../types/Bool.md) | Optional| -|msg\_id|[CLICK ME int](../types/int.md) | Yes| -|info|[CLICK ME PaymentRequestedInfo](../types/PaymentRequestedInfo.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|save|[CLICK ME Bool](../types/Bool.md) | Optional|Save payment info?| +|msg\_id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|info|[CLICK ME PaymentRequestedInfo](../types/PaymentRequestedInfo.md) | Yes|The requested payment info| ### Return type: [payments\_ValidatedRequestedInfo](../types/payments_ValidatedRequestedInfo.md) diff --git a/old_docs/API_docs_v71/methods/photos_deletePhotos.md b/old_docs/API_docs_v71/methods/photos_deletePhotos.md index 104459b7..b9daca10 100644 --- a/old_docs/API_docs_v71/methods/photos_deletePhotos.md +++ b/old_docs/API_docs_v71/methods/photos_deletePhotos.md @@ -1,16 +1,18 @@ --- title: photos.deletePhotos -description: photos.deletePhotos parameters, return type and example +description: Delete profile photos --- ## Method: photos.deletePhotos [Back to methods index](index.md) +Delete profile photos + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Yes|The profile photos to delete| ### Return type: [Vector\_of\_long](../types/long.md) diff --git a/old_docs/API_docs_v71/methods/photos_getUserPhotos.md b/old_docs/API_docs_v71/methods/photos_getUserPhotos.md index 1a7515ba..ea27a44f 100644 --- a/old_docs/API_docs_v71/methods/photos_getUserPhotos.md +++ b/old_docs/API_docs_v71/methods/photos_getUserPhotos.md @@ -1,19 +1,21 @@ --- title: photos.getUserPhotos -description: photos.getUserPhotos parameters, return type and example +description: Get the profile photos of a user --- ## Method: photos.getUserPhotos [Back to methods index](index.md) +Get the profile photos of a user + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|offset|[CLICK ME int](../types/int.md) | Yes| -|max\_id|[CLICK ME long](../types/long.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| +|offset|[CLICK ME int](../types/int.md) | Yes|Offset| +|max\_id|[CLICK ME long](../types/long.md) | Yes|Maximum ID of photo to return| +|limit|[CLICK ME int](../types/int.md) | Yes|Number of photos to return| ### Return type: [photos\_Photos](../types/photos_Photos.md) diff --git a/old_docs/API_docs_v71/methods/photos_updateProfilePhoto.md b/old_docs/API_docs_v71/methods/photos_updateProfilePhoto.md index 28ab5fbf..7f0a4c69 100644 --- a/old_docs/API_docs_v71/methods/photos_updateProfilePhoto.md +++ b/old_docs/API_docs_v71/methods/photos_updateProfilePhoto.md @@ -1,16 +1,18 @@ --- title: photos.updateProfilePhoto -description: photos.updateProfilePhoto parameters, return type and example +description: Update the profile photo (use photos->uploadProfilePhoto to upload the photo) --- ## Method: photos.updateProfilePhoto [Back to methods index](index.md) +Update the profile photo (use photos->uploadProfilePhoto to upload the photo) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional|The photo to use| ### Return type: [UserProfilePhoto](../types/UserProfilePhoto.md) diff --git a/old_docs/API_docs_v71/methods/photos_uploadProfilePhoto.md b/old_docs/API_docs_v71/methods/photos_uploadProfilePhoto.md index 7cc9e9e5..efa08bb0 100644 --- a/old_docs/API_docs_v71/methods/photos_uploadProfilePhoto.md +++ b/old_docs/API_docs_v71/methods/photos_uploadProfilePhoto.md @@ -1,16 +1,18 @@ --- title: photos.uploadProfilePhoto -description: photos.uploadProfilePhoto parameters, return type and example +description: Upload profile photo --- ## Method: photos.uploadProfilePhoto [Back to methods index](index.md) +Upload profile photo + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|file|[File path or InputFile](../types/InputFile.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|file|[File path or InputFile](../types/InputFile.md) | Yes|The photo| ### Return type: [photos\_Photo](../types/photos_Photo.md) diff --git a/old_docs/API_docs_v71/methods/stickers_addStickerToSet.md b/old_docs/API_docs_v71/methods/stickers_addStickerToSet.md index 82a9dbd7..1f90028c 100644 --- a/old_docs/API_docs_v71/methods/stickers_addStickerToSet.md +++ b/old_docs/API_docs_v71/methods/stickers_addStickerToSet.md @@ -1,17 +1,19 @@ --- title: stickers.addStickerToSet -description: stickers.addStickerToSet parameters, return type and example +description: Add sticker to stickerset --- ## Method: stickers.addStickerToSet [Back to methods index](index.md) +Add sticker to stickerset + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional| -|sticker|[CLICK ME InputStickerSetItem](../types/InputStickerSetItem.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset| +|sticker|[CLICK ME InputStickerSetItem](../types/InputStickerSetItem.md) | Yes|The sticker| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/old_docs/API_docs_v71/methods/stickers_changeStickerPosition.md b/old_docs/API_docs_v71/methods/stickers_changeStickerPosition.md index a1a663f7..45552df9 100644 --- a/old_docs/API_docs_v71/methods/stickers_changeStickerPosition.md +++ b/old_docs/API_docs_v71/methods/stickers_changeStickerPosition.md @@ -1,17 +1,19 @@ --- title: stickers.changeStickerPosition -description: stickers.changeStickerPosition parameters, return type and example +description: Change sticker position in photo --- ## Method: stickers.changeStickerPosition [Back to methods index](index.md) +Change sticker position in photo + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|sticker|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional| -|position|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|sticker|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker| +|position|[CLICK ME int](../types/int.md) | Yes|New position| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/old_docs/API_docs_v71/methods/stickers_createStickerSet.md b/old_docs/API_docs_v71/methods/stickers_createStickerSet.md index b99874a0..c4e85852 100644 --- a/old_docs/API_docs_v71/methods/stickers_createStickerSet.md +++ b/old_docs/API_docs_v71/methods/stickers_createStickerSet.md @@ -1,20 +1,22 @@ --- title: stickers.createStickerSet -description: stickers.createStickerSet parameters, return type and example +description: Create stickerset --- ## Method: stickers.createStickerSet [Back to methods index](index.md) +Create stickerset + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|masks|[CLICK ME Bool](../types/Bool.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|title|[CLICK ME string](../types/string.md) | Yes| -|short\_name|[CLICK ME string](../types/string.md) | Yes| -|stickers|Array of [CLICK ME InputStickerSetItem](../types/InputStickerSetItem.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|masks|[CLICK ME Bool](../types/Bool.md) | Optional|Masks?| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user ID associated to this stickerset| +|title|[CLICK ME string](../types/string.md) | Yes|The stickerset title| +|short\_name|[CLICK ME string](../types/string.md) | Yes|The stickerset short name| +|stickers|Array of [CLICK ME InputStickerSetItem](../types/InputStickerSetItem.md) | Yes|The stickers to add| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/old_docs/API_docs_v71/methods/stickers_removeStickerFromSet.md b/old_docs/API_docs_v71/methods/stickers_removeStickerFromSet.md index 34f85cb0..4ae30345 100644 --- a/old_docs/API_docs_v71/methods/stickers_removeStickerFromSet.md +++ b/old_docs/API_docs_v71/methods/stickers_removeStickerFromSet.md @@ -1,16 +1,18 @@ --- title: stickers.removeStickerFromSet -description: stickers.removeStickerFromSet parameters, return type and example +description: Remove sticker from stickerset --- ## Method: stickers.removeStickerFromSet [Back to methods index](index.md) +Remove sticker from stickerset + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|sticker|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|sticker|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker to remove| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/old_docs/API_docs_v71/methods/upload_getWebFile.md b/old_docs/API_docs_v71/methods/upload_getWebFile.md index 30bd3a1f..e864e4b7 100644 --- a/old_docs/API_docs_v71/methods/upload_getWebFile.md +++ b/old_docs/API_docs_v71/methods/upload_getWebFile.md @@ -1,18 +1,20 @@ --- title: upload.getWebFile -description: upload.getWebFile parameters, return type and example +description: Download a file through telegram --- ## Method: upload.getWebFile [Back to methods index](index.md) +Download a file through telegram + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|location|[CLICK ME InputWebFileLocation](../types/InputWebFileLocation.md) | Yes| -|offset|[CLICK ME int](../types/int.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|location|[CLICK ME InputWebFileLocation](../types/InputWebFileLocation.md) | Yes|The file| +|offset|[CLICK ME int](../types/int.md) | Yes|The offset in bytes| +|limit|[CLICK ME int](../types/int.md) | Yes|The number of bytes to fetch| ### Return type: [upload\_WebFile](../types/upload_WebFile.md) diff --git a/old_docs/API_docs_v72/methods/account_registerDevice.md b/old_docs/API_docs_v72/methods/account_registerDevice.md index cd28abcd..017b9af3 100644 --- a/old_docs/API_docs_v72/methods/account_registerDevice.md +++ b/old_docs/API_docs_v72/methods/account_registerDevice.md @@ -12,8 +12,8 @@ Register device for push notifications | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and oTher, see source code of official apps for more info| +|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and oTher, see source code of official apps for more info| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v72/methods/account_unregisterDevice.md b/old_docs/API_docs_v72/methods/account_unregisterDevice.md index 1d2b7670..32e44495 100644 --- a/old_docs/API_docs_v72/methods/account_unregisterDevice.md +++ b/old_docs/API_docs_v72/methods/account_unregisterDevice.md @@ -12,8 +12,8 @@ Stop sending PUSH notifications to app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and oTher, see source code of official apps for more info| +|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and oTher, see source code of official apps for more info| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v72/methods/bots_answerWebhookJSONQuery.md b/old_docs/API_docs_v72/methods/bots_answerWebhookJSONQuery.md index 205b30f9..61056bb4 100644 --- a/old_docs/API_docs_v72/methods/bots_answerWebhookJSONQuery.md +++ b/old_docs/API_docs_v72/methods/bots_answerWebhookJSONQuery.md @@ -1,17 +1,19 @@ --- title: bots.answerWebhookJSONQuery -description: bots.answerWebhookJSONQuery parameters, return type and example +description: Send webhook request via bot API --- ## Method: bots.answerWebhookJSONQuery [Back to methods index](index.md) +Send webhook request via bot API + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|query\_id|[CLICK ME long](../types/long.md) | Yes| -|data|[CLICK ME DataJSON](../types/DataJSON.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|query\_id|[CLICK ME long](../types/long.md) | Yes|The query ID| +|data|[CLICK ME DataJSON](../types/DataJSON.md) | Yes|The parameters| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v72/methods/bots_sendCustomRequest.md b/old_docs/API_docs_v72/methods/bots_sendCustomRequest.md index 590c47b6..fc8e764d 100644 --- a/old_docs/API_docs_v72/methods/bots_sendCustomRequest.md +++ b/old_docs/API_docs_v72/methods/bots_sendCustomRequest.md @@ -1,17 +1,19 @@ --- title: bots.sendCustomRequest -description: bots.sendCustomRequest parameters, return type and example +description: Send a custom request to the bot API --- ## Method: bots.sendCustomRequest [Back to methods index](index.md) +Send a custom request to the bot API + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|custom\_method|[CLICK ME string](../types/string.md) | Yes| -|params|[CLICK ME DataJSON](../types/DataJSON.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|custom\_method|[CLICK ME string](../types/string.md) | Yes|The method to call| +|params|[CLICK ME DataJSON](../types/DataJSON.md) | Yes|Method parameters| ### Return type: [DataJSON](../types/DataJSON.md) diff --git a/old_docs/API_docs_v72/methods/channels_checkUsername.md b/old_docs/API_docs_v72/methods/channels_checkUsername.md index 371f4cd3..7bc7c245 100644 --- a/old_docs/API_docs_v72/methods/channels_checkUsername.md +++ b/old_docs/API_docs_v72/methods/channels_checkUsername.md @@ -1,17 +1,19 @@ --- title: channels.checkUsername -description: channels.checkUsername parameters, return type and example +description: Check if this username is free and can be assigned to a channel/supergroup --- ## Method: channels.checkUsername [Back to methods index](index.md) +Check if this username is free and can be assigned to a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|username|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|username|[CLICK ME string](../types/string.md) | Yes|The new username for this channel/supergroup| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v72/methods/channels_createChannel.md b/old_docs/API_docs_v72/methods/channels_createChannel.md index c5d21585..1305e4fb 100644 --- a/old_docs/API_docs_v72/methods/channels_createChannel.md +++ b/old_docs/API_docs_v72/methods/channels_createChannel.md @@ -1,19 +1,21 @@ --- title: channels.createChannel -description: channels.createChannel parameters, return type and example +description: Create channel/supergroup --- ## Method: channels.createChannel [Back to methods index](index.md) +Create channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|broadcast|[CLICK ME Bool](../types/Bool.md) | Optional| -|megagroup|[CLICK ME Bool](../types/Bool.md) | Optional| -|title|[CLICK ME string](../types/string.md) | Yes| -|about|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|broadcast|[CLICK ME Bool](../types/Bool.md) | Optional|Set this to true to create a channel| +|megagroup|[CLICK ME Bool](../types/Bool.md) | Optional|Set this to true to create a supergroup| +|title|[CLICK ME string](../types/string.md) | Yes|Supergroup/channel title| +|about|[CLICK ME string](../types/string.md) | Yes|About text| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v72/methods/channels_deleteChannel.md b/old_docs/API_docs_v72/methods/channels_deleteChannel.md index 61b29eac..e660d25c 100644 --- a/old_docs/API_docs_v72/methods/channels_deleteChannel.md +++ b/old_docs/API_docs_v72/methods/channels_deleteChannel.md @@ -1,16 +1,18 @@ --- title: channels.deleteChannel -description: channels.deleteChannel parameters, return type and example +description: Delete a channel/supergroup --- ## Method: channels.deleteChannel [Back to methods index](index.md) +Delete a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup to delete| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v72/methods/channels_deleteHistory.md b/old_docs/API_docs_v72/methods/channels_deleteHistory.md index 35fcf2f1..55a5e371 100644 --- a/old_docs/API_docs_v72/methods/channels_deleteHistory.md +++ b/old_docs/API_docs_v72/methods/channels_deleteHistory.md @@ -1,17 +1,19 @@ --- title: channels.deleteHistory -description: channels.deleteHistory parameters, return type and example +description: Delete the history of a supergroup/channel --- ## Method: channels.deleteHistory [Back to methods index](index.md) +Delete the history of a supergroup/channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|max\_id|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to delete| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v72/methods/channels_deleteMessages.md b/old_docs/API_docs_v72/methods/channels_deleteMessages.md index 87a968c5..fb9d3cc2 100644 --- a/old_docs/API_docs_v72/methods/channels_deleteMessages.md +++ b/old_docs/API_docs_v72/methods/channels_deleteMessages.md @@ -1,17 +1,19 @@ --- title: channels.deleteMessages -description: channels.deleteMessages parameters, return type and example +description: Delete channel/supergroup messages --- ## Method: channels.deleteMessages [Back to methods index](index.md) +Delete channel/supergroup messages + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|id|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to delete| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v72/methods/channels_deleteUserHistory.md b/old_docs/API_docs_v72/methods/channels_deleteUserHistory.md index ee828f45..fbe34341 100644 --- a/old_docs/API_docs_v72/methods/channels_deleteUserHistory.md +++ b/old_docs/API_docs_v72/methods/channels_deleteUserHistory.md @@ -1,17 +1,19 @@ --- title: channels.deleteUserHistory -description: channels.deleteUserHistory parameters, return type and example +description: Delete all messages of a user in a channel/supergroup --- ## Method: channels.deleteUserHistory [Back to methods index](index.md) +Delete all messages of a user in a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) diff --git a/old_docs/API_docs_v72/methods/channels_editAbout.md b/old_docs/API_docs_v72/methods/channels_editAbout.md index 94be2503..8908f29e 100644 --- a/old_docs/API_docs_v72/methods/channels_editAbout.md +++ b/old_docs/API_docs_v72/methods/channels_editAbout.md @@ -1,17 +1,19 @@ --- title: channels.editAbout -description: channels.editAbout parameters, return type and example +description: Edit the about text of a channel/supergroup --- ## Method: channels.editAbout [Back to methods index](index.md) +Edit the about text of a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|about|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|about|[CLICK ME string](../types/string.md) | Yes|The new about text| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v72/methods/channels_editAdmin.md b/old_docs/API_docs_v72/methods/channels_editAdmin.md index 08707ff4..dcec7d2f 100644 --- a/old_docs/API_docs_v72/methods/channels_editAdmin.md +++ b/old_docs/API_docs_v72/methods/channels_editAdmin.md @@ -1,18 +1,20 @@ --- title: channels.editAdmin -description: channels.editAdmin parameters, return type and example +description: Edit admin permissions of a user in a channel/supergroup --- ## Method: channels.editAdmin [Back to methods index](index.md) +Edit admin permissions of a user in a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|admin\_rights|[CLICK ME ChannelAdminRights](../types/ChannelAdminRights.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| +|admin\_rights|[CLICK ME ChannelAdminRights](../types/ChannelAdminRights.md) | Yes|The new admin rights| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v72/methods/channels_editBanned.md b/old_docs/API_docs_v72/methods/channels_editBanned.md index 1d896393..9859bcae 100644 --- a/old_docs/API_docs_v72/methods/channels_editBanned.md +++ b/old_docs/API_docs_v72/methods/channels_editBanned.md @@ -1,18 +1,20 @@ --- title: channels.editBanned -description: channels.editBanned parameters, return type and example +description: Kick or ban a user from a channel/supergroup --- ## Method: channels.editBanned [Back to methods index](index.md) +Kick or ban a user from a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|banned\_rights|[CLICK ME ChannelBannedRights](../types/ChannelBannedRights.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to kick/ban| +|banned\_rights|[CLICK ME ChannelBannedRights](../types/ChannelBannedRights.md) | Yes|Banned/kicked permissions| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v72/methods/channels_editPhoto.md b/old_docs/API_docs_v72/methods/channels_editPhoto.md index 3a2c794b..9ccd864f 100644 --- a/old_docs/API_docs_v72/methods/channels_editPhoto.md +++ b/old_docs/API_docs_v72/methods/channels_editPhoto.md @@ -1,17 +1,19 @@ --- title: channels.editPhoto -description: channels.editPhoto parameters, return type and example +description: Edit the photo of a supergroup/channel --- ## Method: channels.editPhoto [Back to methods index](index.md) +Edit the photo of a supergroup/channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new photo| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v72/methods/channels_editTitle.md b/old_docs/API_docs_v72/methods/channels_editTitle.md index ec60e10f..b1024faf 100644 --- a/old_docs/API_docs_v72/methods/channels_editTitle.md +++ b/old_docs/API_docs_v72/methods/channels_editTitle.md @@ -1,17 +1,19 @@ --- title: channels.editTitle -description: channels.editTitle parameters, return type and example +description: Edit the title of a supergroup/channel --- ## Method: channels.editTitle [Back to methods index](index.md) +Edit the title of a supergroup/channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|title|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|title|[CLICK ME string](../types/string.md) | Yes|The new channel/supergroup title| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v72/methods/channels_exportInvite.md b/old_docs/API_docs_v72/methods/channels_exportInvite.md index 3c10f832..f0c737d5 100644 --- a/old_docs/API_docs_v72/methods/channels_exportInvite.md +++ b/old_docs/API_docs_v72/methods/channels_exportInvite.md @@ -1,16 +1,18 @@ --- title: channels.exportInvite -description: channels.exportInvite parameters, return type and example +description: Export the invite link of a channel --- ## Method: channels.exportInvite [Back to methods index](index.md) +Export the invite link of a channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| ### Return type: [ExportedChatInvite](../types/ExportedChatInvite.md) diff --git a/old_docs/API_docs_v72/methods/channels_exportMessageLink.md b/old_docs/API_docs_v72/methods/channels_exportMessageLink.md index 924dc0d5..f910b594 100644 --- a/old_docs/API_docs_v72/methods/channels_exportMessageLink.md +++ b/old_docs/API_docs_v72/methods/channels_exportMessageLink.md @@ -1,17 +1,19 @@ --- title: channels.exportMessageLink -description: channels.exportMessageLink parameters, return type and example +description: Get the link of a message in a channel --- ## Method: channels.exportMessageLink [Back to methods index](index.md) +Get the link of a message in a channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|id|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|id|[CLICK ME int](../types/int.md) | Yes|The ID of the message| ### Return type: [ExportedMessageLink](../types/ExportedMessageLink.md) diff --git a/old_docs/API_docs_v72/methods/channels_getAdminLog.md b/old_docs/API_docs_v72/methods/channels_getAdminLog.md index 0585e157..5c1b805e 100644 --- a/old_docs/API_docs_v72/methods/channels_getAdminLog.md +++ b/old_docs/API_docs_v72/methods/channels_getAdminLog.md @@ -1,22 +1,24 @@ --- title: channels.getAdminLog -description: channels.getAdminLog parameters, return type and example +description: Get admin log of a channel/supergruop --- ## Method: channels.getAdminLog [Back to methods index](index.md) +Get admin log of a channel/supergruop + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|q|[CLICK ME string](../types/string.md) | Yes| -|events\_filter|[CLICK ME ChannelAdminLogEventsFilter](../types/ChannelAdminLogEventsFilter.md) | Optional| -|admins|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|max\_id|[CLICK ME long](../types/long.md) | Yes| -|min\_id|[CLICK ME long](../types/long.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|q|[CLICK ME string](../types/string.md) | Yes|Search query| +|events\_filter|[CLICK ME ChannelAdminLogEventsFilter](../types/ChannelAdminLogEventsFilter.md) | Optional|Event filter| +|admins|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|Fetch only actions from these admins| +|max\_id|[CLICK ME long](../types/long.md) | Yes|Maximum message ID to fetch| +|min\_id|[CLICK ME long](../types/long.md) | Yes|Minimum message ID to fetch| +|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to fetch| ### Return type: [channels\_AdminLogResults](../types/channels_AdminLogResults.md) diff --git a/old_docs/API_docs_v72/methods/channels_getAdminedPublicChannels.md b/old_docs/API_docs_v72/methods/channels_getAdminedPublicChannels.md index f2b48050..9646f529 100644 --- a/old_docs/API_docs_v72/methods/channels_getAdminedPublicChannels.md +++ b/old_docs/API_docs_v72/methods/channels_getAdminedPublicChannels.md @@ -1,11 +1,13 @@ --- title: channels.getAdminedPublicChannels -description: channels.getAdminedPublicChannels parameters, return type and example +description: Get all supergroups/channels where you're admin --- ## Method: channels.getAdminedPublicChannels [Back to methods index](index.md) +Get all supergroups/channels where you're admin + ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v72/methods/channels_getChannels.md b/old_docs/API_docs_v72/methods/channels_getChannels.md index bd5958d6..9cd9e798 100644 --- a/old_docs/API_docs_v72/methods/channels_getChannels.md +++ b/old_docs/API_docs_v72/methods/channels_getChannels.md @@ -1,16 +1,18 @@ --- title: channels.getChannels -description: channels.getChannels parameters, return type and example +description: Get info about multiple channels/supergroups --- ## Method: channels.getChannels [Back to methods index](index.md) +Get info about multiple channels/supergroups + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|Array of [Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|Array of [Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Yes|The channel/supergroup MTProto IDs| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v72/methods/channels_getMessages.md b/old_docs/API_docs_v72/methods/channels_getMessages.md index 4440856c..cc944fe5 100644 --- a/old_docs/API_docs_v72/methods/channels_getMessages.md +++ b/old_docs/API_docs_v72/methods/channels_getMessages.md @@ -1,17 +1,19 @@ --- title: channels.getMessages -description: channels.getMessages parameters, return type and example +description: Get channel/supergroup messages --- ## Method: channels.getMessages [Back to methods index](index.md) +Get channel/supergroup messages + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|id|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The message IDs| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v72/methods/channels_getParticipant.md b/old_docs/API_docs_v72/methods/channels_getParticipant.md index c1819b6b..db9b1fc6 100644 --- a/old_docs/API_docs_v72/methods/channels_getParticipant.md +++ b/old_docs/API_docs_v72/methods/channels_getParticipant.md @@ -1,17 +1,19 @@ --- title: channels.getParticipant -description: channels.getParticipant parameters, return type and example +description: Get info about a certain channel/supergroup participant --- ## Method: channels.getParticipant [Back to methods index](index.md) +Get info about a certain channel/supergroup participant + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to fetch info about| ### Return type: [channels\_ChannelParticipant](../types/channels_ChannelParticipant.md) diff --git a/old_docs/API_docs_v72/methods/channels_getParticipants.md b/old_docs/API_docs_v72/methods/channels_getParticipants.md index c2716da9..9b2b6c2a 100644 --- a/old_docs/API_docs_v72/methods/channels_getParticipants.md +++ b/old_docs/API_docs_v72/methods/channels_getParticipants.md @@ -1,20 +1,22 @@ --- title: channels.getParticipants -description: channels.getParticipants parameters, return type and example +description: Get channel/supergroup participants (you should use `$MadelineProto->get_pwr_chat($id)` instead) --- ## Method: channels.getParticipants [Back to methods index](index.md) +Get channel/supergroup participants (you should use `$MadelineProto->get_pwr_chat($id)` instead) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|filter|[CLICK ME ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) | Yes| -|offset|[CLICK ME int](../types/int.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| -|hash|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|filter|[CLICK ME ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) | Yes|Member filter| +|offset|[CLICK ME int](../types/int.md) | Yes|Offset| +|limit|[CLICK ME int](../types/int.md) | Yes|Limit| +|hash|[CLICK ME int](../types/int.md) | Yes|$MadelineProto->gen_vector_hash(ids of previously fetched participant IDs)| ### Return type: [channels\_ChannelParticipants](../types/channels_ChannelParticipants.md) diff --git a/old_docs/API_docs_v72/methods/channels_inviteToChannel.md b/old_docs/API_docs_v72/methods/channels_inviteToChannel.md index 9bca2967..676f800c 100644 --- a/old_docs/API_docs_v72/methods/channels_inviteToChannel.md +++ b/old_docs/API_docs_v72/methods/channels_inviteToChannel.md @@ -1,17 +1,19 @@ --- title: channels.inviteToChannel -description: channels.inviteToChannel parameters, return type and example +description: Add users to channel/supergroup --- ## Method: channels.inviteToChannel [Back to methods index](index.md) +Add users to channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to add| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v72/methods/channels_joinChannel.md b/old_docs/API_docs_v72/methods/channels_joinChannel.md index 9ecdbe75..721f707c 100644 --- a/old_docs/API_docs_v72/methods/channels_joinChannel.md +++ b/old_docs/API_docs_v72/methods/channels_joinChannel.md @@ -1,16 +1,18 @@ --- title: channels.joinChannel -description: channels.joinChannel parameters, return type and example +description: Join a channel/supergroup --- ## Method: channels.joinChannel [Back to methods index](index.md) +Join a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup to join| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v72/methods/channels_leaveChannel.md b/old_docs/API_docs_v72/methods/channels_leaveChannel.md index 62c20a00..7f02e08c 100644 --- a/old_docs/API_docs_v72/methods/channels_leaveChannel.md +++ b/old_docs/API_docs_v72/methods/channels_leaveChannel.md @@ -1,16 +1,18 @@ --- title: channels.leaveChannel -description: channels.leaveChannel parameters, return type and example +description: Leave a channel/supergroup --- ## Method: channels.leaveChannel [Back to methods index](index.md) +Leave a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup to leave| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v72/methods/channels_readHistory.md b/old_docs/API_docs_v72/methods/channels_readHistory.md index 745893f6..cca891f0 100644 --- a/old_docs/API_docs_v72/methods/channels_readHistory.md +++ b/old_docs/API_docs_v72/methods/channels_readHistory.md @@ -1,17 +1,19 @@ --- title: channels.readHistory -description: channels.readHistory parameters, return type and example +description: Mark channel/supergroup history as read --- ## Method: channels.readHistory [Back to methods index](index.md) +Mark channel/supergroup history as read + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|max\_id|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to mark as read| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v72/methods/channels_readMessageContents.md b/old_docs/API_docs_v72/methods/channels_readMessageContents.md index 8d1d6891..861844c4 100644 --- a/old_docs/API_docs_v72/methods/channels_readMessageContents.md +++ b/old_docs/API_docs_v72/methods/channels_readMessageContents.md @@ -1,17 +1,19 @@ --- title: channels.readMessageContents -description: channels.readMessageContents parameters, return type and example +description: Mark channel/supergroup messages as read --- ## Method: channels.readMessageContents [Back to methods index](index.md) +Mark channel/supergroup messages as read + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|id|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|id|Array of [CLICK ME int](../types/int.md) | Yes|List of message IDs| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v72/methods/channels_reportSpam.md b/old_docs/API_docs_v72/methods/channels_reportSpam.md index 47dd7cff..09af14e0 100644 --- a/old_docs/API_docs_v72/methods/channels_reportSpam.md +++ b/old_docs/API_docs_v72/methods/channels_reportSpam.md @@ -1,18 +1,20 @@ --- title: channels.reportSpam -description: channels.reportSpam parameters, return type and example +description: Report a supergroup/channel for spam --- ## Method: channels.reportSpam [Back to methods index](index.md) +Report a supergroup/channel for spam + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|id|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that added you to this channel| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to report| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v72/methods/channels_setStickers.md b/old_docs/API_docs_v72/methods/channels_setStickers.md index 1b900e48..9ed5bd55 100644 --- a/old_docs/API_docs_v72/methods/channels_setStickers.md +++ b/old_docs/API_docs_v72/methods/channels_setStickers.md @@ -1,17 +1,19 @@ --- title: channels.setStickers -description: channels.setStickers parameters, return type and example +description: Set the supergroup/channel stickerpack --- ## Method: channels.setStickers [Back to methods index](index.md) +Set the supergroup/channel stickerpack + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergoup| +|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v72/methods/channels_toggleInvites.md b/old_docs/API_docs_v72/methods/channels_toggleInvites.md index b6771ed3..5b541f67 100644 --- a/old_docs/API_docs_v72/methods/channels_toggleInvites.md +++ b/old_docs/API_docs_v72/methods/channels_toggleInvites.md @@ -1,17 +1,19 @@ --- title: channels.toggleInvites -description: channels.toggleInvites parameters, return type and example +description: Allow or disallow any user to invite users to this channel/supergroup --- ## Method: channels.toggleInvites [Back to methods index](index.md) +Allow or disallow any user to invite users to this channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Allow or disallow| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v72/methods/channels_togglePreHistoryHidden.md b/old_docs/API_docs_v72/methods/channels_togglePreHistoryHidden.md index 489472b0..9327de90 100644 --- a/old_docs/API_docs_v72/methods/channels_togglePreHistoryHidden.md +++ b/old_docs/API_docs_v72/methods/channels_togglePreHistoryHidden.md @@ -1,17 +1,19 @@ --- title: channels.togglePreHistoryHidden -description: channels.togglePreHistoryHidden parameters, return type and example +description: Enable or disable hidden history for new channel/supergroup users --- ## Method: channels.togglePreHistoryHidden [Back to methods index](index.md) +Enable or disable hidden history for new channel/supergroup users + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Enable or disable hidden history for new channel/supergroup users| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v72/methods/channels_toggleSignatures.md b/old_docs/API_docs_v72/methods/channels_toggleSignatures.md index e8ff70a8..f233a8e1 100644 --- a/old_docs/API_docs_v72/methods/channels_toggleSignatures.md +++ b/old_docs/API_docs_v72/methods/channels_toggleSignatures.md @@ -1,17 +1,19 @@ --- title: channels.toggleSignatures -description: channels.toggleSignatures parameters, return type and example +description: Toggle channel signatures --- ## Method: channels.toggleSignatures [Back to methods index](index.md) +Toggle channel signatures + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Enable or disable channel signatures?| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v72/methods/channels_updatePinnedMessage.md b/old_docs/API_docs_v72/methods/channels_updatePinnedMessage.md index 7a14b68b..f06d1f0f 100644 --- a/old_docs/API_docs_v72/methods/channels_updatePinnedMessage.md +++ b/old_docs/API_docs_v72/methods/channels_updatePinnedMessage.md @@ -1,18 +1,20 @@ --- title: channels.updatePinnedMessage -description: channels.updatePinnedMessage parameters, return type and example +description: Set the pinned message of a channel/supergroup --- ## Method: channels.updatePinnedMessage [Back to methods index](index.md) +Set the pinned message of a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|id|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Pin silently| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|id|[CLICK ME int](../types/int.md) | Yes|The ID of the message to pin| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v72/methods/channels_updateUsername.md b/old_docs/API_docs_v72/methods/channels_updateUsername.md index 19647598..ad34490a 100644 --- a/old_docs/API_docs_v72/methods/channels_updateUsername.md +++ b/old_docs/API_docs_v72/methods/channels_updateUsername.md @@ -1,17 +1,19 @@ --- title: channels.updateUsername -description: channels.updateUsername parameters, return type and example +description: Update the username of a supergroup/channel --- ## Method: channels.updateUsername [Back to methods index](index.md) +Update the username of a supergroup/channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|username|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|username|[CLICK ME string](../types/string.md) | Yes|The new username| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v72/methods/contacts_getBlocked.md b/old_docs/API_docs_v72/methods/contacts_getBlocked.md index d7d8c5cc..300025af 100644 --- a/old_docs/API_docs_v72/methods/contacts_getBlocked.md +++ b/old_docs/API_docs_v72/methods/contacts_getBlocked.md @@ -12,7 +12,7 @@ Get blocked users | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, then set to the number of blocked contacts previously fetched| +|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, Then set to the number of blocked contacts previously fetched| |limit|[CLICK ME int](../types/int.md) | Yes|How many blocked contacts to fetch| diff --git a/old_docs/API_docs_v72/methods/contacts_getTopPeers.md b/old_docs/API_docs_v72/methods/contacts_getTopPeers.md index 226d3aa0..d7b21757 100644 --- a/old_docs/API_docs_v72/methods/contacts_getTopPeers.md +++ b/old_docs/API_docs_v72/methods/contacts_getTopPeers.md @@ -18,7 +18,7 @@ Get most used chats |phone\_calls|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch phone calls?| |groups|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch groups?| |channels|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch channels and supergroups?| -|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, then `$offset += $contacts_TopPeers['categories']['count'];`| +|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, Then `$offset += $contacts_TopPeers['categories']['count'];`| |limit|[CLICK ME int](../types/int.md) | Yes|How many results to fetch| |hash|[CLICK ME int](../types/int.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched peer ids);| diff --git a/old_docs/API_docs_v72/methods/help_getAppChangelog.md b/old_docs/API_docs_v72/methods/help_getAppChangelog.md index ea7192f6..477df2f8 100644 --- a/old_docs/API_docs_v72/methods/help_getAppChangelog.md +++ b/old_docs/API_docs_v72/methods/help_getAppChangelog.md @@ -1,16 +1,18 @@ --- title: help.getAppChangelog -description: help.getAppChangelog parameters, return type and example +description: Get the changelog of this app --- ## Method: help.getAppChangelog [Back to methods index](index.md) +Get the changelog of this app + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|prev\_app\_version|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|prev\_app\_version|[CLICK ME string](../types/string.md) | Yes|Previous app version| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v72/methods/help_getAppUpdate.md b/old_docs/API_docs_v72/methods/help_getAppUpdate.md index ef72cce2..b88906ae 100644 --- a/old_docs/API_docs_v72/methods/help_getAppUpdate.md +++ b/old_docs/API_docs_v72/methods/help_getAppUpdate.md @@ -1,11 +1,13 @@ --- title: help.getAppUpdate -description: help.getAppUpdate parameters, return type and example +description: Get info about app updates --- ## Method: help.getAppUpdate [Back to methods index](index.md) +Get info about app updates + ### Return type: [help\_AppUpdate](../types/help_AppUpdate.md) diff --git a/old_docs/API_docs_v72/methods/help_getCdnConfig.md b/old_docs/API_docs_v72/methods/help_getCdnConfig.md index 55a6e6fd..809ea1fb 100644 --- a/old_docs/API_docs_v72/methods/help_getCdnConfig.md +++ b/old_docs/API_docs_v72/methods/help_getCdnConfig.md @@ -1,11 +1,13 @@ --- title: help.getCdnConfig -description: help.getCdnConfig parameters, return type and example +description: Get CDN configuration --- ## Method: help.getCdnConfig [Back to methods index](index.md) +Get CDN configuration + ### Return type: [CdnConfig](../types/CdnConfig.md) diff --git a/old_docs/API_docs_v72/methods/help_getConfig.md b/old_docs/API_docs_v72/methods/help_getConfig.md index 885ad5d3..16e25c68 100644 --- a/old_docs/API_docs_v72/methods/help_getConfig.md +++ b/old_docs/API_docs_v72/methods/help_getConfig.md @@ -1,11 +1,13 @@ --- title: help.getConfig -description: help.getConfig parameters, return type and example +description: Get server configuration --- ## Method: help.getConfig [Back to methods index](index.md) +Get server configuration + ### Return type: [Config](../types/Config.md) diff --git a/old_docs/API_docs_v72/methods/help_getInviteText.md b/old_docs/API_docs_v72/methods/help_getInviteText.md index 101ead40..6b226bff 100644 --- a/old_docs/API_docs_v72/methods/help_getInviteText.md +++ b/old_docs/API_docs_v72/methods/help_getInviteText.md @@ -1,11 +1,13 @@ --- title: help.getInviteText -description: help.getInviteText parameters, return type and example +description: Get invitation text --- ## Method: help.getInviteText [Back to methods index](index.md) +Get invitation text + ### Return type: [help\_InviteText](../types/help_InviteText.md) diff --git a/old_docs/API_docs_v72/methods/help_getNearestDc.md b/old_docs/API_docs_v72/methods/help_getNearestDc.md index 6196890b..35a8bf91 100644 --- a/old_docs/API_docs_v72/methods/help_getNearestDc.md +++ b/old_docs/API_docs_v72/methods/help_getNearestDc.md @@ -1,11 +1,13 @@ --- title: help.getNearestDc -description: help.getNearestDc parameters, return type and example +description: Get nearest datacenter --- ## Method: help.getNearestDc [Back to methods index](index.md) +Get nearest datacenter + ### Return type: [NearestDc](../types/NearestDc.md) diff --git a/old_docs/API_docs_v72/methods/help_getRecentMeUrls.md b/old_docs/API_docs_v72/methods/help_getRecentMeUrls.md index bec8a8e0..43a47dad 100644 --- a/old_docs/API_docs_v72/methods/help_getRecentMeUrls.md +++ b/old_docs/API_docs_v72/methods/help_getRecentMeUrls.md @@ -1,16 +1,18 @@ --- title: help.getRecentMeUrls -description: help.getRecentMeUrls parameters, return type and example +description: Get recent t.me URLs --- ## Method: help.getRecentMeUrls [Back to methods index](index.md) +Get recent t.me URLs + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|referer|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|referer|[CLICK ME string](../types/string.md) | Yes|Referrer| ### Return type: [help\_RecentMeUrls](../types/help_RecentMeUrls.md) diff --git a/old_docs/API_docs_v72/methods/help_getSupport.md b/old_docs/API_docs_v72/methods/help_getSupport.md index 9b269f78..a5bab0f2 100644 --- a/old_docs/API_docs_v72/methods/help_getSupport.md +++ b/old_docs/API_docs_v72/methods/help_getSupport.md @@ -1,11 +1,13 @@ --- title: help.getSupport -description: help.getSupport parameters, return type and example +description: Get info of support user --- ## Method: help.getSupport [Back to methods index](index.md) +Get info of support user + ### Return type: [help\_Support](../types/help_Support.md) diff --git a/old_docs/API_docs_v72/methods/help_getTermsOfService.md b/old_docs/API_docs_v72/methods/help_getTermsOfService.md index f63807ab..487cd83a 100644 --- a/old_docs/API_docs_v72/methods/help_getTermsOfService.md +++ b/old_docs/API_docs_v72/methods/help_getTermsOfService.md @@ -1,11 +1,13 @@ --- title: help.getTermsOfService -description: help.getTermsOfService parameters, return type and example +description: Get terms of service --- ## Method: help.getTermsOfService [Back to methods index](index.md) +Get terms of service + ### Return type: [help\_TermsOfService](../types/help_TermsOfService.md) diff --git a/old_docs/API_docs_v72/methods/help_saveAppLog.md b/old_docs/API_docs_v72/methods/help_saveAppLog.md index af6e94e2..0165b6e3 100644 --- a/old_docs/API_docs_v72/methods/help_saveAppLog.md +++ b/old_docs/API_docs_v72/methods/help_saveAppLog.md @@ -1,16 +1,18 @@ --- title: help.saveAppLog -description: help.saveAppLog parameters, return type and example +description: Log data for developer of this app --- ## Method: help.saveAppLog [Back to methods index](index.md) +Log data for developer of this app + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|events|Array of [CLICK ME InputAppEvent](../types/InputAppEvent.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|events|Array of [CLICK ME InputAppEvent](../types/InputAppEvent.md) | Yes|Event list| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v72/methods/help_setBotUpdatesStatus.md b/old_docs/API_docs_v72/methods/help_setBotUpdatesStatus.md index 3351fab4..ff314b5c 100644 --- a/old_docs/API_docs_v72/methods/help_setBotUpdatesStatus.md +++ b/old_docs/API_docs_v72/methods/help_setBotUpdatesStatus.md @@ -1,17 +1,19 @@ --- title: help.setBotUpdatesStatus -description: help.setBotUpdatesStatus parameters, return type and example +description: Set the update status of webhook --- ## Method: help.setBotUpdatesStatus [Back to methods index](index.md) +Set the update status of webhook + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|pending\_updates\_count|[CLICK ME int](../types/int.md) | Yes| -|message|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|pending\_updates\_count|[CLICK ME int](../types/int.md) | Yes|Pending update count| +|message|[CLICK ME string](../types/string.md) | Yes|Message| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v72/methods/messages_checkChatInvite.md b/old_docs/API_docs_v72/methods/messages_checkChatInvite.md index 4ddf5084..de1d9ff4 100644 --- a/old_docs/API_docs_v72/methods/messages_checkChatInvite.md +++ b/old_docs/API_docs_v72/methods/messages_checkChatInvite.md @@ -1,16 +1,18 @@ --- title: messages.checkChatInvite -description: messages.checkChatInvite parameters, return type and example +description: Check if an invitation link is valid --- ## Method: messages.checkChatInvite [Back to methods index](index.md) +Check if an invitation link is valid + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| ### Return type: [ChatInvite](../types/ChatInvite.md) diff --git a/old_docs/API_docs_v72/methods/messages_clearRecentStickers.md b/old_docs/API_docs_v72/methods/messages_clearRecentStickers.md index f017087f..9c1b3754 100644 --- a/old_docs/API_docs_v72/methods/messages_clearRecentStickers.md +++ b/old_docs/API_docs_v72/methods/messages_clearRecentStickers.md @@ -1,16 +1,18 @@ --- title: messages.clearRecentStickers -description: messages.clearRecentStickers parameters, return type and example +description: Clear all recent stickers --- ## Method: messages.clearRecentStickers [Back to methods index](index.md) +Clear all recent stickers + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|attached|[CLICK ME Bool](../types/Bool.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|attached|[CLICK ME Bool](../types/Bool.md) | Optional|Clear recent stickers attached to images?| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v72/methods/messages_deleteChatUser.md b/old_docs/API_docs_v72/methods/messages_deleteChatUser.md index a71f4aaf..0a6830de 100644 --- a/old_docs/API_docs_v72/methods/messages_deleteChatUser.md +++ b/old_docs/API_docs_v72/methods/messages_deleteChatUser.md @@ -12,7 +12,7 @@ Delete a user from a chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The MTProto ID of the chat| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to delete (pass @me to leave the chat)| diff --git a/old_docs/API_docs_v72/methods/messages_editChatAdmin.md b/old_docs/API_docs_v72/methods/messages_editChatAdmin.md index 6bc8f9ae..7916f8b1 100644 --- a/old_docs/API_docs_v72/methods/messages_editChatAdmin.md +++ b/old_docs/API_docs_v72/methods/messages_editChatAdmin.md @@ -1,18 +1,20 @@ --- title: messages.editChatAdmin -description: messages.editChatAdmin parameters, return type and example +description: Edit admin permissions --- ## Method: messages.editChatAdmin [Back to methods index](index.md) +Edit admin permissions + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|is\_admin|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat ID (no supergroups)| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user ID| +|is\_admin|[CLICK ME Bool](../types/Bool.md) | Yes|Should the user be admin?| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v72/methods/messages_editChatPhoto.md b/old_docs/API_docs_v72/methods/messages_editChatPhoto.md index 8848eca7..122913c4 100644 --- a/old_docs/API_docs_v72/methods/messages_editChatPhoto.md +++ b/old_docs/API_docs_v72/methods/messages_editChatPhoto.md @@ -12,7 +12,7 @@ Edit the photo of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The MTProto ID of the chat| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| |photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| diff --git a/old_docs/API_docs_v72/methods/messages_editChatTitle.md b/old_docs/API_docs_v72/methods/messages_editChatTitle.md index 1c1c7a16..3a1e974b 100644 --- a/old_docs/API_docs_v72/methods/messages_editChatTitle.md +++ b/old_docs/API_docs_v72/methods/messages_editChatTitle.md @@ -12,7 +12,7 @@ Edit the title of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The MTProto ID of the chat| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| |title|[CLICK ME string](../types/string.md) | Yes|The new title| diff --git a/old_docs/API_docs_v72/methods/messages_editInlineBotMessage.md b/old_docs/API_docs_v72/methods/messages_editInlineBotMessage.md index c0d06614..2237fb20 100644 --- a/old_docs/API_docs_v72/methods/messages_editInlineBotMessage.md +++ b/old_docs/API_docs_v72/methods/messages_editInlineBotMessage.md @@ -1,20 +1,22 @@ --- title: messages.editInlineBotMessage -description: messages.editInlineBotMessage parameters, return type and example +description: Edit a sent inline message --- ## Method: messages.editInlineBotMessage [Back to methods index](index.md) +Edit a sent inline message + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional| -|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes| -|message|[CLICK ME string](../types/string.md) | Optional| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview| +|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The message ID| +|message|[CLICK ME string](../types/string.md) | Optional|The new message| +|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| +|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/old_docs/API_docs_v72/methods/messages_editMessage.md b/old_docs/API_docs_v72/methods/messages_editMessage.md index 6953a15f..f2533fc2 100644 --- a/old_docs/API_docs_v72/methods/messages_editMessage.md +++ b/old_docs/API_docs_v72/methods/messages_editMessage.md @@ -1,24 +1,26 @@ --- title: messages.editMessage -description: messages.editMessage parameters, return type and example +description: Edit a message --- ## Method: messages.editMessage [Back to methods index](index.md) +Edit a message + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional| -|stop\_geo\_live|[CLICK ME Bool](../types/Bool.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|id|[CLICK ME int](../types/int.md) | Yes| -|message|[CLICK ME string](../types/string.md) | Optional| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview| +|stop\_geo\_live|[CLICK ME Bool](../types/Bool.md) | Optional|Stop live location| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| +|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|message|[CLICK ME string](../types/string.md) | Optional|The new message| +|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| +|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| -|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional| +|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional|The new location| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v72/methods/messages_exportChatInvite.md b/old_docs/API_docs_v72/methods/messages_exportChatInvite.md index 74d70c21..98685d96 100644 --- a/old_docs/API_docs_v72/methods/messages_exportChatInvite.md +++ b/old_docs/API_docs_v72/methods/messages_exportChatInvite.md @@ -1,16 +1,18 @@ --- title: messages.exportChatInvite -description: messages.exportChatInvite parameters, return type and example +description: Export chat invite --- ## Method: messages.exportChatInvite [Back to methods index](index.md) +Export chat invite + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat id | ### Return type: [ExportedChatInvite](../types/ExportedChatInvite.md) diff --git a/old_docs/API_docs_v72/methods/messages_faveSticker.md b/old_docs/API_docs_v72/methods/messages_faveSticker.md index b9d9a033..c1ffb16a 100644 --- a/old_docs/API_docs_v72/methods/messages_faveSticker.md +++ b/old_docs/API_docs_v72/methods/messages_faveSticker.md @@ -1,17 +1,19 @@ --- title: messages.faveSticker -description: messages.faveSticker parameters, return type and example +description: Add a sticker to favorites --- ## Method: messages.faveSticker [Back to methods index](index.md) +Add a sticker to favorites + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional| -|unfave|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker to add to favorites| +|unfave|[CLICK ME Bool](../types/Bool.md) | Yes|Remove it from favorites?| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v72/methods/messages_getAllChats.md b/old_docs/API_docs_v72/methods/messages_getAllChats.md index 4b87df49..127456e4 100644 --- a/old_docs/API_docs_v72/methods/messages_getAllChats.md +++ b/old_docs/API_docs_v72/methods/messages_getAllChats.md @@ -1,16 +1,18 @@ --- title: messages.getAllChats -description: messages.getAllChats parameters, return type and example +description: Get all chats (not supergroups or channels) --- ## Method: messages.getAllChats [Back to methods index](index.md) +Get all chats (not supergroups or channels) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|except\_ids|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|except\_ids|Array of [CLICK ME int](../types/int.md) | Yes|Do not fetch these chats (MTProto id)| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v72/methods/messages_getAllDrafts.md b/old_docs/API_docs_v72/methods/messages_getAllDrafts.md index a5dd59f6..2c0ecd42 100644 --- a/old_docs/API_docs_v72/methods/messages_getAllDrafts.md +++ b/old_docs/API_docs_v72/methods/messages_getAllDrafts.md @@ -1,11 +1,13 @@ --- title: messages.getAllDrafts -description: messages.getAllDrafts parameters, return type and example +description: Get all message drafts --- ## Method: messages.getAllDrafts [Back to methods index](index.md) +Get all message drafts + ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v72/methods/messages_getAllStickers.md b/old_docs/API_docs_v72/methods/messages_getAllStickers.md index 575fcd49..16fdba6c 100644 --- a/old_docs/API_docs_v72/methods/messages_getAllStickers.md +++ b/old_docs/API_docs_v72/methods/messages_getAllStickers.md @@ -1,16 +1,18 @@ --- title: messages.getAllStickers -description: messages.getAllStickers parameters, return type and example +description: Get all stickerpacks --- ## Method: messages.getAllStickers [Back to methods index](index.md) +Get all stickerpacks + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v72/methods/messages_getArchivedStickers.md b/old_docs/API_docs_v72/methods/messages_getArchivedStickers.md index 1b4aaa93..f037e1bc 100644 --- a/old_docs/API_docs_v72/methods/messages_getArchivedStickers.md +++ b/old_docs/API_docs_v72/methods/messages_getArchivedStickers.md @@ -1,18 +1,20 @@ --- title: messages.getArchivedStickers -description: messages.getArchivedStickers parameters, return type and example +description: Get all archived stickers --- ## Method: messages.getArchivedStickers [Back to methods index](index.md) +Get all archived stickers + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|masks|[CLICK ME Bool](../types/Bool.md) | Optional| -|offset\_id|[CLICK ME long](../types/long.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|masks|[CLICK ME Bool](../types/Bool.md) | Optional|Get masks?| +|offset\_id|[CLICK ME long](../types/long.md) | Yes|Sticker ID offset| +|limit|[CLICK ME int](../types/int.md) | Yes|Number of stickers to fetch| ### Return type: [messages\_ArchivedStickers](../types/messages_ArchivedStickers.md) diff --git a/old_docs/API_docs_v72/methods/messages_getAttachedStickers.md b/old_docs/API_docs_v72/methods/messages_getAttachedStickers.md index a0d89b31..890680cd 100644 --- a/old_docs/API_docs_v72/methods/messages_getAttachedStickers.md +++ b/old_docs/API_docs_v72/methods/messages_getAttachedStickers.md @@ -1,16 +1,18 @@ --- title: messages.getAttachedStickers -description: messages.getAttachedStickers parameters, return type and example +description: Get stickers attachable to images --- ## Method: messages.getAttachedStickers [Back to methods index](index.md) +Get stickers attachable to images + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|media|[CLICK ME InputStickeredMedia](../types/InputStickeredMedia.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|media|[CLICK ME InputStickeredMedia](../types/InputStickeredMedia.md) | Yes|The stickered media| ### Return type: [Vector\_of\_StickerSetCovered](../types/StickerSetCovered.md) diff --git a/old_docs/API_docs_v72/methods/messages_getBotCallbackAnswer.md b/old_docs/API_docs_v72/methods/messages_getBotCallbackAnswer.md index 7ccd0d1b..09c283f5 100644 --- a/old_docs/API_docs_v72/methods/messages_getBotCallbackAnswer.md +++ b/old_docs/API_docs_v72/methods/messages_getBotCallbackAnswer.md @@ -1,19 +1,21 @@ --- title: messages.getBotCallbackAnswer -description: messages.getBotCallbackAnswer parameters, return type and example +description: Get the callback answer of a bot (after clicking a button) --- ## Method: messages.getBotCallbackAnswer [Back to methods index](index.md) +Get the callback answer of a bot (after clicking a button) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|game|[CLICK ME Bool](../types/Bool.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|msg\_id|[CLICK ME int](../types/int.md) | Yes| -|data|[CLICK ME bytes](../types/bytes.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|game|[CLICK ME Bool](../types/Bool.md) | Optional|Is this a game?| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| +|msg\_id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|data|[CLICK ME bytes](../types/bytes.md) | Optional|The data to send to the bot| ### Return type: [messages\_BotCallbackAnswer](../types/messages_BotCallbackAnswer.md) diff --git a/old_docs/API_docs_v72/methods/messages_getCommonChats.md b/old_docs/API_docs_v72/methods/messages_getCommonChats.md index a57d7f5a..e6eca283 100644 --- a/old_docs/API_docs_v72/methods/messages_getCommonChats.md +++ b/old_docs/API_docs_v72/methods/messages_getCommonChats.md @@ -1,18 +1,20 @@ --- title: messages.getCommonChats -description: messages.getCommonChats parameters, return type and example +description: Get chats in common with a user --- ## Method: messages.getCommonChats [Back to methods index](index.md) +Get chats in common with a user + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|max\_id|[CLICK ME int](../types/int.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| +|max\_id|[CLICK ME int](../types/int.md) | Yes|The maximum chat ID to fetch| +|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to fetch| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v72/methods/messages_getDocumentByHash.md b/old_docs/API_docs_v72/methods/messages_getDocumentByHash.md index b7c45398..1af5bad4 100644 --- a/old_docs/API_docs_v72/methods/messages_getDocumentByHash.md +++ b/old_docs/API_docs_v72/methods/messages_getDocumentByHash.md @@ -1,18 +1,20 @@ --- title: messages.getDocumentByHash -description: messages.getDocumentByHash parameters, return type and example +description: Get document by SHA256 hash --- ## Method: messages.getDocumentByHash [Back to methods index](index.md) +Get document by SHA256 hash + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|sha256|[CLICK ME bytes](../types/bytes.md) | Yes| -|size|[CLICK ME int](../types/int.md) | Yes| -|mime\_type|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|sha256|[CLICK ME bytes](../types/bytes.md) | Yes|`hash('sha256', $filename, true);`| +|size|[CLICK ME int](../types/int.md) | Yes|The file size| +|mime\_type|[CLICK ME string](../types/string.md) | Yes|The mime type of the file| ### Return type: [Document](../types/Document.md) diff --git a/old_docs/API_docs_v72/methods/messages_getFavedStickers.md b/old_docs/API_docs_v72/methods/messages_getFavedStickers.md index e95d0133..1be542be 100644 --- a/old_docs/API_docs_v72/methods/messages_getFavedStickers.md +++ b/old_docs/API_docs_v72/methods/messages_getFavedStickers.md @@ -1,16 +1,18 @@ --- title: messages.getFavedStickers -description: messages.getFavedStickers parameters, return type and example +description: Get favorite stickers --- ## Method: messages.getFavedStickers [Back to methods index](index.md) +Get favorite stickers + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_FavedStickers](../types/messages_FavedStickers.md) diff --git a/old_docs/API_docs_v72/methods/messages_getFeaturedStickers.md b/old_docs/API_docs_v72/methods/messages_getFeaturedStickers.md index 88b5609c..512f2e85 100644 --- a/old_docs/API_docs_v72/methods/messages_getFeaturedStickers.md +++ b/old_docs/API_docs_v72/methods/messages_getFeaturedStickers.md @@ -1,16 +1,18 @@ --- title: messages.getFeaturedStickers -description: messages.getFeaturedStickers parameters, return type and example +description: Get featured stickers --- ## Method: messages.getFeaturedStickers [Back to methods index](index.md) +Get featured stickers + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_FeaturedStickers](../types/messages_FeaturedStickers.md) diff --git a/old_docs/API_docs_v72/methods/messages_getGameHighScores.md b/old_docs/API_docs_v72/methods/messages_getGameHighScores.md index 2c95af05..5137baea 100644 --- a/old_docs/API_docs_v72/methods/messages_getGameHighScores.md +++ b/old_docs/API_docs_v72/methods/messages_getGameHighScores.md @@ -1,18 +1,20 @@ --- title: messages.getGameHighScores -description: messages.getGameHighScores parameters, return type and example +description: Get high scores of a game --- ## Method: messages.getGameHighScores [Back to methods index](index.md) +Get high scores of a game + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|id|[CLICK ME int](../types/int.md) | Yes| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| +|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the high scores| ### Return type: [messages\_HighScores](../types/messages_HighScores.md) diff --git a/old_docs/API_docs_v72/methods/messages_getInlineBotResults.md b/old_docs/API_docs_v72/methods/messages_getInlineBotResults.md index 5b2bb254..8ab5bf78 100644 --- a/old_docs/API_docs_v72/methods/messages_getInlineBotResults.md +++ b/old_docs/API_docs_v72/methods/messages_getInlineBotResults.md @@ -1,20 +1,22 @@ --- title: messages.getInlineBotResults -description: messages.getInlineBotResults parameters, return type and example +description: Call inline bot --- ## Method: messages.getInlineBotResults [Back to methods index](index.md) +Call inline bot + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional| -|query|[CLICK ME string](../types/string.md) | Yes| -|offset|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot to call| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to call the bot| +|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional|The current location| +|query|[CLICK ME string](../types/string.md) | Yes|The query to send to the bot| +|offset|[CLICK ME string](../types/string.md) | Yes|The offset to send to the bot| ### Return type: [messages\_BotResults](../types/messages_BotResults.md) diff --git a/old_docs/API_docs_v72/methods/messages_getInlineGameHighScores.md b/old_docs/API_docs_v72/methods/messages_getInlineGameHighScores.md index 447a55dd..790bfdd9 100644 --- a/old_docs/API_docs_v72/methods/messages_getInlineGameHighScores.md +++ b/old_docs/API_docs_v72/methods/messages_getInlineGameHighScores.md @@ -1,17 +1,19 @@ --- title: messages.getInlineGameHighScores -description: messages.getInlineGameHighScores parameters, return type and example +description: Get high scores of a game sent in an inline message --- ## Method: messages.getInlineGameHighScores [Back to methods index](index.md) +Get high scores of a game sent in an inline message + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The inline message| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the high scores| ### Return type: [messages\_HighScores](../types/messages_HighScores.md) diff --git a/old_docs/API_docs_v72/methods/messages_getMaskStickers.md b/old_docs/API_docs_v72/methods/messages_getMaskStickers.md index 80c16471..f4ed9411 100644 --- a/old_docs/API_docs_v72/methods/messages_getMaskStickers.md +++ b/old_docs/API_docs_v72/methods/messages_getMaskStickers.md @@ -1,16 +1,18 @@ --- title: messages.getMaskStickers -description: messages.getMaskStickers parameters, return type and example +description: Get masks --- ## Method: messages.getMaskStickers [Back to methods index](index.md) +Get masks + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v72/methods/messages_getMessageEditData.md b/old_docs/API_docs_v72/methods/messages_getMessageEditData.md index 339678bd..12e71bee 100644 --- a/old_docs/API_docs_v72/methods/messages_getMessageEditData.md +++ b/old_docs/API_docs_v72/methods/messages_getMessageEditData.md @@ -1,17 +1,19 @@ --- title: messages.getMessageEditData -description: messages.getMessageEditData parameters, return type and example +description: Check if about to edit a message or a media caption --- ## Method: messages.getMessageEditData [Back to methods index](index.md) +Check if about to edit a message or a media caption + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|id|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| +|id|[CLICK ME int](../types/int.md) | Yes|The message ID| ### Return type: [messages\_MessageEditData](../types/messages_MessageEditData.md) diff --git a/old_docs/API_docs_v72/methods/messages_getMessagesViews.md b/old_docs/API_docs_v72/methods/messages_getMessagesViews.md index e3f4e4ea..b8d78c85 100644 --- a/old_docs/API_docs_v72/methods/messages_getMessagesViews.md +++ b/old_docs/API_docs_v72/methods/messages_getMessagesViews.md @@ -1,18 +1,20 @@ --- title: messages.getMessagesViews -description: messages.getMessagesViews parameters, return type and example +description: Get and increase message views --- ## Method: messages.getMessagesViews [Back to methods index](index.md) +Get and increase message views + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|id|Array of [CLICK ME int](../types/int.md) | Yes| -|increment|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the message is located| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs messages to get| +|increment|[CLICK ME Bool](../types/Bool.md) | Yes|Increase message views?| ### Return type: [Vector\_of\_int](../types/int.md) diff --git a/old_docs/API_docs_v72/methods/messages_getPeerDialogs.md b/old_docs/API_docs_v72/methods/messages_getPeerDialogs.md index fe8a821c..da82cfc6 100644 --- a/old_docs/API_docs_v72/methods/messages_getPeerDialogs.md +++ b/old_docs/API_docs_v72/methods/messages_getPeerDialogs.md @@ -1,16 +1,18 @@ --- title: messages.getPeerDialogs -description: messages.getPeerDialogs parameters, return type and example +description: Get dialog info of peers --- ## Method: messages.getPeerDialogs [Back to methods index](index.md) +Get dialog info of peers + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peers|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peers|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Yes|The peers| ### Return type: [messages\_PeerDialogs](../types/messages_PeerDialogs.md) diff --git a/old_docs/API_docs_v72/methods/messages_getPinnedDialogs.md b/old_docs/API_docs_v72/methods/messages_getPinnedDialogs.md index 99ff5651..d12779fe 100644 --- a/old_docs/API_docs_v72/methods/messages_getPinnedDialogs.md +++ b/old_docs/API_docs_v72/methods/messages_getPinnedDialogs.md @@ -1,11 +1,13 @@ --- title: messages.getPinnedDialogs -description: messages.getPinnedDialogs parameters, return type and example +description: Get pinned dialogs --- ## Method: messages.getPinnedDialogs [Back to methods index](index.md) +Get pinned dialogs + ### Return type: [messages\_PeerDialogs](../types/messages_PeerDialogs.md) diff --git a/old_docs/API_docs_v72/methods/messages_getRecentLocations.md b/old_docs/API_docs_v72/methods/messages_getRecentLocations.md index 3a8de92f..1f73943d 100644 --- a/old_docs/API_docs_v72/methods/messages_getRecentLocations.md +++ b/old_docs/API_docs_v72/methods/messages_getRecentLocations.md @@ -1,17 +1,19 @@ --- title: messages.getRecentLocations -description: messages.getRecentLocations parameters, return type and example +description: Get recent locations --- ## Method: messages.getRecentLocations [Back to methods index](index.md) +Get recent locations + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to search locations| +|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to return| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v72/methods/messages_getRecentStickers.md b/old_docs/API_docs_v72/methods/messages_getRecentStickers.md index abab7f44..d76a2160 100644 --- a/old_docs/API_docs_v72/methods/messages_getRecentStickers.md +++ b/old_docs/API_docs_v72/methods/messages_getRecentStickers.md @@ -1,17 +1,19 @@ --- title: messages.getRecentStickers -description: messages.getRecentStickers parameters, return type and example +description: Get recent stickers --- ## Method: messages.getRecentStickers [Back to methods index](index.md) +Get recent stickers + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|attached|[CLICK ME Bool](../types/Bool.md) | Optional| -|hash|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|attached|[CLICK ME Bool](../types/Bool.md) | Optional|Get stickers attached to image?| +|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_RecentStickers](../types/messages_RecentStickers.md) diff --git a/old_docs/API_docs_v72/methods/messages_getSavedGifs.md b/old_docs/API_docs_v72/methods/messages_getSavedGifs.md index 08dc4be6..f61348ce 100644 --- a/old_docs/API_docs_v72/methods/messages_getSavedGifs.md +++ b/old_docs/API_docs_v72/methods/messages_getSavedGifs.md @@ -1,16 +1,18 @@ --- title: messages.getSavedGifs -description: messages.getSavedGifs parameters, return type and example +description: Get saved gifs --- ## Method: messages.getSavedGifs [Back to methods index](index.md) +Get saved gifs + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_SavedGifs](../types/messages_SavedGifs.md) diff --git a/old_docs/API_docs_v72/methods/messages_getStickerSet.md b/old_docs/API_docs_v72/methods/messages_getStickerSet.md index 70bdd9ba..c86807e4 100644 --- a/old_docs/API_docs_v72/methods/messages_getStickerSet.md +++ b/old_docs/API_docs_v72/methods/messages_getStickerSet.md @@ -1,16 +1,18 @@ --- title: messages.getStickerSet -description: messages.getStickerSet parameters, return type and example +description: Get a stickerset --- ## Method: messages.getStickerSet [Back to methods index](index.md) +Get a stickerset + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset to get| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/old_docs/API_docs_v72/methods/messages_getUnreadMentions.md b/old_docs/API_docs_v72/methods/messages_getUnreadMentions.md index 959c52fc..d318506c 100644 --- a/old_docs/API_docs_v72/methods/messages_getUnreadMentions.md +++ b/old_docs/API_docs_v72/methods/messages_getUnreadMentions.md @@ -1,21 +1,23 @@ --- title: messages.getUnreadMentions -description: messages.getUnreadMentions parameters, return type and example +description: Get unread mentions --- ## Method: messages.getUnreadMentions [Back to methods index](index.md) +Get unread mentions + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|offset\_id|[CLICK ME int](../types/int.md) | Yes| -|add\_offset|[CLICK ME int](../types/int.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| -|max\_id|[CLICK ME int](../types/int.md) | Yes| -|min\_id|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to get unread mentions| +|offset\_id|[CLICK ME int](../types/int.md) | Yes|The offset| +|add\_offset|[CLICK ME int](../types/int.md) | Yes|The additional offset| +|limit|[CLICK ME int](../types/int.md) | Yes|The number of results to fetch| +|max\_id|[CLICK ME int](../types/int.md) | Yes|The maximum message ID to fetch| +|min\_id|[CLICK ME int](../types/int.md) | Yes|The minumum message ID to fetch| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v72/methods/messages_getWebPage.md b/old_docs/API_docs_v72/methods/messages_getWebPage.md index b29e5d25..129f8f06 100644 --- a/old_docs/API_docs_v72/methods/messages_getWebPage.md +++ b/old_docs/API_docs_v72/methods/messages_getWebPage.md @@ -1,17 +1,19 @@ --- title: messages.getWebPage -description: messages.getWebPage parameters, return type and example +description: Get webpage preview --- ## Method: messages.getWebPage [Back to methods index](index.md) +Get webpage preview + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|url|[CLICK ME string](../types/string.md) | Yes| -|hash|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|url|[CLICK ME string](../types/string.md) | Yes|URL| +|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [WebPage](../types/WebPage.md) diff --git a/old_docs/API_docs_v72/methods/messages_getWebPagePreview.md b/old_docs/API_docs_v72/methods/messages_getWebPagePreview.md index 35243c9f..d01bdd32 100644 --- a/old_docs/API_docs_v72/methods/messages_getWebPagePreview.md +++ b/old_docs/API_docs_v72/methods/messages_getWebPagePreview.md @@ -1,16 +1,18 @@ --- title: messages.getWebPagePreview -description: messages.getWebPagePreview parameters, return type and example +description: Get webpage preview --- ## Method: messages.getWebPagePreview [Back to methods index](index.md) +Get webpage preview + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|message|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|message|[CLICK ME string](../types/string.md) | Yes|Extract preview from this message| ### Return type: [MessageMedia](../types/MessageMedia.md) diff --git a/old_docs/API_docs_v72/methods/messages_importChatInvite.md b/old_docs/API_docs_v72/methods/messages_importChatInvite.md index 2bea5247..0d6cd7c8 100644 --- a/old_docs/API_docs_v72/methods/messages_importChatInvite.md +++ b/old_docs/API_docs_v72/methods/messages_importChatInvite.md @@ -1,16 +1,18 @@ --- title: messages.importChatInvite -description: messages.importChatInvite parameters, return type and example +description: Import chat invite --- ## Method: messages.importChatInvite [Back to methods index](index.md) +Import chat invite + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v72/methods/messages_installStickerSet.md b/old_docs/API_docs_v72/methods/messages_installStickerSet.md index 61513182..9f6f098c 100644 --- a/old_docs/API_docs_v72/methods/messages_installStickerSet.md +++ b/old_docs/API_docs_v72/methods/messages_installStickerSet.md @@ -1,17 +1,19 @@ --- title: messages.installStickerSet -description: messages.installStickerSet parameters, return type and example +description: Add a sticker set --- ## Method: messages.installStickerSet [Back to methods index](index.md) +Add a sticker set + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional| -|archived|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to add| +|archived|[CLICK ME Bool](../types/Bool.md) | Yes|Archive this set?| ### Return type: [messages\_StickerSetInstallResult](../types/messages_StickerSetInstallResult.md) diff --git a/old_docs/API_docs_v72/methods/messages_migrateChat.md b/old_docs/API_docs_v72/methods/messages_migrateChat.md index 5021ad45..db57adfa 100644 --- a/old_docs/API_docs_v72/methods/messages_migrateChat.md +++ b/old_docs/API_docs_v72/methods/messages_migrateChat.md @@ -1,16 +1,18 @@ --- title: messages.migrateChat -description: messages.migrateChat parameters, return type and example +description: Convert chat to supergroup --- ## Method: messages.migrateChat [Back to methods index](index.md) +Convert chat to supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat to convert| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v72/methods/messages_readEncryptedHistory.md b/old_docs/API_docs_v72/methods/messages_readEncryptedHistory.md index 4d341809..39b110e3 100644 --- a/old_docs/API_docs_v72/methods/messages_readEncryptedHistory.md +++ b/old_docs/API_docs_v72/methods/messages_readEncryptedHistory.md @@ -1,17 +1,19 @@ --- title: messages.readEncryptedHistory -description: messages.readEncryptedHistory parameters, return type and example +description: Mark messages as read in secret chats --- ## Method: messages.readEncryptedHistory [Back to methods index](index.md) +Mark messages as read in secret chats + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|max\_date|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to mark messages as read| +|max\_date|[CLICK ME int](../types/int.md) | Yes|Maximum date of messages to mark| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v72/methods/messages_readFeaturedStickers.md b/old_docs/API_docs_v72/methods/messages_readFeaturedStickers.md index 0631ca5b..4035c76d 100644 --- a/old_docs/API_docs_v72/methods/messages_readFeaturedStickers.md +++ b/old_docs/API_docs_v72/methods/messages_readFeaturedStickers.md @@ -1,16 +1,18 @@ --- title: messages.readFeaturedStickers -description: messages.readFeaturedStickers parameters, return type and example +description: Mark new featured stickers as read --- ## Method: messages.readFeaturedStickers [Back to methods index](index.md) +Mark new featured stickers as read + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|Array of [CLICK ME long](../types/long.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|Array of [CLICK ME long](../types/long.md) | Yes|The stickers to mark as read| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v72/methods/messages_readMentions.md b/old_docs/API_docs_v72/methods/messages_readMentions.md index 113657e8..e30fbfaf 100644 --- a/old_docs/API_docs_v72/methods/messages_readMentions.md +++ b/old_docs/API_docs_v72/methods/messages_readMentions.md @@ -1,16 +1,18 @@ --- title: messages.readMentions -description: messages.readMentions parameters, return type and example +description: Mark mentions as read --- ## Method: messages.readMentions [Back to methods index](index.md) +Mark mentions as read + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) diff --git a/old_docs/API_docs_v72/methods/messages_readMessageContents.md b/old_docs/API_docs_v72/methods/messages_readMessageContents.md index 0d27c209..9bb1bee8 100644 --- a/old_docs/API_docs_v72/methods/messages_readMessageContents.md +++ b/old_docs/API_docs_v72/methods/messages_readMessageContents.md @@ -1,16 +1,18 @@ --- title: messages.readMessageContents -description: messages.readMessageContents parameters, return type and example +description: Mark message as read --- ## Method: messages.readMessageContents [Back to methods index](index.md) +Mark message as read + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v72/methods/messages_receivedQueue.md b/old_docs/API_docs_v72/methods/messages_receivedQueue.md index c91caa37..4ad78ba2 100644 --- a/old_docs/API_docs_v72/methods/messages_receivedQueue.md +++ b/old_docs/API_docs_v72/methods/messages_receivedQueue.md @@ -1,77 +1,13 @@ --- title: messages.receivedQueue -description: messages.receivedQueue parameters, return type and example +description: You cannot use this method directly --- ## Method: messages.receivedQueue [Back to methods index](index.md) -### Parameters: - -| Name | Type | Required | -|----------|---------------|----------| -|max\_qts|[CLICK ME int](../types/int.md) | Yes| - - -### 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| - - -### MadelineProto Example: - - -``` -if (!file_exists('madeline.php')) { - copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); -} -include 'madeline.php'; - -// !!! This API id/API hash combination will not work !!! -// !!! You must get your own @ my.telegram.org !!! -$api_id = 0; -$api_hash = ''; - -$MadelineProto = new \danog\MadelineProto\API('session.madeline', ['app_info' => ['api_id' => $api_id, 'api_hash' => $api_hash]]); -$MadelineProto->start(); - -$Vector_of_long = $MadelineProto->messages->receivedQueue(['max_qts' => int, ]); -``` - -### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): - -### As a bot: - -POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` - -Parameters: - -* method - messages.receivedQueue -* params - `{"max_qts": int, }` - - - -### As a user: - -POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.receivedQueue` - -Parameters: - -max_qts - Json encoded int +**You cannot use this method directly** -Or, if you're into Lua: - -``` -Vector_of_long = messages.receivedQueue({max_qts=int, }) -``` - diff --git a/old_docs/API_docs_v72/methods/messages_reorderPinnedDialogs.md b/old_docs/API_docs_v72/methods/messages_reorderPinnedDialogs.md index 0bf5e073..710caf10 100644 --- a/old_docs/API_docs_v72/methods/messages_reorderPinnedDialogs.md +++ b/old_docs/API_docs_v72/methods/messages_reorderPinnedDialogs.md @@ -1,17 +1,19 @@ --- title: messages.reorderPinnedDialogs -description: messages.reorderPinnedDialogs parameters, return type and example +description: Reorder pinned dialogs --- ## Method: messages.reorderPinnedDialogs [Back to methods index](index.md) +Reorder pinned dialogs + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|force|[CLICK ME Bool](../types/Bool.md) | Optional| -|order|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|force|[CLICK ME Bool](../types/Bool.md) | Optional|Force reordering| +|order|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Yes|New order| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v72/methods/messages_reorderStickerSets.md b/old_docs/API_docs_v72/methods/messages_reorderStickerSets.md index e4f1623c..ddc78dd0 100644 --- a/old_docs/API_docs_v72/methods/messages_reorderStickerSets.md +++ b/old_docs/API_docs_v72/methods/messages_reorderStickerSets.md @@ -1,17 +1,19 @@ --- title: messages.reorderStickerSets -description: messages.reorderStickerSets parameters, return type and example +description: Reorder sticker sets --- ## Method: messages.reorderStickerSets [Back to methods index](index.md) +Reorder sticker sets + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|masks|[CLICK ME Bool](../types/Bool.md) | Optional| -|order|Array of [CLICK ME long](../types/long.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|masks|[CLICK ME Bool](../types/Bool.md) | Optional|Reorder masks?| +|order|Array of [CLICK ME long](../types/long.md) | Yes|The order| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v72/methods/messages_reportEncryptedSpam.md b/old_docs/API_docs_v72/methods/messages_reportEncryptedSpam.md index 44482c76..58b684d1 100644 --- a/old_docs/API_docs_v72/methods/messages_reportEncryptedSpam.md +++ b/old_docs/API_docs_v72/methods/messages_reportEncryptedSpam.md @@ -1,16 +1,18 @@ --- title: messages.reportEncryptedSpam -description: messages.reportEncryptedSpam parameters, return type and example +description: Report for spam a secret chat --- ## Method: messages.reportEncryptedSpam [Back to methods index](index.md) +Report for spam a secret chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat to report| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v72/methods/messages_saveDraft.md b/old_docs/API_docs_v72/methods/messages_saveDraft.md index 9104df33..bbeed707 100644 --- a/old_docs/API_docs_v72/methods/messages_saveDraft.md +++ b/old_docs/API_docs_v72/methods/messages_saveDraft.md @@ -1,20 +1,22 @@ --- title: messages.saveDraft -description: messages.saveDraft parameters, return type and example +description: Save a message draft --- ## Method: messages.saveDraft [Back to methods index](index.md) +Save a message draft + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|message|[CLICK ME string](../types/string.md) | Yes| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview| +|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| +|message|[CLICK ME string](../types/string.md) | Yes|The message| +|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|The entities (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/old_docs/API_docs_v72/methods/messages_saveGif.md b/old_docs/API_docs_v72/methods/messages_saveGif.md index 4a3b6166..6f608c4c 100644 --- a/old_docs/API_docs_v72/methods/messages_saveGif.md +++ b/old_docs/API_docs_v72/methods/messages_saveGif.md @@ -1,17 +1,19 @@ --- title: messages.saveGif -description: messages.saveGif parameters, return type and example +description: Save a GIF --- ## Method: messages.saveGif [Back to methods index](index.md) +Save a GIF + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional| -|unsave|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The GIF to save| +|unsave|[CLICK ME Bool](../types/Bool.md) | Yes|Remove the gif?| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v72/methods/messages_saveRecentSticker.md b/old_docs/API_docs_v72/methods/messages_saveRecentSticker.md index b4f43e13..81ad5d48 100644 --- a/old_docs/API_docs_v72/methods/messages_saveRecentSticker.md +++ b/old_docs/API_docs_v72/methods/messages_saveRecentSticker.md @@ -1,18 +1,20 @@ --- title: messages.saveRecentSticker -description: messages.saveRecentSticker parameters, return type and example +description: Add a sticker to recent stickers --- ## Method: messages.saveRecentSticker [Back to methods index](index.md) +Add a sticker to recent stickers + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|attached|[CLICK ME Bool](../types/Bool.md) | Optional| -|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional| -|unsave|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|attached|[CLICK ME Bool](../types/Bool.md) | Optional|Get stickers attached to image?| +|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker| +|unsave|[CLICK ME Bool](../types/Bool.md) | Yes|Remove the sticker from recent stickers?| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v72/methods/messages_searchGifs.md b/old_docs/API_docs_v72/methods/messages_searchGifs.md index fefef1d7..103ebfeb 100644 --- a/old_docs/API_docs_v72/methods/messages_searchGifs.md +++ b/old_docs/API_docs_v72/methods/messages_searchGifs.md @@ -1,17 +1,19 @@ --- title: messages.searchGifs -description: messages.searchGifs parameters, return type and example +description: Search gifs --- ## Method: messages.searchGifs [Back to methods index](index.md) +Search gifs + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|q|[CLICK ME string](../types/string.md) | Yes| -|offset|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|q|[CLICK ME string](../types/string.md) | Yes|The search query| +|offset|[CLICK ME int](../types/int.md) | Yes|The offset | ### Return type: [messages\_FoundGifs](../types/messages_FoundGifs.md) diff --git a/old_docs/API_docs_v72/methods/messages_searchGlobal.md b/old_docs/API_docs_v72/methods/messages_searchGlobal.md index 32ddd175..0edd1e40 100644 --- a/old_docs/API_docs_v72/methods/messages_searchGlobal.md +++ b/old_docs/API_docs_v72/methods/messages_searchGlobal.md @@ -1,20 +1,22 @@ --- title: messages.searchGlobal -description: messages.searchGlobal parameters, return type and example +description: Global message search --- ## Method: messages.searchGlobal [Back to methods index](index.md) +Global message search + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|q|[CLICK ME string](../types/string.md) | Yes| -|offset\_date|[CLICK ME int](../types/int.md) | Yes| -|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|offset\_id|[CLICK ME int](../types/int.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|q|[CLICK ME string](../types/string.md) | Yes|The query| +|offset\_date|[CLICK ME int](../types/int.md) | Yes|0 or the date offset| +|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|0 or the peer offset| +|offset\_id|[CLICK ME int](../types/int.md) | Yes|0 or the message ID offset| +|limit|[CLICK ME int](../types/int.md) | Yes|The number of results to return| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v72/methods/messages_sendEncrypted.md b/old_docs/API_docs_v72/methods/messages_sendEncrypted.md index 23461760..d48f88d7 100644 --- a/old_docs/API_docs_v72/methods/messages_sendEncrypted.md +++ b/old_docs/API_docs_v72/methods/messages_sendEncrypted.md @@ -1,17 +1,19 @@ --- title: messages.sendEncrypted -description: messages.sendEncrypted parameters, return type and example +description: Send message to secret chat --- ## Method: messages.sendEncrypted [Back to methods index](index.md) +Send message to secret chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the message| +|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v72/methods/messages_sendEncryptedFile.md b/old_docs/API_docs_v72/methods/messages_sendEncryptedFile.md index 64919abe..4fd0648e 100644 --- a/old_docs/API_docs_v72/methods/messages_sendEncryptedFile.md +++ b/old_docs/API_docs_v72/methods/messages_sendEncryptedFile.md @@ -1,18 +1,20 @@ --- title: messages.sendEncryptedFile -description: messages.sendEncryptedFile parameters, return type and example +description: Send a file to a secret chat --- ## Method: messages.sendEncryptedFile [Back to methods index](index.md) +Send a file to a secret chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes| -|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the file| +|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| +|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional|The file (optional)| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v72/methods/messages_sendEncryptedService.md b/old_docs/API_docs_v72/methods/messages_sendEncryptedService.md index 0a0eea8a..d66894bf 100644 --- a/old_docs/API_docs_v72/methods/messages_sendEncryptedService.md +++ b/old_docs/API_docs_v72/methods/messages_sendEncryptedService.md @@ -1,17 +1,19 @@ --- title: messages.sendEncryptedService -description: messages.sendEncryptedService parameters, return type and example +description: Send a service message to a secret chat --- ## Method: messages.sendEncryptedService [Back to methods index](index.md) +Send a service message to a secret chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the service message| +|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v72/methods/messages_sendInlineBotResult.md b/old_docs/API_docs_v72/methods/messages_sendInlineBotResult.md index 4cb9243e..386ac7e3 100644 --- a/old_docs/API_docs_v72/methods/messages_sendInlineBotResult.md +++ b/old_docs/API_docs_v72/methods/messages_sendInlineBotResult.md @@ -1,22 +1,24 @@ --- title: messages.sendInlineBotResult -description: messages.sendInlineBotResult parameters, return type and example +description: Send a received bot result to the chat --- ## Method: messages.sendInlineBotResult [Back to methods index](index.md) +Send a received bot result to the chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional| -|background|[CLICK ME Bool](../types/Bool.md) | Optional| -|clear\_draft|[CLICK ME Bool](../types/Bool.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional| -|query\_id|[CLICK ME long](../types/long.md) | Yes| -|id|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Disable notifications?| +|background|[CLICK ME Bool](../types/Bool.md) | Optional|Disable background notifications?| +|clear\_draft|[CLICK ME Bool](../types/Bool.md) | Optional|Clear the message draft?| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the message| +|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| +|query\_id|[CLICK ME long](../types/long.md) | Yes|The inline query ID| +|id|[CLICK ME string](../types/string.md) | Yes|The result ID| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v72/methods/messages_sendScreenshotNotification.md b/old_docs/API_docs_v72/methods/messages_sendScreenshotNotification.md index c9d1d555..f64f1682 100644 --- a/old_docs/API_docs_v72/methods/messages_sendScreenshotNotification.md +++ b/old_docs/API_docs_v72/methods/messages_sendScreenshotNotification.md @@ -1,17 +1,19 @@ --- title: messages.sendScreenshotNotification -description: messages.sendScreenshotNotification parameters, return type and example +description: Send screenshot notification --- ## Method: messages.sendScreenshotNotification [Back to methods index](index.md) +Send screenshot notification + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the notification| +|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Yes|Reply to message by ID| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v72/methods/messages_setBotCallbackAnswer.md b/old_docs/API_docs_v72/methods/messages_setBotCallbackAnswer.md index 5590828e..e6dc6b09 100644 --- a/old_docs/API_docs_v72/methods/messages_setBotCallbackAnswer.md +++ b/old_docs/API_docs_v72/methods/messages_setBotCallbackAnswer.md @@ -1,20 +1,22 @@ --- title: messages.setBotCallbackAnswer -description: messages.setBotCallbackAnswer parameters, return type and example +description: Bots only: set the callback answer (after a button was clicked) --- ## Method: messages.setBotCallbackAnswer [Back to methods index](index.md) +Bots only: set the callback answer (after a button was clicked) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|alert|[CLICK ME Bool](../types/Bool.md) | Optional| -|query\_id|[CLICK ME long](../types/long.md) | Yes| -|message|[CLICK ME string](../types/string.md) | Optional| -|url|[CLICK ME string](../types/string.md) | Optional| -|cache\_time|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|alert|[CLICK ME Bool](../types/Bool.md) | Optional|Is this an alert?| +|query\_id|[CLICK ME long](../types/long.md) | Yes|The query ID| +|message|[CLICK ME string](../types/string.md) | Optional|The message| +|url|[CLICK ME string](../types/string.md) | Optional|The URL| +|cache\_time|[CLICK ME int](../types/int.md) | Yes|Cache time| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v72/methods/messages_setBotPrecheckoutResults.md b/old_docs/API_docs_v72/methods/messages_setBotPrecheckoutResults.md index 5afa7789..722bff81 100644 --- a/old_docs/API_docs_v72/methods/messages_setBotPrecheckoutResults.md +++ b/old_docs/API_docs_v72/methods/messages_setBotPrecheckoutResults.md @@ -1,18 +1,20 @@ --- title: messages.setBotPrecheckoutResults -description: messages.setBotPrecheckoutResults parameters, return type and example +description: Bots only: set precheckout results --- ## Method: messages.setBotPrecheckoutResults [Back to methods index](index.md) +Bots only: set precheckout results + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|success|[CLICK ME Bool](../types/Bool.md) | Optional| -|query\_id|[CLICK ME long](../types/long.md) | Yes| -|error|[CLICK ME string](../types/string.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|success|[CLICK ME Bool](../types/Bool.md) | Optional|Success?| +|query\_id|[CLICK ME long](../types/long.md) | Yes|Query ID| +|error|[CLICK ME string](../types/string.md) | Optional|Error| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v72/methods/messages_setBotShippingResults.md b/old_docs/API_docs_v72/methods/messages_setBotShippingResults.md index b36dacce..d364a04d 100644 --- a/old_docs/API_docs_v72/methods/messages_setBotShippingResults.md +++ b/old_docs/API_docs_v72/methods/messages_setBotShippingResults.md @@ -1,18 +1,20 @@ --- title: messages.setBotShippingResults -description: messages.setBotShippingResults parameters, return type and example +description: Bots only: set shipping results --- ## Method: messages.setBotShippingResults [Back to methods index](index.md) +Bots only: set shipping results + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|query\_id|[CLICK ME long](../types/long.md) | Yes| -|error|[CLICK ME string](../types/string.md) | Optional| -|shipping\_options|Array of [CLICK ME ShippingOption](../types/ShippingOption.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|query\_id|[CLICK ME long](../types/long.md) | Yes|Query ID| +|error|[CLICK ME string](../types/string.md) | Optional|Error| +|shipping\_options|Array of [CLICK ME ShippingOption](../types/ShippingOption.md) | Optional|Shipping options| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v72/methods/messages_setEncryptedTyping.md b/old_docs/API_docs_v72/methods/messages_setEncryptedTyping.md index 3183fedf..e9afe99c 100644 --- a/old_docs/API_docs_v72/methods/messages_setEncryptedTyping.md +++ b/old_docs/API_docs_v72/methods/messages_setEncryptedTyping.md @@ -12,8 +12,8 @@ Send typing notification to secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|| -|typing|[CLICK ME Bool](../types/Bool.md) | Yes|| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to send the notification| +|typing|[CLICK ME Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v72/methods/messages_setGameScore.md b/old_docs/API_docs_v72/methods/messages_setGameScore.md index c44145c0..aa1f4f0c 100644 --- a/old_docs/API_docs_v72/methods/messages_setGameScore.md +++ b/old_docs/API_docs_v72/methods/messages_setGameScore.md @@ -1,21 +1,23 @@ --- title: messages.setGameScore -description: messages.setGameScore parameters, return type and example +description: Set the game score --- ## Method: messages.setGameScore [Back to methods index](index.md) +Set the game score + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|edit\_message|[CLICK ME Bool](../types/Bool.md) | Optional| -|force|[CLICK ME Bool](../types/Bool.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|id|[CLICK ME int](../types/int.md) | Yes| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|score|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|edit\_message|[CLICK ME Bool](../types/Bool.md) | Optional|Should the message with the game be edited?| +|force|[CLICK ME Bool](../types/Bool.md) | Optional|Force setting the game score| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the game was sent| +|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the score| +|score|[CLICK ME int](../types/int.md) | Yes|The score| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v72/methods/messages_setInlineBotResults.md b/old_docs/API_docs_v72/methods/messages_setInlineBotResults.md index 915e3a4e..79493009 100644 --- a/old_docs/API_docs_v72/methods/messages_setInlineBotResults.md +++ b/old_docs/API_docs_v72/methods/messages_setInlineBotResults.md @@ -1,22 +1,24 @@ --- title: messages.setInlineBotResults -description: messages.setInlineBotResults parameters, return type and example +description: Bots only: set the results of an inline query --- ## Method: messages.setInlineBotResults [Back to methods index](index.md) +Bots only: set the results of an inline query + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|gallery|[CLICK ME Bool](../types/Bool.md) | Optional| -|private|[CLICK ME Bool](../types/Bool.md) | Optional| -|query\_id|[CLICK ME long](../types/long.md) | Yes| -|results|Array of [CLICK ME InputBotInlineResult](../types/InputBotInlineResult.md) | Yes| -|cache\_time|[CLICK ME int](../types/int.md) | Yes| -|next\_offset|[CLICK ME string](../types/string.md) | Optional| -|switch\_pm|[CLICK ME InlineBotSwitchPM](../types/InlineBotSwitchPM.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|gallery|[CLICK ME Bool](../types/Bool.md) | Optional|Is this a gallery?| +|private|[CLICK ME Bool](../types/Bool.md) | Optional|Is this result private (not cached)?| +|query\_id|[CLICK ME long](../types/long.md) | Yes|Query ID| +|results|Array of [CLICK ME InputBotInlineResult](../types/InputBotInlineResult.md) | Yes|Results| +|cache\_time|[CLICK ME int](../types/int.md) | Yes|Cache time| +|next\_offset|[CLICK ME string](../types/string.md) | Optional|The next offset| +|switch\_pm|[CLICK ME InlineBotSwitchPM](../types/InlineBotSwitchPM.md) | Optional|Switch to PM?| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v72/methods/messages_setInlineGameScore.md b/old_docs/API_docs_v72/methods/messages_setInlineGameScore.md index 55e2c063..385c8308 100644 --- a/old_docs/API_docs_v72/methods/messages_setInlineGameScore.md +++ b/old_docs/API_docs_v72/methods/messages_setInlineGameScore.md @@ -1,20 +1,22 @@ --- title: messages.setInlineGameScore -description: messages.setInlineGameScore parameters, return type and example +description: Set the game score of an inline message --- ## Method: messages.setInlineGameScore [Back to methods index](index.md) +Set the game score of an inline message + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|edit\_message|[CLICK ME Bool](../types/Bool.md) | Optional| -|force|[CLICK ME Bool](../types/Bool.md) | Optional| -|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|score|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|edit\_message|[CLICK ME Bool](../types/Bool.md) | Optional|Should the message with the game be edited?| +|force|[CLICK ME Bool](../types/Bool.md) | Optional|Force setting the game score| +|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The ID of the inline message| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the score| +|score|[CLICK ME int](../types/int.md) | Yes|The score| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v72/methods/messages_startBot.md b/old_docs/API_docs_v72/methods/messages_startBot.md index 0de0f1a5..94a4d86a 100644 --- a/old_docs/API_docs_v72/methods/messages_startBot.md +++ b/old_docs/API_docs_v72/methods/messages_startBot.md @@ -1,18 +1,20 @@ --- title: messages.startBot -description: messages.startBot parameters, return type and example +description: Start a bot --- ## Method: messages.startBot [Back to methods index](index.md) +Start a bot + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|start\_param|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot's ID or username| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to start the bot (@me or group ID/username)| +|start\_param|[CLICK ME string](../types/string.md) | Yes|The bot's start parameter| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v72/methods/messages_toggleChatAdmins.md b/old_docs/API_docs_v72/methods/messages_toggleChatAdmins.md index d56e5753..ab591fd9 100644 --- a/old_docs/API_docs_v72/methods/messages_toggleChatAdmins.md +++ b/old_docs/API_docs_v72/methods/messages_toggleChatAdmins.md @@ -1,17 +1,19 @@ --- title: messages.toggleChatAdmins -description: messages.toggleChatAdmins parameters, return type and example +description: Enable all users are admins in normal groups (not supergroups) --- ## Method: messages.toggleChatAdmins [Back to methods index](index.md) +Enable all users are admins in normal groups (not supergroups) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Group ID| +|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Enable all users are admins| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v72/methods/messages_toggleDialogPin.md b/old_docs/API_docs_v72/methods/messages_toggleDialogPin.md index d6dc9692..2bd6a03d 100644 --- a/old_docs/API_docs_v72/methods/messages_toggleDialogPin.md +++ b/old_docs/API_docs_v72/methods/messages_toggleDialogPin.md @@ -1,17 +1,19 @@ --- title: messages.toggleDialogPin -description: messages.toggleDialogPin parameters, return type and example +description: Pin or unpin dialog --- ## Method: messages.toggleDialogPin [Back to methods index](index.md) +Pin or unpin dialog + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|pinned|[CLICK ME Bool](../types/Bool.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|pinned|[CLICK ME Bool](../types/Bool.md) | Optional|Pin or unpin the dialog?| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer to pin| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v72/methods/messages_uninstallStickerSet.md b/old_docs/API_docs_v72/methods/messages_uninstallStickerSet.md index 60b0ca0c..6d04e847 100644 --- a/old_docs/API_docs_v72/methods/messages_uninstallStickerSet.md +++ b/old_docs/API_docs_v72/methods/messages_uninstallStickerSet.md @@ -1,16 +1,18 @@ --- title: messages.uninstallStickerSet -description: messages.uninstallStickerSet parameters, return type and example +description: Remove a sticker set --- ## Method: messages.uninstallStickerSet [Back to methods index](index.md) +Remove a sticker set + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to remove| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v72/methods/messages_uploadMedia.md b/old_docs/API_docs_v72/methods/messages_uploadMedia.md index 5c25333d..c982a860 100644 --- a/old_docs/API_docs_v72/methods/messages_uploadMedia.md +++ b/old_docs/API_docs_v72/methods/messages_uploadMedia.md @@ -1,17 +1,19 @@ --- title: messages.uploadMedia -description: messages.uploadMedia parameters, return type and example +description: Upload a file without sending it to anyone --- ## Method: messages.uploadMedia [Back to methods index](index.md) +Upload a file without sending it to anyone + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Nothing| +|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media to upload| ### Return type: [MessageMedia](../types/MessageMedia.md) diff --git a/old_docs/API_docs_v72/methods/payments_clearSavedInfo.md b/old_docs/API_docs_v72/methods/payments_clearSavedInfo.md index 53fab36f..44050dde 100644 --- a/old_docs/API_docs_v72/methods/payments_clearSavedInfo.md +++ b/old_docs/API_docs_v72/methods/payments_clearSavedInfo.md @@ -1,17 +1,19 @@ --- title: payments.clearSavedInfo -description: payments.clearSavedInfo parameters, return type and example +description: Clear saved payments info --- ## Method: payments.clearSavedInfo [Back to methods index](index.md) +Clear saved payments info + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|credentials|[CLICK ME Bool](../types/Bool.md) | Optional| -|info|[CLICK ME Bool](../types/Bool.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|credentials|[CLICK ME Bool](../types/Bool.md) | Optional|Clear credentials?| +|info|[CLICK ME Bool](../types/Bool.md) | Optional|Clear payment info?| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v72/methods/payments_getPaymentForm.md b/old_docs/API_docs_v72/methods/payments_getPaymentForm.md index 00b4bddc..16a32d11 100644 --- a/old_docs/API_docs_v72/methods/payments_getPaymentForm.md +++ b/old_docs/API_docs_v72/methods/payments_getPaymentForm.md @@ -1,16 +1,18 @@ --- title: payments.getPaymentForm -description: payments.getPaymentForm parameters, return type and example +description: Get payment form --- ## Method: payments.getPaymentForm [Back to methods index](index.md) +Get payment form + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|msg\_id|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|msg\_id|[CLICK ME int](../types/int.md) | Yes|Message ID| ### Return type: [payments\_PaymentForm](../types/payments_PaymentForm.md) diff --git a/old_docs/API_docs_v72/methods/payments_getPaymentReceipt.md b/old_docs/API_docs_v72/methods/payments_getPaymentReceipt.md index 40b73a4b..857585f6 100644 --- a/old_docs/API_docs_v72/methods/payments_getPaymentReceipt.md +++ b/old_docs/API_docs_v72/methods/payments_getPaymentReceipt.md @@ -1,16 +1,18 @@ --- title: payments.getPaymentReceipt -description: payments.getPaymentReceipt parameters, return type and example +description: Get payment receipt --- ## Method: payments.getPaymentReceipt [Back to methods index](index.md) +Get payment receipt + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|msg\_id|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|msg\_id|[CLICK ME int](../types/int.md) | Yes|The message ID| ### Return type: [payments\_PaymentReceipt](../types/payments_PaymentReceipt.md) diff --git a/old_docs/API_docs_v72/methods/payments_getSavedInfo.md b/old_docs/API_docs_v72/methods/payments_getSavedInfo.md index ccaaff75..04ac7374 100644 --- a/old_docs/API_docs_v72/methods/payments_getSavedInfo.md +++ b/old_docs/API_docs_v72/methods/payments_getSavedInfo.md @@ -1,11 +1,13 @@ --- title: payments.getSavedInfo -description: payments.getSavedInfo parameters, return type and example +description: Get saved payments info --- ## Method: payments.getSavedInfo [Back to methods index](index.md) +Get saved payments info + ### Return type: [payments\_SavedInfo](../types/payments_SavedInfo.md) diff --git a/old_docs/API_docs_v72/methods/payments_sendPaymentForm.md b/old_docs/API_docs_v72/methods/payments_sendPaymentForm.md index eb843715..0a9df99f 100644 --- a/old_docs/API_docs_v72/methods/payments_sendPaymentForm.md +++ b/old_docs/API_docs_v72/methods/payments_sendPaymentForm.md @@ -1,19 +1,21 @@ --- title: payments.sendPaymentForm -description: payments.sendPaymentForm parameters, return type and example +description: Bots only: send payment form --- ## Method: payments.sendPaymentForm [Back to methods index](index.md) +Bots only: send payment form + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|msg\_id|[CLICK ME int](../types/int.md) | Yes| -|requested\_info\_id|[CLICK ME string](../types/string.md) | Optional| -|shipping\_option\_id|[CLICK ME string](../types/string.md) | Optional| -|credentials|[CLICK ME InputPaymentCredentials](../types/InputPaymentCredentials.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|msg\_id|[CLICK ME int](../types/int.md) | Yes|Message ID| +|requested\_info\_id|[CLICK ME string](../types/string.md) | Optional|ID of requested info| +|shipping\_option\_id|[CLICK ME string](../types/string.md) | Optional|Shipping option ID| +|credentials|[CLICK ME InputPaymentCredentials](../types/InputPaymentCredentials.md) | Yes|Payment credentials| ### Return type: [payments\_PaymentResult](../types/payments_PaymentResult.md) diff --git a/old_docs/API_docs_v72/methods/payments_validateRequestedInfo.md b/old_docs/API_docs_v72/methods/payments_validateRequestedInfo.md index 32702965..e36f0e42 100644 --- a/old_docs/API_docs_v72/methods/payments_validateRequestedInfo.md +++ b/old_docs/API_docs_v72/methods/payments_validateRequestedInfo.md @@ -1,18 +1,20 @@ --- title: payments.validateRequestedInfo -description: payments.validateRequestedInfo parameters, return type and example +description: Validate requested payment info --- ## Method: payments.validateRequestedInfo [Back to methods index](index.md) +Validate requested payment info + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|save|[CLICK ME Bool](../types/Bool.md) | Optional| -|msg\_id|[CLICK ME int](../types/int.md) | Yes| -|info|[CLICK ME PaymentRequestedInfo](../types/PaymentRequestedInfo.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|save|[CLICK ME Bool](../types/Bool.md) | Optional|Save payment info?| +|msg\_id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|info|[CLICK ME PaymentRequestedInfo](../types/PaymentRequestedInfo.md) | Yes|The requested payment info| ### Return type: [payments\_ValidatedRequestedInfo](../types/payments_ValidatedRequestedInfo.md) diff --git a/old_docs/API_docs_v72/methods/photos_deletePhotos.md b/old_docs/API_docs_v72/methods/photos_deletePhotos.md index 104459b7..b9daca10 100644 --- a/old_docs/API_docs_v72/methods/photos_deletePhotos.md +++ b/old_docs/API_docs_v72/methods/photos_deletePhotos.md @@ -1,16 +1,18 @@ --- title: photos.deletePhotos -description: photos.deletePhotos parameters, return type and example +description: Delete profile photos --- ## Method: photos.deletePhotos [Back to methods index](index.md) +Delete profile photos + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Yes|The profile photos to delete| ### Return type: [Vector\_of\_long](../types/long.md) diff --git a/old_docs/API_docs_v72/methods/photos_getUserPhotos.md b/old_docs/API_docs_v72/methods/photos_getUserPhotos.md index 1a7515ba..ea27a44f 100644 --- a/old_docs/API_docs_v72/methods/photos_getUserPhotos.md +++ b/old_docs/API_docs_v72/methods/photos_getUserPhotos.md @@ -1,19 +1,21 @@ --- title: photos.getUserPhotos -description: photos.getUserPhotos parameters, return type and example +description: Get the profile photos of a user --- ## Method: photos.getUserPhotos [Back to methods index](index.md) +Get the profile photos of a user + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|offset|[CLICK ME int](../types/int.md) | Yes| -|max\_id|[CLICK ME long](../types/long.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| +|offset|[CLICK ME int](../types/int.md) | Yes|Offset| +|max\_id|[CLICK ME long](../types/long.md) | Yes|Maximum ID of photo to return| +|limit|[CLICK ME int](../types/int.md) | Yes|Number of photos to return| ### Return type: [photos\_Photos](../types/photos_Photos.md) diff --git a/old_docs/API_docs_v72/methods/photos_updateProfilePhoto.md b/old_docs/API_docs_v72/methods/photos_updateProfilePhoto.md index 28ab5fbf..7f0a4c69 100644 --- a/old_docs/API_docs_v72/methods/photos_updateProfilePhoto.md +++ b/old_docs/API_docs_v72/methods/photos_updateProfilePhoto.md @@ -1,16 +1,18 @@ --- title: photos.updateProfilePhoto -description: photos.updateProfilePhoto parameters, return type and example +description: Update the profile photo (use photos->uploadProfilePhoto to upload the photo) --- ## Method: photos.updateProfilePhoto [Back to methods index](index.md) +Update the profile photo (use photos->uploadProfilePhoto to upload the photo) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional|The photo to use| ### Return type: [UserProfilePhoto](../types/UserProfilePhoto.md) diff --git a/old_docs/API_docs_v72/methods/photos_uploadProfilePhoto.md b/old_docs/API_docs_v72/methods/photos_uploadProfilePhoto.md index 7cc9e9e5..efa08bb0 100644 --- a/old_docs/API_docs_v72/methods/photos_uploadProfilePhoto.md +++ b/old_docs/API_docs_v72/methods/photos_uploadProfilePhoto.md @@ -1,16 +1,18 @@ --- title: photos.uploadProfilePhoto -description: photos.uploadProfilePhoto parameters, return type and example +description: Upload profile photo --- ## Method: photos.uploadProfilePhoto [Back to methods index](index.md) +Upload profile photo + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|file|[File path or InputFile](../types/InputFile.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|file|[File path or InputFile](../types/InputFile.md) | Yes|The photo| ### Return type: [photos\_Photo](../types/photos_Photo.md) diff --git a/old_docs/API_docs_v72/methods/stickers_addStickerToSet.md b/old_docs/API_docs_v72/methods/stickers_addStickerToSet.md index 82a9dbd7..1f90028c 100644 --- a/old_docs/API_docs_v72/methods/stickers_addStickerToSet.md +++ b/old_docs/API_docs_v72/methods/stickers_addStickerToSet.md @@ -1,17 +1,19 @@ --- title: stickers.addStickerToSet -description: stickers.addStickerToSet parameters, return type and example +description: Add sticker to stickerset --- ## Method: stickers.addStickerToSet [Back to methods index](index.md) +Add sticker to stickerset + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional| -|sticker|[CLICK ME InputStickerSetItem](../types/InputStickerSetItem.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset| +|sticker|[CLICK ME InputStickerSetItem](../types/InputStickerSetItem.md) | Yes|The sticker| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/old_docs/API_docs_v72/methods/stickers_changeStickerPosition.md b/old_docs/API_docs_v72/methods/stickers_changeStickerPosition.md index a1a663f7..45552df9 100644 --- a/old_docs/API_docs_v72/methods/stickers_changeStickerPosition.md +++ b/old_docs/API_docs_v72/methods/stickers_changeStickerPosition.md @@ -1,17 +1,19 @@ --- title: stickers.changeStickerPosition -description: stickers.changeStickerPosition parameters, return type and example +description: Change sticker position in photo --- ## Method: stickers.changeStickerPosition [Back to methods index](index.md) +Change sticker position in photo + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|sticker|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional| -|position|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|sticker|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker| +|position|[CLICK ME int](../types/int.md) | Yes|New position| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/old_docs/API_docs_v72/methods/stickers_createStickerSet.md b/old_docs/API_docs_v72/methods/stickers_createStickerSet.md index b99874a0..c4e85852 100644 --- a/old_docs/API_docs_v72/methods/stickers_createStickerSet.md +++ b/old_docs/API_docs_v72/methods/stickers_createStickerSet.md @@ -1,20 +1,22 @@ --- title: stickers.createStickerSet -description: stickers.createStickerSet parameters, return type and example +description: Create stickerset --- ## Method: stickers.createStickerSet [Back to methods index](index.md) +Create stickerset + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|masks|[CLICK ME Bool](../types/Bool.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|title|[CLICK ME string](../types/string.md) | Yes| -|short\_name|[CLICK ME string](../types/string.md) | Yes| -|stickers|Array of [CLICK ME InputStickerSetItem](../types/InputStickerSetItem.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|masks|[CLICK ME Bool](../types/Bool.md) | Optional|Masks?| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user ID associated to this stickerset| +|title|[CLICK ME string](../types/string.md) | Yes|The stickerset title| +|short\_name|[CLICK ME string](../types/string.md) | Yes|The stickerset short name| +|stickers|Array of [CLICK ME InputStickerSetItem](../types/InputStickerSetItem.md) | Yes|The stickers to add| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/old_docs/API_docs_v72/methods/stickers_removeStickerFromSet.md b/old_docs/API_docs_v72/methods/stickers_removeStickerFromSet.md index 34f85cb0..4ae30345 100644 --- a/old_docs/API_docs_v72/methods/stickers_removeStickerFromSet.md +++ b/old_docs/API_docs_v72/methods/stickers_removeStickerFromSet.md @@ -1,16 +1,18 @@ --- title: stickers.removeStickerFromSet -description: stickers.removeStickerFromSet parameters, return type and example +description: Remove sticker from stickerset --- ## Method: stickers.removeStickerFromSet [Back to methods index](index.md) +Remove sticker from stickerset + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|sticker|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|sticker|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker to remove| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/old_docs/API_docs_v72/methods/upload_getWebFile.md b/old_docs/API_docs_v72/methods/upload_getWebFile.md index 30bd3a1f..e864e4b7 100644 --- a/old_docs/API_docs_v72/methods/upload_getWebFile.md +++ b/old_docs/API_docs_v72/methods/upload_getWebFile.md @@ -1,18 +1,20 @@ --- title: upload.getWebFile -description: upload.getWebFile parameters, return type and example +description: Download a file through telegram --- ## Method: upload.getWebFile [Back to methods index](index.md) +Download a file through telegram + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|location|[CLICK ME InputWebFileLocation](../types/InputWebFileLocation.md) | Yes| -|offset|[CLICK ME int](../types/int.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|location|[CLICK ME InputWebFileLocation](../types/InputWebFileLocation.md) | Yes|The file| +|offset|[CLICK ME int](../types/int.md) | Yes|The offset in bytes| +|limit|[CLICK ME int](../types/int.md) | Yes|The number of bytes to fetch| ### Return type: [upload\_WebFile](../types/upload_WebFile.md) diff --git a/old_docs/API_docs_v73/methods/account_registerDevice.md b/old_docs/API_docs_v73/methods/account_registerDevice.md index cd28abcd..017b9af3 100644 --- a/old_docs/API_docs_v73/methods/account_registerDevice.md +++ b/old_docs/API_docs_v73/methods/account_registerDevice.md @@ -12,8 +12,8 @@ Register device for push notifications | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and oTher, see source code of official apps for more info| +|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and oTher, see source code of official apps for more info| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v73/methods/account_unregisterDevice.md b/old_docs/API_docs_v73/methods/account_unregisterDevice.md index 1d2b7670..32e44495 100644 --- a/old_docs/API_docs_v73/methods/account_unregisterDevice.md +++ b/old_docs/API_docs_v73/methods/account_unregisterDevice.md @@ -12,8 +12,8 @@ Stop sending PUSH notifications to app | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| -|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and other, see source code of official apps for more info| +|token\_type|[CLICK ME int](../types/int.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and oTher, see source code of official apps for more info| +|token|[CLICK ME string](../types/string.md) | Yes|Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and oTher, see source code of official apps for more info| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v73/methods/bots_answerWebhookJSONQuery.md b/old_docs/API_docs_v73/methods/bots_answerWebhookJSONQuery.md index 205b30f9..61056bb4 100644 --- a/old_docs/API_docs_v73/methods/bots_answerWebhookJSONQuery.md +++ b/old_docs/API_docs_v73/methods/bots_answerWebhookJSONQuery.md @@ -1,17 +1,19 @@ --- title: bots.answerWebhookJSONQuery -description: bots.answerWebhookJSONQuery parameters, return type and example +description: Send webhook request via bot API --- ## Method: bots.answerWebhookJSONQuery [Back to methods index](index.md) +Send webhook request via bot API + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|query\_id|[CLICK ME long](../types/long.md) | Yes| -|data|[CLICK ME DataJSON](../types/DataJSON.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|query\_id|[CLICK ME long](../types/long.md) | Yes|The query ID| +|data|[CLICK ME DataJSON](../types/DataJSON.md) | Yes|The parameters| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v73/methods/bots_sendCustomRequest.md b/old_docs/API_docs_v73/methods/bots_sendCustomRequest.md index 590c47b6..fc8e764d 100644 --- a/old_docs/API_docs_v73/methods/bots_sendCustomRequest.md +++ b/old_docs/API_docs_v73/methods/bots_sendCustomRequest.md @@ -1,17 +1,19 @@ --- title: bots.sendCustomRequest -description: bots.sendCustomRequest parameters, return type and example +description: Send a custom request to the bot API --- ## Method: bots.sendCustomRequest [Back to methods index](index.md) +Send a custom request to the bot API + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|custom\_method|[CLICK ME string](../types/string.md) | Yes| -|params|[CLICK ME DataJSON](../types/DataJSON.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|custom\_method|[CLICK ME string](../types/string.md) | Yes|The method to call| +|params|[CLICK ME DataJSON](../types/DataJSON.md) | Yes|Method parameters| ### Return type: [DataJSON](../types/DataJSON.md) diff --git a/old_docs/API_docs_v73/methods/channels_checkUsername.md b/old_docs/API_docs_v73/methods/channels_checkUsername.md index 371f4cd3..7bc7c245 100644 --- a/old_docs/API_docs_v73/methods/channels_checkUsername.md +++ b/old_docs/API_docs_v73/methods/channels_checkUsername.md @@ -1,17 +1,19 @@ --- title: channels.checkUsername -description: channels.checkUsername parameters, return type and example +description: Check if this username is free and can be assigned to a channel/supergroup --- ## Method: channels.checkUsername [Back to methods index](index.md) +Check if this username is free and can be assigned to a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|username|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|username|[CLICK ME string](../types/string.md) | Yes|The new username for this channel/supergroup| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v73/methods/channels_createChannel.md b/old_docs/API_docs_v73/methods/channels_createChannel.md index c5d21585..1305e4fb 100644 --- a/old_docs/API_docs_v73/methods/channels_createChannel.md +++ b/old_docs/API_docs_v73/methods/channels_createChannel.md @@ -1,19 +1,21 @@ --- title: channels.createChannel -description: channels.createChannel parameters, return type and example +description: Create channel/supergroup --- ## Method: channels.createChannel [Back to methods index](index.md) +Create channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|broadcast|[CLICK ME Bool](../types/Bool.md) | Optional| -|megagroup|[CLICK ME Bool](../types/Bool.md) | Optional| -|title|[CLICK ME string](../types/string.md) | Yes| -|about|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|broadcast|[CLICK ME Bool](../types/Bool.md) | Optional|Set this to true to create a channel| +|megagroup|[CLICK ME Bool](../types/Bool.md) | Optional|Set this to true to create a supergroup| +|title|[CLICK ME string](../types/string.md) | Yes|Supergroup/channel title| +|about|[CLICK ME string](../types/string.md) | Yes|About text| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v73/methods/channels_deleteChannel.md b/old_docs/API_docs_v73/methods/channels_deleteChannel.md index 61b29eac..e660d25c 100644 --- a/old_docs/API_docs_v73/methods/channels_deleteChannel.md +++ b/old_docs/API_docs_v73/methods/channels_deleteChannel.md @@ -1,16 +1,18 @@ --- title: channels.deleteChannel -description: channels.deleteChannel parameters, return type and example +description: Delete a channel/supergroup --- ## Method: channels.deleteChannel [Back to methods index](index.md) +Delete a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup to delete| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v73/methods/channels_deleteHistory.md b/old_docs/API_docs_v73/methods/channels_deleteHistory.md index 35fcf2f1..55a5e371 100644 --- a/old_docs/API_docs_v73/methods/channels_deleteHistory.md +++ b/old_docs/API_docs_v73/methods/channels_deleteHistory.md @@ -1,17 +1,19 @@ --- title: channels.deleteHistory -description: channels.deleteHistory parameters, return type and example +description: Delete the history of a supergroup/channel --- ## Method: channels.deleteHistory [Back to methods index](index.md) +Delete the history of a supergroup/channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|max\_id|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to delete| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v73/methods/channels_deleteMessages.md b/old_docs/API_docs_v73/methods/channels_deleteMessages.md index 87a968c5..fb9d3cc2 100644 --- a/old_docs/API_docs_v73/methods/channels_deleteMessages.md +++ b/old_docs/API_docs_v73/methods/channels_deleteMessages.md @@ -1,17 +1,19 @@ --- title: channels.deleteMessages -description: channels.deleteMessages parameters, return type and example +description: Delete channel/supergroup messages --- ## Method: channels.deleteMessages [Back to methods index](index.md) +Delete channel/supergroup messages + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|id|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to delete| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v73/methods/channels_deleteUserHistory.md b/old_docs/API_docs_v73/methods/channels_deleteUserHistory.md index ee828f45..fbe34341 100644 --- a/old_docs/API_docs_v73/methods/channels_deleteUserHistory.md +++ b/old_docs/API_docs_v73/methods/channels_deleteUserHistory.md @@ -1,17 +1,19 @@ --- title: channels.deleteUserHistory -description: channels.deleteUserHistory parameters, return type and example +description: Delete all messages of a user in a channel/supergroup --- ## Method: channels.deleteUserHistory [Back to methods index](index.md) +Delete all messages of a user in a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) diff --git a/old_docs/API_docs_v73/methods/channels_editAbout.md b/old_docs/API_docs_v73/methods/channels_editAbout.md index 94be2503..8908f29e 100644 --- a/old_docs/API_docs_v73/methods/channels_editAbout.md +++ b/old_docs/API_docs_v73/methods/channels_editAbout.md @@ -1,17 +1,19 @@ --- title: channels.editAbout -description: channels.editAbout parameters, return type and example +description: Edit the about text of a channel/supergroup --- ## Method: channels.editAbout [Back to methods index](index.md) +Edit the about text of a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|about|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|about|[CLICK ME string](../types/string.md) | Yes|The new about text| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v73/methods/channels_editAdmin.md b/old_docs/API_docs_v73/methods/channels_editAdmin.md index 08707ff4..dcec7d2f 100644 --- a/old_docs/API_docs_v73/methods/channels_editAdmin.md +++ b/old_docs/API_docs_v73/methods/channels_editAdmin.md @@ -1,18 +1,20 @@ --- title: channels.editAdmin -description: channels.editAdmin parameters, return type and example +description: Edit admin permissions of a user in a channel/supergroup --- ## Method: channels.editAdmin [Back to methods index](index.md) +Edit admin permissions of a user in a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|admin\_rights|[CLICK ME ChannelAdminRights](../types/ChannelAdminRights.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| +|admin\_rights|[CLICK ME ChannelAdminRights](../types/ChannelAdminRights.md) | Yes|The new admin rights| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v73/methods/channels_editBanned.md b/old_docs/API_docs_v73/methods/channels_editBanned.md index 1d896393..9859bcae 100644 --- a/old_docs/API_docs_v73/methods/channels_editBanned.md +++ b/old_docs/API_docs_v73/methods/channels_editBanned.md @@ -1,18 +1,20 @@ --- title: channels.editBanned -description: channels.editBanned parameters, return type and example +description: Kick or ban a user from a channel/supergroup --- ## Method: channels.editBanned [Back to methods index](index.md) +Kick or ban a user from a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|banned\_rights|[CLICK ME ChannelBannedRights](../types/ChannelBannedRights.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to kick/ban| +|banned\_rights|[CLICK ME ChannelBannedRights](../types/ChannelBannedRights.md) | Yes|Banned/kicked permissions| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v73/methods/channels_editPhoto.md b/old_docs/API_docs_v73/methods/channels_editPhoto.md index 3a2c794b..9ccd864f 100644 --- a/old_docs/API_docs_v73/methods/channels_editPhoto.md +++ b/old_docs/API_docs_v73/methods/channels_editPhoto.md @@ -1,17 +1,19 @@ --- title: channels.editPhoto -description: channels.editPhoto parameters, return type and example +description: Edit the photo of a supergroup/channel --- ## Method: channels.editPhoto [Back to methods index](index.md) +Edit the photo of a supergroup/channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new photo| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v73/methods/channels_editTitle.md b/old_docs/API_docs_v73/methods/channels_editTitle.md index ec60e10f..b1024faf 100644 --- a/old_docs/API_docs_v73/methods/channels_editTitle.md +++ b/old_docs/API_docs_v73/methods/channels_editTitle.md @@ -1,17 +1,19 @@ --- title: channels.editTitle -description: channels.editTitle parameters, return type and example +description: Edit the title of a supergroup/channel --- ## Method: channels.editTitle [Back to methods index](index.md) +Edit the title of a supergroup/channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|title|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|title|[CLICK ME string](../types/string.md) | Yes|The new channel/supergroup title| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v73/methods/channels_exportInvite.md b/old_docs/API_docs_v73/methods/channels_exportInvite.md index 3c10f832..f0c737d5 100644 --- a/old_docs/API_docs_v73/methods/channels_exportInvite.md +++ b/old_docs/API_docs_v73/methods/channels_exportInvite.md @@ -1,16 +1,18 @@ --- title: channels.exportInvite -description: channels.exportInvite parameters, return type and example +description: Export the invite link of a channel --- ## Method: channels.exportInvite [Back to methods index](index.md) +Export the invite link of a channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| ### Return type: [ExportedChatInvite](../types/ExportedChatInvite.md) diff --git a/old_docs/API_docs_v73/methods/channels_exportMessageLink.md b/old_docs/API_docs_v73/methods/channels_exportMessageLink.md index 924dc0d5..f910b594 100644 --- a/old_docs/API_docs_v73/methods/channels_exportMessageLink.md +++ b/old_docs/API_docs_v73/methods/channels_exportMessageLink.md @@ -1,17 +1,19 @@ --- title: channels.exportMessageLink -description: channels.exportMessageLink parameters, return type and example +description: Get the link of a message in a channel --- ## Method: channels.exportMessageLink [Back to methods index](index.md) +Get the link of a message in a channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|id|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|id|[CLICK ME int](../types/int.md) | Yes|The ID of the message| ### Return type: [ExportedMessageLink](../types/ExportedMessageLink.md) diff --git a/old_docs/API_docs_v73/methods/channels_getAdminLog.md b/old_docs/API_docs_v73/methods/channels_getAdminLog.md index 0585e157..5c1b805e 100644 --- a/old_docs/API_docs_v73/methods/channels_getAdminLog.md +++ b/old_docs/API_docs_v73/methods/channels_getAdminLog.md @@ -1,22 +1,24 @@ --- title: channels.getAdminLog -description: channels.getAdminLog parameters, return type and example +description: Get admin log of a channel/supergruop --- ## Method: channels.getAdminLog [Back to methods index](index.md) +Get admin log of a channel/supergruop + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|q|[CLICK ME string](../types/string.md) | Yes| -|events\_filter|[CLICK ME ChannelAdminLogEventsFilter](../types/ChannelAdminLogEventsFilter.md) | Optional| -|admins|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|max\_id|[CLICK ME long](../types/long.md) | Yes| -|min\_id|[CLICK ME long](../types/long.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|q|[CLICK ME string](../types/string.md) | Yes|Search query| +|events\_filter|[CLICK ME ChannelAdminLogEventsFilter](../types/ChannelAdminLogEventsFilter.md) | Optional|Event filter| +|admins|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|Fetch only actions from these admins| +|max\_id|[CLICK ME long](../types/long.md) | Yes|Maximum message ID to fetch| +|min\_id|[CLICK ME long](../types/long.md) | Yes|Minimum message ID to fetch| +|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to fetch| ### Return type: [channels\_AdminLogResults](../types/channels_AdminLogResults.md) diff --git a/old_docs/API_docs_v73/methods/channels_getAdminedPublicChannels.md b/old_docs/API_docs_v73/methods/channels_getAdminedPublicChannels.md index f2b48050..9646f529 100644 --- a/old_docs/API_docs_v73/methods/channels_getAdminedPublicChannels.md +++ b/old_docs/API_docs_v73/methods/channels_getAdminedPublicChannels.md @@ -1,11 +1,13 @@ --- title: channels.getAdminedPublicChannels -description: channels.getAdminedPublicChannels parameters, return type and example +description: Get all supergroups/channels where you're admin --- ## Method: channels.getAdminedPublicChannels [Back to methods index](index.md) +Get all supergroups/channels where you're admin + ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v73/methods/channels_getChannels.md b/old_docs/API_docs_v73/methods/channels_getChannels.md index bd5958d6..9cd9e798 100644 --- a/old_docs/API_docs_v73/methods/channels_getChannels.md +++ b/old_docs/API_docs_v73/methods/channels_getChannels.md @@ -1,16 +1,18 @@ --- title: channels.getChannels -description: channels.getChannels parameters, return type and example +description: Get info about multiple channels/supergroups --- ## Method: channels.getChannels [Back to methods index](index.md) +Get info about multiple channels/supergroups + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|Array of [Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|Array of [Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Yes|The channel/supergroup MTProto IDs| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v73/methods/channels_getMessages.md b/old_docs/API_docs_v73/methods/channels_getMessages.md index 4440856c..cc944fe5 100644 --- a/old_docs/API_docs_v73/methods/channels_getMessages.md +++ b/old_docs/API_docs_v73/methods/channels_getMessages.md @@ -1,17 +1,19 @@ --- title: channels.getMessages -description: channels.getMessages parameters, return type and example +description: Get channel/supergroup messages --- ## Method: channels.getMessages [Back to methods index](index.md) +Get channel/supergroup messages + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|id|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The message IDs| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v73/methods/channels_getParticipant.md b/old_docs/API_docs_v73/methods/channels_getParticipant.md index c1819b6b..db9b1fc6 100644 --- a/old_docs/API_docs_v73/methods/channels_getParticipant.md +++ b/old_docs/API_docs_v73/methods/channels_getParticipant.md @@ -1,17 +1,19 @@ --- title: channels.getParticipant -description: channels.getParticipant parameters, return type and example +description: Get info about a certain channel/supergroup participant --- ## Method: channels.getParticipant [Back to methods index](index.md) +Get info about a certain channel/supergroup participant + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to fetch info about| ### Return type: [channels\_ChannelParticipant](../types/channels_ChannelParticipant.md) diff --git a/old_docs/API_docs_v73/methods/channels_getParticipants.md b/old_docs/API_docs_v73/methods/channels_getParticipants.md index c2716da9..9b2b6c2a 100644 --- a/old_docs/API_docs_v73/methods/channels_getParticipants.md +++ b/old_docs/API_docs_v73/methods/channels_getParticipants.md @@ -1,20 +1,22 @@ --- title: channels.getParticipants -description: channels.getParticipants parameters, return type and example +description: Get channel/supergroup participants (you should use `$MadelineProto->get_pwr_chat($id)` instead) --- ## Method: channels.getParticipants [Back to methods index](index.md) +Get channel/supergroup participants (you should use `$MadelineProto->get_pwr_chat($id)` instead) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|filter|[CLICK ME ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) | Yes| -|offset|[CLICK ME int](../types/int.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| -|hash|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|filter|[CLICK ME ChannelParticipantsFilter](../types/ChannelParticipantsFilter.md) | Yes|Member filter| +|offset|[CLICK ME int](../types/int.md) | Yes|Offset| +|limit|[CLICK ME int](../types/int.md) | Yes|Limit| +|hash|[CLICK ME int](../types/int.md) | Yes|$MadelineProto->gen_vector_hash(ids of previously fetched participant IDs)| ### Return type: [channels\_ChannelParticipants](../types/channels_ChannelParticipants.md) diff --git a/old_docs/API_docs_v73/methods/channels_inviteToChannel.md b/old_docs/API_docs_v73/methods/channels_inviteToChannel.md index 9bca2967..676f800c 100644 --- a/old_docs/API_docs_v73/methods/channels_inviteToChannel.md +++ b/old_docs/API_docs_v73/methods/channels_inviteToChannel.md @@ -1,17 +1,19 @@ --- title: channels.inviteToChannel -description: channels.inviteToChannel parameters, return type and example +description: Add users to channel/supergroup --- ## Method: channels.inviteToChannel [Back to methods index](index.md) +Add users to channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to add| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v73/methods/channels_joinChannel.md b/old_docs/API_docs_v73/methods/channels_joinChannel.md index 9ecdbe75..721f707c 100644 --- a/old_docs/API_docs_v73/methods/channels_joinChannel.md +++ b/old_docs/API_docs_v73/methods/channels_joinChannel.md @@ -1,16 +1,18 @@ --- title: channels.joinChannel -description: channels.joinChannel parameters, return type and example +description: Join a channel/supergroup --- ## Method: channels.joinChannel [Back to methods index](index.md) +Join a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup to join| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v73/methods/channels_leaveChannel.md b/old_docs/API_docs_v73/methods/channels_leaveChannel.md index 62c20a00..7f02e08c 100644 --- a/old_docs/API_docs_v73/methods/channels_leaveChannel.md +++ b/old_docs/API_docs_v73/methods/channels_leaveChannel.md @@ -1,16 +1,18 @@ --- title: channels.leaveChannel -description: channels.leaveChannel parameters, return type and example +description: Leave a channel/supergroup --- ## Method: channels.leaveChannel [Back to methods index](index.md) +Leave a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup to leave| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v73/methods/channels_readHistory.md b/old_docs/API_docs_v73/methods/channels_readHistory.md index 745893f6..cca891f0 100644 --- a/old_docs/API_docs_v73/methods/channels_readHistory.md +++ b/old_docs/API_docs_v73/methods/channels_readHistory.md @@ -1,17 +1,19 @@ --- title: channels.readHistory -description: channels.readHistory parameters, return type and example +description: Mark channel/supergroup history as read --- ## Method: channels.readHistory [Back to methods index](index.md) +Mark channel/supergroup history as read + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|max\_id|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message ID to mark as read| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v73/methods/channels_readMessageContents.md b/old_docs/API_docs_v73/methods/channels_readMessageContents.md index 8d1d6891..861844c4 100644 --- a/old_docs/API_docs_v73/methods/channels_readMessageContents.md +++ b/old_docs/API_docs_v73/methods/channels_readMessageContents.md @@ -1,17 +1,19 @@ --- title: channels.readMessageContents -description: channels.readMessageContents parameters, return type and example +description: Mark channel/supergroup messages as read --- ## Method: channels.readMessageContents [Back to methods index](index.md) +Mark channel/supergroup messages as read + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|id|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|id|Array of [CLICK ME int](../types/int.md) | Yes|List of message IDs| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v73/methods/channels_reportSpam.md b/old_docs/API_docs_v73/methods/channels_reportSpam.md index 47dd7cff..09af14e0 100644 --- a/old_docs/API_docs_v73/methods/channels_reportSpam.md +++ b/old_docs/API_docs_v73/methods/channels_reportSpam.md @@ -1,18 +1,20 @@ --- title: channels.reportSpam -description: channels.reportSpam parameters, return type and example +description: Report a supergroup/channel for spam --- ## Method: channels.reportSpam [Back to methods index](index.md) +Report a supergroup/channel for spam + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|id|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that added you to this channel| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs of messages to report| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v73/methods/channels_setStickers.md b/old_docs/API_docs_v73/methods/channels_setStickers.md index 1b900e48..9ed5bd55 100644 --- a/old_docs/API_docs_v73/methods/channels_setStickers.md +++ b/old_docs/API_docs_v73/methods/channels_setStickers.md @@ -1,17 +1,19 @@ --- title: channels.setStickers -description: channels.setStickers parameters, return type and example +description: Set the supergroup/channel stickerpack --- ## Method: channels.setStickers [Back to methods index](index.md) +Set the supergroup/channel stickerpack + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergoup| +|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v73/methods/channels_toggleInvites.md b/old_docs/API_docs_v73/methods/channels_toggleInvites.md index b6771ed3..5b541f67 100644 --- a/old_docs/API_docs_v73/methods/channels_toggleInvites.md +++ b/old_docs/API_docs_v73/methods/channels_toggleInvites.md @@ -1,17 +1,19 @@ --- title: channels.toggleInvites -description: channels.toggleInvites parameters, return type and example +description: Allow or disallow any user to invite users to this channel/supergroup --- ## Method: channels.toggleInvites [Back to methods index](index.md) +Allow or disallow any user to invite users to this channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Allow or disallow| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v73/methods/channels_togglePreHistoryHidden.md b/old_docs/API_docs_v73/methods/channels_togglePreHistoryHidden.md index 489472b0..9327de90 100644 --- a/old_docs/API_docs_v73/methods/channels_togglePreHistoryHidden.md +++ b/old_docs/API_docs_v73/methods/channels_togglePreHistoryHidden.md @@ -1,17 +1,19 @@ --- title: channels.togglePreHistoryHidden -description: channels.togglePreHistoryHidden parameters, return type and example +description: Enable or disable hidden history for new channel/supergroup users --- ## Method: channels.togglePreHistoryHidden [Back to methods index](index.md) +Enable or disable hidden history for new channel/supergroup users + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Enable or disable hidden history for new channel/supergroup users| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v73/methods/channels_toggleSignatures.md b/old_docs/API_docs_v73/methods/channels_toggleSignatures.md index e8ff70a8..f233a8e1 100644 --- a/old_docs/API_docs_v73/methods/channels_toggleSignatures.md +++ b/old_docs/API_docs_v73/methods/channels_toggleSignatures.md @@ -1,17 +1,19 @@ --- title: channels.toggleSignatures -description: channels.toggleSignatures parameters, return type and example +description: Toggle channel signatures --- ## Method: channels.toggleSignatures [Back to methods index](index.md) +Toggle channel signatures + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Enable or disable channel signatures?| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v73/methods/channels_updatePinnedMessage.md b/old_docs/API_docs_v73/methods/channels_updatePinnedMessage.md index 7a14b68b..f06d1f0f 100644 --- a/old_docs/API_docs_v73/methods/channels_updatePinnedMessage.md +++ b/old_docs/API_docs_v73/methods/channels_updatePinnedMessage.md @@ -1,18 +1,20 @@ --- title: channels.updatePinnedMessage -description: channels.updatePinnedMessage parameters, return type and example +description: Set the pinned message of a channel/supergroup --- ## Method: channels.updatePinnedMessage [Back to methods index](index.md) +Set the pinned message of a channel/supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|id|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Pin silently| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|id|[CLICK ME int](../types/int.md) | Yes|The ID of the message to pin| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v73/methods/channels_updateUsername.md b/old_docs/API_docs_v73/methods/channels_updateUsername.md index 19647598..ad34490a 100644 --- a/old_docs/API_docs_v73/methods/channels_updateUsername.md +++ b/old_docs/API_docs_v73/methods/channels_updateUsername.md @@ -1,17 +1,19 @@ --- title: channels.updateUsername -description: channels.updateUsername parameters, return type and example +description: Update the username of a supergroup/channel --- ## Method: channels.updateUsername [Back to methods index](index.md) +Update the username of a supergroup/channel + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional| -|username|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup| +|username|[CLICK ME string](../types/string.md) | Yes|The new username| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v73/methods/contacts_getBlocked.md b/old_docs/API_docs_v73/methods/contacts_getBlocked.md index d7d8c5cc..300025af 100644 --- a/old_docs/API_docs_v73/methods/contacts_getBlocked.md +++ b/old_docs/API_docs_v73/methods/contacts_getBlocked.md @@ -12,7 +12,7 @@ Get blocked users | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, then set to the number of blocked contacts previously fetched| +|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, Then set to the number of blocked contacts previously fetched| |limit|[CLICK ME int](../types/int.md) | Yes|How many blocked contacts to fetch| diff --git a/old_docs/API_docs_v73/methods/contacts_getTopPeers.md b/old_docs/API_docs_v73/methods/contacts_getTopPeers.md index 226d3aa0..d7b21757 100644 --- a/old_docs/API_docs_v73/methods/contacts_getTopPeers.md +++ b/old_docs/API_docs_v73/methods/contacts_getTopPeers.md @@ -18,7 +18,7 @@ Get most used chats |phone\_calls|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch phone calls?| |groups|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch groups?| |channels|[CLICK ME Bool](../types/Bool.md) | Optional|Fetch channels and supergroups?| -|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, then `$offset += $contacts_TopPeers['categories']['count'];`| +|offset|[CLICK ME int](../types/int.md) | Yes|Initially 0, Then `$offset += $contacts_TopPeers['categories']['count'];`| |limit|[CLICK ME int](../types/int.md) | Yes|How many results to fetch| |hash|[CLICK ME int](../types/int.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched peer ids);| diff --git a/old_docs/API_docs_v73/methods/help_getAppChangelog.md b/old_docs/API_docs_v73/methods/help_getAppChangelog.md index ea7192f6..477df2f8 100644 --- a/old_docs/API_docs_v73/methods/help_getAppChangelog.md +++ b/old_docs/API_docs_v73/methods/help_getAppChangelog.md @@ -1,16 +1,18 @@ --- title: help.getAppChangelog -description: help.getAppChangelog parameters, return type and example +description: Get the changelog of this app --- ## Method: help.getAppChangelog [Back to methods index](index.md) +Get the changelog of this app + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|prev\_app\_version|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|prev\_app\_version|[CLICK ME string](../types/string.md) | Yes|Previous app version| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v73/methods/help_getAppUpdate.md b/old_docs/API_docs_v73/methods/help_getAppUpdate.md index ef72cce2..b88906ae 100644 --- a/old_docs/API_docs_v73/methods/help_getAppUpdate.md +++ b/old_docs/API_docs_v73/methods/help_getAppUpdate.md @@ -1,11 +1,13 @@ --- title: help.getAppUpdate -description: help.getAppUpdate parameters, return type and example +description: Get info about app updates --- ## Method: help.getAppUpdate [Back to methods index](index.md) +Get info about app updates + ### Return type: [help\_AppUpdate](../types/help_AppUpdate.md) diff --git a/old_docs/API_docs_v73/methods/help_getCdnConfig.md b/old_docs/API_docs_v73/methods/help_getCdnConfig.md index 55a6e6fd..809ea1fb 100644 --- a/old_docs/API_docs_v73/methods/help_getCdnConfig.md +++ b/old_docs/API_docs_v73/methods/help_getCdnConfig.md @@ -1,11 +1,13 @@ --- title: help.getCdnConfig -description: help.getCdnConfig parameters, return type and example +description: Get CDN configuration --- ## Method: help.getCdnConfig [Back to methods index](index.md) +Get CDN configuration + ### Return type: [CdnConfig](../types/CdnConfig.md) diff --git a/old_docs/API_docs_v73/methods/help_getConfig.md b/old_docs/API_docs_v73/methods/help_getConfig.md index 885ad5d3..16e25c68 100644 --- a/old_docs/API_docs_v73/methods/help_getConfig.md +++ b/old_docs/API_docs_v73/methods/help_getConfig.md @@ -1,11 +1,13 @@ --- title: help.getConfig -description: help.getConfig parameters, return type and example +description: Get server configuration --- ## Method: help.getConfig [Back to methods index](index.md) +Get server configuration + ### Return type: [Config](../types/Config.md) diff --git a/old_docs/API_docs_v73/methods/help_getInviteText.md b/old_docs/API_docs_v73/methods/help_getInviteText.md index 101ead40..6b226bff 100644 --- a/old_docs/API_docs_v73/methods/help_getInviteText.md +++ b/old_docs/API_docs_v73/methods/help_getInviteText.md @@ -1,11 +1,13 @@ --- title: help.getInviteText -description: help.getInviteText parameters, return type and example +description: Get invitation text --- ## Method: help.getInviteText [Back to methods index](index.md) +Get invitation text + ### Return type: [help\_InviteText](../types/help_InviteText.md) diff --git a/old_docs/API_docs_v73/methods/help_getNearestDc.md b/old_docs/API_docs_v73/methods/help_getNearestDc.md index 6196890b..35a8bf91 100644 --- a/old_docs/API_docs_v73/methods/help_getNearestDc.md +++ b/old_docs/API_docs_v73/methods/help_getNearestDc.md @@ -1,11 +1,13 @@ --- title: help.getNearestDc -description: help.getNearestDc parameters, return type and example +description: Get nearest datacenter --- ## Method: help.getNearestDc [Back to methods index](index.md) +Get nearest datacenter + ### Return type: [NearestDc](../types/NearestDc.md) diff --git a/old_docs/API_docs_v73/methods/help_getRecentMeUrls.md b/old_docs/API_docs_v73/methods/help_getRecentMeUrls.md index bec8a8e0..43a47dad 100644 --- a/old_docs/API_docs_v73/methods/help_getRecentMeUrls.md +++ b/old_docs/API_docs_v73/methods/help_getRecentMeUrls.md @@ -1,16 +1,18 @@ --- title: help.getRecentMeUrls -description: help.getRecentMeUrls parameters, return type and example +description: Get recent t.me URLs --- ## Method: help.getRecentMeUrls [Back to methods index](index.md) +Get recent t.me URLs + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|referer|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|referer|[CLICK ME string](../types/string.md) | Yes|Referrer| ### Return type: [help\_RecentMeUrls](../types/help_RecentMeUrls.md) diff --git a/old_docs/API_docs_v73/methods/help_getSupport.md b/old_docs/API_docs_v73/methods/help_getSupport.md index 9b269f78..a5bab0f2 100644 --- a/old_docs/API_docs_v73/methods/help_getSupport.md +++ b/old_docs/API_docs_v73/methods/help_getSupport.md @@ -1,11 +1,13 @@ --- title: help.getSupport -description: help.getSupport parameters, return type and example +description: Get info of support user --- ## Method: help.getSupport [Back to methods index](index.md) +Get info of support user + ### Return type: [help\_Support](../types/help_Support.md) diff --git a/old_docs/API_docs_v73/methods/help_getTermsOfService.md b/old_docs/API_docs_v73/methods/help_getTermsOfService.md index f63807ab..487cd83a 100644 --- a/old_docs/API_docs_v73/methods/help_getTermsOfService.md +++ b/old_docs/API_docs_v73/methods/help_getTermsOfService.md @@ -1,11 +1,13 @@ --- title: help.getTermsOfService -description: help.getTermsOfService parameters, return type and example +description: Get terms of service --- ## Method: help.getTermsOfService [Back to methods index](index.md) +Get terms of service + ### Return type: [help\_TermsOfService](../types/help_TermsOfService.md) diff --git a/old_docs/API_docs_v73/methods/help_saveAppLog.md b/old_docs/API_docs_v73/methods/help_saveAppLog.md index af6e94e2..0165b6e3 100644 --- a/old_docs/API_docs_v73/methods/help_saveAppLog.md +++ b/old_docs/API_docs_v73/methods/help_saveAppLog.md @@ -1,16 +1,18 @@ --- title: help.saveAppLog -description: help.saveAppLog parameters, return type and example +description: Log data for developer of this app --- ## Method: help.saveAppLog [Back to methods index](index.md) +Log data for developer of this app + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|events|Array of [CLICK ME InputAppEvent](../types/InputAppEvent.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|events|Array of [CLICK ME InputAppEvent](../types/InputAppEvent.md) | Yes|Event list| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v73/methods/help_setBotUpdatesStatus.md b/old_docs/API_docs_v73/methods/help_setBotUpdatesStatus.md index 3351fab4..ff314b5c 100644 --- a/old_docs/API_docs_v73/methods/help_setBotUpdatesStatus.md +++ b/old_docs/API_docs_v73/methods/help_setBotUpdatesStatus.md @@ -1,17 +1,19 @@ --- title: help.setBotUpdatesStatus -description: help.setBotUpdatesStatus parameters, return type and example +description: Set the update status of webhook --- ## Method: help.setBotUpdatesStatus [Back to methods index](index.md) +Set the update status of webhook + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|pending\_updates\_count|[CLICK ME int](../types/int.md) | Yes| -|message|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|pending\_updates\_count|[CLICK ME int](../types/int.md) | Yes|Pending update count| +|message|[CLICK ME string](../types/string.md) | Yes|Message| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v73/methods/messages_checkChatInvite.md b/old_docs/API_docs_v73/methods/messages_checkChatInvite.md index 4ddf5084..de1d9ff4 100644 --- a/old_docs/API_docs_v73/methods/messages_checkChatInvite.md +++ b/old_docs/API_docs_v73/methods/messages_checkChatInvite.md @@ -1,16 +1,18 @@ --- title: messages.checkChatInvite -description: messages.checkChatInvite parameters, return type and example +description: Check if an invitation link is valid --- ## Method: messages.checkChatInvite [Back to methods index](index.md) +Check if an invitation link is valid + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| ### Return type: [ChatInvite](../types/ChatInvite.md) diff --git a/old_docs/API_docs_v73/methods/messages_clearRecentStickers.md b/old_docs/API_docs_v73/methods/messages_clearRecentStickers.md index f017087f..9c1b3754 100644 --- a/old_docs/API_docs_v73/methods/messages_clearRecentStickers.md +++ b/old_docs/API_docs_v73/methods/messages_clearRecentStickers.md @@ -1,16 +1,18 @@ --- title: messages.clearRecentStickers -description: messages.clearRecentStickers parameters, return type and example +description: Clear all recent stickers --- ## Method: messages.clearRecentStickers [Back to methods index](index.md) +Clear all recent stickers + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|attached|[CLICK ME Bool](../types/Bool.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|attached|[CLICK ME Bool](../types/Bool.md) | Optional|Clear recent stickers attached to images?| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v73/methods/messages_deleteChatUser.md b/old_docs/API_docs_v73/methods/messages_deleteChatUser.md index a71f4aaf..0a6830de 100644 --- a/old_docs/API_docs_v73/methods/messages_deleteChatUser.md +++ b/old_docs/API_docs_v73/methods/messages_deleteChatUser.md @@ -12,7 +12,7 @@ Delete a user from a chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The MTProto ID of the chat| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| |user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to delete (pass @me to leave the chat)| diff --git a/old_docs/API_docs_v73/methods/messages_editChatAdmin.md b/old_docs/API_docs_v73/methods/messages_editChatAdmin.md index 6bc8f9ae..7916f8b1 100644 --- a/old_docs/API_docs_v73/methods/messages_editChatAdmin.md +++ b/old_docs/API_docs_v73/methods/messages_editChatAdmin.md @@ -1,18 +1,20 @@ --- title: messages.editChatAdmin -description: messages.editChatAdmin parameters, return type and example +description: Edit admin permissions --- ## Method: messages.editChatAdmin [Back to methods index](index.md) +Edit admin permissions + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|is\_admin|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat ID (no supergroups)| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user ID| +|is\_admin|[CLICK ME Bool](../types/Bool.md) | Yes|Should the user be admin?| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v73/methods/messages_editChatPhoto.md b/old_docs/API_docs_v73/methods/messages_editChatPhoto.md index 8848eca7..122913c4 100644 --- a/old_docs/API_docs_v73/methods/messages_editChatPhoto.md +++ b/old_docs/API_docs_v73/methods/messages_editChatPhoto.md @@ -12,7 +12,7 @@ Edit the photo of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The MTProto ID of the chat| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| |photo|[CLICK ME InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| diff --git a/old_docs/API_docs_v73/methods/messages_editChatTitle.md b/old_docs/API_docs_v73/methods/messages_editChatTitle.md index 1c1c7a16..3a1e974b 100644 --- a/old_docs/API_docs_v73/methods/messages_editChatTitle.md +++ b/old_docs/API_docs_v73/methods/messages_editChatTitle.md @@ -12,7 +12,7 @@ Edit the title of a normal chat (not supergroup) | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The MTProto ID of the chat| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| |title|[CLICK ME string](../types/string.md) | Yes|The new title| diff --git a/old_docs/API_docs_v73/methods/messages_editInlineBotMessage.md b/old_docs/API_docs_v73/methods/messages_editInlineBotMessage.md index 9c4ef8d8..3c7fa055 100644 --- a/old_docs/API_docs_v73/methods/messages_editInlineBotMessage.md +++ b/old_docs/API_docs_v73/methods/messages_editInlineBotMessage.md @@ -1,23 +1,25 @@ --- title: messages.editInlineBotMessage -description: messages.editInlineBotMessage parameters, return type and example +description: Edit a sent inline message --- ## Method: messages.editInlineBotMessage [Back to methods index](index.md) +Edit a sent inline message + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional| -|stop\_geo\_live|[CLICK ME Bool](../types/Bool.md) | Optional| -|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes| -|message|[CLICK ME string](../types/string.md) | Optional| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview| +|stop\_geo\_live|[CLICK ME Bool](../types/Bool.md) | Optional|Stop live location| +|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The message ID| +|message|[CLICK ME string](../types/string.md) | Optional|The new message| +|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| +|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| -|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional| +|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional|The new location| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v73/methods/messages_editMessage.md b/old_docs/API_docs_v73/methods/messages_editMessage.md index 6953a15f..f2533fc2 100644 --- a/old_docs/API_docs_v73/methods/messages_editMessage.md +++ b/old_docs/API_docs_v73/methods/messages_editMessage.md @@ -1,24 +1,26 @@ --- title: messages.editMessage -description: messages.editMessage parameters, return type and example +description: Edit a message --- ## Method: messages.editMessage [Back to methods index](index.md) +Edit a message + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional| -|stop\_geo\_live|[CLICK ME Bool](../types/Bool.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|id|[CLICK ME int](../types/int.md) | Yes| -|message|[CLICK ME string](../types/string.md) | Optional| -|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview| +|stop\_geo\_live|[CLICK ME Bool](../types/Bool.md) | Optional|Stop live location| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| +|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|message|[CLICK ME string](../types/string.md) | Optional|The new message| +|reply\_markup|[CLICK ME ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| +|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| -|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional| +|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional|The new location| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v73/methods/messages_exportChatInvite.md b/old_docs/API_docs_v73/methods/messages_exportChatInvite.md index 74d70c21..98685d96 100644 --- a/old_docs/API_docs_v73/methods/messages_exportChatInvite.md +++ b/old_docs/API_docs_v73/methods/messages_exportChatInvite.md @@ -1,16 +1,18 @@ --- title: messages.exportChatInvite -description: messages.exportChatInvite parameters, return type and example +description: Export chat invite --- ## Method: messages.exportChatInvite [Back to methods index](index.md) +Export chat invite + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat id | ### Return type: [ExportedChatInvite](../types/ExportedChatInvite.md) diff --git a/old_docs/API_docs_v73/methods/messages_faveSticker.md b/old_docs/API_docs_v73/methods/messages_faveSticker.md index b9d9a033..c1ffb16a 100644 --- a/old_docs/API_docs_v73/methods/messages_faveSticker.md +++ b/old_docs/API_docs_v73/methods/messages_faveSticker.md @@ -1,17 +1,19 @@ --- title: messages.faveSticker -description: messages.faveSticker parameters, return type and example +description: Add a sticker to favorites --- ## Method: messages.faveSticker [Back to methods index](index.md) +Add a sticker to favorites + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional| -|unfave|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker to add to favorites| +|unfave|[CLICK ME Bool](../types/Bool.md) | Yes|Remove it from favorites?| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v73/methods/messages_getAllChats.md b/old_docs/API_docs_v73/methods/messages_getAllChats.md index 4b87df49..127456e4 100644 --- a/old_docs/API_docs_v73/methods/messages_getAllChats.md +++ b/old_docs/API_docs_v73/methods/messages_getAllChats.md @@ -1,16 +1,18 @@ --- title: messages.getAllChats -description: messages.getAllChats parameters, return type and example +description: Get all chats (not supergroups or channels) --- ## Method: messages.getAllChats [Back to methods index](index.md) +Get all chats (not supergroups or channels) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|except\_ids|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|except\_ids|Array of [CLICK ME int](../types/int.md) | Yes|Do not fetch these chats (MTProto id)| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v73/methods/messages_getAllDrafts.md b/old_docs/API_docs_v73/methods/messages_getAllDrafts.md index a5dd59f6..2c0ecd42 100644 --- a/old_docs/API_docs_v73/methods/messages_getAllDrafts.md +++ b/old_docs/API_docs_v73/methods/messages_getAllDrafts.md @@ -1,11 +1,13 @@ --- title: messages.getAllDrafts -description: messages.getAllDrafts parameters, return type and example +description: Get all message drafts --- ## Method: messages.getAllDrafts [Back to methods index](index.md) +Get all message drafts + ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v73/methods/messages_getAllStickers.md b/old_docs/API_docs_v73/methods/messages_getAllStickers.md index 575fcd49..16fdba6c 100644 --- a/old_docs/API_docs_v73/methods/messages_getAllStickers.md +++ b/old_docs/API_docs_v73/methods/messages_getAllStickers.md @@ -1,16 +1,18 @@ --- title: messages.getAllStickers -description: messages.getAllStickers parameters, return type and example +description: Get all stickerpacks --- ## Method: messages.getAllStickers [Back to methods index](index.md) +Get all stickerpacks + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v73/methods/messages_getArchivedStickers.md b/old_docs/API_docs_v73/methods/messages_getArchivedStickers.md index 1b4aaa93..f037e1bc 100644 --- a/old_docs/API_docs_v73/methods/messages_getArchivedStickers.md +++ b/old_docs/API_docs_v73/methods/messages_getArchivedStickers.md @@ -1,18 +1,20 @@ --- title: messages.getArchivedStickers -description: messages.getArchivedStickers parameters, return type and example +description: Get all archived stickers --- ## Method: messages.getArchivedStickers [Back to methods index](index.md) +Get all archived stickers + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|masks|[CLICK ME Bool](../types/Bool.md) | Optional| -|offset\_id|[CLICK ME long](../types/long.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|masks|[CLICK ME Bool](../types/Bool.md) | Optional|Get masks?| +|offset\_id|[CLICK ME long](../types/long.md) | Yes|Sticker ID offset| +|limit|[CLICK ME int](../types/int.md) | Yes|Number of stickers to fetch| ### Return type: [messages\_ArchivedStickers](../types/messages_ArchivedStickers.md) diff --git a/old_docs/API_docs_v73/methods/messages_getAttachedStickers.md b/old_docs/API_docs_v73/methods/messages_getAttachedStickers.md index a0d89b31..890680cd 100644 --- a/old_docs/API_docs_v73/methods/messages_getAttachedStickers.md +++ b/old_docs/API_docs_v73/methods/messages_getAttachedStickers.md @@ -1,16 +1,18 @@ --- title: messages.getAttachedStickers -description: messages.getAttachedStickers parameters, return type and example +description: Get stickers attachable to images --- ## Method: messages.getAttachedStickers [Back to methods index](index.md) +Get stickers attachable to images + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|media|[CLICK ME InputStickeredMedia](../types/InputStickeredMedia.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|media|[CLICK ME InputStickeredMedia](../types/InputStickeredMedia.md) | Yes|The stickered media| ### Return type: [Vector\_of\_StickerSetCovered](../types/StickerSetCovered.md) diff --git a/old_docs/API_docs_v73/methods/messages_getBotCallbackAnswer.md b/old_docs/API_docs_v73/methods/messages_getBotCallbackAnswer.md index 7ccd0d1b..09c283f5 100644 --- a/old_docs/API_docs_v73/methods/messages_getBotCallbackAnswer.md +++ b/old_docs/API_docs_v73/methods/messages_getBotCallbackAnswer.md @@ -1,19 +1,21 @@ --- title: messages.getBotCallbackAnswer -description: messages.getBotCallbackAnswer parameters, return type and example +description: Get the callback answer of a bot (after clicking a button) --- ## Method: messages.getBotCallbackAnswer [Back to methods index](index.md) +Get the callback answer of a bot (after clicking a button) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|game|[CLICK ME Bool](../types/Bool.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|msg\_id|[CLICK ME int](../types/int.md) | Yes| -|data|[CLICK ME bytes](../types/bytes.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|game|[CLICK ME Bool](../types/Bool.md) | Optional|Is this a game?| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| +|msg\_id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|data|[CLICK ME bytes](../types/bytes.md) | Optional|The data to send to the bot| ### Return type: [messages\_BotCallbackAnswer](../types/messages_BotCallbackAnswer.md) diff --git a/old_docs/API_docs_v73/methods/messages_getCommonChats.md b/old_docs/API_docs_v73/methods/messages_getCommonChats.md index a57d7f5a..e6eca283 100644 --- a/old_docs/API_docs_v73/methods/messages_getCommonChats.md +++ b/old_docs/API_docs_v73/methods/messages_getCommonChats.md @@ -1,18 +1,20 @@ --- title: messages.getCommonChats -description: messages.getCommonChats parameters, return type and example +description: Get chats in common with a user --- ## Method: messages.getCommonChats [Back to methods index](index.md) +Get chats in common with a user + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|max\_id|[CLICK ME int](../types/int.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| +|max\_id|[CLICK ME int](../types/int.md) | Yes|The maximum chat ID to fetch| +|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to fetch| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v73/methods/messages_getDocumentByHash.md b/old_docs/API_docs_v73/methods/messages_getDocumentByHash.md index b7c45398..1af5bad4 100644 --- a/old_docs/API_docs_v73/methods/messages_getDocumentByHash.md +++ b/old_docs/API_docs_v73/methods/messages_getDocumentByHash.md @@ -1,18 +1,20 @@ --- title: messages.getDocumentByHash -description: messages.getDocumentByHash parameters, return type and example +description: Get document by SHA256 hash --- ## Method: messages.getDocumentByHash [Back to methods index](index.md) +Get document by SHA256 hash + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|sha256|[CLICK ME bytes](../types/bytes.md) | Yes| -|size|[CLICK ME int](../types/int.md) | Yes| -|mime\_type|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|sha256|[CLICK ME bytes](../types/bytes.md) | Yes|`hash('sha256', $filename, true);`| +|size|[CLICK ME int](../types/int.md) | Yes|The file size| +|mime\_type|[CLICK ME string](../types/string.md) | Yes|The mime type of the file| ### Return type: [Document](../types/Document.md) diff --git a/old_docs/API_docs_v73/methods/messages_getFavedStickers.md b/old_docs/API_docs_v73/methods/messages_getFavedStickers.md index e95d0133..1be542be 100644 --- a/old_docs/API_docs_v73/methods/messages_getFavedStickers.md +++ b/old_docs/API_docs_v73/methods/messages_getFavedStickers.md @@ -1,16 +1,18 @@ --- title: messages.getFavedStickers -description: messages.getFavedStickers parameters, return type and example +description: Get favorite stickers --- ## Method: messages.getFavedStickers [Back to methods index](index.md) +Get favorite stickers + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_FavedStickers](../types/messages_FavedStickers.md) diff --git a/old_docs/API_docs_v73/methods/messages_getFeaturedStickers.md b/old_docs/API_docs_v73/methods/messages_getFeaturedStickers.md index 88b5609c..512f2e85 100644 --- a/old_docs/API_docs_v73/methods/messages_getFeaturedStickers.md +++ b/old_docs/API_docs_v73/methods/messages_getFeaturedStickers.md @@ -1,16 +1,18 @@ --- title: messages.getFeaturedStickers -description: messages.getFeaturedStickers parameters, return type and example +description: Get featured stickers --- ## Method: messages.getFeaturedStickers [Back to methods index](index.md) +Get featured stickers + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_FeaturedStickers](../types/messages_FeaturedStickers.md) diff --git a/old_docs/API_docs_v73/methods/messages_getGameHighScores.md b/old_docs/API_docs_v73/methods/messages_getGameHighScores.md index 2c95af05..5137baea 100644 --- a/old_docs/API_docs_v73/methods/messages_getGameHighScores.md +++ b/old_docs/API_docs_v73/methods/messages_getGameHighScores.md @@ -1,18 +1,20 @@ --- title: messages.getGameHighScores -description: messages.getGameHighScores parameters, return type and example +description: Get high scores of a game --- ## Method: messages.getGameHighScores [Back to methods index](index.md) +Get high scores of a game + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|id|[CLICK ME int](../types/int.md) | Yes| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| +|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the high scores| ### Return type: [messages\_HighScores](../types/messages_HighScores.md) diff --git a/old_docs/API_docs_v73/methods/messages_getInlineBotResults.md b/old_docs/API_docs_v73/methods/messages_getInlineBotResults.md index 5b2bb254..8ab5bf78 100644 --- a/old_docs/API_docs_v73/methods/messages_getInlineBotResults.md +++ b/old_docs/API_docs_v73/methods/messages_getInlineBotResults.md @@ -1,20 +1,22 @@ --- title: messages.getInlineBotResults -description: messages.getInlineBotResults parameters, return type and example +description: Call inline bot --- ## Method: messages.getInlineBotResults [Back to methods index](index.md) +Call inline bot + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional| -|query|[CLICK ME string](../types/string.md) | Yes| -|offset|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot to call| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to call the bot| +|geo\_point|[CLICK ME InputGeoPoint](../types/InputGeoPoint.md) | Optional|The current location| +|query|[CLICK ME string](../types/string.md) | Yes|The query to send to the bot| +|offset|[CLICK ME string](../types/string.md) | Yes|The offset to send to the bot| ### Return type: [messages\_BotResults](../types/messages_BotResults.md) diff --git a/old_docs/API_docs_v73/methods/messages_getInlineGameHighScores.md b/old_docs/API_docs_v73/methods/messages_getInlineGameHighScores.md index 447a55dd..790bfdd9 100644 --- a/old_docs/API_docs_v73/methods/messages_getInlineGameHighScores.md +++ b/old_docs/API_docs_v73/methods/messages_getInlineGameHighScores.md @@ -1,17 +1,19 @@ --- title: messages.getInlineGameHighScores -description: messages.getInlineGameHighScores parameters, return type and example +description: Get high scores of a game sent in an inline message --- ## Method: messages.getInlineGameHighScores [Back to methods index](index.md) +Get high scores of a game sent in an inline message + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The inline message| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the high scores| ### Return type: [messages\_HighScores](../types/messages_HighScores.md) diff --git a/old_docs/API_docs_v73/methods/messages_getMaskStickers.md b/old_docs/API_docs_v73/methods/messages_getMaskStickers.md index 80c16471..f4ed9411 100644 --- a/old_docs/API_docs_v73/methods/messages_getMaskStickers.md +++ b/old_docs/API_docs_v73/methods/messages_getMaskStickers.md @@ -1,16 +1,18 @@ --- title: messages.getMaskStickers -description: messages.getMaskStickers parameters, return type and example +description: Get masks --- ## Method: messages.getMaskStickers [Back to methods index](index.md) +Get masks + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v73/methods/messages_getMessageEditData.md b/old_docs/API_docs_v73/methods/messages_getMessageEditData.md index 339678bd..12e71bee 100644 --- a/old_docs/API_docs_v73/methods/messages_getMessageEditData.md +++ b/old_docs/API_docs_v73/methods/messages_getMessageEditData.md @@ -1,17 +1,19 @@ --- title: messages.getMessageEditData -description: messages.getMessageEditData parameters, return type and example +description: Check if about to edit a message or a media caption --- ## Method: messages.getMessageEditData [Back to methods index](index.md) +Check if about to edit a message or a media caption + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|id|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| +|id|[CLICK ME int](../types/int.md) | Yes|The message ID| ### Return type: [messages\_MessageEditData](../types/messages_MessageEditData.md) diff --git a/old_docs/API_docs_v73/methods/messages_getMessagesViews.md b/old_docs/API_docs_v73/methods/messages_getMessagesViews.md index e3f4e4ea..b8d78c85 100644 --- a/old_docs/API_docs_v73/methods/messages_getMessagesViews.md +++ b/old_docs/API_docs_v73/methods/messages_getMessagesViews.md @@ -1,18 +1,20 @@ --- title: messages.getMessagesViews -description: messages.getMessagesViews parameters, return type and example +description: Get and increase message views --- ## Method: messages.getMessagesViews [Back to methods index](index.md) +Get and increase message views + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|id|Array of [CLICK ME int](../types/int.md) | Yes| -|increment|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the message is located| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The IDs messages to get| +|increment|[CLICK ME Bool](../types/Bool.md) | Yes|Increase message views?| ### Return type: [Vector\_of\_int](../types/int.md) diff --git a/old_docs/API_docs_v73/methods/messages_getPeerDialogs.md b/old_docs/API_docs_v73/methods/messages_getPeerDialogs.md index fe8a821c..da82cfc6 100644 --- a/old_docs/API_docs_v73/methods/messages_getPeerDialogs.md +++ b/old_docs/API_docs_v73/methods/messages_getPeerDialogs.md @@ -1,16 +1,18 @@ --- title: messages.getPeerDialogs -description: messages.getPeerDialogs parameters, return type and example +description: Get dialog info of peers --- ## Method: messages.getPeerDialogs [Back to methods index](index.md) +Get dialog info of peers + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peers|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peers|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Yes|The peers| ### Return type: [messages\_PeerDialogs](../types/messages_PeerDialogs.md) diff --git a/old_docs/API_docs_v73/methods/messages_getPinnedDialogs.md b/old_docs/API_docs_v73/methods/messages_getPinnedDialogs.md index 99ff5651..d12779fe 100644 --- a/old_docs/API_docs_v73/methods/messages_getPinnedDialogs.md +++ b/old_docs/API_docs_v73/methods/messages_getPinnedDialogs.md @@ -1,11 +1,13 @@ --- title: messages.getPinnedDialogs -description: messages.getPinnedDialogs parameters, return type and example +description: Get pinned dialogs --- ## Method: messages.getPinnedDialogs [Back to methods index](index.md) +Get pinned dialogs + ### Return type: [messages\_PeerDialogs](../types/messages_PeerDialogs.md) diff --git a/old_docs/API_docs_v73/methods/messages_getRecentLocations.md b/old_docs/API_docs_v73/methods/messages_getRecentLocations.md index 3a8de92f..1f73943d 100644 --- a/old_docs/API_docs_v73/methods/messages_getRecentLocations.md +++ b/old_docs/API_docs_v73/methods/messages_getRecentLocations.md @@ -1,17 +1,19 @@ --- title: messages.getRecentLocations -description: messages.getRecentLocations parameters, return type and example +description: Get recent locations --- ## Method: messages.getRecentLocations [Back to methods index](index.md) +Get recent locations + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to search locations| +|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to return| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v73/methods/messages_getRecentStickers.md b/old_docs/API_docs_v73/methods/messages_getRecentStickers.md index abab7f44..d76a2160 100644 --- a/old_docs/API_docs_v73/methods/messages_getRecentStickers.md +++ b/old_docs/API_docs_v73/methods/messages_getRecentStickers.md @@ -1,17 +1,19 @@ --- title: messages.getRecentStickers -description: messages.getRecentStickers parameters, return type and example +description: Get recent stickers --- ## Method: messages.getRecentStickers [Back to methods index](index.md) +Get recent stickers + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|attached|[CLICK ME Bool](../types/Bool.md) | Optional| -|hash|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|attached|[CLICK ME Bool](../types/Bool.md) | Optional|Get stickers attached to image?| +|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_RecentStickers](../types/messages_RecentStickers.md) diff --git a/old_docs/API_docs_v73/methods/messages_getSavedGifs.md b/old_docs/API_docs_v73/methods/messages_getSavedGifs.md index 08dc4be6..f61348ce 100644 --- a/old_docs/API_docs_v73/methods/messages_getSavedGifs.md +++ b/old_docs/API_docs_v73/methods/messages_getSavedGifs.md @@ -1,16 +1,18 @@ --- title: messages.getSavedGifs -description: messages.getSavedGifs parameters, return type and example +description: Get saved gifs --- ## Method: messages.getSavedGifs [Back to methods index](index.md) +Get saved gifs + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [messages\_SavedGifs](../types/messages_SavedGifs.md) diff --git a/old_docs/API_docs_v73/methods/messages_getStickerSet.md b/old_docs/API_docs_v73/methods/messages_getStickerSet.md index 70bdd9ba..c86807e4 100644 --- a/old_docs/API_docs_v73/methods/messages_getStickerSet.md +++ b/old_docs/API_docs_v73/methods/messages_getStickerSet.md @@ -1,16 +1,18 @@ --- title: messages.getStickerSet -description: messages.getStickerSet parameters, return type and example +description: Get a stickerset --- ## Method: messages.getStickerSet [Back to methods index](index.md) +Get a stickerset + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset to get| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/old_docs/API_docs_v73/methods/messages_getUnreadMentions.md b/old_docs/API_docs_v73/methods/messages_getUnreadMentions.md index 959c52fc..d318506c 100644 --- a/old_docs/API_docs_v73/methods/messages_getUnreadMentions.md +++ b/old_docs/API_docs_v73/methods/messages_getUnreadMentions.md @@ -1,21 +1,23 @@ --- title: messages.getUnreadMentions -description: messages.getUnreadMentions parameters, return type and example +description: Get unread mentions --- ## Method: messages.getUnreadMentions [Back to methods index](index.md) +Get unread mentions + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|offset\_id|[CLICK ME int](../types/int.md) | Yes| -|add\_offset|[CLICK ME int](../types/int.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| -|max\_id|[CLICK ME int](../types/int.md) | Yes| -|min\_id|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to get unread mentions| +|offset\_id|[CLICK ME int](../types/int.md) | Yes|The offset| +|add\_offset|[CLICK ME int](../types/int.md) | Yes|The additional offset| +|limit|[CLICK ME int](../types/int.md) | Yes|The number of results to fetch| +|max\_id|[CLICK ME int](../types/int.md) | Yes|The maximum message ID to fetch| +|min\_id|[CLICK ME int](../types/int.md) | Yes|The minumum message ID to fetch| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v73/methods/messages_getWebPage.md b/old_docs/API_docs_v73/methods/messages_getWebPage.md index b29e5d25..129f8f06 100644 --- a/old_docs/API_docs_v73/methods/messages_getWebPage.md +++ b/old_docs/API_docs_v73/methods/messages_getWebPage.md @@ -1,17 +1,19 @@ --- title: messages.getWebPage -description: messages.getWebPage parameters, return type and example +description: Get webpage preview --- ## Method: messages.getWebPage [Back to methods index](index.md) +Get webpage preview + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|url|[CLICK ME string](../types/string.md) | Yes| -|hash|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|url|[CLICK ME string](../types/string.md) | Yes|URL| +|hash|[CLICK ME int](../types/int.md) | Yes|0 or $result['hash']| ### Return type: [WebPage](../types/WebPage.md) diff --git a/old_docs/API_docs_v73/methods/messages_getWebPagePreview.md b/old_docs/API_docs_v73/methods/messages_getWebPagePreview.md index 35243c9f..d01bdd32 100644 --- a/old_docs/API_docs_v73/methods/messages_getWebPagePreview.md +++ b/old_docs/API_docs_v73/methods/messages_getWebPagePreview.md @@ -1,16 +1,18 @@ --- title: messages.getWebPagePreview -description: messages.getWebPagePreview parameters, return type and example +description: Get webpage preview --- ## Method: messages.getWebPagePreview [Back to methods index](index.md) +Get webpage preview + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|message|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|message|[CLICK ME string](../types/string.md) | Yes|Extract preview from this message| ### Return type: [MessageMedia](../types/MessageMedia.md) diff --git a/old_docs/API_docs_v73/methods/messages_importChatInvite.md b/old_docs/API_docs_v73/methods/messages_importChatInvite.md index 2bea5247..0d6cd7c8 100644 --- a/old_docs/API_docs_v73/methods/messages_importChatInvite.md +++ b/old_docs/API_docs_v73/methods/messages_importChatInvite.md @@ -1,16 +1,18 @@ --- title: messages.importChatInvite -description: messages.importChatInvite parameters, return type and example +description: Import chat invite --- ## Method: messages.importChatInvite [Back to methods index](index.md) +Import chat invite + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|hash|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|hash|[CLICK ME string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v73/methods/messages_installStickerSet.md b/old_docs/API_docs_v73/methods/messages_installStickerSet.md index 61513182..9f6f098c 100644 --- a/old_docs/API_docs_v73/methods/messages_installStickerSet.md +++ b/old_docs/API_docs_v73/methods/messages_installStickerSet.md @@ -1,17 +1,19 @@ --- title: messages.installStickerSet -description: messages.installStickerSet parameters, return type and example +description: Add a sticker set --- ## Method: messages.installStickerSet [Back to methods index](index.md) +Add a sticker set + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional| -|archived|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to add| +|archived|[CLICK ME Bool](../types/Bool.md) | Yes|Archive this set?| ### Return type: [messages\_StickerSetInstallResult](../types/messages_StickerSetInstallResult.md) diff --git a/old_docs/API_docs_v73/methods/messages_migrateChat.md b/old_docs/API_docs_v73/methods/messages_migrateChat.md index 5021ad45..db57adfa 100644 --- a/old_docs/API_docs_v73/methods/messages_migrateChat.md +++ b/old_docs/API_docs_v73/methods/messages_migrateChat.md @@ -1,16 +1,18 @@ --- title: messages.migrateChat -description: messages.migrateChat parameters, return type and example +description: Convert chat to supergroup --- ## Method: messages.migrateChat [Back to methods index](index.md) +Convert chat to supergroup + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat to convert| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v73/methods/messages_readEncryptedHistory.md b/old_docs/API_docs_v73/methods/messages_readEncryptedHistory.md index 4d341809..39b110e3 100644 --- a/old_docs/API_docs_v73/methods/messages_readEncryptedHistory.md +++ b/old_docs/API_docs_v73/methods/messages_readEncryptedHistory.md @@ -1,17 +1,19 @@ --- title: messages.readEncryptedHistory -description: messages.readEncryptedHistory parameters, return type and example +description: Mark messages as read in secret chats --- ## Method: messages.readEncryptedHistory [Back to methods index](index.md) +Mark messages as read in secret chats + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|max\_date|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to mark messages as read| +|max\_date|[CLICK ME int](../types/int.md) | Yes|Maximum date of messages to mark| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v73/methods/messages_readFeaturedStickers.md b/old_docs/API_docs_v73/methods/messages_readFeaturedStickers.md index 0631ca5b..4035c76d 100644 --- a/old_docs/API_docs_v73/methods/messages_readFeaturedStickers.md +++ b/old_docs/API_docs_v73/methods/messages_readFeaturedStickers.md @@ -1,16 +1,18 @@ --- title: messages.readFeaturedStickers -description: messages.readFeaturedStickers parameters, return type and example +description: Mark new featured stickers as read --- ## Method: messages.readFeaturedStickers [Back to methods index](index.md) +Mark new featured stickers as read + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|Array of [CLICK ME long](../types/long.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|Array of [CLICK ME long](../types/long.md) | Yes|The stickers to mark as read| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v73/methods/messages_readMentions.md b/old_docs/API_docs_v73/methods/messages_readMentions.md index 113657e8..e30fbfaf 100644 --- a/old_docs/API_docs_v73/methods/messages_readMentions.md +++ b/old_docs/API_docs_v73/methods/messages_readMentions.md @@ -1,16 +1,18 @@ --- title: messages.readMentions -description: messages.readMentions parameters, return type and example +description: Mark mentions as read --- ## Method: messages.readMentions [Back to methods index](index.md) +Mark mentions as read + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) diff --git a/old_docs/API_docs_v73/methods/messages_readMessageContents.md b/old_docs/API_docs_v73/methods/messages_readMessageContents.md index 0d27c209..9bb1bee8 100644 --- a/old_docs/API_docs_v73/methods/messages_readMessageContents.md +++ b/old_docs/API_docs_v73/methods/messages_readMessageContents.md @@ -1,16 +1,18 @@ --- title: messages.readMessageContents -description: messages.readMessageContents parameters, return type and example +description: Mark message as read --- ## Method: messages.readMessageContents [Back to methods index](index.md) +Mark message as read + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|Array of [CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|Array of [CLICK ME int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v73/methods/messages_receivedQueue.md b/old_docs/API_docs_v73/methods/messages_receivedQueue.md index c91caa37..4ad78ba2 100644 --- a/old_docs/API_docs_v73/methods/messages_receivedQueue.md +++ b/old_docs/API_docs_v73/methods/messages_receivedQueue.md @@ -1,77 +1,13 @@ --- title: messages.receivedQueue -description: messages.receivedQueue parameters, return type and example +description: You cannot use this method directly --- ## Method: messages.receivedQueue [Back to methods index](index.md) -### Parameters: - -| Name | Type | Required | -|----------|---------------|----------| -|max\_qts|[CLICK ME int](../types/int.md) | Yes| - - -### 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| - - -### MadelineProto Example: - - -``` -if (!file_exists('madeline.php')) { - copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php'); -} -include 'madeline.php'; - -// !!! This API id/API hash combination will not work !!! -// !!! You must get your own @ my.telegram.org !!! -$api_id = 0; -$api_hash = ''; - -$MadelineProto = new \danog\MadelineProto\API('session.madeline', ['app_info' => ['api_id' => $api_id, 'api_hash' => $api_hash]]); -$MadelineProto->start(); - -$Vector_of_long = $MadelineProto->messages->receivedQueue(['max_qts' => int, ]); -``` - -### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto): - -### As a bot: - -POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline` - -Parameters: - -* method - messages.receivedQueue -* params - `{"max_qts": int, }` - - - -### As a user: - -POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.receivedQueue` - -Parameters: - -max_qts - Json encoded int +**You cannot use this method directly** -Or, if you're into Lua: - -``` -Vector_of_long = messages.receivedQueue({max_qts=int, }) -``` - diff --git a/old_docs/API_docs_v73/methods/messages_reorderPinnedDialogs.md b/old_docs/API_docs_v73/methods/messages_reorderPinnedDialogs.md index 0bf5e073..710caf10 100644 --- a/old_docs/API_docs_v73/methods/messages_reorderPinnedDialogs.md +++ b/old_docs/API_docs_v73/methods/messages_reorderPinnedDialogs.md @@ -1,17 +1,19 @@ --- title: messages.reorderPinnedDialogs -description: messages.reorderPinnedDialogs parameters, return type and example +description: Reorder pinned dialogs --- ## Method: messages.reorderPinnedDialogs [Back to methods index](index.md) +Reorder pinned dialogs + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|force|[CLICK ME Bool](../types/Bool.md) | Optional| -|order|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|force|[CLICK ME Bool](../types/Bool.md) | Optional|Force reordering| +|order|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Yes|New order| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v73/methods/messages_reorderStickerSets.md b/old_docs/API_docs_v73/methods/messages_reorderStickerSets.md index e4f1623c..ddc78dd0 100644 --- a/old_docs/API_docs_v73/methods/messages_reorderStickerSets.md +++ b/old_docs/API_docs_v73/methods/messages_reorderStickerSets.md @@ -1,17 +1,19 @@ --- title: messages.reorderStickerSets -description: messages.reorderStickerSets parameters, return type and example +description: Reorder sticker sets --- ## Method: messages.reorderStickerSets [Back to methods index](index.md) +Reorder sticker sets + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|masks|[CLICK ME Bool](../types/Bool.md) | Optional| -|order|Array of [CLICK ME long](../types/long.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|masks|[CLICK ME Bool](../types/Bool.md) | Optional|Reorder masks?| +|order|Array of [CLICK ME long](../types/long.md) | Yes|The order| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v73/methods/messages_reportEncryptedSpam.md b/old_docs/API_docs_v73/methods/messages_reportEncryptedSpam.md index 44482c76..58b684d1 100644 --- a/old_docs/API_docs_v73/methods/messages_reportEncryptedSpam.md +++ b/old_docs/API_docs_v73/methods/messages_reportEncryptedSpam.md @@ -1,16 +1,18 @@ --- title: messages.reportEncryptedSpam -description: messages.reportEncryptedSpam parameters, return type and example +description: Report for spam a secret chat --- ## Method: messages.reportEncryptedSpam [Back to methods index](index.md) +Report for spam a secret chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat to report| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v73/methods/messages_saveDraft.md b/old_docs/API_docs_v73/methods/messages_saveDraft.md index 9104df33..bbeed707 100644 --- a/old_docs/API_docs_v73/methods/messages_saveDraft.md +++ b/old_docs/API_docs_v73/methods/messages_saveDraft.md @@ -1,20 +1,22 @@ --- title: messages.saveDraft -description: messages.saveDraft parameters, return type and example +description: Save a message draft --- ## Method: messages.saveDraft [Back to methods index](index.md) +Save a message draft + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|message|[CLICK ME string](../types/string.md) | Yes| -|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|no\_webpage|[CLICK ME Bool](../types/Bool.md) | Optional|Disable webpage preview| +|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| +|message|[CLICK ME string](../types/string.md) | Yes|The message| +|entities|Array of [CLICK ME MessageEntity](../types/MessageEntity.md) | Optional|The entities (for styled text)| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/old_docs/API_docs_v73/methods/messages_saveGif.md b/old_docs/API_docs_v73/methods/messages_saveGif.md index 4a3b6166..6f608c4c 100644 --- a/old_docs/API_docs_v73/methods/messages_saveGif.md +++ b/old_docs/API_docs_v73/methods/messages_saveGif.md @@ -1,17 +1,19 @@ --- title: messages.saveGif -description: messages.saveGif parameters, return type and example +description: Save a GIF --- ## Method: messages.saveGif [Back to methods index](index.md) +Save a GIF + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional| -|unsave|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The GIF to save| +|unsave|[CLICK ME Bool](../types/Bool.md) | Yes|Remove the gif?| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v73/methods/messages_saveRecentSticker.md b/old_docs/API_docs_v73/methods/messages_saveRecentSticker.md index b4f43e13..81ad5d48 100644 --- a/old_docs/API_docs_v73/methods/messages_saveRecentSticker.md +++ b/old_docs/API_docs_v73/methods/messages_saveRecentSticker.md @@ -1,18 +1,20 @@ --- title: messages.saveRecentSticker -description: messages.saveRecentSticker parameters, return type and example +description: Add a sticker to recent stickers --- ## Method: messages.saveRecentSticker [Back to methods index](index.md) +Add a sticker to recent stickers + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|attached|[CLICK ME Bool](../types/Bool.md) | Optional| -|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional| -|unsave|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|attached|[CLICK ME Bool](../types/Bool.md) | Optional|Get stickers attached to image?| +|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker| +|unsave|[CLICK ME Bool](../types/Bool.md) | Yes|Remove the sticker from recent stickers?| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v73/methods/messages_searchGifs.md b/old_docs/API_docs_v73/methods/messages_searchGifs.md index fefef1d7..103ebfeb 100644 --- a/old_docs/API_docs_v73/methods/messages_searchGifs.md +++ b/old_docs/API_docs_v73/methods/messages_searchGifs.md @@ -1,17 +1,19 @@ --- title: messages.searchGifs -description: messages.searchGifs parameters, return type and example +description: Search gifs --- ## Method: messages.searchGifs [Back to methods index](index.md) +Search gifs + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|q|[CLICK ME string](../types/string.md) | Yes| -|offset|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|q|[CLICK ME string](../types/string.md) | Yes|The search query| +|offset|[CLICK ME int](../types/int.md) | Yes|The offset | ### Return type: [messages\_FoundGifs](../types/messages_FoundGifs.md) diff --git a/old_docs/API_docs_v73/methods/messages_searchGlobal.md b/old_docs/API_docs_v73/methods/messages_searchGlobal.md index 32ddd175..0edd1e40 100644 --- a/old_docs/API_docs_v73/methods/messages_searchGlobal.md +++ b/old_docs/API_docs_v73/methods/messages_searchGlobal.md @@ -1,20 +1,22 @@ --- title: messages.searchGlobal -description: messages.searchGlobal parameters, return type and example +description: Global message search --- ## Method: messages.searchGlobal [Back to methods index](index.md) +Global message search + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|q|[CLICK ME string](../types/string.md) | Yes| -|offset\_date|[CLICK ME int](../types/int.md) | Yes| -|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|offset\_id|[CLICK ME int](../types/int.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|q|[CLICK ME string](../types/string.md) | Yes|The query| +|offset\_date|[CLICK ME int](../types/int.md) | Yes|0 or the date offset| +|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|0 or the peer offset| +|offset\_id|[CLICK ME int](../types/int.md) | Yes|0 or the message ID offset| +|limit|[CLICK ME int](../types/int.md) | Yes|The number of results to return| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v73/methods/messages_sendEncrypted.md b/old_docs/API_docs_v73/methods/messages_sendEncrypted.md index 23461760..d48f88d7 100644 --- a/old_docs/API_docs_v73/methods/messages_sendEncrypted.md +++ b/old_docs/API_docs_v73/methods/messages_sendEncrypted.md @@ -1,17 +1,19 @@ --- title: messages.sendEncrypted -description: messages.sendEncrypted parameters, return type and example +description: Send message to secret chat --- ## Method: messages.sendEncrypted [Back to methods index](index.md) +Send message to secret chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the message| +|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v73/methods/messages_sendEncryptedFile.md b/old_docs/API_docs_v73/methods/messages_sendEncryptedFile.md index 64919abe..4fd0648e 100644 --- a/old_docs/API_docs_v73/methods/messages_sendEncryptedFile.md +++ b/old_docs/API_docs_v73/methods/messages_sendEncryptedFile.md @@ -1,18 +1,20 @@ --- title: messages.sendEncryptedFile -description: messages.sendEncryptedFile parameters, return type and example +description: Send a file to a secret chat --- ## Method: messages.sendEncryptedFile [Back to methods index](index.md) +Send a file to a secret chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes| -|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the file| +|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| +|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional|The file (optional)| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v73/methods/messages_sendEncryptedService.md b/old_docs/API_docs_v73/methods/messages_sendEncryptedService.md index 0a0eea8a..d66894bf 100644 --- a/old_docs/API_docs_v73/methods/messages_sendEncryptedService.md +++ b/old_docs/API_docs_v73/methods/messages_sendEncryptedService.md @@ -1,17 +1,19 @@ --- title: messages.sendEncryptedService -description: messages.sendEncryptedService parameters, return type and example +description: Send a service message to a secret chat --- ## Method: messages.sendEncryptedService [Back to methods index](index.md) +Send a service message to a secret chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the service message| +|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v73/methods/messages_sendInlineBotResult.md b/old_docs/API_docs_v73/methods/messages_sendInlineBotResult.md index 4cb9243e..386ac7e3 100644 --- a/old_docs/API_docs_v73/methods/messages_sendInlineBotResult.md +++ b/old_docs/API_docs_v73/methods/messages_sendInlineBotResult.md @@ -1,22 +1,24 @@ --- title: messages.sendInlineBotResult -description: messages.sendInlineBotResult parameters, return type and example +description: Send a received bot result to the chat --- ## Method: messages.sendInlineBotResult [Back to methods index](index.md) +Send a received bot result to the chat + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional| -|background|[CLICK ME Bool](../types/Bool.md) | Optional| -|clear\_draft|[CLICK ME Bool](../types/Bool.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional| -|query\_id|[CLICK ME long](../types/long.md) | Yes| -|id|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Disable notifications?| +|background|[CLICK ME Bool](../types/Bool.md) | Optional|Disable background notifications?| +|clear\_draft|[CLICK ME Bool](../types/Bool.md) | Optional|Clear the message draft?| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the message| +|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| +|query\_id|[CLICK ME long](../types/long.md) | Yes|The inline query ID| +|id|[CLICK ME string](../types/string.md) | Yes|The result ID| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v73/methods/messages_sendMultiMedia.md b/old_docs/API_docs_v73/methods/messages_sendMultiMedia.md index 38babb1f..08a7a8a1 100644 --- a/old_docs/API_docs_v73/methods/messages_sendMultiMedia.md +++ b/old_docs/API_docs_v73/methods/messages_sendMultiMedia.md @@ -1,21 +1,23 @@ --- title: messages.sendMultiMedia -description: messages.sendMultiMedia parameters, return type and example +description: Send an album --- ## Method: messages.sendMultiMedia [Back to methods index](index.md) +Send an album + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|silent|[CLICK ME Bool](../types/Bool.md) | Optional| -|background|[CLICK ME Bool](../types/Bool.md) | Optional| -|clear\_draft|[CLICK ME Bool](../types/Bool.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional| -|multi\_media|Array of [CLICK ME InputSingleMedia](../types/InputSingleMedia.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Disable notifications?| +|background|[CLICK ME Bool](../types/Bool.md) | Optional|Disable background notification?| +|clear\_draft|[CLICK ME Bool](../types/Bool.md) | Optional|Clear draft?| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the album| +|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Optional|Reply to message by ID| +|multi\_media|Array of [CLICK ME InputSingleMedia](../types/InputSingleMedia.md) | Yes|The album| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v73/methods/messages_sendScreenshotNotification.md b/old_docs/API_docs_v73/methods/messages_sendScreenshotNotification.md index c9d1d555..f64f1682 100644 --- a/old_docs/API_docs_v73/methods/messages_sendScreenshotNotification.md +++ b/old_docs/API_docs_v73/methods/messages_sendScreenshotNotification.md @@ -1,17 +1,19 @@ --- title: messages.sendScreenshotNotification -description: messages.sendScreenshotNotification parameters, return type and example +description: Send screenshot notification --- ## Method: messages.sendScreenshotNotification [Back to methods index](index.md) +Send screenshot notification + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the notification| +|reply\_to\_msg\_id|[CLICK ME int](../types/int.md) | Yes|Reply to message by ID| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v73/methods/messages_setBotCallbackAnswer.md b/old_docs/API_docs_v73/methods/messages_setBotCallbackAnswer.md index 5590828e..e6dc6b09 100644 --- a/old_docs/API_docs_v73/methods/messages_setBotCallbackAnswer.md +++ b/old_docs/API_docs_v73/methods/messages_setBotCallbackAnswer.md @@ -1,20 +1,22 @@ --- title: messages.setBotCallbackAnswer -description: messages.setBotCallbackAnswer parameters, return type and example +description: Bots only: set the callback answer (after a button was clicked) --- ## Method: messages.setBotCallbackAnswer [Back to methods index](index.md) +Bots only: set the callback answer (after a button was clicked) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|alert|[CLICK ME Bool](../types/Bool.md) | Optional| -|query\_id|[CLICK ME long](../types/long.md) | Yes| -|message|[CLICK ME string](../types/string.md) | Optional| -|url|[CLICK ME string](../types/string.md) | Optional| -|cache\_time|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|alert|[CLICK ME Bool](../types/Bool.md) | Optional|Is this an alert?| +|query\_id|[CLICK ME long](../types/long.md) | Yes|The query ID| +|message|[CLICK ME string](../types/string.md) | Optional|The message| +|url|[CLICK ME string](../types/string.md) | Optional|The URL| +|cache\_time|[CLICK ME int](../types/int.md) | Yes|Cache time| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v73/methods/messages_setBotPrecheckoutResults.md b/old_docs/API_docs_v73/methods/messages_setBotPrecheckoutResults.md index 5afa7789..722bff81 100644 --- a/old_docs/API_docs_v73/methods/messages_setBotPrecheckoutResults.md +++ b/old_docs/API_docs_v73/methods/messages_setBotPrecheckoutResults.md @@ -1,18 +1,20 @@ --- title: messages.setBotPrecheckoutResults -description: messages.setBotPrecheckoutResults parameters, return type and example +description: Bots only: set precheckout results --- ## Method: messages.setBotPrecheckoutResults [Back to methods index](index.md) +Bots only: set precheckout results + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|success|[CLICK ME Bool](../types/Bool.md) | Optional| -|query\_id|[CLICK ME long](../types/long.md) | Yes| -|error|[CLICK ME string](../types/string.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|success|[CLICK ME Bool](../types/Bool.md) | Optional|Success?| +|query\_id|[CLICK ME long](../types/long.md) | Yes|Query ID| +|error|[CLICK ME string](../types/string.md) | Optional|Error| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v73/methods/messages_setBotShippingResults.md b/old_docs/API_docs_v73/methods/messages_setBotShippingResults.md index b36dacce..d364a04d 100644 --- a/old_docs/API_docs_v73/methods/messages_setBotShippingResults.md +++ b/old_docs/API_docs_v73/methods/messages_setBotShippingResults.md @@ -1,18 +1,20 @@ --- title: messages.setBotShippingResults -description: messages.setBotShippingResults parameters, return type and example +description: Bots only: set shipping results --- ## Method: messages.setBotShippingResults [Back to methods index](index.md) +Bots only: set shipping results + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|query\_id|[CLICK ME long](../types/long.md) | Yes| -|error|[CLICK ME string](../types/string.md) | Optional| -|shipping\_options|Array of [CLICK ME ShippingOption](../types/ShippingOption.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|query\_id|[CLICK ME long](../types/long.md) | Yes|Query ID| +|error|[CLICK ME string](../types/string.md) | Optional|Error| +|shipping\_options|Array of [CLICK ME ShippingOption](../types/ShippingOption.md) | Optional|Shipping options| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v73/methods/messages_setEncryptedTyping.md b/old_docs/API_docs_v73/methods/messages_setEncryptedTyping.md index 3183fedf..e9afe99c 100644 --- a/old_docs/API_docs_v73/methods/messages_setEncryptedTyping.md +++ b/old_docs/API_docs_v73/methods/messages_setEncryptedTyping.md @@ -12,8 +12,8 @@ Send typing notification to secret chat | Name | Type | Required | Description | |----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|| -|typing|[CLICK ME Bool](../types/Bool.md) | Yes|| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to send the notification| +|typing|[CLICK ME Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v73/methods/messages_setGameScore.md b/old_docs/API_docs_v73/methods/messages_setGameScore.md index c44145c0..aa1f4f0c 100644 --- a/old_docs/API_docs_v73/methods/messages_setGameScore.md +++ b/old_docs/API_docs_v73/methods/messages_setGameScore.md @@ -1,21 +1,23 @@ --- title: messages.setGameScore -description: messages.setGameScore parameters, return type and example +description: Set the game score --- ## Method: messages.setGameScore [Back to methods index](index.md) +Set the game score + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|edit\_message|[CLICK ME Bool](../types/Bool.md) | Optional| -|force|[CLICK ME Bool](../types/Bool.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|id|[CLICK ME int](../types/int.md) | Yes| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|score|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|edit\_message|[CLICK ME Bool](../types/Bool.md) | Optional|Should the message with the game be edited?| +|force|[CLICK ME Bool](../types/Bool.md) | Optional|Force setting the game score| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the game was sent| +|id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the score| +|score|[CLICK ME int](../types/int.md) | Yes|The score| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v73/methods/messages_setInlineBotResults.md b/old_docs/API_docs_v73/methods/messages_setInlineBotResults.md index 915e3a4e..79493009 100644 --- a/old_docs/API_docs_v73/methods/messages_setInlineBotResults.md +++ b/old_docs/API_docs_v73/methods/messages_setInlineBotResults.md @@ -1,22 +1,24 @@ --- title: messages.setInlineBotResults -description: messages.setInlineBotResults parameters, return type and example +description: Bots only: set the results of an inline query --- ## Method: messages.setInlineBotResults [Back to methods index](index.md) +Bots only: set the results of an inline query + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|gallery|[CLICK ME Bool](../types/Bool.md) | Optional| -|private|[CLICK ME Bool](../types/Bool.md) | Optional| -|query\_id|[CLICK ME long](../types/long.md) | Yes| -|results|Array of [CLICK ME InputBotInlineResult](../types/InputBotInlineResult.md) | Yes| -|cache\_time|[CLICK ME int](../types/int.md) | Yes| -|next\_offset|[CLICK ME string](../types/string.md) | Optional| -|switch\_pm|[CLICK ME InlineBotSwitchPM](../types/InlineBotSwitchPM.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|gallery|[CLICK ME Bool](../types/Bool.md) | Optional|Is this a gallery?| +|private|[CLICK ME Bool](../types/Bool.md) | Optional|Is this result private (not cached)?| +|query\_id|[CLICK ME long](../types/long.md) | Yes|Query ID| +|results|Array of [CLICK ME InputBotInlineResult](../types/InputBotInlineResult.md) | Yes|Results| +|cache\_time|[CLICK ME int](../types/int.md) | Yes|Cache time| +|next\_offset|[CLICK ME string](../types/string.md) | Optional|The next offset| +|switch\_pm|[CLICK ME InlineBotSwitchPM](../types/InlineBotSwitchPM.md) | Optional|Switch to PM?| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v73/methods/messages_setInlineGameScore.md b/old_docs/API_docs_v73/methods/messages_setInlineGameScore.md index 55e2c063..385c8308 100644 --- a/old_docs/API_docs_v73/methods/messages_setInlineGameScore.md +++ b/old_docs/API_docs_v73/methods/messages_setInlineGameScore.md @@ -1,20 +1,22 @@ --- title: messages.setInlineGameScore -description: messages.setInlineGameScore parameters, return type and example +description: Set the game score of an inline message --- ## Method: messages.setInlineGameScore [Back to methods index](index.md) +Set the game score of an inline message + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|edit\_message|[CLICK ME Bool](../types/Bool.md) | Optional| -|force|[CLICK ME Bool](../types/Bool.md) | Optional| -|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|score|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|edit\_message|[CLICK ME Bool](../types/Bool.md) | Optional|Should the message with the game be edited?| +|force|[CLICK ME Bool](../types/Bool.md) | Optional|Force setting the game score| +|id|[CLICK ME InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The ID of the inline message| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the score| +|score|[CLICK ME int](../types/int.md) | Yes|The score| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v73/methods/messages_startBot.md b/old_docs/API_docs_v73/methods/messages_startBot.md index 0de0f1a5..94a4d86a 100644 --- a/old_docs/API_docs_v73/methods/messages_startBot.md +++ b/old_docs/API_docs_v73/methods/messages_startBot.md @@ -1,18 +1,20 @@ --- title: messages.startBot -description: messages.startBot parameters, return type and example +description: Start a bot --- ## Method: messages.startBot [Back to methods index](index.md) +Start a bot + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|start\_param|[CLICK ME string](../types/string.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot's ID or username| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to start the bot (@me or group ID/username)| +|start\_param|[CLICK ME string](../types/string.md) | Yes|The bot's start parameter| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v73/methods/messages_toggleChatAdmins.md b/old_docs/API_docs_v73/methods/messages_toggleChatAdmins.md index d56e5753..ab591fd9 100644 --- a/old_docs/API_docs_v73/methods/messages_toggleChatAdmins.md +++ b/old_docs/API_docs_v73/methods/messages_toggleChatAdmins.md @@ -1,17 +1,19 @@ --- title: messages.toggleChatAdmins -description: messages.toggleChatAdmins parameters, return type and example +description: Enable all users are admins in normal groups (not supergroups) --- ## Method: messages.toggleChatAdmins [Back to methods index](index.md) +Enable all users are admins in normal groups (not supergroups) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|enabled|[CLICK ME Bool](../types/Bool.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Group ID| +|enabled|[CLICK ME Bool](../types/Bool.md) | Yes|Enable all users are admins| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v73/methods/messages_toggleDialogPin.md b/old_docs/API_docs_v73/methods/messages_toggleDialogPin.md index d6dc9692..2bd6a03d 100644 --- a/old_docs/API_docs_v73/methods/messages_toggleDialogPin.md +++ b/old_docs/API_docs_v73/methods/messages_toggleDialogPin.md @@ -1,17 +1,19 @@ --- title: messages.toggleDialogPin -description: messages.toggleDialogPin parameters, return type and example +description: Pin or unpin dialog --- ## Method: messages.toggleDialogPin [Back to methods index](index.md) +Pin or unpin dialog + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|pinned|[CLICK ME Bool](../types/Bool.md) | Optional| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|pinned|[CLICK ME Bool](../types/Bool.md) | Optional|Pin or unpin the dialog?| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer to pin| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v73/methods/messages_uninstallStickerSet.md b/old_docs/API_docs_v73/methods/messages_uninstallStickerSet.md index 60b0ca0c..6d04e847 100644 --- a/old_docs/API_docs_v73/methods/messages_uninstallStickerSet.md +++ b/old_docs/API_docs_v73/methods/messages_uninstallStickerSet.md @@ -1,16 +1,18 @@ --- title: messages.uninstallStickerSet -description: messages.uninstallStickerSet parameters, return type and example +description: Remove a sticker set --- ## Method: messages.uninstallStickerSet [Back to methods index](index.md) +Remove a sticker set + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to remove| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v73/methods/messages_uploadEncryptedFile.md b/old_docs/API_docs_v73/methods/messages_uploadEncryptedFile.md index a8bdc698..0c9bed76 100644 --- a/old_docs/API_docs_v73/methods/messages_uploadEncryptedFile.md +++ b/old_docs/API_docs_v73/methods/messages_uploadEncryptedFile.md @@ -1,17 +1,19 @@ --- title: messages.uploadEncryptedFile -description: messages.uploadEncryptedFile parameters, return type and example +description: Upload a secret chat file without sending it to anyone --- ## Method: messages.uploadEncryptedFile [Back to methods index](index.md) +Upload a secret chat file without sending it to anyone + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes| -|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|Ignore this| +|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional|The file| ### Return type: [EncryptedFile](../types/EncryptedFile.md) diff --git a/old_docs/API_docs_v73/methods/messages_uploadMedia.md b/old_docs/API_docs_v73/methods/messages_uploadMedia.md index 5c25333d..c982a860 100644 --- a/old_docs/API_docs_v73/methods/messages_uploadMedia.md +++ b/old_docs/API_docs_v73/methods/messages_uploadMedia.md @@ -1,17 +1,19 @@ --- title: messages.uploadMedia -description: messages.uploadMedia parameters, return type and example +description: Upload a file without sending it to anyone --- ## Method: messages.uploadMedia [Back to methods index](index.md) +Upload a file without sending it to anyone + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional| -|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Nothing| +|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media to upload| ### Return type: [MessageMedia](../types/MessageMedia.md) diff --git a/old_docs/API_docs_v73/methods/payments_clearSavedInfo.md b/old_docs/API_docs_v73/methods/payments_clearSavedInfo.md index 53fab36f..44050dde 100644 --- a/old_docs/API_docs_v73/methods/payments_clearSavedInfo.md +++ b/old_docs/API_docs_v73/methods/payments_clearSavedInfo.md @@ -1,17 +1,19 @@ --- title: payments.clearSavedInfo -description: payments.clearSavedInfo parameters, return type and example +description: Clear saved payments info --- ## Method: payments.clearSavedInfo [Back to methods index](index.md) +Clear saved payments info + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|credentials|[CLICK ME Bool](../types/Bool.md) | Optional| -|info|[CLICK ME Bool](../types/Bool.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|credentials|[CLICK ME Bool](../types/Bool.md) | Optional|Clear credentials?| +|info|[CLICK ME Bool](../types/Bool.md) | Optional|Clear payment info?| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v73/methods/payments_getPaymentForm.md b/old_docs/API_docs_v73/methods/payments_getPaymentForm.md index 00b4bddc..16a32d11 100644 --- a/old_docs/API_docs_v73/methods/payments_getPaymentForm.md +++ b/old_docs/API_docs_v73/methods/payments_getPaymentForm.md @@ -1,16 +1,18 @@ --- title: payments.getPaymentForm -description: payments.getPaymentForm parameters, return type and example +description: Get payment form --- ## Method: payments.getPaymentForm [Back to methods index](index.md) +Get payment form + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|msg\_id|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|msg\_id|[CLICK ME int](../types/int.md) | Yes|Message ID| ### Return type: [payments\_PaymentForm](../types/payments_PaymentForm.md) diff --git a/old_docs/API_docs_v73/methods/payments_getPaymentReceipt.md b/old_docs/API_docs_v73/methods/payments_getPaymentReceipt.md index 40b73a4b..857585f6 100644 --- a/old_docs/API_docs_v73/methods/payments_getPaymentReceipt.md +++ b/old_docs/API_docs_v73/methods/payments_getPaymentReceipt.md @@ -1,16 +1,18 @@ --- title: payments.getPaymentReceipt -description: payments.getPaymentReceipt parameters, return type and example +description: Get payment receipt --- ## Method: payments.getPaymentReceipt [Back to methods index](index.md) +Get payment receipt + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|msg\_id|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|msg\_id|[CLICK ME int](../types/int.md) | Yes|The message ID| ### Return type: [payments\_PaymentReceipt](../types/payments_PaymentReceipt.md) diff --git a/old_docs/API_docs_v73/methods/payments_getSavedInfo.md b/old_docs/API_docs_v73/methods/payments_getSavedInfo.md index ccaaff75..04ac7374 100644 --- a/old_docs/API_docs_v73/methods/payments_getSavedInfo.md +++ b/old_docs/API_docs_v73/methods/payments_getSavedInfo.md @@ -1,11 +1,13 @@ --- title: payments.getSavedInfo -description: payments.getSavedInfo parameters, return type and example +description: Get saved payments info --- ## Method: payments.getSavedInfo [Back to methods index](index.md) +Get saved payments info + ### Return type: [payments\_SavedInfo](../types/payments_SavedInfo.md) diff --git a/old_docs/API_docs_v73/methods/payments_sendPaymentForm.md b/old_docs/API_docs_v73/methods/payments_sendPaymentForm.md index eb843715..0a9df99f 100644 --- a/old_docs/API_docs_v73/methods/payments_sendPaymentForm.md +++ b/old_docs/API_docs_v73/methods/payments_sendPaymentForm.md @@ -1,19 +1,21 @@ --- title: payments.sendPaymentForm -description: payments.sendPaymentForm parameters, return type and example +description: Bots only: send payment form --- ## Method: payments.sendPaymentForm [Back to methods index](index.md) +Bots only: send payment form + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|msg\_id|[CLICK ME int](../types/int.md) | Yes| -|requested\_info\_id|[CLICK ME string](../types/string.md) | Optional| -|shipping\_option\_id|[CLICK ME string](../types/string.md) | Optional| -|credentials|[CLICK ME InputPaymentCredentials](../types/InputPaymentCredentials.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|msg\_id|[CLICK ME int](../types/int.md) | Yes|Message ID| +|requested\_info\_id|[CLICK ME string](../types/string.md) | Optional|ID of requested info| +|shipping\_option\_id|[CLICK ME string](../types/string.md) | Optional|Shipping option ID| +|credentials|[CLICK ME InputPaymentCredentials](../types/InputPaymentCredentials.md) | Yes|Payment credentials| ### Return type: [payments\_PaymentResult](../types/payments_PaymentResult.md) diff --git a/old_docs/API_docs_v73/methods/payments_validateRequestedInfo.md b/old_docs/API_docs_v73/methods/payments_validateRequestedInfo.md index 32702965..e36f0e42 100644 --- a/old_docs/API_docs_v73/methods/payments_validateRequestedInfo.md +++ b/old_docs/API_docs_v73/methods/payments_validateRequestedInfo.md @@ -1,18 +1,20 @@ --- title: payments.validateRequestedInfo -description: payments.validateRequestedInfo parameters, return type and example +description: Validate requested payment info --- ## Method: payments.validateRequestedInfo [Back to methods index](index.md) +Validate requested payment info + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|save|[CLICK ME Bool](../types/Bool.md) | Optional| -|msg\_id|[CLICK ME int](../types/int.md) | Yes| -|info|[CLICK ME PaymentRequestedInfo](../types/PaymentRequestedInfo.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|save|[CLICK ME Bool](../types/Bool.md) | Optional|Save payment info?| +|msg\_id|[CLICK ME int](../types/int.md) | Yes|The message ID| +|info|[CLICK ME PaymentRequestedInfo](../types/PaymentRequestedInfo.md) | Yes|The requested payment info| ### Return type: [payments\_ValidatedRequestedInfo](../types/payments_ValidatedRequestedInfo.md) diff --git a/old_docs/API_docs_v73/methods/photos_deletePhotos.md b/old_docs/API_docs_v73/methods/photos_deletePhotos.md index 104459b7..b9daca10 100644 --- a/old_docs/API_docs_v73/methods/photos_deletePhotos.md +++ b/old_docs/API_docs_v73/methods/photos_deletePhotos.md @@ -1,16 +1,18 @@ --- title: photos.deletePhotos -description: photos.deletePhotos parameters, return type and example +description: Delete profile photos --- ## Method: photos.deletePhotos [Back to methods index](index.md) +Delete profile photos + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Yes|The profile photos to delete| ### Return type: [Vector\_of\_long](../types/long.md) diff --git a/old_docs/API_docs_v73/methods/photos_getUserPhotos.md b/old_docs/API_docs_v73/methods/photos_getUserPhotos.md index 1a7515ba..ea27a44f 100644 --- a/old_docs/API_docs_v73/methods/photos_getUserPhotos.md +++ b/old_docs/API_docs_v73/methods/photos_getUserPhotos.md @@ -1,19 +1,21 @@ --- title: photos.getUserPhotos -description: photos.getUserPhotos parameters, return type and example +description: Get the profile photos of a user --- ## Method: photos.getUserPhotos [Back to methods index](index.md) +Get the profile photos of a user + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|offset|[CLICK ME int](../types/int.md) | Yes| -|max\_id|[CLICK ME long](../types/long.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| +|offset|[CLICK ME int](../types/int.md) | Yes|Offset| +|max\_id|[CLICK ME long](../types/long.md) | Yes|Maximum ID of photo to return| +|limit|[CLICK ME int](../types/int.md) | Yes|Number of photos to return| ### Return type: [photos\_Photos](../types/photos_Photos.md) diff --git a/old_docs/API_docs_v73/methods/photos_updateProfilePhoto.md b/old_docs/API_docs_v73/methods/photos_updateProfilePhoto.md index 28ab5fbf..7f0a4c69 100644 --- a/old_docs/API_docs_v73/methods/photos_updateProfilePhoto.md +++ b/old_docs/API_docs_v73/methods/photos_updateProfilePhoto.md @@ -1,16 +1,18 @@ --- title: photos.updateProfilePhoto -description: photos.updateProfilePhoto parameters, return type and example +description: Update the profile photo (use photos->uploadProfilePhoto to upload the photo) --- ## Method: photos.updateProfilePhoto [Back to methods index](index.md) +Update the profile photo (use photos->uploadProfilePhoto to upload the photo) + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional|The photo to use| ### Return type: [UserProfilePhoto](../types/UserProfilePhoto.md) diff --git a/old_docs/API_docs_v73/methods/photos_uploadProfilePhoto.md b/old_docs/API_docs_v73/methods/photos_uploadProfilePhoto.md index 7cc9e9e5..efa08bb0 100644 --- a/old_docs/API_docs_v73/methods/photos_uploadProfilePhoto.md +++ b/old_docs/API_docs_v73/methods/photos_uploadProfilePhoto.md @@ -1,16 +1,18 @@ --- title: photos.uploadProfilePhoto -description: photos.uploadProfilePhoto parameters, return type and example +description: Upload profile photo --- ## Method: photos.uploadProfilePhoto [Back to methods index](index.md) +Upload profile photo + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|file|[File path or InputFile](../types/InputFile.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|file|[File path or InputFile](../types/InputFile.md) | Yes|The photo| ### Return type: [photos\_Photo](../types/photos_Photo.md) diff --git a/old_docs/API_docs_v73/methods/stickers_addStickerToSet.md b/old_docs/API_docs_v73/methods/stickers_addStickerToSet.md index 82a9dbd7..1f90028c 100644 --- a/old_docs/API_docs_v73/methods/stickers_addStickerToSet.md +++ b/old_docs/API_docs_v73/methods/stickers_addStickerToSet.md @@ -1,17 +1,19 @@ --- title: stickers.addStickerToSet -description: stickers.addStickerToSet parameters, return type and example +description: Add sticker to stickerset --- ## Method: stickers.addStickerToSet [Back to methods index](index.md) +Add sticker to stickerset + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional| -|sticker|[CLICK ME InputStickerSetItem](../types/InputStickerSetItem.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|stickerset|[CLICK ME InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset| +|sticker|[CLICK ME InputStickerSetItem](../types/InputStickerSetItem.md) | Yes|The sticker| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/old_docs/API_docs_v73/methods/stickers_changeStickerPosition.md b/old_docs/API_docs_v73/methods/stickers_changeStickerPosition.md index a1a663f7..45552df9 100644 --- a/old_docs/API_docs_v73/methods/stickers_changeStickerPosition.md +++ b/old_docs/API_docs_v73/methods/stickers_changeStickerPosition.md @@ -1,17 +1,19 @@ --- title: stickers.changeStickerPosition -description: stickers.changeStickerPosition parameters, return type and example +description: Change sticker position in photo --- ## Method: stickers.changeStickerPosition [Back to methods index](index.md) +Change sticker position in photo + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|sticker|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional| -|position|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|sticker|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker| +|position|[CLICK ME int](../types/int.md) | Yes|New position| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/old_docs/API_docs_v73/methods/stickers_createStickerSet.md b/old_docs/API_docs_v73/methods/stickers_createStickerSet.md index b99874a0..c4e85852 100644 --- a/old_docs/API_docs_v73/methods/stickers_createStickerSet.md +++ b/old_docs/API_docs_v73/methods/stickers_createStickerSet.md @@ -1,20 +1,22 @@ --- title: stickers.createStickerSet -description: stickers.createStickerSet parameters, return type and example +description: Create stickerset --- ## Method: stickers.createStickerSet [Back to methods index](index.md) +Create stickerset + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|masks|[CLICK ME Bool](../types/Bool.md) | Optional| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional| -|title|[CLICK ME string](../types/string.md) | Yes| -|short\_name|[CLICK ME string](../types/string.md) | Yes| -|stickers|Array of [CLICK ME InputStickerSetItem](../types/InputStickerSetItem.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|masks|[CLICK ME Bool](../types/Bool.md) | Optional|Masks?| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user ID associated to this stickerset| +|title|[CLICK ME string](../types/string.md) | Yes|The stickerset title| +|short\_name|[CLICK ME string](../types/string.md) | Yes|The stickerset short name| +|stickers|Array of [CLICK ME InputStickerSetItem](../types/InputStickerSetItem.md) | Yes|The stickers to add| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/old_docs/API_docs_v73/methods/stickers_removeStickerFromSet.md b/old_docs/API_docs_v73/methods/stickers_removeStickerFromSet.md index 34f85cb0..4ae30345 100644 --- a/old_docs/API_docs_v73/methods/stickers_removeStickerFromSet.md +++ b/old_docs/API_docs_v73/methods/stickers_removeStickerFromSet.md @@ -1,16 +1,18 @@ --- title: stickers.removeStickerFromSet -description: stickers.removeStickerFromSet parameters, return type and example +description: Remove sticker from stickerset --- ## Method: stickers.removeStickerFromSet [Back to methods index](index.md) +Remove sticker from stickerset + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|sticker|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|sticker|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker to remove| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/old_docs/API_docs_v73/methods/upload_getWebFile.md b/old_docs/API_docs_v73/methods/upload_getWebFile.md index 30bd3a1f..e864e4b7 100644 --- a/old_docs/API_docs_v73/methods/upload_getWebFile.md +++ b/old_docs/API_docs_v73/methods/upload_getWebFile.md @@ -1,18 +1,20 @@ --- title: upload.getWebFile -description: upload.getWebFile parameters, return type and example +description: Download a file through telegram --- ## Method: upload.getWebFile [Back to methods index](index.md) +Download a file through telegram + ### Parameters: -| Name | Type | Required | -|----------|---------------|----------| -|location|[CLICK ME InputWebFileLocation](../types/InputWebFileLocation.md) | Yes| -|offset|[CLICK ME int](../types/int.md) | Yes| -|limit|[CLICK ME int](../types/int.md) | Yes| +| Name | Type | Required | Description | +|----------|---------------|----------|-------------| +|location|[CLICK ME InputWebFileLocation](../types/InputWebFileLocation.md) | Yes|The file| +|offset|[CLICK ME int](../types/int.md) | Yes|The offset in bytes| +|limit|[CLICK ME int](../types/int.md) | Yes|The number of bytes to fetch| ### Return type: [upload\_WebFile](../types/upload_WebFile.md) diff --git a/src/danog/MadelineProto/Lang.php b/src/danog/MadelineProto/Lang.php index f6aee75b..6d79696c 100644 --- a/src/danog/MadelineProto/Lang.php +++ b/src/danog/MadelineProto/Lang.php @@ -1,17 +1,17 @@ . -*/ - + /* + Copyright 2016-2018 Daniil Gentili + (https://daniil.it) + This file is part of MadelineProto. + MadelineProto is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. + MadelineProto is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. + See the GNU Affero General Public License for more details. + You should have received a copy of the GNU General Public License along with MadelineProto. + If not, see . + */ + namespace danog\MadelineProto; - + class Lang { public static $lang = array ( @@ -207,14 +207,14 @@ class Lang 'v_error' => '506c656173652075706461746520746f20746865206c61746573742076657273696f6e206f66204d6164656c696e6550726f746f2e', 'v_tgerror' => '506c6561736520757064617465207068702d6c69627467766f6970', 'no_mode_specified' => 'No mode was specified!', - 'constructor_function_uncalled' => 'The constructor function wasn\'t called! Please call The constructor function before using this method.', + 'constructor_function_uncalled' => 'The constructor function wasn\'t called! Please call the constructor function before using this method.', 'proxy_class_invalid' => 'Invalid proxy class provided!', 'socket_con_error' => 'Connection: couldn\'t connect to socket.', 'protocol_not_implemented' => 'Connection: This protocol isn\'t implemented yet.', 'protocol_invalid' => 'Connection: invalid protocol specified.', - 'nothing_in_socket' => 'Nothing in The socket!', + 'nothing_in_socket' => 'Nothing in the socket!', 'wrong_length_read' => 'WARNING: Wrong length was read (should\'ve read %s, read %s)!', - 'no_data_in_socket' => 'No data in The socket!', + 'no_data_in_socket' => 'No data in the socket!', 'dc_con_start' => 'Connecting to DC %s...', 'dc_con_stop' => 'Disconnecting from DC %s...', 'dc_con_test_start' => 'Connecting to DC %s (%s server, %s, %s)...', @@ -228,19 +228,19 @@ class Lang 'login_user' => 'Logging in as a normal user...', 'login_bot' => 'Logging in as a bot...', 'login_code_sending' => 'Sending code...', - 'login_code_sent' => 'Code sent successfully! Once you receive The code you should use The complete_phone_login function.', - 'login_code_uncalled' => 'I\'m not waiting for The code! Please call The phone_login method first', - 'login_2fa_enabled' => '2FA enabled, you will have to call The complete_2fa_login function...', - 'login_need_signup' => 'An account has not been created for this number, you will have to call The complete_signup function...', + 'login_code_sent' => 'Code sent successfully! Once you receive the code you should use the complete_phone_login function.', + 'login_code_uncalled' => 'I\'m not waiting for the code! Please call the phone_login method first', + 'login_2fa_enabled' => '2FA enabled, you will have to call the complete_2fa_login function...', + 'login_need_signup' => 'An account has not been created for this number, you will have to call the complete_signup function...', 'login_auth_key' => 'Logging in using auth key...', 'not_logged_in' => 'I\'m not logged in!', - 'signup_uncalled' => 'I\'m not waiting to signup! Please call The phone_login and The complete_phone_login methods first!', + 'signup_uncalled' => 'I\'m not waiting to signup! Please call the phone_login and the complete_phone_login methods first!', 'signing_up' => 'Signing up as a normal user...', 'signup_ok' => 'Signed up in successfully!', - '2fa_uncalled' => 'I\'m not waiting for The password! Please call The phone_login and The complete_phone_login methods first!', + '2fa_uncalled' => 'I\'m not waiting for the password! Please call the phone_login and the complete_phone_login methods first!', 'getting_dialogs' => 'Getting dialogs...', 'libtgvoip_required' => 'The php-libtgvoip extension is required to accept and manage calls. See daniil.it/MadelineProto for more info.', - 'peer_not_in_db' => 'This peer is not present in The internal peer database', + 'peer_not_in_db' => 'This peer is not present in the internal peer database', 'calling_user' => 'Calling %s...', 'generating_a' => 'Generating a...', 'generating_g_a' => 'Generating g_a...', @@ -274,7 +274,7 @@ class Lang 'type_extract_error' => 'Could not extract type "%s"', 'method_not_found' => 'Could not find method: ', 'params_missing' => 'Missing required parameter', - 'sec_peer_not_in_db' => 'This secret peer is not present in The internal peer database', + 'sec_peer_not_in_db' => 'This secret peer is not present in the internal peer database', 'stream_handle_invalid' => 'An invalid stream handle was provided.', 'length_too_big' => 'Length is too big', 'deserialize_not_str' => 'Deserialize: Generated value isn\'t a string', @@ -286,11 +286,11 @@ class Lang 'non_text_conversion' => 'Can\'t convert non text messages yet!', 'last_byte_invalid' => 'Invalid last byte', 'file_type_invalid' => 'Invalid file type detected (%s)', - 'recreate_temp_auth_key' => 'I had to recreate The temporary authorization key', + 'recreate_temp_auth_key' => 'I had to recreate the temporary authorization key', 'resetting_auth_key' => 'WARNING: Resetting auth key...', 'shutting_down_reader_pool' => 'Shutting down reader pool ', 'shutting_down_handler_pool' => 'Shutting down handler pool for dc %s, %d jobs left', - 'secret_chat_skipping' => 'I do not have The secret chat %s in The database, skipping message...', + 'secret_chat_skipping' => 'I do not have the secret chat %s in the database, skipping message...', 'fingerprint_mismatch' => 'Key fingerprint mismatch', 'msg_data_length_too_big' => 'message_data_length is too big', 'length_not_divisible_16' => 'Length of decrypted data is not divisible by 16', @@ -314,27 +314,27 @@ class Lang 'method_set_client_DH_params_param_server_nonce_type_int128' => 'Random number for cryptographic security, given by server', 'method_set_client_DH_params_param_encrypted_data_type_bytes' => 'Encrypted key exchange message', 'method_rpc_drop_answer' => 'Do not send answer to provided request', - 'method_rpc_drop_answer_param_req_msg_id_type_long' => 'The message ID of The request', + 'method_rpc_drop_answer_param_req_msg_id_type_long' => 'The message ID of the request', 'method_get_future_salts' => 'Get future salts', 'method_get_future_salts_param_num_type_int' => 'How many salts should be fetched', - 'method_ping' => 'pings The server', + 'method_ping' => 'pings the server', 'method_ping_param_ping_id_type_long' => 'Ping ID', - 'method_ping_delay_disconnect' => 'Pings The server and causes disconection if The same method is not called within ping_disconnect_delay', + 'method_ping_delay_disconnect' => 'Pings the server and causes disconection if the same method is not called within ping_disconnect_delay', 'method_ping_delay_disconnect_param_ping_id_type_long' => 'Ping ID', 'method_ping_delay_disconnect_param_disconnect_delay_type_int' => 'Disconection delay', - 'method_destroy_session' => 'Destroy The current MTProto session', + 'method_destroy_session' => 'Destroy the current MTProto session', 'method_destroy_session_param_session_id_type_long' => 'The session to destroy', - 'method_http_wait' => 'Makes The server send messages waiting in The buffer', - 'method_http_wait_param_max_delay_type_int' => 'Denotes The maximum number of milliseconds that has elapsed between The first message for this session and The transmission of an HTTP response', - 'method_http_wait_param_wait_after_type_int' => 'after The receipt of The latest message for a particular session, The server waits anoTher wait_after milliseconds in case There are more messages. If There are no additional messages, The result is transmitted (a container with all The messages).', - 'method_http_wait_param_max_wait_type_int' => 'If more messages appear, The wait_after timer is reset.', - 'method_invokeAfterMsg' => 'Invokes a query after successfull completion of one of The previous queries.', + 'method_http_wait' => 'Makes the server send messages waiting in the buffer', + 'method_http_wait_param_max_delay_type_int' => 'Denotes the maximum number of milliseconds that has elapsed between the first message for this session and the transmission of an HTTP response', + 'method_http_wait_param_wait_after_type_int' => 'after the receipt of the latest message for a particular session, the server waits anoTher wait_after milliseconds in case There are more messages. If There are no additional messages, the result is transmitted (a container with all the messages).', + 'method_http_wait_param_max_wait_type_int' => 'If more messages appear, the wait_after timer is reset.', + 'method_invokeAfterMsg' => 'Invokes a query after successfull completion of one of the previous queries.', 'method_invokeAfterMsg_param_msg_id_type_long' => 'Message identifier on which a current query depends', 'method_invokeAfterMsg_param_query_type_!X' => 'The query itself', 'method_invokeAfterMsgs' => 'Result type returned by a current query.', 'method_invokeAfterMsgs_param_msg_ids_type_Vector t' => 'List of messages on which a current query depends', 'method_invokeAfterMsgs_param_query_type_!X' => 'The query itself', - 'method_initConnection' => 'Initializes connection and save information on The user\'s device and application.', + 'method_initConnection' => 'Initializes connection and save information on the user\'s device and application.', 'method_initConnection_param_api_id_type_int' => 'Application identifier', 'method_initConnection_param_device_model_type_string' => 'Device model', 'method_initConnection_param_system_version_type_string' => 'System version', @@ -346,7 +346,7 @@ class Lang 'method_invokeWithLayer' => 'Invoke this method with layer X', 'method_invokeWithLayer_param_layer_type_int' => 'The layer version', 'method_invokeWithLayer_param_query_type_!X' => 'The query', - 'method_invokeWithoutUpdates' => 'Invoke with method without returning updates in The socket', + 'method_invokeWithoutUpdates' => 'Invoke with method without returning updates in the socket', 'method_invokeWithoutUpdates_param_query_type_!X' => 'The query', 'method_auth.checkPhone' => 'Check if this phone number is registered on telegram', 'method_auth.checkPhone_param_phone_number_type_string' => 'The phone number to check', @@ -387,28 +387,28 @@ class Lang 'method_auth.importBotAuthorization_param_bot_auth_token_type_string' => 'You cannot use this method directly, use the bot_login method instead (see https://docs.madelineproto.xyz for more info)', 'method_auth.checkPassword' => 'You cannot use this method directly, use the complete_2fa_login method instead (see https://docs.madelineproto.xyz for more info)', 'method_auth.checkPassword_param_password_hash_type_bytes' => 'You cannot use this method directly, use the complete_2fa_login method instead (see https://docs.madelineproto.xyz for more info)', - 'method_auth.requestPasswordRecovery' => 'Send an email to recover The 2FA password', - 'method_auth.recoverPassword' => 'Use The code that was emailed to you after running $MadelineProto->auth->requestPasswordRecovery to login to your account', + 'method_auth.requestPasswordRecovery' => 'Send an email to recover the 2FA password', + 'method_auth.recoverPassword' => 'Use the code that was emailed to you after running $MadelineProto->auth->requestPasswordRecovery to login to your account', 'method_auth.recoverPassword_param_code_type_string' => 'The code that was emailed to you', - 'method_auth.resendCode' => 'Resend The SMS verification code', + 'method_auth.resendCode' => 'Resend the SMS verification code', 'method_auth.resendCode_param_phone_number_type_string' => 'The phone number', 'method_auth.resendCode_param_phone_code_hash_type_string' => 'The phone code hash', 'method_auth.cancelCode' => 'Invalidate sent phone code', 'method_auth.cancelCode_param_phone_number_type_string' => 'Phone number', 'method_auth.cancelCode_param_phone_code_hash_type_string' => 'Phone code hash', - 'method_auth.dropTempAuthKeys' => 'Delete all temporary authorization keys except The ones provided', + 'method_auth.dropTempAuthKeys' => 'Delete all temporary authorization keys except the ones provided', 'method_auth.dropTempAuthKeys_param_except_auth_keys_type_Vector t' => 'The temporary authorization keys to keep', 'method_account.registerDevice' => 'Register device for push notifications', 'method_account.registerDevice_param_token_type_type_int' => 'Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and oTher, see source code of official apps for more info', 'method_account.registerDevice_param_token_type_string' => 'Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and oTher, see source code of official apps for more info', - 'method_account.registerDevice_param_app_sandbox_type_Bool' => 'Should The app run in a sandbox?', + 'method_account.registerDevice_param_app_sandbox_type_Bool' => 'Should the app run in a sandbox?', 'method_account.registerDevice_param_oTher_uids_type_Vector t' => 'OTher UUIDs', 'method_account.unregisterDevice' => 'Stop sending PUSH notifications to app', 'method_account.unregisterDevice_param_token_type_type_int' => 'Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and oTher, see source code of official apps for more info', 'method_account.unregisterDevice_param_token_type_string' => 'Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and oTher, see source code of official apps for more info', 'method_account.unregisterDevice_param_oTher_uids_type_Vector t' => 'OTher UUIDs', 'method_account.updateNotifySettings' => 'Change notification settings', - 'method_account.updateNotifySettings_param_peer_type_InputNotifyPeer' => 'The peers to which The notification settings should be applied', + 'method_account.updateNotifySettings_param_peer_type_InputNotifyPeer' => 'The peers to which the notification settings should be applied', 'method_account.updateNotifySettings_param_settings_type_InputPeerNotifySettings' => 'Notification settings', 'method_account.getNotifySettings' => 'Get notification settings', 'method_account.getNotifySettings_param_peer_type_InputNotifyPeer' => 'Notification source ', @@ -418,7 +418,7 @@ class Lang 'method_account.updateProfile_param_last_name_type_string' => 'The last name', 'method_account.updateProfile_param_about_type_string' => 'The bio/about field', 'method_account.updateStatus' => 'Update online status', - 'method_account.updateStatus_param_offline_type_Bool' => 'offline to set The status to offline', + 'method_account.updateStatus_param_offline_type_Bool' => 'offline to set the status to offline', 'method_account.getWallPapers' => 'Returns a list of available wallpapers.', 'method_account.reportPeer' => 'Report for spam', 'method_account.reportPeer_param_peer_type_InputPeer' => 'The peer to report', @@ -437,11 +437,11 @@ class Lang 'method_account.getAccountTTL' => 'Get account TTL', 'method_account.setAccountTTL' => 'Set account TTL', 'method_account.setAccountTTL_param_ttl_type_AccountDaysTTL' => 'Time To Live of account', - 'method_account.sendChangePhoneCode' => 'Change The phone number', - 'method_account.sendChangePhoneCode_param_allow_flashcall_type_true' => 'Can The code be sent using a flash call instead of an SMS?', + 'method_account.sendChangePhoneCode' => 'Change the phone number', + 'method_account.sendChangePhoneCode_param_allow_flashcall_type_true' => 'Can the code be sent using a flash call instead of an SMS?', 'method_account.sendChangePhoneCode_param_phone_number_type_string' => 'New phone number', 'method_account.sendChangePhoneCode_param_current_number_type_Bool' => 'Current phone number', - 'method_account.changePhone' => 'Change The phone number associated to this account', + 'method_account.changePhone' => 'Change the phone number associated to this account', 'method_account.changePhone_param_phone_number_type_string' => 'Phone number', 'method_account.changePhone_param_phone_code_hash_type_string' => 'Phone code hash returned by account.sendChangePhoneCode', 'method_account.changePhone_param_phone_code_type_string' => 'The phone code sent by account.sendChangePhoneCode', @@ -450,10 +450,10 @@ class Lang 'method_account.getAuthorizations' => 'Get all logged-in authorizations', 'method_account.resetAuthorization' => 'Delete a certain session', 'method_account.resetAuthorization_param_hash_type_long' => 'The session hash, obtained from $MadelineProto->account->getAuthorizations', - 'method_account.getPassword' => 'Get The current password', - 'method_account.getPasswordSettings' => 'Get The current 2FA settings', + 'method_account.getPassword' => 'Get the current password', + 'method_account.getPasswordSettings' => 'Get the current 2FA settings', 'method_account.getPasswordSettings_param_current_password_hash_type_bytes' => 'Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()[\'current_salt\']; $current_password_hash = hash(\'sha256\', $current_salt.$password.$current_salt, true);`', - 'method_account.updatePasswordSettings' => 'Update The 2FA password settings', + 'method_account.updatePasswordSettings' => 'Update the 2FA password settings', 'method_account.updatePasswordSettings_param_current_password_hash_type_bytes' => 'Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()[\'current_salt\']; $current_password_hash = hash(\'sha256\', $current_salt.$password.$current_salt, true);`', 'method_account.updatePasswordSettings_param_new_settings_type_account.PasswordInputSettings' => 'New 2FA settings', 'method_account.sendConfirmPhoneCode' => 'Send confirmation phone code', @@ -471,12 +471,12 @@ class Lang 'method_account.resetWebAuthorization_param_hash_type_long' => 'The authorization\'s hash', 'method_account.resetWebAuthorizations' => 'Reset all telegram web login authorizations', 'method_users.getUsers' => 'Get info about users', - 'method_users.getUsers_param_id_type_Vector t' => 'The ids of The users', + 'method_users.getUsers_param_id_type_Vector t' => 'The ids of the users', 'method_users.getFullUser' => 'You cannot use this method directly, use the get_pwr_chat, get_info, get_full_info methods instead (see https://docs.madelineproto.xyz for more info)', 'method_users.getFullUser_param_id_type_InputUser' => 'You cannot use this method directly, use the get_pwr_chat, get_info, get_full_info methods instead (see https://docs.madelineproto.xyz for more info)', 'method_contacts.getStatuses' => 'Get online status of all users', 'method_contacts.getContacts' => 'Get info about a certain contact', - 'method_contacts.getContacts_param_hash_type_int' => '$ids is The list ids of previously fetched contacts, `$hash = $MadelineProto->gen_vector_hash($ids);`', + 'method_contacts.getContacts_param_hash_type_int' => '$ids is the list ids of previously fetched contacts, `$hash = $MadelineProto->gen_vector_hash($ids);`', 'method_contacts.importContacts' => 'Add phone number as contact', 'method_contacts.importContacts_param_contacts_type_Vector t' => 'The numbers to import', 'method_contacts.deleteContact' => 'Delete a contact', @@ -488,7 +488,7 @@ class Lang 'method_contacts.unblock' => 'Unblock a user', 'method_contacts.unblock_param_id_type_InputUser' => 'The user to unblock', 'method_contacts.getBlocked' => 'Get blocked users', - 'method_contacts.getBlocked_param_offset_type_int' => 'Initially 0, Then set to The number of blocked contacts previously fetched', + 'method_contacts.getBlocked_param_offset_type_int' => 'Initially 0, Then set to the number of blocked contacts previously fetched', 'method_contacts.getBlocked_param_limit_type_int' => 'How many blocked contacts to fetch', 'method_contacts.exportCard' => 'Export contact as card', 'method_contacts.importCard' => 'Import card as contact', @@ -523,7 +523,7 @@ class Lang 'method_messages.getHistory' => 'Get previous messages of a group', 'method_messages.getHistory_param_peer_type_InputPeer' => 'The chat', 'method_messages.getHistory_param_offset_id_type_int' => 'The last fetched message ID, initially 0', - 'method_messages.getHistory_param_offset_date_type_int' => 'The date of The last previously fetched message, initially 0', + 'method_messages.getHistory_param_offset_date_type_int' => 'The date of the last previously fetched message, initially 0', 'method_messages.getHistory_param_add_offset_type_int' => 'Additional offset, can be 0', 'method_messages.getHistory_param_limit_type_int' => 'Number of messages to fetch', 'method_messages.getHistory_param_max_id_type_int' => 'Maximum message ID to fetch', @@ -549,7 +549,7 @@ class Lang 'method_messages.deleteHistory_param_peer_type_InputPeer' => 'Where to clear it', 'method_messages.deleteHistory_param_max_id_type_int' => 'Maximum message id of messages to delete', 'method_messages.deleteMessages' => 'Delete messages', - 'method_messages.deleteMessages_param_revoke_type_true' => 'Delete The messages for everyone?', + 'method_messages.deleteMessages_param_revoke_type_true' => 'Delete the messages for everyone?', 'method_messages.deleteMessages_param_id_type_Vector t' => 'IDs of messages to delete, use channels->deleteMessages for supergroups', 'method_messages.receivedMessages' => 'Mark messages as read', 'method_messages.receivedMessages_param_max_id_type_int' => 'Maximum message id of messages to mark as read', @@ -560,7 +560,7 @@ class Lang 'method_messages.sendMessage_param_no_webpage_type_true' => 'Disable webpage preview?', 'method_messages.sendMessage_param_silent_type_true' => 'Disable notifications?', 'method_messages.sendMessage_param_background_type_true' => 'Disable background notifications?', - 'method_messages.sendMessage_param_clear_draft_type_true' => 'Clear The message draft of this chat?', + 'method_messages.sendMessage_param_clear_draft_type_true' => 'Clear the message draft of this chat?', 'method_messages.sendMessage_param_peer_type_InputPeer' => 'The chat where to send this message', 'method_messages.sendMessage_param_reply_to_msg_id_type_int' => 'Reply to message by ID', 'method_messages.sendMessage_param_message_type_string' => 'The message to send', @@ -569,8 +569,8 @@ class Lang 'method_messages.sendMedia' => 'Send a media', 'method_messages.sendMedia_param_silent_type_true' => 'Disable notifications?', 'method_messages.sendMedia_param_background_type_true' => 'Disable background notifications?', - 'method_messages.sendMedia_param_clear_draft_type_true' => 'Clear The message draft of this chat?', - 'method_messages.sendMedia_param_peer_type_InputPeer' => 'Where to send The media', + 'method_messages.sendMedia_param_clear_draft_type_true' => 'Clear the message draft of this chat?', + 'method_messages.sendMedia_param_peer_type_InputPeer' => 'Where to send the media', 'method_messages.sendMedia_param_reply_to_msg_id_type_int' => 'Reply to message by ID', 'method_messages.sendMedia_param_media_type_InputMedia' => 'The media to send', 'method_messages.sendMedia_param_message_type_string' => 'The caption', @@ -581,34 +581,34 @@ class Lang 'method_messages.forwardMessages_param_background_type_true' => 'Disable background notifications', 'method_messages.forwardMessages_param_with_my_score_type_true' => 'If forwarding a game, forward your score, too', 'method_messages.forwardMessages_param_grouped_type_true' => 'Set to true if forwarding albums', - 'method_messages.forwardMessages_param_from_peer_type_InputPeer' => 'From where to forward The messages', + 'method_messages.forwardMessages_param_from_peer_type_InputPeer' => 'From where to forward the messages', 'method_messages.forwardMessages_param_id_type_Vector t' => 'The message IDs', - 'method_messages.forwardMessages_param_to_peer_type_InputPeer' => 'Where to forward The messages', + 'method_messages.forwardMessages_param_to_peer_type_InputPeer' => 'Where to forward the messages', 'method_messages.reportSpam' => 'Report a peer for spam', 'method_messages.reportSpam_param_peer_type_InputPeer' => 'The peer to report', 'method_messages.hideReportSpam' => 'Hide report spam popup', - 'method_messages.hideReportSpam_param_peer_type_InputPeer' => 'Where to hide The popup', - 'method_messages.getPeerSettings' => 'Get The settings of apeer', + 'method_messages.hideReportSpam_param_peer_type_InputPeer' => 'Where to hide the popup', + 'method_messages.getPeerSettings' => 'Get the settings of apeer', 'method_messages.getPeerSettings_param_peer_type_InputPeer' => 'The peer', 'method_messages.getChats' => 'Get info about chats', 'method_messages.getChats_param_id_type_Vector t' => 'The MTProto IDs of chats to fetch info about', 'method_messages.getFullChat' => 'You cannot use this method directly, use the get_pwr_chat, get_info, get_full_info methods instead (see https://docs.madelineproto.xyz for more info)', 'method_messages.getFullChat_param_chat_id_type_InputPeer' => 'You cannot use this method directly, use the get_pwr_chat, get_info, get_full_info methods instead (see https://docs.madelineproto.xyz for more info)', - 'method_messages.editChatTitle' => 'Edit The title of a normal chat (not supergroup)', - 'method_messages.editChatTitle_param_chat_id_type_InputPeer' => 'The ID of The chat', + 'method_messages.editChatTitle' => 'Edit the title of a normal chat (not supergroup)', + 'method_messages.editChatTitle_param_chat_id_type_InputPeer' => 'The ID of the chat', 'method_messages.editChatTitle_param_title_type_string' => 'The new title', - 'method_messages.editChatPhoto' => 'Edit The photo of a normal chat (not supergroup)', - 'method_messages.editChatPhoto_param_chat_id_type_InputPeer' => 'The ID of The chat', + 'method_messages.editChatPhoto' => 'Edit the photo of a normal chat (not supergroup)', + 'method_messages.editChatPhoto_param_chat_id_type_InputPeer' => 'The ID of the chat', 'method_messages.editChatPhoto_param_photo_type_InputChatPhoto' => 'The new phto', 'method_messages.addChatUser' => 'Add a user to a normal chat (use channels->inviteToChannel for supergroups)', 'method_messages.addChatUser_param_chat_id_type_InputPeer' => 'The chat where to invite users', 'method_messages.addChatUser_param_user_id_type_InputUser' => 'The user to invite', - 'method_messages.addChatUser_param_fwd_limit_type_int' => 'Number of old messages The user will see', + 'method_messages.addChatUser_param_fwd_limit_type_int' => 'Number of old messages the user will see', 'method_messages.deleteChatUser' => 'Delete a user from a chat (not supergroup)', - 'method_messages.deleteChatUser_param_chat_id_type_InputPeer' => 'The ID of The chat', - 'method_messages.deleteChatUser_param_user_id_type_InputUser' => 'The user to delete (pass @me to leave The chat)', + 'method_messages.deleteChatUser_param_chat_id_type_InputPeer' => 'The ID of the chat', + 'method_messages.deleteChatUser_param_user_id_type_InputUser' => 'The user to delete (pass @me to leave the chat)', 'method_messages.createChat' => 'Create a chat (not supergroup)', - 'method_messages.createChat_param_users_type_Vector t' => 'The users to add to The chat', + 'method_messages.createChat_param_users_type_Vector t' => 'The users to add to the chat', 'method_messages.createChat_param_title_type_string' => 'The new chat\'s title', 'method_messages.getDhConfig' => 'You cannot use this method directly, instead use $MadelineProto->get_dh_config();', 'method_messages.getDhConfig_param_version_type_int' => 'You cannot use this method directly, instead use $MadelineProto->get_dh_config();', @@ -623,20 +623,20 @@ class Lang 'method_messages.discardEncryption' => 'You cannot use this method directly, see https://docs.madelineproto.xyz for more info on handling secret chats', 'method_messages.discardEncryption_param_chat_id_type_int' => 'You cannot use this method directly, see https://docs.madelineproto.xyz for more info on handling secret chats', 'method_messages.setEncryptedTyping' => 'Send typing notification to secret chat', - 'method_messages.setEncryptedTyping_param_peer_type_InputEncryptedChat' => 'The secret chat where to send The notification', - 'method_messages.setEncryptedTyping_param_typing_type_Bool' => 'Set to true to enable The notification, false to disable it', + 'method_messages.setEncryptedTyping_param_peer_type_InputEncryptedChat' => 'The secret chat where to send the notification', + 'method_messages.setEncryptedTyping_param_typing_type_Bool' => 'Set to true to enable the notification, false to disable it', 'method_messages.readEncryptedHistory' => 'Mark messages as read in secret chats', 'method_messages.readEncryptedHistory_param_peer_type_InputEncryptedChat' => 'The secret chat where to mark messages as read', 'method_messages.readEncryptedHistory_param_max_date_type_int' => 'Maximum date of messages to mark', 'method_messages.sendEncrypted' => 'Send message to secret chat', - 'method_messages.sendEncrypted_param_peer_type_InputEncryptedChat' => 'The chat where to send The message', + 'method_messages.sendEncrypted_param_peer_type_InputEncryptedChat' => 'The chat where to send the message', 'method_messages.sendEncrypted_param_message_type_DecryptedMessage' => 'The message to send', 'method_messages.sendEncryptedFile' => 'Send a file to a secret chat', - 'method_messages.sendEncryptedFile_param_peer_type_InputEncryptedChat' => 'The chat where to send The file', - 'method_messages.sendEncryptedFile_param_message_type_DecryptedMessage' => 'The message with The file', + 'method_messages.sendEncryptedFile_param_peer_type_InputEncryptedChat' => 'The chat where to send the file', + 'method_messages.sendEncryptedFile_param_message_type_DecryptedMessage' => 'The message with the file', 'method_messages.sendEncryptedFile_param_file_type_InputEncryptedFile' => 'The file (optional)', 'method_messages.sendEncryptedService' => 'Send a service message to a secret chat', - 'method_messages.sendEncryptedService_param_peer_type_InputEncryptedChat' => 'The chat where to send The service message', + 'method_messages.sendEncryptedService_param_peer_type_InputEncryptedChat' => 'The chat where to send the service message', 'method_messages.sendEncryptedService_param_message_type_DecryptedMessage' => 'The service message', 'method_messages.receivedQueue' => 'You cannot use this method directly', 'method_messages.receivedQueue_param_max_qts_type_int' => 'You cannot use this method directly', @@ -667,10 +667,10 @@ class Lang 'method_messages.uninstallStickerSet_param_stickerset_type_InputStickerSet' => 'The sticker set to remove', 'method_messages.startBot' => 'Start a bot', 'method_messages.startBot_param_bot_type_InputUser' => 'The bot\'s ID or username', - 'method_messages.startBot_param_peer_type_InputPeer' => 'Where to start The bot (@me or group ID/username)', + 'method_messages.startBot_param_peer_type_InputPeer' => 'Where to start the bot (@me or group ID/username)', 'method_messages.startBot_param_start_param_type_string' => 'The bot\'s start parameter', 'method_messages.getMessagesViews' => 'Get and increase message views', - 'method_messages.getMessagesViews_param_peer_type_InputPeer' => 'The chat where The message is located', + 'method_messages.getMessagesViews_param_peer_type_InputPeer' => 'The chat where the message is located', 'method_messages.getMessagesViews_param_id_type_Vector t' => 'The IDs messages to get', 'method_messages.getMessagesViews_param_increment_type_Bool' => 'Increase message views?', 'method_messages.toggleChatAdmins' => 'Enable all users are admins in normal groups (not supergroups)', @@ -679,14 +679,14 @@ class Lang 'method_messages.editChatAdmin' => 'Edit admin permissions', 'method_messages.editChatAdmin_param_chat_id_type_InputPeer' => 'The chat ID (no supergroups)', 'method_messages.editChatAdmin_param_user_id_type_InputUser' => 'The user ID', - 'method_messages.editChatAdmin_param_is_admin_type_Bool' => 'Should The user be admin?', + 'method_messages.editChatAdmin_param_is_admin_type_Bool' => 'Should the user be admin?', 'method_messages.migrateChat' => 'Convert chat to supergroup', 'method_messages.migrateChat_param_chat_id_type_InputPeer' => 'The chat to convert', 'method_messages.searchGlobal' => 'Global message search', 'method_messages.searchGlobal_param_q_type_string' => 'The query', - 'method_messages.searchGlobal_param_offset_date_type_int' => '0 or The date offset', - 'method_messages.searchGlobal_param_offset_peer_type_InputPeer' => '0 or The peer offset', - 'method_messages.searchGlobal_param_offset_id_type_int' => '0 or The message ID offset', + 'method_messages.searchGlobal_param_offset_date_type_int' => '0 or the date offset', + 'method_messages.searchGlobal_param_offset_peer_type_InputPeer' => '0 or the peer offset', + 'method_messages.searchGlobal_param_offset_id_type_int' => '0 or the message ID offset', 'method_messages.searchGlobal_param_limit_type_int' => 'The number of results to return', 'method_messages.reorderStickerSets' => 'Reorder sticker sets', 'method_messages.reorderStickerSets_param_masks_type_true' => 'Reorder masks?', @@ -694,7 +694,7 @@ class Lang 'method_messages.getDocumentByHash' => 'Get document by SHA256 hash', 'method_messages.getDocumentByHash_param_sha256_type_bytes' => '`hash(\'sha256\', $filename, true);`', 'method_messages.getDocumentByHash_param_size_type_int' => 'The file size', - 'method_messages.getDocumentByHash_param_mime_type_type_string' => 'The mime type of The file', + 'method_messages.getDocumentByHash_param_mime_type_type_string' => 'The mime type of the file', 'method_messages.searchGifs' => 'Search gifs', 'method_messages.searchGifs_param_q_type_string' => 'The search query', 'method_messages.searchGifs_param_offset_type_int' => 'The offset ', @@ -702,14 +702,14 @@ class Lang 'method_messages.getSavedGifs_param_hash_type_int' => '0 or $result[\'hash\']', 'method_messages.saveGif' => 'Save a GIF', 'method_messages.saveGif_param_id_type_InputDocument' => 'The GIF to save', - 'method_messages.saveGif_param_unsave_type_Bool' => 'Remove The gif?', + 'method_messages.saveGif_param_unsave_type_Bool' => 'Remove the gif?', 'method_messages.getInlineBotResults' => 'Call inline bot', 'method_messages.getInlineBotResults_param_bot_type_InputUser' => 'The bot to call', - 'method_messages.getInlineBotResults_param_peer_type_InputPeer' => 'The chat where to call The bot', + 'method_messages.getInlineBotResults_param_peer_type_InputPeer' => 'The chat where to call the bot', 'method_messages.getInlineBotResults_param_geo_point_type_InputGeoPoint' => 'The current location', - 'method_messages.getInlineBotResults_param_query_type_string' => 'The query to send to The bot', - 'method_messages.getInlineBotResults_param_offset_type_string' => 'The offset to send to The bot', - 'method_messages.setInlineBotResults' => 'Bots only: set The results of an inline query', + 'method_messages.getInlineBotResults_param_query_type_string' => 'The query to send to the bot', + 'method_messages.getInlineBotResults_param_offset_type_string' => 'The offset to send to the bot', + 'method_messages.setInlineBotResults' => 'Bots only: set the results of an inline query', 'method_messages.setInlineBotResults_param_gallery_type_true' => 'Is this a gallery?', 'method_messages.setInlineBotResults_param_private_type_true' => 'Is this result private (not cached)?', 'method_messages.setInlineBotResults_param_query_id_type_long' => 'Query ID', @@ -717,11 +717,11 @@ class Lang 'method_messages.setInlineBotResults_param_cache_time_type_int' => 'Cache time', 'method_messages.setInlineBotResults_param_next_offset_type_string' => 'The next offset', 'method_messages.setInlineBotResults_param_switch_pm_type_InlineBotSwitchPM' => 'Switch to PM?', - 'method_messages.sendInlineBotResult' => 'Send a received bot result to The chat', + 'method_messages.sendInlineBotResult' => 'Send a received bot result to the chat', 'method_messages.sendInlineBotResult_param_silent_type_true' => 'Disable notifications?', 'method_messages.sendInlineBotResult_param_background_type_true' => 'Disable background notifications?', - 'method_messages.sendInlineBotResult_param_clear_draft_type_true' => 'Clear The message draft?', - 'method_messages.sendInlineBotResult_param_peer_type_InputPeer' => 'Where to send The message', + 'method_messages.sendInlineBotResult_param_clear_draft_type_true' => 'Clear the message draft?', + 'method_messages.sendInlineBotResult_param_peer_type_InputPeer' => 'Where to send the message', 'method_messages.sendInlineBotResult_param_reply_to_msg_id_type_int' => 'Reply to message by ID', 'method_messages.sendInlineBotResult_param_query_id_type_long' => 'The inline query ID', 'method_messages.sendInlineBotResult_param_id_type_string' => 'The result ID', @@ -745,12 +745,12 @@ class Lang 'method_messages.editInlineBotMessage_param_reply_markup_type_ReplyMarkup' => 'The new keyboard', 'method_messages.editInlineBotMessage_param_entities_type_Vector t' => 'The new entities (for styled text)', 'method_messages.editInlineBotMessage_param_geo_point_type_InputGeoPoint' => 'The new location', - 'method_messages.getBotCallbackAnswer' => 'Get The callback answer of a bot (after clicking a button)', + 'method_messages.getBotCallbackAnswer' => 'Get the callback answer of a bot (after clicking a button)', 'method_messages.getBotCallbackAnswer_param_game_type_true' => 'Is this a game?', 'method_messages.getBotCallbackAnswer_param_peer_type_InputPeer' => 'The chat', 'method_messages.getBotCallbackAnswer_param_msg_id_type_int' => 'The message ID', - 'method_messages.getBotCallbackAnswer_param_data_type_bytes' => 'The data to send to The bot', - 'method_messages.setBotCallbackAnswer' => 'Bots only: set The callback answer (after a button was clicked)', + 'method_messages.getBotCallbackAnswer_param_data_type_bytes' => 'The data to send to the bot', + 'method_messages.setBotCallbackAnswer' => 'Bots only: set the callback answer (after a button was clicked)', 'method_messages.setBotCallbackAnswer_param_alert_type_true' => 'Is this an alert?', 'method_messages.setBotCallbackAnswer_param_query_id_type_long' => 'The query ID', 'method_messages.setBotCallbackAnswer_param_message_type_string' => 'The message', @@ -775,7 +775,7 @@ class Lang 'method_messages.saveRecentSticker' => 'Add a sticker to recent stickers', 'method_messages.saveRecentSticker_param_attached_type_true' => 'Get stickers attached to image?', 'method_messages.saveRecentSticker_param_id_type_InputDocument' => 'The sticker', - 'method_messages.saveRecentSticker_param_unsave_type_Bool' => 'Remove The sticker from recent stickers?', + 'method_messages.saveRecentSticker_param_unsave_type_Bool' => 'Remove the sticker from recent stickers?', 'method_messages.clearRecentStickers' => 'Clear all recent stickers', 'method_messages.clearRecentStickers_param_attached_type_true' => 'Clear recent stickers attached to images?', 'method_messages.getArchivedStickers' => 'Get all archived stickers', @@ -1105,8 +1105,8 @@ class Lang 'method_langpack.getDifference' => '', 'method_langpack.getDifference_param_from_version_type_int' => '', 'method_langpack.getLanguages' => '', - 'method_auth.sendCode_param_sms_type_type_int' => 'You cannot use this method directly, use The phone_login method instead (see https://docs.madelineproto.xyz for more info)', - 'method_auth.sendCode_param_lang_code_type_string' => 'You cannot use this method directly, use The phone_login method instead (see https://docs.madelineproto.xyz for more info)', + 'method_auth.sendCode_param_sms_type_type_int' => 'You cannot use this method directly, use the phone_login method instead (see https://docs.madelineproto.xyz for more info)', + 'method_auth.sendCode_param_lang_code_type_string' => 'You cannot use this method directly, use the phone_login method instead (see https://docs.madelineproto.xyz for more info)', 'method_auth.sendCall' => '', 'method_auth.sendCall_param_phone_number_type_string' => '', 'method_auth.sendCall_param_phone_code_hash_type_string' => '', @@ -1267,10 +1267,10 @@ class Lang 'method_contest.saveDeveloperInfo_param_phone_number_type_string' => '', 'method_contest.saveDeveloperInfo_param_age_type_int' => '', 'method_contest.saveDeveloperInfo_param_city_type_string' => '', - 'method_auth.importBotAuthorization_param_a_type_true' => 'You cannot use this method directly, use The bot_login method instead (see https://docs.madelineproto.xyz for more info)', - 'method_auth.importBotAuthorization_param_b_type_true' => 'You cannot use this method directly, use The bot_login method instead (see https://docs.madelineproto.xyz for more info)', - 'method_auth.importBotAuthorization_param_c_type_true' => 'You cannot use this method directly, use The bot_login method instead (see https://docs.madelineproto.xyz for more info)', - 'method_auth.importBotAuthorization_param_d_type_true' => 'You cannot use this method directly, use The bot_login method instead (see https://docs.madelineproto.xyz for more info)', + 'method_auth.importBotAuthorization_param_a_type_true' => 'You cannot use this method directly, use the bot_login method instead (see https://docs.madelineproto.xyz for more info)', + 'method_auth.importBotAuthorization_param_b_type_true' => 'You cannot use this method directly, use the bot_login method instead (see https://docs.madelineproto.xyz for more info)', + 'method_auth.importBotAuthorization_param_c_type_true' => 'You cannot use this method directly, use the bot_login method instead (see https://docs.madelineproto.xyz for more info)', + 'method_auth.importBotAuthorization_param_d_type_true' => 'You cannot use this method directly, use the bot_login method instead (see https://docs.madelineproto.xyz for more info)', 'object_vector' => '', 'object_resPQ' => '', 'object_resPQ_param_nonce_type_int128' => '', @@ -4108,9 +4108,17 @@ class Lang 'object_help.configSimple_param_dc_id_type_int' => '', 'object_help.configSimple_param_ip_port_list_type_Vector t' => '', 'object_inputMessagesFilterMyMentionsUnread' => '', + 'method_account.registerDevice_param_other_uids_type_Vector t' => '', + 'method_account.unregisterDevice_param_other_uids_type_Vector t' => '', + 'object_inputReportReasonOther' => '', + 'object_inputReportReasonOther_param_text_type_string' => '', + 'object_updates.difference_param_other_updates_type_Vector t' => '', + 'object_updates.differenceSlice_param_other_updates_type_Vector t' => '', + 'object_updates.channelDifference_param_other_updates_type_Vector t' => '', + 'object_langPackStringPluralized_param_other_value_type_string' => '', ), ); - + // THIS WILL BE OVERWRITTEN BY $lang["en"] public static $current_lang = array ( 'req_pq' => 'Requesting pq...', @@ -4161,14 +4169,14 @@ class Lang 'v_error' => '506c656173652075706461746520746f20746865206c61746573742076657273696f6e206f66204d6164656c696e6550726f746f2e', 'v_tgerror' => '506c6561736520757064617465207068702d6c69627467766f6970', 'no_mode_specified' => 'No mode was specified!', - 'constructor_function_uncalled' => 'The constructor function wasn\'t called! Please call The constructor function before using this method.', + 'constructor_function_uncalled' => 'The constructor function wasn\'t called! Please call the constructor function before using this method.', 'proxy_class_invalid' => 'Invalid proxy class provided!', 'socket_con_error' => 'Connection: couldn\'t connect to socket.', 'protocol_not_implemented' => 'Connection: This protocol isn\'t implemented yet.', 'protocol_invalid' => 'Connection: invalid protocol specified.', - 'nothing_in_socket' => 'Nothing in The socket!', + 'nothing_in_socket' => 'Nothing in the socket!', 'wrong_length_read' => 'WARNING: Wrong length was read (should\'ve read %s, read %s)!', - 'no_data_in_socket' => 'No data in The socket!', + 'no_data_in_socket' => 'No data in the socket!', 'dc_con_start' => 'Connecting to DC %s...', 'dc_con_stop' => 'Disconnecting from DC %s...', 'dc_con_test_start' => 'Connecting to DC %s (%s server, %s, %s)...', @@ -4182,19 +4190,19 @@ class Lang 'login_user' => 'Logging in as a normal user...', 'login_bot' => 'Logging in as a bot...', 'login_code_sending' => 'Sending code...', - 'login_code_sent' => 'Code sent successfully! Once you receive The code you should use The complete_phone_login function.', - 'login_code_uncalled' => 'I\'m not waiting for The code! Please call The phone_login method first', - 'login_2fa_enabled' => '2FA enabled, you will have to call The complete_2fa_login function...', - 'login_need_signup' => 'An account has not been created for this number, you will have to call The complete_signup function...', + 'login_code_sent' => 'Code sent successfully! Once you receive the code you should use the complete_phone_login function.', + 'login_code_uncalled' => 'I\'m not waiting for the code! Please call the phone_login method first', + 'login_2fa_enabled' => '2FA enabled, you will have to call the complete_2fa_login function...', + 'login_need_signup' => 'An account has not been created for this number, you will have to call the complete_signup function...', 'login_auth_key' => 'Logging in using auth key...', 'not_logged_in' => 'I\'m not logged in!', - 'signup_uncalled' => 'I\'m not waiting to signup! Please call The phone_login and The complete_phone_login methods first!', + 'signup_uncalled' => 'I\'m not waiting to signup! Please call the phone_login and the complete_phone_login methods first!', 'signing_up' => 'Signing up as a normal user...', 'signup_ok' => 'Signed up in successfully!', - '2fa_uncalled' => 'I\'m not waiting for The password! Please call The phone_login and The complete_phone_login methods first!', + '2fa_uncalled' => 'I\'m not waiting for the password! Please call the phone_login and the complete_phone_login methods first!', 'getting_dialogs' => 'Getting dialogs...', 'libtgvoip_required' => 'The php-libtgvoip extension is required to accept and manage calls. See daniil.it/MadelineProto for more info.', - 'peer_not_in_db' => 'This peer is not present in The internal peer database', + 'peer_not_in_db' => 'This peer is not present in the internal peer database', 'calling_user' => 'Calling %s...', 'generating_a' => 'Generating a...', 'generating_g_a' => 'Generating g_a...', @@ -4228,7 +4236,7 @@ class Lang 'type_extract_error' => 'Could not extract type "%s"', 'method_not_found' => 'Could not find method: ', 'params_missing' => 'Missing required parameter', - 'sec_peer_not_in_db' => 'This secret peer is not present in The internal peer database', + 'sec_peer_not_in_db' => 'This secret peer is not present in the internal peer database', 'stream_handle_invalid' => 'An invalid stream handle was provided.', 'length_too_big' => 'Length is too big', 'deserialize_not_str' => 'Deserialize: Generated value isn\'t a string', @@ -4240,11 +4248,11 @@ class Lang 'non_text_conversion' => 'Can\'t convert non text messages yet!', 'last_byte_invalid' => 'Invalid last byte', 'file_type_invalid' => 'Invalid file type detected (%s)', - 'recreate_temp_auth_key' => 'I had to recreate The temporary authorization key', + 'recreate_temp_auth_key' => 'I had to recreate the temporary authorization key', 'resetting_auth_key' => 'WARNING: Resetting auth key...', 'shutting_down_reader_pool' => 'Shutting down reader pool ', 'shutting_down_handler_pool' => 'Shutting down handler pool for dc %s, %d jobs left', - 'secret_chat_skipping' => 'I do not have The secret chat %s in The database, skipping message...', + 'secret_chat_skipping' => 'I do not have the secret chat %s in the database, skipping message...', 'fingerprint_mismatch' => 'Key fingerprint mismatch', 'msg_data_length_too_big' => 'message_data_length is too big', 'length_not_divisible_16' => 'Length of decrypted data is not divisible by 16', @@ -4268,27 +4276,27 @@ class Lang 'method_set_client_DH_params_param_server_nonce_type_int128' => 'Random number for cryptographic security, given by server', 'method_set_client_DH_params_param_encrypted_data_type_bytes' => 'Encrypted key exchange message', 'method_rpc_drop_answer' => 'Do not send answer to provided request', - 'method_rpc_drop_answer_param_req_msg_id_type_long' => 'The message ID of The request', + 'method_rpc_drop_answer_param_req_msg_id_type_long' => 'The message ID of the request', 'method_get_future_salts' => 'Get future salts', 'method_get_future_salts_param_num_type_int' => 'How many salts should be fetched', - 'method_ping' => 'pings The server', + 'method_ping' => 'pings the server', 'method_ping_param_ping_id_type_long' => 'Ping ID', - 'method_ping_delay_disconnect' => 'Pings The server and causes disconection if The same method is not called within ping_disconnect_delay', + 'method_ping_delay_disconnect' => 'Pings the server and causes disconection if the same method is not called within ping_disconnect_delay', 'method_ping_delay_disconnect_param_ping_id_type_long' => 'Ping ID', 'method_ping_delay_disconnect_param_disconnect_delay_type_int' => 'Disconection delay', - 'method_destroy_session' => 'Destroy The current MTProto session', + 'method_destroy_session' => 'Destroy the current MTProto session', 'method_destroy_session_param_session_id_type_long' => 'The session to destroy', - 'method_http_wait' => 'Makes The server send messages waiting in The buffer', - 'method_http_wait_param_max_delay_type_int' => 'Denotes The maximum number of milliseconds that has elapsed between The first message for this session and The transmission of an HTTP response', - 'method_http_wait_param_wait_after_type_int' => 'after The receipt of The latest message for a particular session, The server waits anoTher wait_after milliseconds in case There are more messages. If There are no additional messages, The result is transmitted (a container with all The messages).', - 'method_http_wait_param_max_wait_type_int' => 'If more messages appear, The wait_after timer is reset.', - 'method_invokeAfterMsg' => 'Invokes a query after successfull completion of one of The previous queries.', + 'method_http_wait' => 'Makes the server send messages waiting in the buffer', + 'method_http_wait_param_max_delay_type_int' => 'Denotes the maximum number of milliseconds that has elapsed between the first message for this session and the transmission of an HTTP response', + 'method_http_wait_param_wait_after_type_int' => 'after the receipt of the latest message for a particular session, the server waits anoTher wait_after milliseconds in case There are more messages. If There are no additional messages, the result is transmitted (a container with all the messages).', + 'method_http_wait_param_max_wait_type_int' => 'If more messages appear, the wait_after timer is reset.', + 'method_invokeAfterMsg' => 'Invokes a query after successfull completion of one of the previous queries.', 'method_invokeAfterMsg_param_msg_id_type_long' => 'Message identifier on which a current query depends', 'method_invokeAfterMsg_param_query_type_!X' => 'The query itself', 'method_invokeAfterMsgs' => 'Result type returned by a current query.', 'method_invokeAfterMsgs_param_msg_ids_type_Vector t' => 'List of messages on which a current query depends', 'method_invokeAfterMsgs_param_query_type_!X' => 'The query itself', - 'method_initConnection' => 'Initializes connection and save information on The user\'s device and application.', + 'method_initConnection' => 'Initializes connection and save information on the user\'s device and application.', 'method_initConnection_param_api_id_type_int' => 'Application identifier', 'method_initConnection_param_device_model_type_string' => 'Device model', 'method_initConnection_param_system_version_type_string' => 'System version', @@ -4300,7 +4308,7 @@ class Lang 'method_invokeWithLayer' => 'Invoke this method with layer X', 'method_invokeWithLayer_param_layer_type_int' => 'The layer version', 'method_invokeWithLayer_param_query_type_!X' => 'The query', - 'method_invokeWithoutUpdates' => 'Invoke with method without returning updates in The socket', + 'method_invokeWithoutUpdates' => 'Invoke with method without returning updates in the socket', 'method_invokeWithoutUpdates_param_query_type_!X' => 'The query', 'method_auth.checkPhone' => 'Check if this phone number is registered on telegram', 'method_auth.checkPhone_param_phone_number_type_string' => 'The phone number to check', @@ -4341,28 +4349,28 @@ class Lang 'method_auth.importBotAuthorization_param_bot_auth_token_type_string' => 'You cannot use this method directly, use the bot_login method instead (see https://docs.madelineproto.xyz for more info)', 'method_auth.checkPassword' => 'You cannot use this method directly, use the complete_2fa_login method instead (see https://docs.madelineproto.xyz for more info)', 'method_auth.checkPassword_param_password_hash_type_bytes' => 'You cannot use this method directly, use the complete_2fa_login method instead (see https://docs.madelineproto.xyz for more info)', - 'method_auth.requestPasswordRecovery' => 'Send an email to recover The 2FA password', - 'method_auth.recoverPassword' => 'Use The code that was emailed to you after running $MadelineProto->auth->requestPasswordRecovery to login to your account', + 'method_auth.requestPasswordRecovery' => 'Send an email to recover the 2FA password', + 'method_auth.recoverPassword' => 'Use the code that was emailed to you after running $MadelineProto->auth->requestPasswordRecovery to login to your account', 'method_auth.recoverPassword_param_code_type_string' => 'The code that was emailed to you', - 'method_auth.resendCode' => 'Resend The SMS verification code', + 'method_auth.resendCode' => 'Resend the SMS verification code', 'method_auth.resendCode_param_phone_number_type_string' => 'The phone number', 'method_auth.resendCode_param_phone_code_hash_type_string' => 'The phone code hash', 'method_auth.cancelCode' => 'Invalidate sent phone code', 'method_auth.cancelCode_param_phone_number_type_string' => 'Phone number', 'method_auth.cancelCode_param_phone_code_hash_type_string' => 'Phone code hash', - 'method_auth.dropTempAuthKeys' => 'Delete all temporary authorization keys except The ones provided', + 'method_auth.dropTempAuthKeys' => 'Delete all temporary authorization keys except the ones provided', 'method_auth.dropTempAuthKeys_param_except_auth_keys_type_Vector t' => 'The temporary authorization keys to keep', 'method_account.registerDevice' => 'Register device for push notifications', 'method_account.registerDevice_param_token_type_type_int' => 'Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone, 6 - Blackberry, and oTher, see source code of official apps for more info', 'method_account.registerDevice_param_token_type_string' => 'Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and oTher, see source code of official apps for more info', - 'method_account.registerDevice_param_app_sandbox_type_Bool' => 'Should The app run in a sandbox?', + 'method_account.registerDevice_param_app_sandbox_type_Bool' => 'Should the app run in a sandbox?', 'method_account.registerDevice_param_oTher_uids_type_Vector t' => 'OTher UUIDs', 'method_account.unregisterDevice' => 'Stop sending PUSH notifications to app', 'method_account.unregisterDevice_param_token_type_type_int' => 'Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and oTher, see source code of official apps for more info', 'method_account.unregisterDevice_param_token_type_string' => 'Device token type. Possible values: 1 - APNS, 2 - GCM, 3 - MPNS, 4 - Simple Push, 5 - Ubuntu Phone,6 - Blackberry, and oTher, see source code of official apps for more info', 'method_account.unregisterDevice_param_oTher_uids_type_Vector t' => 'OTher UUIDs', 'method_account.updateNotifySettings' => 'Change notification settings', - 'method_account.updateNotifySettings_param_peer_type_InputNotifyPeer' => 'The peers to which The notification settings should be applied', + 'method_account.updateNotifySettings_param_peer_type_InputNotifyPeer' => 'The peers to which the notification settings should be applied', 'method_account.updateNotifySettings_param_settings_type_InputPeerNotifySettings' => 'Notification settings', 'method_account.getNotifySettings' => 'Get notification settings', 'method_account.getNotifySettings_param_peer_type_InputNotifyPeer' => 'Notification source ', @@ -4372,7 +4380,7 @@ class Lang 'method_account.updateProfile_param_last_name_type_string' => 'The last name', 'method_account.updateProfile_param_about_type_string' => 'The bio/about field', 'method_account.updateStatus' => 'Update online status', - 'method_account.updateStatus_param_offline_type_Bool' => 'offline to set The status to offline', + 'method_account.updateStatus_param_offline_type_Bool' => 'offline to set the status to offline', 'method_account.getWallPapers' => 'Returns a list of available wallpapers.', 'method_account.reportPeer' => 'Report for spam', 'method_account.reportPeer_param_peer_type_InputPeer' => 'The peer to report', @@ -4391,11 +4399,11 @@ class Lang 'method_account.getAccountTTL' => 'Get account TTL', 'method_account.setAccountTTL' => 'Set account TTL', 'method_account.setAccountTTL_param_ttl_type_AccountDaysTTL' => 'Time To Live of account', - 'method_account.sendChangePhoneCode' => 'Change The phone number', - 'method_account.sendChangePhoneCode_param_allow_flashcall_type_true' => 'Can The code be sent using a flash call instead of an SMS?', + 'method_account.sendChangePhoneCode' => 'Change the phone number', + 'method_account.sendChangePhoneCode_param_allow_flashcall_type_true' => 'Can the code be sent using a flash call instead of an SMS?', 'method_account.sendChangePhoneCode_param_phone_number_type_string' => 'New phone number', 'method_account.sendChangePhoneCode_param_current_number_type_Bool' => 'Current phone number', - 'method_account.changePhone' => 'Change The phone number associated to this account', + 'method_account.changePhone' => 'Change the phone number associated to this account', 'method_account.changePhone_param_phone_number_type_string' => 'Phone number', 'method_account.changePhone_param_phone_code_hash_type_string' => 'Phone code hash returned by account.sendChangePhoneCode', 'method_account.changePhone_param_phone_code_type_string' => 'The phone code sent by account.sendChangePhoneCode', @@ -4404,10 +4412,10 @@ class Lang 'method_account.getAuthorizations' => 'Get all logged-in authorizations', 'method_account.resetAuthorization' => 'Delete a certain session', 'method_account.resetAuthorization_param_hash_type_long' => 'The session hash, obtained from $MadelineProto->account->getAuthorizations', - 'method_account.getPassword' => 'Get The current password', - 'method_account.getPasswordSettings' => 'Get The current 2FA settings', + 'method_account.getPassword' => 'Get the current password', + 'method_account.getPasswordSettings' => 'Get the current 2FA settings', 'method_account.getPasswordSettings_param_current_password_hash_type_bytes' => 'Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()[\'current_salt\']; $current_password_hash = hash(\'sha256\', $current_salt.$password.$current_salt, true);`', - 'method_account.updatePasswordSettings' => 'Update The 2FA password settings', + 'method_account.updatePasswordSettings' => 'Update the 2FA password settings', 'method_account.updatePasswordSettings_param_current_password_hash_type_bytes' => 'Use only if you have set a 2FA password: `$current_salt = $MadelineProto->account->getPassword()[\'current_salt\']; $current_password_hash = hash(\'sha256\', $current_salt.$password.$current_salt, true);`', 'method_account.updatePasswordSettings_param_new_settings_type_account.PasswordInputSettings' => 'New 2FA settings', 'method_account.sendConfirmPhoneCode' => 'Send confirmation phone code', @@ -4425,12 +4433,12 @@ class Lang 'method_account.resetWebAuthorization_param_hash_type_long' => 'The authorization\'s hash', 'method_account.resetWebAuthorizations' => 'Reset all telegram web login authorizations', 'method_users.getUsers' => 'Get info about users', - 'method_users.getUsers_param_id_type_Vector t' => 'The ids of The users', + 'method_users.getUsers_param_id_type_Vector t' => 'The ids of the users', 'method_users.getFullUser' => 'You cannot use this method directly, use the get_pwr_chat, get_info, get_full_info methods instead (see https://docs.madelineproto.xyz for more info)', 'method_users.getFullUser_param_id_type_InputUser' => 'You cannot use this method directly, use the get_pwr_chat, get_info, get_full_info methods instead (see https://docs.madelineproto.xyz for more info)', 'method_contacts.getStatuses' => 'Get online status of all users', 'method_contacts.getContacts' => 'Get info about a certain contact', - 'method_contacts.getContacts_param_hash_type_int' => '$ids is The list ids of previously fetched contacts, `$hash = $MadelineProto->gen_vector_hash($ids);`', + 'method_contacts.getContacts_param_hash_type_int' => '$ids is the list ids of previously fetched contacts, `$hash = $MadelineProto->gen_vector_hash($ids);`', 'method_contacts.importContacts' => 'Add phone number as contact', 'method_contacts.importContacts_param_contacts_type_Vector t' => 'The numbers to import', 'method_contacts.deleteContact' => 'Delete a contact', @@ -4442,7 +4450,7 @@ class Lang 'method_contacts.unblock' => 'Unblock a user', 'method_contacts.unblock_param_id_type_InputUser' => 'The user to unblock', 'method_contacts.getBlocked' => 'Get blocked users', - 'method_contacts.getBlocked_param_offset_type_int' => 'Initially 0, Then set to The number of blocked contacts previously fetched', + 'method_contacts.getBlocked_param_offset_type_int' => 'Initially 0, Then set to the number of blocked contacts previously fetched', 'method_contacts.getBlocked_param_limit_type_int' => 'How many blocked contacts to fetch', 'method_contacts.exportCard' => 'Export contact as card', 'method_contacts.importCard' => 'Import card as contact', @@ -4477,7 +4485,7 @@ class Lang 'method_messages.getHistory' => 'Get previous messages of a group', 'method_messages.getHistory_param_peer_type_InputPeer' => 'The chat', 'method_messages.getHistory_param_offset_id_type_int' => 'The last fetched message ID, initially 0', - 'method_messages.getHistory_param_offset_date_type_int' => 'The date of The last previously fetched message, initially 0', + 'method_messages.getHistory_param_offset_date_type_int' => 'The date of the last previously fetched message, initially 0', 'method_messages.getHistory_param_add_offset_type_int' => 'Additional offset, can be 0', 'method_messages.getHistory_param_limit_type_int' => 'Number of messages to fetch', 'method_messages.getHistory_param_max_id_type_int' => 'Maximum message ID to fetch', @@ -4503,7 +4511,7 @@ class Lang 'method_messages.deleteHistory_param_peer_type_InputPeer' => 'Where to clear it', 'method_messages.deleteHistory_param_max_id_type_int' => 'Maximum message id of messages to delete', 'method_messages.deleteMessages' => 'Delete messages', - 'method_messages.deleteMessages_param_revoke_type_true' => 'Delete The messages for everyone?', + 'method_messages.deleteMessages_param_revoke_type_true' => 'Delete the messages for everyone?', 'method_messages.deleteMessages_param_id_type_Vector t' => 'IDs of messages to delete, use channels->deleteMessages for supergroups', 'method_messages.receivedMessages' => 'Mark messages as read', 'method_messages.receivedMessages_param_max_id_type_int' => 'Maximum message id of messages to mark as read', @@ -4514,7 +4522,7 @@ class Lang 'method_messages.sendMessage_param_no_webpage_type_true' => 'Disable webpage preview?', 'method_messages.sendMessage_param_silent_type_true' => 'Disable notifications?', 'method_messages.sendMessage_param_background_type_true' => 'Disable background notifications?', - 'method_messages.sendMessage_param_clear_draft_type_true' => 'Clear The message draft of this chat?', + 'method_messages.sendMessage_param_clear_draft_type_true' => 'Clear the message draft of this chat?', 'method_messages.sendMessage_param_peer_type_InputPeer' => 'The chat where to send this message', 'method_messages.sendMessage_param_reply_to_msg_id_type_int' => 'Reply to message by ID', 'method_messages.sendMessage_param_message_type_string' => 'The message to send', @@ -4523,8 +4531,8 @@ class Lang 'method_messages.sendMedia' => 'Send a media', 'method_messages.sendMedia_param_silent_type_true' => 'Disable notifications?', 'method_messages.sendMedia_param_background_type_true' => 'Disable background notifications?', - 'method_messages.sendMedia_param_clear_draft_type_true' => 'Clear The message draft of this chat?', - 'method_messages.sendMedia_param_peer_type_InputPeer' => 'Where to send The media', + 'method_messages.sendMedia_param_clear_draft_type_true' => 'Clear the message draft of this chat?', + 'method_messages.sendMedia_param_peer_type_InputPeer' => 'Where to send the media', 'method_messages.sendMedia_param_reply_to_msg_id_type_int' => 'Reply to message by ID', 'method_messages.sendMedia_param_media_type_InputMedia' => 'The media to send', 'method_messages.sendMedia_param_message_type_string' => 'The caption', @@ -4535,34 +4543,34 @@ class Lang 'method_messages.forwardMessages_param_background_type_true' => 'Disable background notifications', 'method_messages.forwardMessages_param_with_my_score_type_true' => 'If forwarding a game, forward your score, too', 'method_messages.forwardMessages_param_grouped_type_true' => 'Set to true if forwarding albums', - 'method_messages.forwardMessages_param_from_peer_type_InputPeer' => 'From where to forward The messages', + 'method_messages.forwardMessages_param_from_peer_type_InputPeer' => 'From where to forward the messages', 'method_messages.forwardMessages_param_id_type_Vector t' => 'The message IDs', - 'method_messages.forwardMessages_param_to_peer_type_InputPeer' => 'Where to forward The messages', + 'method_messages.forwardMessages_param_to_peer_type_InputPeer' => 'Where to forward the messages', 'method_messages.reportSpam' => 'Report a peer for spam', 'method_messages.reportSpam_param_peer_type_InputPeer' => 'The peer to report', 'method_messages.hideReportSpam' => 'Hide report spam popup', - 'method_messages.hideReportSpam_param_peer_type_InputPeer' => 'Where to hide The popup', - 'method_messages.getPeerSettings' => 'Get The settings of apeer', + 'method_messages.hideReportSpam_param_peer_type_InputPeer' => 'Where to hide the popup', + 'method_messages.getPeerSettings' => 'Get the settings of apeer', 'method_messages.getPeerSettings_param_peer_type_InputPeer' => 'The peer', 'method_messages.getChats' => 'Get info about chats', 'method_messages.getChats_param_id_type_Vector t' => 'The MTProto IDs of chats to fetch info about', 'method_messages.getFullChat' => 'You cannot use this method directly, use the get_pwr_chat, get_info, get_full_info methods instead (see https://docs.madelineproto.xyz for more info)', 'method_messages.getFullChat_param_chat_id_type_InputPeer' => 'You cannot use this method directly, use the get_pwr_chat, get_info, get_full_info methods instead (see https://docs.madelineproto.xyz for more info)', - 'method_messages.editChatTitle' => 'Edit The title of a normal chat (not supergroup)', - 'method_messages.editChatTitle_param_chat_id_type_InputPeer' => 'The ID of The chat', + 'method_messages.editChatTitle' => 'Edit the title of a normal chat (not supergroup)', + 'method_messages.editChatTitle_param_chat_id_type_InputPeer' => 'The ID of the chat', 'method_messages.editChatTitle_param_title_type_string' => 'The new title', - 'method_messages.editChatPhoto' => 'Edit The photo of a normal chat (not supergroup)', - 'method_messages.editChatPhoto_param_chat_id_type_InputPeer' => 'The ID of The chat', + 'method_messages.editChatPhoto' => 'Edit the photo of a normal chat (not supergroup)', + 'method_messages.editChatPhoto_param_chat_id_type_InputPeer' => 'The ID of the chat', 'method_messages.editChatPhoto_param_photo_type_InputChatPhoto' => 'The new phto', 'method_messages.addChatUser' => 'Add a user to a normal chat (use channels->inviteToChannel for supergroups)', 'method_messages.addChatUser_param_chat_id_type_InputPeer' => 'The chat where to invite users', 'method_messages.addChatUser_param_user_id_type_InputUser' => 'The user to invite', - 'method_messages.addChatUser_param_fwd_limit_type_int' => 'Number of old messages The user will see', + 'method_messages.addChatUser_param_fwd_limit_type_int' => 'Number of old messages the user will see', 'method_messages.deleteChatUser' => 'Delete a user from a chat (not supergroup)', - 'method_messages.deleteChatUser_param_chat_id_type_InputPeer' => 'The ID of The chat', - 'method_messages.deleteChatUser_param_user_id_type_InputUser' => 'The user to delete (pass @me to leave The chat)', + 'method_messages.deleteChatUser_param_chat_id_type_InputPeer' => 'The ID of the chat', + 'method_messages.deleteChatUser_param_user_id_type_InputUser' => 'The user to delete (pass @me to leave the chat)', 'method_messages.createChat' => 'Create a chat (not supergroup)', - 'method_messages.createChat_param_users_type_Vector t' => 'The users to add to The chat', + 'method_messages.createChat_param_users_type_Vector t' => 'The users to add to the chat', 'method_messages.createChat_param_title_type_string' => 'The new chat\'s title', 'method_messages.getDhConfig' => 'You cannot use this method directly, instead use $MadelineProto->get_dh_config();', 'method_messages.getDhConfig_param_version_type_int' => 'You cannot use this method directly, instead use $MadelineProto->get_dh_config();', @@ -4577,20 +4585,20 @@ class Lang 'method_messages.discardEncryption' => 'You cannot use this method directly, see https://docs.madelineproto.xyz for more info on handling secret chats', 'method_messages.discardEncryption_param_chat_id_type_int' => 'You cannot use this method directly, see https://docs.madelineproto.xyz for more info on handling secret chats', 'method_messages.setEncryptedTyping' => 'Send typing notification to secret chat', - 'method_messages.setEncryptedTyping_param_peer_type_InputEncryptedChat' => 'The secret chat where to send The notification', - 'method_messages.setEncryptedTyping_param_typing_type_Bool' => 'Set to true to enable The notification, false to disable it', + 'method_messages.setEncryptedTyping_param_peer_type_InputEncryptedChat' => 'The secret chat where to send the notification', + 'method_messages.setEncryptedTyping_param_typing_type_Bool' => 'Set to true to enable the notification, false to disable it', 'method_messages.readEncryptedHistory' => 'Mark messages as read in secret chats', 'method_messages.readEncryptedHistory_param_peer_type_InputEncryptedChat' => 'The secret chat where to mark messages as read', 'method_messages.readEncryptedHistory_param_max_date_type_int' => 'Maximum date of messages to mark', 'method_messages.sendEncrypted' => 'Send message to secret chat', - 'method_messages.sendEncrypted_param_peer_type_InputEncryptedChat' => 'The chat where to send The message', + 'method_messages.sendEncrypted_param_peer_type_InputEncryptedChat' => 'The chat where to send the message', 'method_messages.sendEncrypted_param_message_type_DecryptedMessage' => 'The message to send', 'method_messages.sendEncryptedFile' => 'Send a file to a secret chat', - 'method_messages.sendEncryptedFile_param_peer_type_InputEncryptedChat' => 'The chat where to send The file', - 'method_messages.sendEncryptedFile_param_message_type_DecryptedMessage' => 'The message with The file', + 'method_messages.sendEncryptedFile_param_peer_type_InputEncryptedChat' => 'The chat where to send the file', + 'method_messages.sendEncryptedFile_param_message_type_DecryptedMessage' => 'The message with the file', 'method_messages.sendEncryptedFile_param_file_type_InputEncryptedFile' => 'The file (optional)', 'method_messages.sendEncryptedService' => 'Send a service message to a secret chat', - 'method_messages.sendEncryptedService_param_peer_type_InputEncryptedChat' => 'The chat where to send The service message', + 'method_messages.sendEncryptedService_param_peer_type_InputEncryptedChat' => 'The chat where to send the service message', 'method_messages.sendEncryptedService_param_message_type_DecryptedMessage' => 'The service message', 'method_messages.receivedQueue' => 'You cannot use this method directly', 'method_messages.receivedQueue_param_max_qts_type_int' => 'You cannot use this method directly', @@ -4621,10 +4629,10 @@ class Lang 'method_messages.uninstallStickerSet_param_stickerset_type_InputStickerSet' => 'The sticker set to remove', 'method_messages.startBot' => 'Start a bot', 'method_messages.startBot_param_bot_type_InputUser' => 'The bot\'s ID or username', - 'method_messages.startBot_param_peer_type_InputPeer' => 'Where to start The bot (@me or group ID/username)', + 'method_messages.startBot_param_peer_type_InputPeer' => 'Where to start the bot (@me or group ID/username)', 'method_messages.startBot_param_start_param_type_string' => 'The bot\'s start parameter', 'method_messages.getMessagesViews' => 'Get and increase message views', - 'method_messages.getMessagesViews_param_peer_type_InputPeer' => 'The chat where The message is located', + 'method_messages.getMessagesViews_param_peer_type_InputPeer' => 'The chat where the message is located', 'method_messages.getMessagesViews_param_id_type_Vector t' => 'The IDs messages to get', 'method_messages.getMessagesViews_param_increment_type_Bool' => 'Increase message views?', 'method_messages.toggleChatAdmins' => 'Enable all users are admins in normal groups (not supergroups)', @@ -4633,14 +4641,14 @@ class Lang 'method_messages.editChatAdmin' => 'Edit admin permissions', 'method_messages.editChatAdmin_param_chat_id_type_InputPeer' => 'The chat ID (no supergroups)', 'method_messages.editChatAdmin_param_user_id_type_InputUser' => 'The user ID', - 'method_messages.editChatAdmin_param_is_admin_type_Bool' => 'Should The user be admin?', + 'method_messages.editChatAdmin_param_is_admin_type_Bool' => 'Should the user be admin?', 'method_messages.migrateChat' => 'Convert chat to supergroup', 'method_messages.migrateChat_param_chat_id_type_InputPeer' => 'The chat to convert', 'method_messages.searchGlobal' => 'Global message search', 'method_messages.searchGlobal_param_q_type_string' => 'The query', - 'method_messages.searchGlobal_param_offset_date_type_int' => '0 or The date offset', - 'method_messages.searchGlobal_param_offset_peer_type_InputPeer' => '0 or The peer offset', - 'method_messages.searchGlobal_param_offset_id_type_int' => '0 or The message ID offset', + 'method_messages.searchGlobal_param_offset_date_type_int' => '0 or the date offset', + 'method_messages.searchGlobal_param_offset_peer_type_InputPeer' => '0 or the peer offset', + 'method_messages.searchGlobal_param_offset_id_type_int' => '0 or the message ID offset', 'method_messages.searchGlobal_param_limit_type_int' => 'The number of results to return', 'method_messages.reorderStickerSets' => 'Reorder sticker sets', 'method_messages.reorderStickerSets_param_masks_type_true' => 'Reorder masks?', @@ -4648,7 +4656,7 @@ class Lang 'method_messages.getDocumentByHash' => 'Get document by SHA256 hash', 'method_messages.getDocumentByHash_param_sha256_type_bytes' => '`hash(\'sha256\', $filename, true);`', 'method_messages.getDocumentByHash_param_size_type_int' => 'The file size', - 'method_messages.getDocumentByHash_param_mime_type_type_string' => 'The mime type of The file', + 'method_messages.getDocumentByHash_param_mime_type_type_string' => 'The mime type of the file', 'method_messages.searchGifs' => 'Search gifs', 'method_messages.searchGifs_param_q_type_string' => 'The search query', 'method_messages.searchGifs_param_offset_type_int' => 'The offset ', @@ -4656,14 +4664,14 @@ class Lang 'method_messages.getSavedGifs_param_hash_type_int' => '0 or $result[\'hash\']', 'method_messages.saveGif' => 'Save a GIF', 'method_messages.saveGif_param_id_type_InputDocument' => 'The GIF to save', - 'method_messages.saveGif_param_unsave_type_Bool' => 'Remove The gif?', + 'method_messages.saveGif_param_unsave_type_Bool' => 'Remove the gif?', 'method_messages.getInlineBotResults' => 'Call inline bot', 'method_messages.getInlineBotResults_param_bot_type_InputUser' => 'The bot to call', - 'method_messages.getInlineBotResults_param_peer_type_InputPeer' => 'The chat where to call The bot', + 'method_messages.getInlineBotResults_param_peer_type_InputPeer' => 'The chat where to call the bot', 'method_messages.getInlineBotResults_param_geo_point_type_InputGeoPoint' => 'The current location', - 'method_messages.getInlineBotResults_param_query_type_string' => 'The query to send to The bot', - 'method_messages.getInlineBotResults_param_offset_type_string' => 'The offset to send to The bot', - 'method_messages.setInlineBotResults' => 'Bots only: set The results of an inline query', + 'method_messages.getInlineBotResults_param_query_type_string' => 'The query to send to the bot', + 'method_messages.getInlineBotResults_param_offset_type_string' => 'The offset to send to the bot', + 'method_messages.setInlineBotResults' => 'Bots only: set the results of an inline query', 'method_messages.setInlineBotResults_param_gallery_type_true' => 'Is this a gallery?', 'method_messages.setInlineBotResults_param_private_type_true' => 'Is this result private (not cached)?', 'method_messages.setInlineBotResults_param_query_id_type_long' => 'Query ID', @@ -4671,11 +4679,11 @@ class Lang 'method_messages.setInlineBotResults_param_cache_time_type_int' => 'Cache time', 'method_messages.setInlineBotResults_param_next_offset_type_string' => 'The next offset', 'method_messages.setInlineBotResults_param_switch_pm_type_InlineBotSwitchPM' => 'Switch to PM?', - 'method_messages.sendInlineBotResult' => 'Send a received bot result to The chat', + 'method_messages.sendInlineBotResult' => 'Send a received bot result to the chat', 'method_messages.sendInlineBotResult_param_silent_type_true' => 'Disable notifications?', 'method_messages.sendInlineBotResult_param_background_type_true' => 'Disable background notifications?', - 'method_messages.sendInlineBotResult_param_clear_draft_type_true' => 'Clear The message draft?', - 'method_messages.sendInlineBotResult_param_peer_type_InputPeer' => 'Where to send The message', + 'method_messages.sendInlineBotResult_param_clear_draft_type_true' => 'Clear the message draft?', + 'method_messages.sendInlineBotResult_param_peer_type_InputPeer' => 'Where to send the message', 'method_messages.sendInlineBotResult_param_reply_to_msg_id_type_int' => 'Reply to message by ID', 'method_messages.sendInlineBotResult_param_query_id_type_long' => 'The inline query ID', 'method_messages.sendInlineBotResult_param_id_type_string' => 'The result ID', @@ -4699,12 +4707,12 @@ class Lang 'method_messages.editInlineBotMessage_param_reply_markup_type_ReplyMarkup' => 'The new keyboard', 'method_messages.editInlineBotMessage_param_entities_type_Vector t' => 'The new entities (for styled text)', 'method_messages.editInlineBotMessage_param_geo_point_type_InputGeoPoint' => 'The new location', - 'method_messages.getBotCallbackAnswer' => 'Get The callback answer of a bot (after clicking a button)', + 'method_messages.getBotCallbackAnswer' => 'Get the callback answer of a bot (after clicking a button)', 'method_messages.getBotCallbackAnswer_param_game_type_true' => 'Is this a game?', 'method_messages.getBotCallbackAnswer_param_peer_type_InputPeer' => 'The chat', 'method_messages.getBotCallbackAnswer_param_msg_id_type_int' => 'The message ID', - 'method_messages.getBotCallbackAnswer_param_data_type_bytes' => 'The data to send to The bot', - 'method_messages.setBotCallbackAnswer' => 'Bots only: set The callback answer (after a button was clicked)', + 'method_messages.getBotCallbackAnswer_param_data_type_bytes' => 'The data to send to the bot', + 'method_messages.setBotCallbackAnswer' => 'Bots only: set the callback answer (after a button was clicked)', 'method_messages.setBotCallbackAnswer_param_alert_type_true' => 'Is this an alert?', 'method_messages.setBotCallbackAnswer_param_query_id_type_long' => 'The query ID', 'method_messages.setBotCallbackAnswer_param_message_type_string' => 'The message', @@ -4729,7 +4737,7 @@ class Lang 'method_messages.saveRecentSticker' => 'Add a sticker to recent stickers', 'method_messages.saveRecentSticker_param_attached_type_true' => 'Get stickers attached to image?', 'method_messages.saveRecentSticker_param_id_type_InputDocument' => 'The sticker', - 'method_messages.saveRecentSticker_param_unsave_type_Bool' => 'Remove The sticker from recent stickers?', + 'method_messages.saveRecentSticker_param_unsave_type_Bool' => 'Remove the sticker from recent stickers?', 'method_messages.clearRecentStickers' => 'Clear all recent stickers', 'method_messages.clearRecentStickers_param_attached_type_true' => 'Clear recent stickers attached to images?', 'method_messages.getArchivedStickers' => 'Get all archived stickers', @@ -5059,8 +5067,8 @@ class Lang 'method_langpack.getDifference' => '', 'method_langpack.getDifference_param_from_version_type_int' => '', 'method_langpack.getLanguages' => '', - 'method_auth.sendCode_param_sms_type_type_int' => 'You cannot use this method directly, use The phone_login method instead (see https://docs.madelineproto.xyz for more info)', - 'method_auth.sendCode_param_lang_code_type_string' => 'You cannot use this method directly, use The phone_login method instead (see https://docs.madelineproto.xyz for more info)', + 'method_auth.sendCode_param_sms_type_type_int' => 'You cannot use this method directly, use the phone_login method instead (see https://docs.madelineproto.xyz for more info)', + 'method_auth.sendCode_param_lang_code_type_string' => 'You cannot use this method directly, use the phone_login method instead (see https://docs.madelineproto.xyz for more info)', 'method_auth.sendCall' => '', 'method_auth.sendCall_param_phone_number_type_string' => '', 'method_auth.sendCall_param_phone_code_hash_type_string' => '', @@ -5221,10 +5229,10 @@ class Lang 'method_contest.saveDeveloperInfo_param_phone_number_type_string' => '', 'method_contest.saveDeveloperInfo_param_age_type_int' => '', 'method_contest.saveDeveloperInfo_param_city_type_string' => '', - 'method_auth.importBotAuthorization_param_a_type_true' => 'You cannot use this method directly, use The bot_login method instead (see https://docs.madelineproto.xyz for more info)', - 'method_auth.importBotAuthorization_param_b_type_true' => 'You cannot use this method directly, use The bot_login method instead (see https://docs.madelineproto.xyz for more info)', - 'method_auth.importBotAuthorization_param_c_type_true' => 'You cannot use this method directly, use The bot_login method instead (see https://docs.madelineproto.xyz for more info)', - 'method_auth.importBotAuthorization_param_d_type_true' => 'You cannot use this method directly, use The bot_login method instead (see https://docs.madelineproto.xyz for more info)', + 'method_auth.importBotAuthorization_param_a_type_true' => 'You cannot use this method directly, use the bot_login method instead (see https://docs.madelineproto.xyz for more info)', + 'method_auth.importBotAuthorization_param_b_type_true' => 'You cannot use this method directly, use the bot_login method instead (see https://docs.madelineproto.xyz for more info)', + 'method_auth.importBotAuthorization_param_c_type_true' => 'You cannot use this method directly, use the bot_login method instead (see https://docs.madelineproto.xyz for more info)', + 'method_auth.importBotAuthorization_param_d_type_true' => 'You cannot use this method directly, use the bot_login method instead (see https://docs.madelineproto.xyz for more info)', 'object_vector' => '', 'object_resPQ' => '', 'object_resPQ_param_nonce_type_int128' => '', @@ -8062,5 +8070,13 @@ class Lang 'object_help.configSimple_param_dc_id_type_int' => '', 'object_help.configSimple_param_ip_port_list_type_Vector t' => '', 'object_inputMessagesFilterMyMentionsUnread' => '', + 'method_account.registerDevice_param_other_uids_type_Vector t' => '', + 'method_account.unregisterDevice_param_other_uids_type_Vector t' => '', + 'object_inputReportReasonOther' => '', + 'object_inputReportReasonOther_param_text_type_string' => '', + 'object_updates.difference_param_other_updates_type_Vector t' => '', + 'object_updates.differenceSlice_param_other_updates_type_Vector t' => '', + 'object_updates.channelDifference_param_other_updates_type_Vector t' => '', + 'object_langPackStringPluralized_param_other_value_type_string' => '', ); -} \ No newline at end of file +}