Get campaign recipients
curl --request GET \
--url https://api.vambe.me/api/public/outreach-campaign/{campaignId}/recipients \
--header 'x-api-key: <x-api-key>'const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};
fetch('https://api.vambe.me/api/public/outreach-campaign/{campaignId}/recipients', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.vambe.me/api/public/outreach-campaign/{campaignId}/recipients"
headers = {"x-api-key": "<x-api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"total": 123,
"page": 123,
"page_size": 123,
"has_more": true,
"steps": [
{
"node_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"step_number": 123,
"kind": "send-template",
"name": "<string>",
"channel": "whatsapp"
}
],
"recipients": [
{
"recipient_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"phone": "<string>",
"email": "<string>",
"status": "pending",
"reach": "full",
"dispatched_at": "2023-11-07T05:31:56Z",
"batch_number": 123,
"next_step_at": "2023-11-07T05:31:56Z",
"responded_at": "2023-11-07T05:31:56Z",
"converted_at": "2023-11-07T05:31:56Z",
"error": "<string>",
"steps": [
{
"node_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "pending",
"reason": "<string>",
"failure_level": "system",
"at": "2023-11-07T05:31:56Z",
"delivered_at": "2023-11-07T05:31:56Z",
"read_at": "2023-11-07T05:31:56Z",
"failed_at": "2023-11-07T05:31:56Z",
"failed_reason": "<string>",
"button_presses": [
{
"button": "<string>",
"pressed_at": "2023-11-07T05:31:56Z"
}
],
"email_status": "<string>",
"email_status_at": "2023-11-07T05:31:56Z",
"email_failed_reason": "<string>",
"call": {
"status": "<string>",
"answered": true,
"duration_seconds": 123
}
}
]
}
]
}Campaigns
Get campaign recipients
Retrieve a campaign’s recipients a page at a time: who was reached, who responded or converted and, for every send step, the per-message outcome (delivered, read, failed and why, buttons pressed, email status, call result).
GET
/
api
/
public
/
outreach-campaign
/
{campaignId}
/
recipients
Get campaign recipients
curl --request GET \
--url https://api.vambe.me/api/public/outreach-campaign/{campaignId}/recipients \
--header 'x-api-key: <x-api-key>'const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};
fetch('https://api.vambe.me/api/public/outreach-campaign/{campaignId}/recipients', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.vambe.me/api/public/outreach-campaign/{campaignId}/recipients"
headers = {"x-api-key": "<x-api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"total": 123,
"page": 123,
"page_size": 123,
"has_more": true,
"steps": [
{
"node_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"step_number": 123,
"kind": "send-template",
"name": "<string>",
"channel": "whatsapp"
}
],
"recipients": [
{
"recipient_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"phone": "<string>",
"email": "<string>",
"status": "pending",
"reach": "full",
"dispatched_at": "2023-11-07T05:31:56Z",
"batch_number": 123,
"next_step_at": "2023-11-07T05:31:56Z",
"responded_at": "2023-11-07T05:31:56Z",
"converted_at": "2023-11-07T05:31:56Z",
"error": "<string>",
"steps": [
{
"node_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "pending",
"reason": "<string>",
"failure_level": "system",
"at": "2023-11-07T05:31:56Z",
"delivered_at": "2023-11-07T05:31:56Z",
"read_at": "2023-11-07T05:31:56Z",
"failed_at": "2023-11-07T05:31:56Z",
"failed_reason": "<string>",
"button_presses": [
{
"button": "<string>",
"pressed_at": "2023-11-07T05:31:56Z"
}
],
"email_status": "<string>",
"email_status_at": "2023-11-07T05:31:56Z",
"email_failed_reason": "<string>",
"call": {
"status": "<string>",
"answered": true,
"duration_seconds": 123
}
}
]
}
]
}Headers
API key needed to authorize the request
Path Parameters
The ID of the campaign, from List campaigns
Query Parameters
Required range:
x >= 1Required range:
1 <= x <= 100Was this page helpful?
