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

ShowMessagesQueue#

Test Postman Apidog

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

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

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

Запрос#

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

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

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

Ответ#

Поля ответа#

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

Поле Тип Описание
messageID string ID сообщения, если type = sendMessage/sendPoll/sendFileByUrl/sendLocation/sendContact/sendTextStatus/sendMediaStatus/sendVoiceStatus
messagesIDs array Массив ID сообщений, если type = ForwardMessages
type string Тип запроса:
sendMessage - текстовое сообщение
body object Объект данных о сообщении в очереди

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

Поле Тип Описание
chatId string Идентификатор чата в который сообщение будет отправлено
message string Текст сообщения, если type = sendMessage/sendPoll/sendFileByUrl/sendLocation/sendContact /sendTextStatus
messages array Массив пересылаемых сообщений, если type = ForwardMessages
linkPreview boolean Параметр включает отображение превью и описание ссылки, если type = sendMessage/sendTextStatus
urlLink string URL отправляемой ссылки, если type = sendLink (Не используется)

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

Поле Тип Описание
title string Заголовок превью (до 300 символов)
description string Описание (до 300 символов)
link string Доменное имя сайта со ссылкой (до 300 символов)
urlFile string Ссылка на файл с картинкой для создания большого превью
jpegThumbnail string Предпросмотр изображения в base64

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

[
    {
        "messageID": "2755255162705",
        "type": "sendMessage",
        "body": {
            "chatId": "79240778788",
            "message": "test",
            "linkPreview": false,
            "typingTime": null,
            "typePreview": "small"
        }
    },
]

Ошибки ShowMessagesQueue#

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

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

import requests

url = "{{apiUrl}}/v3/waInstance{{idInstance}}/showMessagesQueue/{{apiTokenInstance}}"

payload = {}
headers= {}

response = requests.request("GET", url, headers=headers, data = payload)

print(response.text.encode('utf8'))
curl --location '{{apiUrl}}/v3/waInstance{{idInstance}}/showMessagesQueue/{{apiTokenInstance}}'
var restTemplate = new RestTemplate();
var requestUrl = new StringBuilder();
requestUrl
    .append({{apiUrl}})
    .append("/v3/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("/v3/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}}/v3/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