Регистрация

Модуль Taskqueue

Получение информации о задачах в очереди асинхронного выполнения задач

API methods

Получение прогресса выполнения фоновой задачи
https://api.mobizon.kz/service/Taskqueue/GetStatus

Получение прогресса выполнения фоновой задачи

https://api.mobizon.kz/service/Taskqueue/GetStatus

Данный метод позволяет получить прогресс выполнения фоновой задачи по ее ID. Наш сервис использует фоновые задачи для того чтобы вашим процессам не приходилось ожидать завершения долгого запроса в таких случаях как:

  • Загрузка получателей в SMS-кампанию;
  • Импорт контактов в контактную книгу;
  • Создание отчетов о кампаниях и сообщениях.
Данный запрос следует отправлять не чаще 1 раза в секунду.

Параметры запроса

ПараметрТипОписание
idintegerИдентификатор фоновой задачи.

Ответ сервера

Массив данных:

ПолеТипОписание
progressintegerПрогресс выполнения задачи по шкале от 0 до 100%.
statusintegerКод статуса задачи:
0 – ожидает начала выполнения;
1 – в процессе;
2 – завершена;
3 – отклонена.

Коды ответов API

КодОписание
0Прогресс выполнения фоновой задачи успешно получен.
2Если задача с указанным идентификатором не найдена.

Examples

curl -X POST \
  'https://api.mobizon.kz/service/taskqueue/getStatus?output=json&api=v1&apiKey=KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK' \
  -H 'cache-control: no-cache' \
  -H 'content-type: application/x-www-form-urlencoded' \
  -d 'id=123'
var data = "id=123";

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
if (this.readyState === 4) {
console.log(this.responseText);
}
});

xhr.open("POST", "https://api.mobizon.kz/service/taskqueue/getStatus?output=json&api=v1&apiKey=KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK");
xhr.setRequestHeader("content-type", "application/x-www-form-urlencoded");
xhr.setRequestHeader("cache-control", "no-cache");

xhr.send(data);
<?php
use Mobizon\MobizonApi;

$api = new MobizonApi('KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK', 'api.mobizon.kz');

// Вызов АПИ метода
if ($api->call(
    'taskqueue',
    'getStatus',
    array(
        //идентификатор фоновой задачи
        'id' => '123'
    )
)
) {
    // Получение результата выполнения метода
    $result = $api->getData();
} else {
    // Во время выполнения произошла ошибка, вывод кода ошибки и текста сообщения
    echo '[' . $api->getCode() . '] ' . $api->getMessage() . PHP_EOL;
}