Layer 227
MessagesExportChatInvite
Export an invite link for a chat
method
Users
Bots
messages.exportChatInvite#a455de90 flags:# legacy_revoke_permanent:flags.2?true request_needed:flags.3?true peer:InputPeer expire_date:flags.0?int usage_limit:flags.1?int title:flags.4?string subscription_pricing:flags.5?StarsSubscriptionPricing = ExportedChatInvite;
Parameters
| Name | Type | Description |
|---|---|---|
| LegacyRevokePermanent | flags .2? true | Legacy flag, reproducing legacy behavior of this method: if set, revokes all previous links before creating a new one. Kept for bot API BC, should not be used by modern clients. |
| RequestNeeded | flags .3? true | Whether admin confirmation is required before admitting each separate user into the chat |
| Peer | InputPeer | Chat |
| ExpireDate | flags .0? int | Expiration date |
| UsageLimit | flags .1? int | Maximum number of users that can join using this link |
| Title | flags .4? string | Description of the invite link, visible only to administrators |
| SubscriptionPricing | flags .5? StarsSubscriptionPricing | For Telegram Star subscriptions, contains the pricing of the subscription the user must activate to join the private channel. |
Returns
ExportedChatInviteGogram Example
// MessagesExportChatInvite - using Params struct result, err := client.MessagesExportChatInvite(&tg.MessagesExportChatInviteParams{ LegacyRevokePermanent: nil, RequestNeeded: nil, Peer: &tg.InputPeerUser{UserID: int64(777000)}, ExpireDate: nil, UsageLimit: nil, Title: "Hello, World!", SubscriptionPricing: nil, }) if err != nil { // handle error } // result is *tg.ExportedChatInvite
Possible Errors
| Code | Type | Description |
|---|---|---|
| 400 | CHANNEL_INVALID | The provided channel is invalid. |
| 400 | CHANNEL_MONOFORUM_UNSUPPORTED | Monoforums do not support this feature. |
| 400 | CHANNEL_PRIVATE | You haven't joined this channel/supergroup. |
| 400 | CHAT_ADMIN_REQUIRED | You must be an admin in this chat to do this. |
| 400 | CHAT_ID_INVALID | The provided chat id is invalid. |
| 403 | CHAT_WRITE_FORBIDDEN | You can't write in this chat. |
| 400 | EXPIRE_DATE_INVALID | The specified expiration date is invalid. |
| 400 | INPUT_USER_DEACTIVATED | The specified user was deleted. |
| 400 | MSG_ID_INVALID | Invalid message ID provided. |
| 400 | PEER_ID_INVALID | The provided peer id is invalid. |
| 400 | PRICING_CHAT_INVALID | The pricing for the subscription is invalid, the maximum price is specified in the stars_subscription_amount_max config key. |
| 400 | SUBSCRIPTION_PERIOD_INVALID | The specified subscription_pricing. period is invalid. |
| 400 | USAGE_LIMIT_INVALID | The specified usage limit is invalid. |