Реєстрація

Модуль Taskqueue

Отримання інформації про завдання в черзі асинхронного виконання завдань

API methods

Отримання прогресу виконання фонового завдання
https://api.mobizon.ua/service/Taskqueue/GetStatus

Отримання прогресу виконання фонового завдання

https://api.mobizon.ua/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.ua/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.ua/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.ua');

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