Message Batches

Lista itens do lote

Lista destinatários e resultados por cursor opaco. O cursor de itens é derivado da posição original do destinatário.

Pro

GEThttp://localhost:8084/message/batches/{batchId}/items

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 itens

response 200object

nextCursorstring | nullobrigatório

previousCursorstring | nullobrigatório

totalRecordsintegerobrigatórioformat: int64

recordsarrayobrigatório

items[]object

idstringobrigatórioformat: uuid

batchIdstringobrigatórioformat: uuid

positionintegerobrigatóriomín: 0

recipientInputstringobrigatório

normalizedRecipientstringobrigatório

recipientJidstringobrigatório

selectedInstanceIdinteger

selectedInstanceNamestring

clientMessageIdstring

whatsappMessageIdstring

messageIdinteger

attemptCountintegerobrigatóriomín: 0

selectedDelayMsintegerformat: int64 · mín: 0

lastErrorCodestring

lastErrorMessagestring

responsePayloadobject

createdAtstringobrigatórioformat: date-time

updatedAtstringobrigatórioformat: date-time

processingStartedAtstringformat: date-time

finishedAtstringformat: 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",
      "position": 1,
      "recipientInput": "5511999999999",
      "normalizedRecipient": "5511999999999",
      "recipientJid": "[email protected]",
      "status": "PENDING",
      "selectedInstanceId": 1,
      "selectedInstanceName": "minha-instancia",
      "clientMessageId": "3EB0CODECHATMESSAGE",
      "whatsappMessageId": "3EB0CODECHATMESSAGE",
      "messageId": 1,
      "attemptCount": 1,
      "selectedDelayMs": 1,
      "lastErrorCode": "string",
      "lastErrorMessage": "Olá! Esta é uma mensagem de exemplo da CodeChat.",
      "responsePayload": {},
      "createdAt": "2026-07-13T15:10:00Z",
      "updatedAt": "2026-07-13T15:10:00Z",
      "processingStartedAt": "2026-07-13T15:10:00Z",
      "finishedAt": "2026-07-13T15:10:00Z"
    }
  ]
}

{

"nextCursor": "string",

"previousCursor": "string",

"totalRecords": 1,

"records": [

{

"id": "01900000-0000-7000-8000-000000000001",

"batchId": "01900000-0000-7000-8000-000000000001",

"position": 1,

"recipientInput": "5511999999999",

"normalizedRecipient": "5511999999999",

"recipientJid": "[email protected]",

"status": "PENDING",

"selectedInstanceId": 1,

"selectedInstanceName": "minha-instancia",

"clientMessageId": "3EB0CODECHATMESSAGE",

"whatsappMessageId": "3EB0CODECHATMESSAGE",

"messageId": 1,

"attemptCount": 1,

"selectedDelayMs": 1,

"lastErrorCode": "string",

"lastErrorMessage": "Olá! Esta é uma mensagem de exemplo da CodeChat.",

"responsePayload": {},

"createdAt": "2026-07-13T15:10:00Z",

"updatedAt": "2026-07-13T15:10:00Z",

"processingStartedAt": "2026-07-13T15:10:00Z",

"finishedAt": "2026-07-13T15:10:00Z"

}

]

}