pinChat и unpinChat

Закрепляют чат наверху списка чатов и открепляют. Работают в WhatsApp. Изменение видно на всех устройствах номера, в том числе на телефоне сотрудника.

Параметры

Оба метода принимают одно поле:

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

Закрепить рабочую группу:

curl

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

Python

import os
import requests

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

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

$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/unpinChat/$GRATIO_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{"chatId": "120363012345678901@g.us"}'

Ошибки

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

• WhatsApp. Закреп — только в списке чатов номера, собеседник его не видит. Закрепить сообщение у всех в чате — pinMessage и unpinMessage.
• MAX, Telegram и почта — 501 not_supported.

Что дальше

• pinMessage и unpinMessage — закрепить сообщение в чате.
• archiveChat и unarchiveChat — убрать чат в архив.