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

ShowMessagesQueue#

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

Запрос#

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

GET https://api.green-api.com/waInstance{{idInstance}}/showMessagesQueue/{{apiTokenInstance}}

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

Ответ#

Поля ответа#

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

Поле Тип Описание
messageID string ID сообщения, если type = sendMessage/locationMessage/contactMessage
messagesIDs array Массив ID сообщений, если type = ForwardMessages
type string Тип запроса:
sendMessage - текстовое сообщение
sendContact - сообщение с контактом
sendFileByUrl - сообщение с файлом (сообщения отправленные методом sendFileByUrl, sendFileByUpload)
sendLink - сообщение с ссылкой
sendLocation - сообщение с геопозицией
ForwardMessages - сообщения к пересылке
body object Объект данных о сообщении в очереди

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

Поле Тип Описание
chatId string Идентификатор чата в который сообщение будет отправлено
message string Текст сообщения, если type = sendMessage/locationMessage/contactMessage
messages array Массив пересылаемых сообщений, если type = ForwardMessages
linkPreview boolean Параметр включает отображение превью и описание ссылки, если type = sendMessage
quotedMessageId string Идентификатор цитируемого сообщения, если type = sendMessage/locationMessage/contactMessage/sendFileByUrl
fileName string Имя отправляемого файла, если type = sendFileByUrl
caption string Описание под файлом, если type = sendFileByUrl
urlFile string Ссылка на отправляемый файл type = sendFileByUrl
archive string Поле устарело, если type = sendFileByUrl
nameLocation string Название локации, если type = sendLocation
address string Адрес локации, если type = sendLocation
latitude string Широта локации, если type = sendLocation
longitude string Долгота локации, если type = sendLocation
contact object Объект данных о сообщении с контактом, если type = contactMessage

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

Поле Тип Описание
phoneContact string Номер телефона контакта в международном формате (без +) 11 или 12 цифр
firstName string Имя контакта
lastName string Фамилия контакта
middleName string Отчество контакта
company 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": "BAE1234567456",
        "type": "sendContact",
        "body": {
            "chatId": "11001234567@c.us",
            "contact": {
                "phoneContact": 79001234568,
                "firstName": "Артем",
                "middleName": "Петрович",
                "lastName": "Евпаторийский",
                "company": "Велосипед"
            }
        }
    },
    {
        "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"
        }
    },
    {
        "messageID": "BAE1234561230",
        "type": "sendLocation",
        "body": {
            "chatId": "11001234567@c.us",
            "nameLocation": "I'm here, come",
            "address": "613123, Perm",
            "latitude": 44.9370129,
            "longitude": 89.8728409
        }
    },
    {
        "messagesIDs": [
            "BAE1234561256",
            "BAE1234561278"
        ],
        "type": "ForwardMessages",
        "body": {
            "chatId": "11001234567@g.us",
            "chatIdFrom": "12036304684212345@g.us",
            "messages": [
                "BAE1234561296",
                "BAE1234561205"
            ]
        }
    }
]

Ошибки ShowMessagesQueue#

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

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

import requests

url = "https://api.green-api.com/waInstance{{idInstance}}/showMessagesQueue/{{apiTokenInstance}}"

payload = {}
headers= {}

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

print(response.text.encode('utf8'))

curl --location 'https://api.green-api.com/waInstance{{idInstance}}/showMessagesQueue/{{apiTokenInstance}}'

var restTemplate = new RestTemplate();
var requestUrl = new StringBuilder();
requestUrl
    .append("https://api.greenapi.com")
    .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("https://api.greenapi.com")
    .append("/waInstance").append({{idInstance}})
    .append("/showMessagesQueue/")
    .append({{apiTokenInstance}});

var response = Unirest.get(requestUrl.toString())
    .header("Content-Type", "application/json")
    .asString();

System.out.println(response);