Перейти к содержанию

ShowMessagesQueue#

Test Postman

Метод предназначен для получения списка сообщений, находящихся в очереди на отправку.

Сообщения на отправку хранятся в очереди 24 часа.
Отправка сообщений происходит только при статусе инстанса Авторизован.
Скорость отправки сообщений из очереди регулирует параметр Интервал отправки сообщений.

Метод возвращает первые 500 сообщений, добавленные в очередь на отправку.

Для метода используются ограничения на частоту запросов в секунду.

Запрос#

Для получения списка сообщений требуется выполнить запрос по адресу:

GET 
{{apiUrl}}/waInstance{{idInstance}}/showMessagesQueue/{{apiTokenInstance}}

Для получения параметров запроса apiUrl, idInstance и apiTokenInstance обратитесь к разделу Перед началом работы.

Ответ#

Поля ответа#

Массив объектов с полями:

Поле Тип Описание
messageID string ID сообщения
type string Тип запроса: sendMessage/sendFileByUrl/sendLocation/sendPoll
body object Объект данных о сообщении в очереди

Поля объекта body:

Поле Тип Описание
chatId string Идентификатор чата, в который сообщение будет отправлено
message string Текст сообщения

Пример тела ответа#

[
    {
        "messageID": "1762333029830",
        "type": "sendMessage",
        "body": {
            "chatId": "10000000",
            "message": "test"
        }
    }
]

Ошибки#

Перечень общих для всех методов ошибок смотрите в разделе Стандартные ошибки

Примеры кода#

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("/waaInstance").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 apiUrl, idInstance and apiTokenInstance values are available in console, 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