GET /v1/campaigns/{id}/recipients
GET
/v1/campaigns/{id}/recipients
const url = 'https://seu-endereco-da-api/v1/campaigns/example/recipients?status=pending&engagement=opened';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}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).
Authorizations
Seção intitulada “Authorizations”Parameters
Seção intitulada “Parameters”Path Parameters
Seção intitulada “Path Parameters”id
required
string
Query Parameters
Seção intitulada “Query Parameters”status
string
replied
boolean
Only recipients who replied to the campaign
engagement
string
E-mail only: who opened, who clicked or whose message bounced
cursor
string
Opaque pagination cursor
limit
number
Page size (default 50, max 200)
Responses
Seção intitulada “Responses”Media typeapplication/json
object
items
required
Array<object>
object
id
required
string
contactId
required
string
contactName
required
string
contactProfilePicUrl
required
Presigned url for the contact’s whatsapp profile photo
string
phoneNumber
required
Null on e-mail and sms recipients, which use address
string
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
openedAt
required
string format: date-time
clickedAt
required
string format: date-time
status
required
string
errorCode
required
string
statusReason
required
Motivo da mensagem presa, como o numero esta desconectado
string
errorProvider
required
Dono do codigo de erro, quando o codigo veio do provedor
string
reasonText
required
Motivo da falha em portugues, para o cliente; o detalhe tecnico fica so nos logs; nula quando o destinatario nao falhou
string
repliedAt
required
string format: date-time
updatedAt
required
string format: date-time
nextCursor
required
string
Example
{ "items": [ { "errorProvider": "meta" } ]}