Pular para o conteúdo

GET /v1/campaigns/{id}/recipients

GET
/v1/campaigns/{id}/recipients
curl --request GET \
--url 'https://seu-endereco-da-api/v1/campaigns/example/recipients?status=pending&engagement=opened' \
--header 'Authorization: Bearer <token>'

Permissão que a Chave de acesso precisa: Ler campanhas (campaigns:read).

id
required
string
status
string
Allowed values: pending queued held sent delivered read failed
replied
boolean

Only recipients who replied to the campaign

engagement
string
Allowed values: opened clicked bounced

E-mail only: who opened, who clicked or whose message bounced

cursor
string

Opaque pagination cursor

limit
number
>= 1 <= 200

Page size (default 50, max 200)

Media typeapplication/json
object
items
required
Array<object>
object
id
required
string
contactId
required
string
contactName
required
string
nullable
contactProfilePicUrl
required

Presigned url for the contact’s whatsapp profile photo

string
nullable
phoneNumber
required

Null on e-mail and sms recipients, which use address

string
nullable
address
required

E-mail or phone of a broadcast recipient; masked to the domain or the last digits for readers without contacts:read_phone

string
nullable
openedAt
required
string format: date-time
nullable
clickedAt
required
string format: date-time
nullable
status
required
string
errorCode
required
string
nullable
statusReason
required

Motivo da mensagem presa, como o numero esta desconectado

string
nullable
errorProvider
required

Dono do codigo de erro, quando o codigo veio do provedor

string
nullable
Allowed values: meta telegram
reasonText
required

Motivo da falha em portugues, para o cliente; o detalhe tecnico fica so nos logs; nula quando o destinatario nao falhou

string
nullable
repliedAt
required
string format: date-time
nullable
updatedAt
required
string format: date-time
nextCursor
required
string
nullable

Example

{
"items": [
{
"errorProvider": "meta"
}
]
}