2024-06-05 12:19:46 +02:00
|
|
|
---
|
|
|
|
|
sidebar_position: 3
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
# Create invitation link
|
|
|
|
|
Creates a link for joining a closed chat
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
*Function CreateInvitationLink(Val Token, Val ChatID, Val Title = "", Val ExpirationDate = "", Val UserLimit = 0) Export*
|
|
|
|
|
|
|
|
|
|
| Parameter | CLI option | Type | Destination |
|
|
|
|
|
|-|-|-|-|
|
|
|
|
|
| Token | --token | String | Bot token |
|
|
|
|
|
| ChatID | --chat | String, Number | Target chat ID or ChatID*TopicID |
|
|
|
|
|
| Title | --title | String | Invitation title |
|
|
|
|
|
| ExpirationDate | --expire | Date | Link expiration date (permanent if not specified) |
|
|
|
|
|
| UserLimit | --limit | Number | User limit (infinite if not specified) |
|
|
|
|
|
|
|
|
|
|
|
2024-06-06 14:33:52 +02:00
|
|
|
Returns: Map Of KeyAndValue - Serialized JSON response from Telegram
|
2024-06-05 12:19:46 +02:00
|
|
|
|
|
|
|
|
```bsl title="Code example"
|
|
|
|
|
|
|
|
|
|
Token = "6129457865:AAFyzNYOAFbu...";
|
|
|
|
|
ChannelID = "@testsichee";
|
|
|
|
|
Day = 86400;
|
|
|
|
|
CurrentDate = OPI_Tools.GetCurrentDate();
|
2024-06-05 12:35:05 +02:00
|
|
|
|
2024-06-05 12:19:46 +02:00
|
|
|
Title = "Link " + String(CurrentDate);
|
|
|
|
|
Expiration = CurrentDate + Day;
|
|
|
|
|
UnixExpiration = OPI_Tools.UNIXTime(Expiration);
|
|
|
|
|
|
|
|
|
|
Result = OPI_Telegram.CreateInvitationLink(Token, ChannelID, Title, Expiration, 200);
|
2024-06-05 12:35:05 +02:00
|
|
|
|
2024-06-05 12:19:46 +02:00
|
|
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
```sh title="CLI command example"
|
|
|
|
|
|
|
|
|
|
oint telegram CreateInvitationLink --token "6129457865:AAFyzNYOAFbu..." --chat %chat% --title %title% --expire %expire% --limit %limit%
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
```json title="Result"
|
|
|
|
|
|
|
|
|
|
{
|
|
|
|
|
"ok": true,
|
|
|
|
|
"result": {
|
|
|
|
|
"invite_link": "https://t.me/+W-9MzjOejStiYzYy",
|
|
|
|
|
"name": "Link 05/30/2024 12:34:59",
|
|
|
|
|
"creator": {
|
|
|
|
|
"id": 6129457865,
|
|
|
|
|
"is_bot": true,
|
|
|
|
|
"first_name": "Vitaly The Bot",
|
|
|
|
|
"username": "sicheebot"
|
|
|
|
|
},
|
|
|
|
|
"expire_date": 1717155300,
|
|
|
|
|
"member_limit": 200,
|
|
|
|
|
"creates_join_request": false,
|
|
|
|
|
"is_primary": false,
|
|
|
|
|
"is_revoked": false
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
```
|
