> For the complete documentation index, see [llms.txt](https://painor.gitbook.io/gramjs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://painor.gitbook.io/gramjs/working-with-chats-and-supergroups-and-channels/messages.checkchatinvite.md).

# messages.checkChatInvite

Check the validity of a chat invite link and get basic info about it

## Example

{% tabs %}
{% tab title="Javascript" %}

```javascript
const {Api, TelegramClient} = require('telegram');
const {StringSession} = require('telegram/sessions');

const session = new StringSession('');
const client = new TelegramClient(session, apiId, apiHash, {});

(async function run() {
    const result = await client.invoke(new Api.messages.checkChatInvite({
        hash: 'random string here',
        }));
    console.log(result); // prints the result
})();
```

{% endtab %}

{% tab title="TypeScript" %}

```typescript
import {Api, TelegramClient} from 'telegram';
import {StringSession} from 'telegram/sessions';

const session = new StringSession('');
const client = new TelegramClient(session, apiId, apiHash, {});

(async function run() {
    const result: Api.ChatInvite = await client.invoke(new Api.messages.checkChatInvite({
        hash: 'random string here',
        }));
    console.log(result); // prints the result
})();
```

{% endtab %}
{% endtabs %}

## TL schema

```
chatInviteAlready#5a686d7c chat:Chat = ChatInvite;
chatInvite#dfc2f58e flags:# channel:flags.0?true broadcast:flags.1?true public:flags.2?true megagroup:flags.3?true title:string photo:Photo participants_count:int participants:flags.4?Vector<User> = ChatInvite;
chatInvitePeek#61695cb0 chat:Chat expires:int = ChatInvite;
---functions---
messages.checkChatInvite#3eadb1bb hash:string = ChatInvite;
```

## Parameters

|   Name   | Type                                            | Description                       |
| :------: | ----------------------------------------------- | --------------------------------- |
| **hash** | [string](https://core.telegram.org/type/string) | Invite hash in t.me/joinchat/hash |

## Result

[ChatInvite](https://core.telegram.org/type/ChatInvite)

## Possible errors

| 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  |

## Can bots use this methd ?

### yes

## Related pages


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://painor.gitbook.io/gramjs/working-with-chats-and-supergroups-and-channels/messages.checkchatinvite.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.