MadelineProtoDocs/old_docs/API_docs_v55/methods/messages.checkChatInvite.md

56 lines
1.5 KiB
Markdown
Raw Normal View History

2019-06-23 13:07:51 +02:00
---
title: messages.checkChatInvite
2019-12-27 17:48:04 +01:00
description: Check the validity of a chat invite link and get basic info about it
2019-06-23 13:07:51 +02:00
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
2019-12-27 18:46:25 +01:00
redirect_from: /API_docs/methods/messages_checkChatInvite.html
2019-06-23 13:07:51 +02:00
---
# Method: messages.checkChatInvite
[Back to methods index](index.md)
2019-12-27 17:48:04 +01:00
Check the validity of a chat invite link and get basic info about it
2019-06-23 13:07:51 +02:00
### Parameters:
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
2019-12-27 17:48:04 +01:00
|hash|[string](../types/string.md) | Invite hash in `t.me/joinchat/hash` | Yes|
2019-06-23 13:07:51 +02:00
### Return type: [ChatInvite](../types/ChatInvite.md)
### Can bots use this method: **NO**
### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)):
```php
if (!file_exists('madeline.php')) {
copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php');
}
include 'madeline.php';
$MadelineProto = new \danog\MadelineProto\API('session.madeline');
$MadelineProto->start();
$ChatInvite = $MadelineProto->messages->checkChatInvite(['hash' => 'string', ]);
```
Or, if you're into Lua:
```lua
ChatInvite = messages.checkChatInvite({hash='string', })
```
2019-09-02 17:41:28 +02:00
### Errors
2019-06-23 13:07:51 +02:00
2019-09-02 17:41:28 +02:00
| Code | Type | Description |
|------|----------|---------------|
|400|INVITE_HASH_EMPTY|The invite hash is empty|
|400|INVITE_HASH_EXPIRED|The invite link has expired|
|400|INVITE_HASH_INVALID|The invite hash is invalid|
2019-10-29 19:02:30 +01:00
|401|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login|
2019-06-23 13:07:51 +02:00