Admin/Get Campaigns
App
GET /v1/admin/campaigns

Get Campaigns

Base URL https://api.{cluster}.{platform}.voiger.io
Request · cURL 
curl https://api.{cluster}.{platform}.voiger.io/v1/admin/campaigns?_limit=&_skip= \
  -H "Cookie: sid=$VOIGER_SESSION" \
  -H "x-workspace-code: your-workspace-code"

Parameters

x-workspace-code string required in header
_limit number optional in query
_skip number optional in query
_search string optional in query
_sort string optional in query

Response

campaigns▾
array
id
string
name
string
strategy
string The strategy/type combination for the campaign. - progressive_dialer: Type will be pre_connect or post_connect. - voice_broadcast: Type will be audio, tts or ivr.
type
string
audio_id
null | string Present when type is audio.
tts▾
null | object Present when type is tts.
language
string
text
string
ivr_id
null | string Present when type is ivr.
queue_id
null | string Present when type is pre_connect or post_connect. Omitted for voice_broadcast.
connector_id
string
country
string
retries
integer
retry_delay
integer
ring_timeout
integer
concurrency
integer
calls_per_agent
integer Predictive dialer only. Number of calls to place per available agent.
reason
string
agent_script
string
restrict_tag_ids
null | array If null, any tag is allowed. If empty array, no tags are allowed. If filled, only those tag ids are allowed.
recall_waiting_time
integer
timeslots
object
total
integer Total customers in the campaign.
processed
integer Number of customers processed (terminal disposition). Use with total for progress (processed / total) and with answered for answer rate (answered / processed).
answered
integer Number of customers who answered. Answer rate = answered / processed (when processed > 0).
weight
number Campaign weight for proportional slot distribution when agents are shared across campaigns. Updated via PUT /campaigns/weights.
status
string
start_date
string
end_date
string
created_at
string
updated_at
string
ESC