Pular para o conteúdo principal
GET
/
api
/
v1
/
message-batches
/
{id}
Obter lote por ID
curl --request GET \
  --url https://6827d740d717.ngrok-free.app/api/v1/message-batches/{id} \
  --header 'Authorization: <api-key>'
{
  "id": "mb_1694024400000_xyz123456",
  "teamId": "tm_1694024400000_xyz123456",
  "status": "COMPLETED",
  "createdAt": "2023-09-06T19:45:00.000Z",
  "name": "Campanha Black Friday 2024",
  "content": "🎉 Black Friday chegou! Descontos de até 70% em todos os produtos. Aproveite!",
  "mediaType": "IMAGE",
  "slug": "campanha-black-friday-2024",
  "instanceIds": [
    "inst_1694024400000_xyz123456",
    "inst_1694024400000_abc789012"
  ],
  "mediaUrl": "https://example.com/media/image.jpg",
  "groupIds": [
    "group_001",
    "group_002",
    "group_003"
  ],
  "contactIds": [
    "contact_001",
    "contact_002",
    "contact_003"
  ],
  "metadata": {
    "campanha": "black-friday-2024",
    "origem": "dashboard",
    "prioridade": "alta"
  },
  "updatedAt": "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 caminho

​
id
string
obrigatório

Resposta

Lote encontrado

​
id
string
obrigatório

ID do lote

Exemplo:

"mb_1694024400000_xyz123456"

​
teamId
string
obrigatório

ID do time

Exemplo:

"tm_1694024400000_xyz123456"

​
status
enum<string>
obrigatório

Status do lote

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

"COMPLETED"

​
createdAt
string<date-time>
obrigatório

Data de criação do lote

Exemplo:

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

​
name
string

Nome do lote

Exemplo:

"Campanha Black Friday 2024"

​
content
string

Conteúdo da mensagem

Exemplo:

"🎉 Black Friday chegou! Descontos de até 70% em todos os produtos. Aproveite!"

​
mediaType
enum<string>

Tipo de mídia

Opções disponíveis:
IMAGE,
VIDEO,
DOCUMENT,
AUDIO
Exemplo:

"IMAGE"

​
slug
string

Slug único do lote

Exemplo:

"campanha-black-friday-2024"

​
instanceIds
string[]

IDs das instâncias do WhatsApp para distribuição

Exemplo:
[
  "inst_1694024400000_xyz123456",
  "inst_1694024400000_abc789012"
]
​
mediaUrl
string

URL da mídia

Exemplo:

"https://example.com/media/image.jpg"

​
groupIds
string[]

IDs dos grupos

Exemplo:
["group_001", "group_002", "group_003"]
​
contactIds
string[]

IDs dos contatos

Exemplo:
["contact_001", "contact_002", "contact_003"]
​
metadata
object

Metadados adicionais do lote

Exemplo:
{
  "campanha": "black-friday-2024",
  "origem": "dashboard",
  "prioridade": "alta"
}
​
updatedAt
string<date-time>

Data de atualização do lote

Exemplo:

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