broadcasts
List broadcast recipients
Returns recipients for a broadcast with individual delivery status. Filter by status.
AuthorizationBearer <token>
API key authentication - use your Zernio API key as a Bearer token
In: header
Path Parameters
broadcastIdstring
Query Parameters
status?string
Value in
"pending" | "sent" | "delivered" | "read" | "failed"limit?integer
Default
50skip?integer
Default
0Response Body
application/json
application/json
application/json
import Zernio from '@zernio/node';const zernio = new Zernio({ apiKey: process.env.ZERNIO_API_KEY });const { data } = await zernio.broadcasts.listBroadcastRecipients({ path: { broadcastId: 'broadcast_abc123', },});console.log(data);{
"success": true,
"recipients": [
{
"id": "string",
"contactId": "string",
"channelId": "string",
"platformIdentifier": "string",
"contactName": "string",
"status": "pending",
"messageId": "string",
"error": "string",
"sentAt": "2019-08-24T14:15:22Z",
"deliveredAt": "2019-08-24T14:15:22Z",
"readAt": "2019-08-24T14:15:22Z"
}
],
"pagination": {
"total": 0,
"limit": 0,
"skip": 0,
"hasMore": true
}
}{
"error": "Unauthorized"
}{
"error": "Not found"
}