Consultar estado e métricas das campanhas
GET /sender/stats
Retorna uma fotografia do processador de campanhas da instância: estado atual, campanha em execução, ritmo observado e próximo envio agendado.
As métricas representam a execução desde a última inicialização do serviço e
não substituem a consulta das campanhas e mensagens. messages_processed
indica processamento pela fila, não entrega ou leitura pelo destinatário.
Autenticação
[
{
"token": []
}
]
{
"token": {
"name": "token",
"type": "apiKey",
"in": "header"
}
}
Respostas
{
"200": {
"description": "Estado atual do processador de campanhas.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"status",
"data"
],
"properties": {
"status": {
"type": "string",
"enum": [
"success"
]
},
"data": {
"type": "object",
"required": [
"status"
],
"properties": {
"status": {
"type": "object",
"required": [
"current"
],
"properties": {
"current": {
"type": "string",
"enum": [
"not_initialized",
"paused_for_direct_message",
"sending",
"paused",
"processing",
"idle"
]
},
"direct_message_active": {
"type": "boolean"
},
"current_folder_id": {
"type": "string"
},
"delay_min": {
"type": "integer"
},
"delay_max": {
"type": "integer"
}
}
},
"statistics": {
"type": "object",
"properties": {
"messages_processed": {
"type": "integer"
},
"avg_processing_ms": {
"type": "integer"
},
"messages_per_minute": {
"type": "number"
}
}
},
"instance": {
"type": "object",
"properties": {
"groups_count": {
"type": "integer"
},
"is_business": {
"type": "boolean"
},
"platform": {
"type": "string"
},
"system_name": {
"type": "string"
},
"profile_name": {
"type": "string"
}
}
},
"scheduling": {
"type": "object",
"properties": {
"next_send_at": {
"type": "string",
"nullable": true,
"description": "Horário local formatado como YYYY-MM-DD HH:mm:ss."
},
"next_send_in_seconds": {
"type": "integer",
"nullable": true,
"description": "Presente quando o próximo envio ocorrer em menos de uma hora."
}
}
}
}
}
}
},
"examples": {
"idle": {
"value": {
"status": "success",
"data": {
"status": {
"current": "idle",
"direct_message_active": false
},
"statistics": {
"messages_processed": 120,
"avg_processing_ms": 850,
"messages_per_minute": 12.5
},
"instance": {
"groups_count": 8,
"is_business": true,
"platform": "android",
"system_name": "Android",
"profile_name": "Atendimento"
},
"scheduling": {
"next_send_at": null,
"next_send_in_seconds": null
}
}
}
},
"not_initialized": {
"value": {
"status": "success",
"data": {
"status": {
"current": "not_initialized"
}
}
}
}
}
}
}
},
"401": {
"description": "Token da instância ausente ou inválido."
},
"500": {
"description": "Processador de campanhas temporariamente indisponível."
}
}