Listar campanhas de envio
GET /sender/listfolders
Retorna as campanhas de envio em massa da instância atual, ordenadas das mais recentes para as mais antigas.
Use esta operação para montar o histórico de campanhas e escolher qual abrir
em POST /sender/listmessages. Uma lista vazia indica que ainda não existem
campanhas disponíveis para a instância.
Autenticação
[
{
"token": []
}
]
{
"token": {
"name": "token",
"type": "apiKey",
"in": "header"
}
}
Parâmetros
[
{
"in": "query",
"name": "status",
"schema": {
"type": "string",
"enum": [
"Active",
"Archived"
]
},
"description": "Filtro reservado para compatibilidade. A resposta atual pode retornar\ntodas as campanhas independentemente desse valor.\n"
}
]
Respostas
{
"200": {
"description": "Lista de campanhas retornada com sucesso",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MessageQueueFolder"
}
}
}
}
},
"500": {
"description": "Erro interno do servidor",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"example": "Failed to fetch batches: database error"
}
}
}
}
}
}
}
#/components/schemas/MessageQueueFolder
{
"type": "object",
"description": "Pasta para organização de campanhas de mensagens em massa",
"properties": {
"id": {
"type": "string",
"description": "Identificador único"
},
"info": {
"type": "string",
"description": "Informações adicionais sobre a pasta"
},
"status": {
"type": "string",
"description": "Status atual da pasta",
"example": "ativo"
},
"scheduled_for": {
"type": "integer",
"format": "int64",
"description": "Timestamp Unix para execução agendada"
},
"delayMax": {
"type": "integer",
"format": "int64",
"description": "Atraso máximo entre mensagens em milissegundos"
},
"delayMin": {
"type": "integer",
"format": "int64",
"description": "Atraso mínimo entre mensagens em milissegundos"
},
"log_delivered": {
"type": "integer",
"format": "int64",
"description": "Contagem de mensagens entregues"
},
"log_failed": {
"type": "integer",
"format": "int64",
"description": "Contagem de mensagens com falha"
},
"log_played": {
"type": "integer",
"format": "int64",
"description": "Contagem de mensagens reproduzidas (para áudio/vídeo)"
},
"log_read": {
"type": "integer",
"format": "int64",
"description": "Contagem de mensagens lidas"
},
"log_sucess": {
"type": "integer",
"format": "int64",
"description": "Contagem de mensagens enviadas com sucesso"
},
"log_total": {
"type": "integer",
"format": "int64",
"description": "Contagem total de mensagens"
},
"owner": {
"type": "string",
"description": "Identificador do proprietário da instância"
},
"created": {
"type": "string",
"format": "date-time",
"description": "Data e hora de criação"
},
"updated": {
"type": "string",
"format": "date-time",
"description": "Data e hora da última atualização"
}
}
}