Referência da APICampanhas
Lista destinatarios (status por destinatario)
Lista os destinatarios da campanha com o status individual (pending/sending/sent/delivered/read/responded/failed/invalid), o motivo de erro quando houver e os marcos de tempo. Paginado (50 por pagina); filtre por status com ?status=. Apenas leitura.
Authorization
bearerAuth AuthorizationBearer <token>
API key enviada como Authorization Bearer pzk_live_... ou pzk_test_...
In: header
Path Parameters
id*string
Identificador da campanha.
Query Parameters
page?integer
Pagina (1-based). Default 1.
status?string
Filtra por status (maiusculo): PENDING|SENDING|SENT|DELIVERED|READ|RESPONDED|FAILED|INVALID.
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/campaigns/string/recipients"{
"items": [
{
"id": "string",
"recipient": "string",
"recipientJid": "string",
"name": "string",
"status": "pending",
"error": "string",
"sentAt": "2019-08-24T14:15:22Z",
"waMessageId": "string",
"nextSendAt": "2019-08-24T14:15:22Z"
}
],
"page": 0,
"total": 0
}{
"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"
}
}