pinMessage и unpinMessage

Закрепляют сообщение у всех участников чата и открепляют. Работают в WhatsApp. Удобно, чтобы держать наверху группы расписание или важное объявление.

Параметры

WhatsApp даёт три срока: 24 часа (86400), 7 дней (604800) и 30 дней (2592000). Другое значение Gratio округляет вверх до ближайшего из них, больше 30 дней — до 30 дней.

Пример запроса

Закрепить объявление в группе на неделю:

curl

curl -X POST "$GRATIO_URL/waInstance$GRATIO_ID/pinMessage/$GRATIO_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
    "chatId": "120363012345678901@g.us",
    "idMessage": "3EB0C767D26A1D5A6F0B",
    "duration": 604800
  }'

Python

import os
import requests

BASE = f"{os.environ['GRATIO_URL']}/waInstance{os.environ['GRATIO_ID']}"
TOKEN = os.environ["GRATIO_TOKEN"]

url = f"{BASE}/pinMessage/{TOKEN}"
payload = {
    "chatId": "120363012345678901@g.us",
    "idMessage": "3EB0C767D26A1D5A6F0B",
    "duration": 604800,
}
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}/pinMessage/${GRATIO_TOKEN}`;
const payload = {
  chatId: "120363012345678901@g.us",
  idMessage: "3EB0C767D26A1D5A6F0B",
  duration: 604800,
};
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 . '/pinMessage/' . getenv('GRATIO_TOKEN');
$payload = [
    'chatId' => '120363012345678901@g.us',
    'idMessage' => '3EB0C767D26A1D5A6F0B',
    'duration' => 604800,
];

$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 — пустой объект, у обоих методов:

{}

Ещё примеры

На сутки в личном чате

Напоминание о занятии наверху чата с Марией:

curl -X POST "$GRATIO_URL/waInstance$GRATIO_ID/pinMessage/$GRATIO_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
    "chatId": "79991234567@c.us",
    "idMessage": "3EB0C767D26A1D5A6F0B",
    "duration": 86400
  }'

Открепить

duration не нужен:

curl -X POST "$GRATIO_URL/waInstance$GRATIO_ID/unpinMessage/$GRATIO_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
    "chatId": "120363012345678901@g.us",
    "idMessage": "3EB0C767D26A1D5A6F0B"
  }'

Ошибки

Особенности каналов

• WhatsApp. Закреп видят все участники чата. Закрепить можно сообщения, которые канал видел с момента привязки, — свои и собеседников.
• MAX, Telegram и почта — 501 not_supported.

Что дальше

• pinChat и unpinChat — закрепить сам чат в списке.
• Группа для клиентов — объявления в группе WhatsApp.
• WhatsApp — особенности канала WhatsApp.