ShowMessagesQueue#
Метод предназначен для получения списка сообщений, находящихся в очереди на отправку. Сообщение на отправку хранится 24 часа в очереди и будет отправлено сразу же после авторизации телефона. Скорость отправки сообщений из очереди регулирует параметр Интервал отправки сообщений.
Запрос#
Для получения списка сообщений требуется выполнить запрос по адресу:
GET {{apiUrl}}/waInstance{{idInstance}}/showMessagesQueue/{{apiTokenInstance}}
Для получения параметров запроса idInstance, apiTokenInstance и apiUrl обратитесь к разделу Перед началом работы.
Ответ#
Поля ответа#
Массив объектов с полями:
| Поле | Тип | Описание |
|---|---|---|
messageID | string | ID сообщения, если type = sendMessage/ sendFileByUrl |
type | string | Тип запроса: |
sendMessage - текстовое сообщение | ||
sendFileByUrl - сообщение с файлом (сообщения отправленные методом sendFileByUrl, sendFileByUpload) | ||
body | object | Объект данных о сообщении в очереди |
Поля объекта body:
| Поле | Тип | Описание |
|---|---|---|
chatId | string | Идентификатор чата в который сообщение будет отправлено |
message | string | Текст сообщения, если type = sendMessage/sendFileByUrl |
linkPreview | boolean | Параметр включает отображение превью и описание ссылки, если type = sendMessage |
quotedMessageId | string | Идентификатор цитируемого сообщения, если type = sendMessage/sendFileByUrl |
fileName | string | Имя отправляемого файла, если type = sendFileByUrl |
caption | string | Описание под файлом, если type = sendFileByUrl |
urlFile | string | Ссылка на отправляемый файл type = sendFileByUrl |
archive | string | Поле устарело, если type = sendFileByUrl |
chatIdFrom | string | Идентификатор чата с которого пересылается сообщение |
Поля массива options
| Параметр | Тип | Описание |
|---|---|---|
optionName | string | Текст варинта выбора |
Пример тела ответа#
[
{
"messageID": "BAE123456789",
"type": "sendMessage",
"body": {
"chatId": "11001234567@c.us",
"message": "I use GREEN-API to send this message to you!",
"linkPreview": true
}
},
{
"messageID": "BAE1234567123",
"type": "sendMessage",
"body": {
"chatId": "11001234567@c.us",
"message": "Hello",
"quotedMessageId": "BAE123456789",
"linkPreview": true
}
},
{
"messageID": "BAE1234567789",
"type": "sendFileByUrl",
"body": {
"fileName": "test.jpg",
"chatId": "11001234567@c.us",
"quotedMessageId": "BAE1234567159",
"caption": "caption",
"archive": false,
"urlFile": "https://sw-media-out.storage.yandexcloud.net/1101123456/5005fe15-23ee-43ef-8535-35e1dff8315c.jpg"
}
}
]
Ошибки ShowMessagesQueue#
Перечень общих для всех методов ошибок смотрите в разделе Стандартные ошибки
Примеры кода#
import requests
url = "{{apiUrl}}/waInstance{{idInstance}}/showMessagesQueue/{{apiTokenInstance}}"
payload = {}
headers= {}
response = requests.request("GET", url, headers=headers, data = payload)
print(response.text.encode('utf8'))
curl --location '{{apiUrl}}/waInstance{{idInstance}}/showMessagesQueue/{{apiTokenInstance}}'
var restTemplate = new RestTemplate();
var requestUrl = new StringBuilder();
requestUrl
.append({{apiUrl}})
.append("/waInstance").append({{idInstance}})
.append("/showMessagesQueue/")
.append({{apiTokenInstance}});
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("/showMessagesQueue/")
.append({{apiTokenInstance}});
var response = Unirest.get(requestUrl.toString())
.header("Content-Type", "application/json")
.asString();
System.out.println(response);
Sub ShowMessagesQueue()
Dim url As String
Dim http As Object
Dim response As String
' The idInstance and apiTokenInstance values are available in your account, double brackets must be removed
url = "{{apiUrl}}/waInstance{{idInstance}}/showMessagesQueue/{{apiTokenInstance}}"
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