MadelineProto/old_docs/API_docs_v73/methods/messages_checkChatInvite.md

66 lines
1.4 KiB
Markdown
Raw Normal View History

---
title: messages.checkChatInvite
description: messages.checkChatInvite parameters, return type and example
---
## Method: messages.checkChatInvite
[Back to methods index](index.md)
### Parameters:
| Name | Type | Required |
|----------|---------------|----------|
|hash|[string](../types/string.md) | Yes|
### Return type: [ChatInvite](../types/ChatInvite.md)
### Can bots use this method: **NO**
### Errors this method can return:
| Error | Description |
|----------|---------------|
|INVITE_HASH_EMPTY|The invite hash is empty|
|INVITE_HASH_EXPIRED|The invite link has expired|
|INVITE_HASH_INVALID|The invite hash is invalid|
### Example:
```
$MadelineProto = new \danog\MadelineProto\API();
$MadelineProto->session = 'mySession.madeline';
if (isset($number)) { // Login as a user
$MadelineProto->phone_login($number);
$code = readline('Enter the code you received: '); // Or do this in two separate steps in an HTTP API
$MadelineProto->complete_phone_login($code);
}
$ChatInvite = $MadelineProto->messages->checkChatInvite(['hash' => 'string', ]);
```
Or, if you're using the [PWRTelegram HTTP API](https://pwrtelegram.xyz):
### As a user:
POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.checkChatInvite`
Parameters:
hash - Json encoded string
Or, if you're into Lua:
```
ChatInvite = messages.checkChatInvite({hash='string', })
```