Создаёт ещё одну ссылку-приглашение рядом с основной: например, отдельную ссылку для рассылки родителям, которая перестанет работать через неделю. Основная ссылка не меняется. Работает только в Telegram, нужны права админа.
| Запрос | POST /waInstance{idInstance}/createInviteLink/{apiTokenInstance} |
| Тело | JSON |
| Каналы | Telegram |
Параметры
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
chatId |
string | да | ваша группа или канал |
joinRequest |
boolean | нет | вход по одобрению админа, по умолчанию false. Нельзя вместе с usageLimit |
expiresAt |
integer | нет | до какого момента ссылка работает, Unix |
usageLimit |
integer | нет | сколько человек могут войти по ссылке |
title |
string | нет | название ссылки для админов, до 32 символов — длиннее обрежется |
Пример запроса
Ссылка для родителей на неделю, не больше 30 входов:
curl
curl -X POST "$GRATIO_URL/waInstance$GRATIO_ID/createInviteLink/$GRATIO_TOKEN" \
-H 'Content-Type: application/json' \
-d '{
"chatId": "-1001234567890",
"expiresAt": 1792428458,
"usageLimit": 30,
"title": "Родители 3А"
}'
Python
import os
import requests
BASE = f"{os.environ['GRATIO_URL']}/waInstance{os.environ['GRATIO_ID']}"
TOKEN = os.environ["GRATIO_TOKEN"]
url = f"{BASE}/createInviteLink/{TOKEN}"
payload = {
"chatId": "-1001234567890",
"expiresAt": 1792428458,
"usageLimit": 30,
"title": "Родители 3А",
}
response = requests.post(url, json=payload, timeout=60)
print(response.status_code, response.json())
Node.js
const { GRATIO_URL, GRATIO_ID, GRATIO_TOKEN } = process.env;
const base = `${GRATIO_URL}/waInstance${GRATIO_ID}`;
const url = `${base}/createInviteLink/${GRATIO_TOKEN}`;
const payload = {
chatId: "-1001234567890",
expiresAt: 1792428458,
usageLimit: 30,
title: "Родители 3А",
};
const response = await fetch(url, {
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify(payload),
});
console.log(response.status, await response.json());
PHP
<?php
$base = getenv('GRATIO_URL') . '/waInstance' . getenv('GRATIO_ID');
$url = $base . '/createInviteLink/' . getenv('GRATIO_TOKEN');
$payload = [
'chatId' => '-1001234567890',
'expiresAt' => 1792428458,
'usageLimit' => 30,
'title' => 'Родители 3А',
];
$ch = curl_init($url);
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_HTTPHEADER => ['Content-Type: application/json'],
CURLOPT_POSTFIELDS => json_encode($payload, JSON_UNESCAPED_UNICODE),
CURLOPT_RETURNTRANSFER => true,
CURLOPT_TIMEOUT => 60,
]);
$response = json_decode(curl_exec($ch), true);
echo curl_getinfo($ch, CURLINFO_HTTP_CODE), PHP_EOL;
print_r($response);
Пример ответа
Ответ 200 OK:
{"chatId": "-1001234567890", "inviteLink": "https://t.me/+QrStUvWxYz012345"}
Поля ответа
| Поле | Тип | Описание |
|---|---|---|
chatId |
string | группа или канал из запроса |
inviteLink |
string | новая дополнительная ссылка |
Ещё примеры
Вход по заявке
Каждого, кто откроет ссылку, одобряет админ — заявки придут в getJoinRequests:
curl -X POST "$GRATIO_URL/waInstance$GRATIO_ID/createInviteLink/$GRATIO_TOKEN" \
-H 'Content-Type: application/json' \
-d '{
"chatId": "-1001234567890",
"joinRequest": true,
"title": "Запись в 3А"
}'
Ошибки
| Код | code |
Когда | Что делать |
|---|---|---|---|
400 |
validation |
нет chatId; expiresAt или usageLimit не число |
исправить запрос |
400 |
not_a_group |
chatId — личный чат |
передать группу или канал |
400 |
bad_invite |
joinRequest: true вместе с usageLimit |
убрать одно из двух |
400 |
admin_required |
аккаунт не админ или без права приглашать | выдать права в приложении |
400 |
invite_failed |
Telegram не выдал ссылку | повторить позже |
400 |
not_authorized |
канал не на связи | проверить getStateInstance |
402 |
payment_required |
канал на паузе за неоплату | продлить канал в кабинете |
501 |
not_supported |
MAX, WhatsApp или почта | — |
Особенности каналов
- Telegram. revokeInviteLink меняет только основную ссылку — дополнительные продолжают работать.
- MAX. У чата одна ссылка, дополнительных нет —
501. Сменить её — revokeInviteLink.
Что дальше
- revokeInviteLink — сменить основную ссылку.
- getJoinRequests — заявки по ссылке с одобрением.
- joinChat — как вступают по приглашению.
