Skip to content
Blue Dots EconomyBlue Dots EconomyDocumentation
campaign

Get one voice job's status and per-item outcomes

GET
/v1/campaign/voice/{job_id}
curl --request GET \
  --url https://aggregator.example.com/v1/campaign/voice/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Returns the job status (derived from item counts) and each item id with its status, provider ref and skip/error reason. Scoped to this org and to the voice channel — a job belonging to another org or channel returns 403.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
job_id
required
string format: uuid

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
job_id
required
string format: uuid
channel
required
string
Allowed values: export email voice
status
required
string
Allowed values: queued processing partial completed failed
counts
required
object
total
required
integer
pending
required
integer
resolved
required
integer
submitted
required
integer
sent
required
integer
skipped_not_owned
required
integer
skipped_no_contact
required
integer
duplicate_active
required
integer
failed
required
integer
created_at
required
string
updated_at
required
string
metadata
required
Array<object>
object
key
required
string
value
required
string
provider_response
nullable
items
required
Array<object>
object
item_id
required
string
status
required
string
Allowed values: pending resolved submitted sent skipped_not_owned skipped_no_contact duplicate_active failed
provider_ref
required
string
nullable
provider_batch_ref
required
string
nullable
skip_reason
required
string
nullable
error_reason
required
string
nullable
Example
{
  "channel": "export",
  "status": "queued",
  "items": [
    {
      "status": "pending"
    }
  ]
}

401

Section titled “401”

Default Response

Media typeapplication/json
object
error
required
object
code
required
string
title
required
string
detail
required
string
docs
string
fields
object
key
additional properties
requestId
required
string
timestamp
required
string
key
additional properties
any
key
additional properties
any
Examplegenerated
{
  "error": {
    "code": "example",
    "title": "example",
    "detail": "example",
    "docs": "example",
    "fields": {
      "additionalProperty": "example"
    },
    "requestId": "example",
    "timestamp": "example"
  }
}

403

Section titled “403”

Default Response

Media typeapplication/json
object
error
required
object
code
required
string
title
required
string
detail
required
string
docs
string
fields
object
key
additional properties
requestId
required
string
timestamp
required
string
key
additional properties
any
key
additional properties
any
Examplegenerated
{
  "error": {
    "code": "example",
    "title": "example",
    "detail": "example",
    "docs": "example",
    "fields": {
      "additionalProperty": "example"
    },
    "requestId": "example",
    "timestamp": "example"
  }
}