Оставляет истории в профиле аккаунта после того, как они ушли из активных, — в разделе «Публикации». Можно закрепить их вверху или убрать из профиля.
| Запрос | POST /waInstance{idInstance}/pinStory/{apiTokenInstance} |
| Тело | JSON |
| Каналы | Telegram |
Параметры
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
storyIds |
array или string | да | id своих историй — массивом или через запятую. Одну можно передать в storyId |
pinned |
boolean | нет | true — в «Публикации», по умолчанию; false — убрать оттуда |
toTop |
boolean | нет | закрепить вверху «Публикаций», по умолчанию false. Работает при pinned: true |
Пример запроса
Добавить историю в профиль и закрепить вверху:
curl
curl -X POST "$GRATIO_URL/waInstance$GRATIO_ID/pinStory/$GRATIO_TOKEN" \
-H 'Content-Type: application/json' \
-d '{"storyIds": ["2"], "pinned": true, "toTop": true}'
Python
import os
import requests
BASE = f"{os.environ['GRATIO_URL']}/waInstance{os.environ['GRATIO_ID']}"
TOKEN = os.environ["GRATIO_TOKEN"]
url = f"{BASE}/pinStory/{TOKEN}"
payload = {"storyIds": ["2"], "pinned": True, "toTop": True}
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}/pinStory/${GRATIO_TOKEN}`;
const payload = { storyIds: ["2"], pinned: true, toTop: true };
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 . '/pinStory/' . getenv('GRATIO_TOKEN');
$payload = ['storyIds' => ['2'], 'pinned' => true, 'toTop' => true];
$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:
{"pinStory": true}
Telegram отказал — тоже 200, с false и причиной в reason.
Поля ответа
| Поле | Тип | Описание |
|---|---|---|
pinStory |
boolean | true — готово |
reason |
string | только при false: код и текст причины |
Ещё примеры
Убрать из профиля
curl -X POST "$GRATIO_URL/waInstance$GRATIO_ID/pinStory/$GRATIO_TOKEN" \
-H 'Content-Type: application/json' \
-d '{"storyId": "2", "pinned": false}'
Ошибки
| Код | code |
Когда | Что делать |
|---|---|---|---|
400 |
validation |
нет ни storyIds, ни storyId |
добавить поле |
400 |
not_authorized |
канал не на связи | проверить getStateInstance |
501 |
not_supported |
MAX, WhatsApp или почта | — |
Что дальше
- getStories —
type: "posts": что сейчас в «Публикациях». - sendStory —
pinToProfile: в профиль сразу при публикации. - Истории Telegram — правила.
