Referência da APICampanhas
Consulta uma campanha (status agregado + cadencia)
Retorna os detalhes da campanha: status, totais por status do destinatario (pending/sent/delivered/read/responded/failed/invalid), a configuracao de cadencia e o estado de runtime (dia da campanha, teto do dia, enviados no dia, ultimo e proximo envio). Recomendado para acompanhar o andamento. Apenas leitura, sem gate comercial.
Authorization
bearerAuth AuthorizationBearer <token>
API key enviada como Authorization Bearer pzk_live_... ou pzk_test_...
In: header
Path Parameters
id*string
Identificador da campanha.
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/campaigns/string"{
"id": "string",
"name": "string",
"status": "DRAFT",
"pausedReason": "string",
"template": "string",
"totals": {
"total": 0,
"pending": 0,
"sent": 0,
"delivered": 0,
"read": 0,
"responded": 0,
"failed": 0,
"invalid": 0
},
"cadence": {
"warmup": {
"base": 0,
"factor": 0,
"cap": 0
},
"window": {
"start": "string",
"end": "string",
"tz": "string"
},
"pacing": {
"baseSeconds": 0,
"jitterPct": 0
},
"autoPause": {
"consecutiveThreshold": 0
},
"validateNumbers": true
},
"runtime": {
"dayIndex": 0,
"capToday": 0,
"sentToday": 0,
"lastSentAt": "2019-08-24T14:15:22Z",
"nextSendAt": "2019-08-24T14:15:22Z"
},
"startedAt": "2019-08-24T14:15:22Z",
"completedAt": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z"
}{
"error": {
"code": "UNAUTHORIZED",
"message": "API key ausente ou invalida"
}
}{
"error": {
"code": "FORBIDDEN",
"message": "Projeto inativo ou sem permissao"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Instancia nao encontrada"
}
}