Only deliveries on this channel type, e.g. 'whatsapp_bot'.
contact_id
string
Only deliveries to this contact.
user_id
string
username
string
email
string
Only deliveries to this email address.
search
string
Search recipients by name, email, phone or username.
from_date
string<date-time> | null
Only deliveries created at or after this ISO 8601 date.
to_date
string<date-time> | null
Only deliveries created at or before this ISO 8601 date.
sort_field
enum<string>
Field to sort broadcast recipients by
Available options:
created_at,
updated_at
sort_direction
enum<string>
Direction to sort broadcast recipients by
Available options:
asc,
desc
page
number
Page number
take
number
Number of items to take
next
string
Next page token (Only used on special endpoints)
progressive
boolean
Skip the total count: pagination-count is exact on the last page, and one more than the items so far while more pages exist (Only used on special endpoints)
Response
200 - application/json
id
string
required
broadcast_id
string
required
broadcast_name
string
required
template_id
string | null
required
channel_type
enum<string>
required
The channel type
Available options:
internal,
org,
agent,
custom,
whatsapp_bot,
messenger_bot,
instagram_dm,
tiktok_dm,
telegram_bot,
slack_bot,
teams_bot,
gmail,
outlook,
twilio,
telnyx,
email,
smpp
user_id
string | null
required
name
string | null
required
username
string | null
required
phone
string | null
required
email
string | null
required
status
enum<string>
required
The status of the broadcast recipient
Available options:
QUEUED,
SENDING,
PROCESSED,
SENT,
FAILED,
SKIPPED
source
enum<string> | null
required
How the recipient was triggered (transactional only)