Pular para o conteúdo principal
GET
/
api
/
v1
/
message-batches
Listar lotes com filtros
curl --request GET \
  --url https://6827d740d717.ngrok-free.app/api/v1/message-batches \
  --header 'Authorization: <api-key>'
[
  {
    "id": "mb_1694024400000_xyz123456",
    "name": "Campanha Promocional Verão",
    "status": "COMPLETED",
    "totalMessages": 100,
    "processedMessages": 100,
    "successfulMessages": 95,
    "failedMessages": 5,
    "progressPercentage": 100,
    "successRate": 95,
    "createdAt": "2023-09-06T19:45:00.000Z",
    "startedAt": "2023-09-06T20:00:00.000Z",
    "completedAt": "2023-09-06T20:30:00.000Z"
  }
]

Autorizações

​
Authorization
string
header
obrigatório

API Key de autenticação - usar ApiKey {sua-api-key}

Parâmetros de consulta

​
status
enum<string>

Status do lote para filtrar

Opções disponíveis:
PENDING,
PROCESSING,
COMPLETED,
FAILED,
CANCELLED
Exemplo:

"COMPLETED"

​
name
string

Nome do lote para busca (busca parcial)

Exemplo:

"Campanha"

​
instanceId
string

ID da instância para filtrar

Exemplo:

"inst_1694024400000_xyz123456"

​
startDate
string

Data inicial para filtrar (ISO string)

Exemplo:

"2023-09-06T00:00:00.000Z"

​
endDate
string

Data final para filtrar (ISO string)

Exemplo:

"2023-09-06T23:59:59.999Z"

​
hasFailures
boolean

Filtrar apenas lotes com falhas

Exemplo:

true

​
minSuccessRate
number

Taxa mínima de sucesso (%)

Exemplo:

90

​
page
number

Página para paginação

Exemplo:

1

​
limit
number

Itens por página

Exemplo:

10

Resposta

200 - application/json

Lista de lotes

​
id
string
obrigatório

ID do lote

Exemplo:

"mb_1694024400000_xyz123456"

​
name
string
obrigatório

Nome do lote

Exemplo:

"Campanha Promocional Verão"

​
status
enum<string>
obrigatório

Status do lote

Opções disponíveis:
PENDING,
PROCESSING,
COMPLETED,
FAILED,
CANCELLED
Exemplo:

"COMPLETED"

​
totalMessages
number
obrigatório

Quantidade total de mensagens no lote

Exemplo:

100

​
processedMessages
number
obrigatório

Quantidade de mensagens processadas

Exemplo:

100

​
successfulMessages
number
obrigatório

Quantidade de mensagens bem-sucedidas

Exemplo:

95

​
failedMessages
number
obrigatório

Quantidade de mensagens com falha

Exemplo:

5

​
progressPercentage
number
obrigatório

Porcentagem de progresso do lote

Exemplo:

100

​
successRate
number
obrigatório

Taxa de sucesso do lote (%)

Exemplo:

95

​
createdAt
string<date-time>
obrigatório

Data de criação do lote

Exemplo:

"2023-09-06T19:45:00.000Z"

​
startedAt
string<date-time>

Data de início do processamento

Exemplo:

"2023-09-06T20:00:00.000Z"

​
completedAt
string<date-time>

Data de conclusão do processamento

Exemplo:

"2023-09-06T20:30:00.000Z"