CodeChat APIv1.0.0
ChangelogPostman
Referência/Message Batches/listMessageBatchAttempts
Message Batches

Lista tentativas do lote

Lista tentativas persistidas, incluindo indisponibilidade de instância e resultados UNKNOWN após recovery.

Pro
GEThttp://localhost:8084/message/batches/{batchId}/attempts

Autenticação

UserBearerobrigatório

JWT HS256 de usuario. Deve conter userId em formato UUID e exp; a expiracao sempre e validada.

Header
Authorization
Exemplo
Bearer <INSTANCE_TOKEN>

Parâmetros

batchIdpathobrigatório
string<uuid>

Sem descrição adicional.

statusquery
any

Sem descrição adicional.

recipientquery
string

Sem descrição adicional.

instanceNamequery
string

Sem descrição adicional.

limitquery
integer

Sem descrição adicional.

padrão 50mín 1máx 200
nextCursorquery
string

Sem descrição adicional.

previousCursorquery
string

Sem descrição adicional.

Respostas

application/json
200

Página de tentativas

response 200object
nextCursorstring | nullobrigatório
previousCursorstring | nullobrigatório
totalRecordsintegerobrigatórioformat: int64
recordsarrayobrigatório
items[]object
idstringobrigatórioformat: uuid
batchIdstringobrigatórioformat: uuid
batchItemIdstringobrigatórioformat: uuid
positioninteger
recipientstring
instanceIdinteger
instanceNamestring
attemptNumberintegerobrigatóriomín: 1
statusenum<SENDING | SUCCESS | FAILED | INSTANCE_UNAVAILABLE | INTERRUPTED | UNKNOWN>obrigatório
clientMessageIdstring
whatsappMessageIdstring
errorCodestring
errorMessagestring
requestPayloadobject
responsePayloadobject
startedAtstringobrigatórioformat: date-time
finishedAtstringformat: date-time
createdAtstringobrigatórioformat: date-time
Exemplo 200gerado do schema
{
  "nextCursor": "string",
  "previousCursor": "string",
  "totalRecords": 1,
  "records": [
    {
      "id": "01900000-0000-7000-8000-000000000001",
      "batchId": "01900000-0000-7000-8000-000000000001",
      "batchItemId": "01900000-0000-7000-8000-000000000001",
      "position": 1,
      "recipient": "5511999999999",
      "instanceId": 1,
      "instanceName": "minha-instancia",
      "attemptNumber": 1,
      "status": "SENDING",
      "clientMessageId": "3EB0CODECHATMESSAGE",
      "whatsappMessageId": "3EB0CODECHATMESSAGE",
      "errorCode": "string",
      "errorMessage": "Olá! Esta é uma mensagem de exemplo da CodeChat.",
      "requestPayload": {},
      "responsePayload": {},
      "startedAt": "2026-07-13T15:10:00Z",
      "finishedAt": "2026-07-13T15:10:00Z",
      "createdAt": "2026-07-13T15:10:00Z"
    }
  ]
}