GetAllowedReactions#
Бета-версия
Функциональность находится в режиме бета-версии. Функции могут быть изменены, а также могут работать нестабильно.
Метод предназначен для получения списка доступных реакций в мессенджере.
Запрос#
Для получения списка доступных реакций требуется выполнить запрос по адресу:
GET
{{apiUrl}}/waInstance{{idInstance}}/getAllowedReactions/{{apiTokenInstance}}
Префикс v3 стал необязательным параметром запроса
Для вашего удобства унифицировали формат запросов методов API для всех мессенджеров.
Подробнее о правилах вызова методов читайте в статье Выполнение запросов.
Для получения параметров запроса apiUrl, idInstance и apiTokenInstance обратитесь к разделу Перед началом работы.
Параметры URL запроса#
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
chatId | string | Нет | При указании идентификатора чата метод отдаст набор реакций, доступных для указанного чата. По умолчанию показывает все доступные реакции в мессенджере MAX |
Пример тела запроса#
{
"chatId": "10000000"
}
Ответ#
Поля ответа#
| Поле | Тип | Описание |
|---|---|---|
reactions | object | Объект данных с реакциями |
Поля объекта reactions#
| Поле | Тип | Описание |
|---|---|---|
quick | object | Объект данных категории с быстрыми реакциями |
default | object | Объект данных категории со стандартными реакциями |
animalsNature | object | Объект данных категории "Животные и природа" |
foodDrink | object | Объект данных категории "Еда и напитки" |
activity | object | Объект данных категории "Активность" |
travelPlaces | object | Объект данных категории "Путешествия" |
objects | object | Объект данных категории "Объекты" |
symbols | object | Объект данных категории "Символы" |
flags | object | Объект данных категории "Флаги" |
custom | object | Объект данных категории с кастомными реакциями |
Поля объекта категории#
| Поле | Тип | Описание |
|---|---|---|
reaction | string | Эмодзи реакции |
unicode | string | Реакция в юникод-формате |
Пример тела ответа#
{
"reactions": {
"quick": [
{
"reaction": "❤",
"unicode": "\\u2764"
},
{
"reaction": "👍",
"unicode": "\\uD83D\\uDC4D"
},
{
"reaction": "👎",
"unicode": "\\uD83D\\uDC4E"
},
{
"reaction": "🔥",
"unicode": "\\uD83D\\uDD25"
},
{
"reaction": "🥰",
"unicode": "\\uD83E\\uDD70"
},
{
"reaction": "👏",
"unicode": "\\uD83D\\uDC4F"
}
],
"default": [
{
"reaction": "❤",
"unicode": "\\u2764"
},
{
"reaction": "👍",
"unicode": "\\uD83D\\uDC4D"
},
{
"reaction": "👎",
"unicode": "\\uD83D\\uDC4E"
},
{
"reaction": "🔥",
"unicode": "\\uD83D\\uDD25"
},
{
"reaction": "🤷♂",
"unicode": "\\uD83E\\uDD37\\u200D\\u2642"
},
{
"reaction": "🤷",
"unicode": "\\uD83E\\uDD37"
},
{
"reaction": "🤷♀",
"unicode": "\\uD83E\\uDD37\\u200D\\u2640"
},
{
"reaction": "😡",
"unicode": "\\uD83D\\uDE21"
}
],
"animalsNature": [],
"foodDrink": [],
"activity": [],
"travelPlaces": [],
"objects": [],
"symbols": [],
"flags": [],
"custom": []
}
}
Ошибки GetAllowedReactions#
Перечень общих для всех методов ошибок смотрите в разделе Стандартные ошибки
Примеры кода#
import requests
url = "{{apiUrl}}/waInstance{{idInstance}}/getAllowedReactions/{{apiTokenInstance}}"
payload = {
"chatId": "10000000"
}
headers = {'Content-Type': 'application/json'}
response = requests.post(url, json=payload)
print(response.text.encode('utf8'))
curl --location '{{apiUrl}}/waInstance{{idInstance}}/getAllowedReactions/{{apiTokenInstance}}'
--header 'Content-Type: application/json' \
--data-raw '{
"chatId": "10000000"
}'
var restTemplate = new RestTemplate();
var requestUrl = new StringBuilder();
requestUrl
.append({{apiUrl}})
.append("/waInstance").append({{idInstance}})
.append("/getAllowedReactions/")
.append({{apiTokenInstance}});
var headers = new HttpHeaders();
headers.setContentType(MediaType.APPLICATION_JSON);
var jsonBody = "{\"chatId\": \"10000000\"}";
var requestEntity = new HttpEntity<>(jsonBody, headers);
var response = restTemplate.exchange(requestUrl.toString(), HttpMethod.GET, null, String.class);
System.out.println(response);
var requestUrl = new StringBuilder();
requestUrl
.append({{apiUrl}})
.append("/waInstance").append({{idInstance}})
.append("/getAllowedReactions/")
.append({{apiTokenInstance}});
var response = Unirest.post(requestUrl.toString())
.header("Content-Type", "application/json")
.body("{\"chatId\": \"10000000\"}")
.asString();
System.out.println(response);
Sub GetAllowedReactions()
Dim url As String
Dim http As Object
Dim response As String
' The apiUrl, idInstance and apiTokenInstance values are available in console, double brackets must be removed
url = "{{apiUrl}}/waInstance{{idInstance}}/getAllowedReactions/{{apiTokenInstance}}"
'chatId - personal or group chat identifier whose message history you want to receive, count - number of messages to receive, default value 100
RequestBody = "{""chatId"":""10000000""}"
Set http = CreateObject("MSXML2.XMLHTTP")
http.Open "GET", url, False
http.Send
response = http.responseText
Debug.Print response
' Outputting the answer to the desired cell
Range("A1").Value = response
Set http = Nothing
End Sub