VocalDocscontracts 1.65.0

List a Campaign's numbers

GET /v1/campaigns/{campaign_id}/numbers

PropertyValue
Operationlist_campaign_numbers
GroupCampaigns
Scopecampaigns:read
Route classread
IdempotencyNo Idempotency-Key
AuditNot audited: Aggregates and number health: counts, rates and ids, never content.
Released in1.65.0
Phase 0 hostServed (the hosted api pins 1.65.0)

Pages the numbers of a Campaign with their state, caps and health over the last 24 hours (1.65.0; section 5).

Request

Set VOCAL_API to the base URL of your API and VOCAL_API_KEY to an API key with the campaigns:read scope (Authentication and keys). Replace each placeholder, such as agt_... or <name>, with your own value.

curl "$VOCAL_API/v1/campaigns/cmp_.../numbers" \
  -H "Authorization: Bearer $VOCAL_API_KEY"

Parameters

NameInTypeRequiredDescription
campaign_idpathCampaignIdyesThe id of a Campaign: cmp_ and the row's UUIDv7 in 26 Crockford base32 characters. Opaque and safe to log.
limitqueryintegernoThe page size, 1 to 100.
cursorquerystringnoThe opaque next_cursor of the previous page; it binds the filters it was issued under.

Responses

StatusContent typeShapeError codes
200application/jsonCampaignNumberList
400application/jsonErrorEnvelopeinvalid_request, invalid_cursor
401application/jsonErrorEnvelopeunauthenticated
403application/jsonErrorEnvelopeforbidden
404application/jsonErrorEnvelopenot_found
429application/jsonErrorEnveloperate_limited
500application/jsonErrorEnvelopeinternal_error

Fields of the 200 answer

The shape is CampaignNumberList.

FieldTypeRequiredDescription
dataarray of CampaignNumberyesThe numbers of a Campaign of this page, newest first.
has_morebooleanyesTrue when a further page exists.
next_cursorstring or nullyesThe cursor of the next page, or null on the last page.
object"list"yes