Módulo Taskqueue

Obter informações sobre tarefas na fila de execução assíncrona de tarefas.

Métodos de API

Obter o progresso de execução de uma tarefa em segundo plano
https://api.mobizon.com.br/service/Taskqueue/GetStatus

Obter o progresso de execução de uma tarefa em segundo plano

https://api.mobizon.com.br/service/Taskqueue/GetStatus

Este método permite obter o progresso de execução de uma tarefa em segundo plano por seu ID. Nosso serviço utiliza tarefas em segundo plano para que seus processos não precisem esperar pela conclusão de uma requisição longa em casos como:

Carregamento de destinatários em uma campanha de SMS;
Importação de contatos para a agenda de contatos;
Criação de relatórios sobre campanhas e mensagens.

Esta requisição deve ser enviada no máximo uma vez por segundo.

Parâmetros da requisição

Parâmetro	Tipo	Descrição
`id`	integer	Identificador da tarefa em segundo plano.

Resposta do servidor

Array de dados:

Campo	Tipo	Descrição
progress	integer	Progresso da execução da tarefa em uma escala de 0 a 100%.
status	integer	Código de status da tarefa: 0 – aguardando o início da execução; 1 – em processo; 2 – concluída; 3 – rejeitada.

Códigos de resposta da API

Código	Descrição
0	Progresso da execução da tarefa em segundo plano obtido com sucesso.
2	Se a tarefa com o identificador especificado não for encontrada.

curl -X POST \
  'https://api.mobizon.com.br/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.com.br/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.com.br');

// Chamada do método API
if ($api->call(
    'taskqueue',
    'getStatus',
    array(
        //identificador da tarefa em segundo plano
        'id' => '123'
    )
)
) {
    // Obtenção do resultado da execução do método
    $result = $api->getData();
} else {
    // Ocorreu um erro durante a execução, exibição do código de erro e do texto da mensagem
    echo '[' . $api->getCode() . '] ' . $api->getMessage() . PHP_EOL;
}

Módulo User → ← Módulo Message