Skip to main content
GET
Consultar comando assíncrono
Quando você envia um comando com async: true, a API responde na hora com um commandId e executa o comando em segundo plano. Este endpoint diz o que aconteceu com ele.

Status

status não é o sucesso do comando. Um comando que rodou e falhou (número inválido, sessão desconectada) fica completed com result.success: false e o motivo em result.error. O status: "failed" cobre só a falha do worker.
O campo result traz o mesmo payload do webhook command.result e só é preenchido quando o comando termina. Antes disso ele vem null.

Escopo e retenção

Você só enxerga comandos das suas próprias sessões. Uma API Key restrita a uma sessão consulta apenas os comandos daquela sessão. Comando de terceiros responde 404, igual a um commandId inexistente.
O resultado fica disponível por uma janela limitada — cerca de 1 hora após a execução (24 horas em caso de falha do worker). Passado esse prazo a resposta é 404. Para entrega garantida, use o webhook command.result em vez de polling.

Authorizations

Authorization
string
header
required

API Key para autenticação. Formato: <API_KEY>

Path Parameters

commandId
string
required
Minimum string length: 1

Response

Resposta bem-sucedida