Skip to main content
GET
List Campaign Targets

Headers

authorization
string | null

Path Parameters

campaign_id
string<uuid>
required

Query Parameters

status
enum<string> | null

One target's place in its campaign (#229, #232).

pending waits to be dialled; dialling is claimed by a worker that has not asked the carrier yet; placing is the carrier being asked; calling has a call placed; the rest are final.

dialling and placing are separate committed steps because a worker can die in either, and they mean opposite things: a dead claim in dialling never reached the carrier and goes back to pending, while one in placing may have rung a phone with no call row to show for it, so the janitor ends it failed rather than ever dialling it a second time.

Available options:
pending,
dialling,
placing,
calling,
completed,
suppressed,
failed,
cancelled
page
integer
default:1
Required range: x >= 1
limit
integer
default:100
Required range: 1 <= x <= 500

Response

Successful Response

The response is of type Response List Campaign Targets V1 Campaigns Campaign Id Targets Get · object.