campaign audiences
list an audience's contacts
the audience’s rows in file order: the number as dialled (E.164) and every column as uploaded.
GET
/
v1
/
campaign-audiences
/
{audience_id}
/
contacts
list an audience's contacts
curl --request GET \
--url https://silk-api.rumik.ai/v1/campaign-audiences/{audience_id}/contacts \
--header 'Authorization: Bearer <token>'import requests
url = "https://silk-api.rumik.ai/v1/campaign-audiences/{audience_id}/contacts"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://silk-api.rumik.ai/v1/campaign-audiences/{audience_id}/contacts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://silk-api.rumik.ai/v1/campaign-audiences/{audience_id}/contacts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://silk-api.rumik.ai/v1/campaign-audiences/{audience_id}/contacts"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://silk-api.rumik.ai/v1/campaign-audiences/{audience_id}/contacts")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://silk-api.rumik.ai/v1/campaign-audiences/{audience_id}/contacts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"items": [
{
"id": "01a0d276-81a4-73b5-e021-3c4d5e6f7081",
"rowNumber": 1,
"phoneNumber": "+919876543210",
"data": {
"name": "Asha",
"city": "Pune",
"mobile": "9876543210"
}
}
],
"count": 2,
"page": 1,
"totalPages": 1
}{
"error": "Invalid API key",
"code": "unauthorized"
}{
"error": "This API key lacks the 'agent' scope",
"code": "forbidden_scope"
}{
"error": "Contact group not found",
"code": "campaign_audience_not_found"
}{
"error": "Rate limit exceeded",
"code": "rate_limited",
"limit": 100,
"current": 101
}Authorizations
your rumik api key, e.g. rk_live_.... create one in the rumik dashboard.
Path Parameters
the audience's id.
Query Parameters
page number, from 1.
Required range:
x >= 1page size (1–200, default 50).
Required range:
1 <= x <= 200⌘I
list an audience's contacts
curl --request GET \
--url https://silk-api.rumik.ai/v1/campaign-audiences/{audience_id}/contacts \
--header 'Authorization: Bearer <token>'import requests
url = "https://silk-api.rumik.ai/v1/campaign-audiences/{audience_id}/contacts"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://silk-api.rumik.ai/v1/campaign-audiences/{audience_id}/contacts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://silk-api.rumik.ai/v1/campaign-audiences/{audience_id}/contacts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://silk-api.rumik.ai/v1/campaign-audiences/{audience_id}/contacts"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://silk-api.rumik.ai/v1/campaign-audiences/{audience_id}/contacts")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://silk-api.rumik.ai/v1/campaign-audiences/{audience_id}/contacts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"items": [
{
"id": "01a0d276-81a4-73b5-e021-3c4d5e6f7081",
"rowNumber": 1,
"phoneNumber": "+919876543210",
"data": {
"name": "Asha",
"city": "Pune",
"mobile": "9876543210"
}
}
],
"count": 2,
"page": 1,
"totalPages": 1
}{
"error": "Invalid API key",
"code": "unauthorized"
}{
"error": "This API key lacks the 'agent' scope",
"code": "forbidden_scope"
}{
"error": "Contact group not found",
"code": "campaign_audience_not_found"
}{
"error": "Rate limit exceeded",
"code": "rate_limited",
"limit": 100,
"current": 101
}