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

Consulta item e suas tentativas

Retorna um destinatário do lote com o histórico completo de tentativas de envio.

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

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.

itemIdpathobrigatório
string<uuid>

Sem descrição adicional.

Respostas

application/json
200

Item detalhado

response 200allOf
opção 1object
idstringobrigatórioformat: uuid
batchIdstringobrigatórioformat: uuid
positionintegerobrigatóriomín: 0
recipientInputstringobrigatório
normalizedRecipientstringobrigatório
recipientJidstringobrigatório
statusenum<PENDING | SENDING | SUCCESS | FAILED | SKIPPED | INTERRUPTED | UNKNOWN>obrigató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
opção 2object
attemptsarrayobrigató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
{
  "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",
  "attempts": [
    {
      "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"
    }
  ]
}