amqp.php¶

В этой статье

Методы API

amqp/get

amqp/list

amqp/remove

amqp/status

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

Методы API¶

Метод	Действие	Описание
`get`	получение задач	Возвращает список задач из AMQP очереди с фильтрацией по статусу и пагинацией
`list`	получение списка	Возвращает общее количество задач в очереди AMQP.
`remove`	удаление задач	Удаляет задачи из очереди по указанному ID
`status`	проверка статуса очереди	Отправляет проверочное сообщение в очередь для проверки её работоспособности.

amqp/get¶

Возвращает список задач из AMQP очереди с фильтрацией по статусу и пагинацией

HTTP-метод: GET

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `get`
token	✅	string	Токен авторизации
id	❌	integer	Идентификатор задачи для фильтрации.
status	❌	string	Статус задачи для фильтрации.
start	❌	integer	Смещение (offset) для пагинации результатов.

Пример запроса

curl -s "https://invapi.hostkey.ru/amqp.php" -X GET \
--data "action=get" \
--data "token=HOSTKEY_TOKEN"

Пример успешного ответа

{
"result": "OK",
"report": [
{
"id": 123,
"status": "pending",
"created_at": "2024-05-20T12:00:00Z"
}
]
}

Примеры ошибок

{
"-1": [
{
"message": "amqp/get: invalid request",
"condition": "auth_check_permission returns customer == 1"
},
{
"message": "amqp/get: authentication required",
"condition": "token is empty"
}
],
"-2": [
{
"message": "amqp/get: invalid token, logout",
"condition": "auth_validate_token returns -1"
}
]
}

amqp/list¶

Возвращает общеное количество задач в очереди AMQP.

HTTP-метод: GET

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `list`
-	-	-	Других параметров нет

Пример запроса

curl -s "https://invapi.hostkey.ru/amqp.php" -X GET \
--data "action=list"

Пример успешного ответа

{
"result": "OK",
"report": 125
}

Примеры ошибок

{
"code": -1,
"message": "Ошибка выполнения запроса"
}

amqp/remove¶

Удаляет задачи из очереди по указанному ID

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `remove`
token	✅	string	Токен авторизации
id	❌	`integer\|array<integer>`	Идентификатор задачи или массив идентификаторов для удаления из очереди AMQP

Пример запроса

curl -s "https://invapi.hostkey.ru/amqp.php" -X POST \
--data "action=remove" \
--data "token=HOSTKEY_TOKEN" \
--data "id[]=123" \
--data "id[]=456"

Пример успешного ответа

{
"result": "OK",
"jobs": "integer|array<integer>"
}

Примеры ошибок

{
"-1": "amqp/remove: invalid request",
"-2": "amqp/remove: invalid token, logout"
}

amqp/status¶

Отправляет проверочное сообщение в очередь для проверки её работоспособности.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `status`
token	❌	string	Токен авторизации
queue	✅	string	Название очереди для отправки проверочного сообщения

Пример запроса

curl -s "https://invapi.hostkey.ru/amqp.php" -X POST \
--data "action=status" \
--data "queue=test_queue"

Пример успешного ответа

{
"result": "OK",
"action": "status",
"queue": "test_queue",
"callback_key": "7bc29eb23fb1b879b21fce509597f07c"
}

Примеры ошибок

{
"code": -1,
"message": "empty queue in request"
}