Module Taskqueue

Асинхронды тапсырмаларды орындау кезегіндегі тапсырмалар туралы ақпарат алу

API methods

Фондық тапсырманың орындалу прогресін алу
https://api.mobizon.kz/service/Taskqueue/GetStatus

Фондық тапсырманың орындалу прогресін алу

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

Бұл әдіс фондық тапсырманың ID бойынша орындалу прогресін алуға мүмкіндік береді. Біздің сервис ұзақ сұраныстың аяқталуын күту үшін процестеріңізге уақыт жұмсамай, фондық тапсырмаларды пайдаланады. Мұндай жағдайларда:

SMS-кампанияға алушыларды жүктеу;
Байланыс кітапшасына контактілерді импорттау;
Кампаниялар мен хабарламалар туралы есептерді құру.

Бұл сұранысты секунд сайын 1 реттен жиі жіберуге болмайды.

Сұрау параметрлері

Параметр	Түрі	Сипаттама
`id`	integer	Фондық тапсырма идентификаторы.

Сервер жауабы

Деректер массиві:

Өріс	Түрі	Сипаттама
progress	integer	Тапсырманың орындалу прогресі 0-ден 100%-ға дейінгі шкала бойынша.
status	integer	Тапсырма күйінің коды: 0 – орындалуды күтіп тұр; 1 – орындалу үстінде; 2 – аяқталды; 3 – қабылданбады.

API жауап кодтары

Код	Сипаттама
0	Фондық тапсырманың орындалу прогресі сәтті алынды.
2	Егер көрсетілген идентификатор бойынша тапсырма табылмаса.

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;
}

Module User → ← Module Message