Call lists

40 operations · all resources

What this covers#

Upload people to call (CSV, Excel, a Google Sheet or JSON rows), pick an agent and a phone line, set calling hours and start. Each person is called through the same door as an outbound voice session, a few at a time. The do-not-call list is here too.

Every example below runs as written once these are exported:

export DVAARIK_API_KEY="dvk_..."        # project API key, server side only
export DVAARIK_TOKEN="<account access token>"   # console session, from POST /console/auth/login
export LIST_ID="<uuid>"
export PHONE_NUMBER="<uuid>"
export PROJECT_ID="<uuid>"

A <value> inside a JSON body is a value you supply. Responses are JSON; every error body is { "detail": … }. Each schema is expanded once per page, where it first appears.

Machine door errors#

Raised by the project-key dependency before any handler on this page runs.

Account door errors#

Operations — project API key#

Call these from your own server with a project key. Never from a browser or a mobile bundle.

GET /v2/call-lists#

List the project's call lists, newest first, with how far each has got.

CallListPage#

CallListInfo#

Plus the machine-door errors above. Full list on the errors page.

curl -sS -X GET "https://api.developers.dvaarik.com/v2/call-lists?limit=20" \
  -H "X-Api-Key: $DVAARIK_API_KEY"

POST /v2/call-lists#

Make a call list for one agent and one phone line. Nobody is called until you start it.

Request body: CallListCreate.

CallListCreate#

CallListSettings#

CallListCounts#

Plus the machine-door errors above. Full list on the errors page.

curl -sS -X POST "https://api.developers.dvaarik.com/v2/call-lists" \
  -H "X-Api-Key: $DVAARIK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "agent_id": "<agent_id uuid>",
    "from": "<from>",
    "name": "<name>"
  }'

DELETE /v2/call-lists/{list_id}#

Delete a list and everyone on it. Pause or cancel it first.

Plus the machine-door errors above. Full list on the errors page.

curl -sS -X DELETE "https://api.developers.dvaarik.com/v2/call-lists/$LIST_ID" \
  -H "X-Api-Key: $DVAARIK_API_KEY"

GET /v2/call-lists/{list_id}#

Read one call list: its settings, its counts and why it paused, if it did.

Plus the machine-door errors above. Full list on the errors page.

curl -sS -X GET "https://api.developers.dvaarik.com/v2/call-lists/$LIST_ID" \
  -H "X-Api-Key: $DVAARIK_API_KEY"

PATCH /v2/call-lists/{list_id}#

Change a list's name, agent, phone line or settings. Only while it is a draft or paused.

Request body: CallListUpdate.

CallListUpdate#

Plus the machine-door errors above. Full list on the errors page.

curl -sS -X PATCH "https://api.developers.dvaarik.com/v2/call-lists/$LIST_ID" \
  -H "X-Api-Key: $DVAARIK_API_KEY"

POST /v2/call-lists/{list_id}/cancel#

End the list. Everyone not called yet is skipped; calls already ringing finish.

Plus the machine-door errors above. Full list on the errors page.

curl -sS -X POST "https://api.developers.dvaarik.com/v2/call-lists/$LIST_ID/cancel" \
  -H "X-Api-Key: $DVAARIK_API_KEY"

POST /v2/call-lists/{list_id}/pause#

Stop placing new calls. Calls already ringing finish.

Plus the machine-door errors above. Full list on the errors page.

curl -sS -X POST "https://api.developers.dvaarik.com/v2/call-lists/$LIST_ID/pause" \
  -H "X-Api-Key: $DVAARIK_API_KEY"

POST /v2/call-lists/{list_id}/preview/file#

Show how a file would be read (phone column, variables, skipped rows) without saving anything.

CallListPreview#

CallListPreviewRow#

Plus the machine-door errors above. Full list on the errors page.

curl -sS -X POST "https://api.developers.dvaarik.com/v2/call-lists/$LIST_ID/preview/file" \
  -H "X-Api-Key: $DVAARIK_API_KEY"

POST /v2/call-lists/{list_id}/preview/sheet#

Show how a Google Sheet would be read without saving anything.

Request body: CallListSheetIn.

CallListSheetIn#

Plus the machine-door errors above. Full list on the errors page.

curl -sS -X POST "https://api.developers.dvaarik.com/v2/call-lists/$LIST_ID/preview/sheet" \
  -H "X-Api-Key: $DVAARIK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "<url>"
  }'

GET /v2/call-lists/{list_id}/results.csv#

Everyone on the list with how their call went, the call id, connected seconds and cost, as a CSV.

Plus the machine-door errors above. Full list on the errors page.

curl -sS -X GET "https://api.developers.dvaarik.com/v2/call-lists/$LIST_ID/results.csv" \
  -H "X-Api-Key: $DVAARIK_API_KEY"

POST /v2/call-lists/{list_id}/resume#

Carry on after a pause, once whatever paused it is fixed.

Plus the machine-door errors above. Full list on the errors page.

curl -sS -X POST "https://api.developers.dvaarik.com/v2/call-lists/$LIST_ID/resume" \
  -H "X-Api-Key: $DVAARIK_API_KEY"

GET /v2/call-lists/{list_id}/rows#

Page through the people with their status, tries and outcome.

CallListRowPage#

CallListRowInfo#

Plus the machine-door errors above. Full list on the errors page.

curl -sS -X GET "https://api.developers.dvaarik.com/v2/call-lists/$LIST_ID/rows?limit=20" \
  -H "X-Api-Key: $DVAARIK_API_KEY"

POST /v2/call-lists/{list_id}/rows#

Add up to 1,000 people as JSON. Variable names must match the agent's exactly.

Request body: CallListRowsIn.

CallListRowsIn#

CallListRowIn#

CallListRowsAdded#

Plus the machine-door errors above. Full list on the errors page.

curl -sS -X POST "https://api.developers.dvaarik.com/v2/call-lists/$LIST_ID/rows" \
  -H "X-Api-Key: $DVAARIK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "rows": []
  }'

POST /v2/call-lists/{list_id}/rows/file#

Add people from a .csv or .xlsx sent as the raw request body (at most 5 MB, 10,000 people per list).

Plus the machine-door errors above. Full list on the errors page.

curl -sS -X POST "https://api.developers.dvaarik.com/v2/call-lists/$LIST_ID/rows/file" \
  -H "X-Api-Key: $DVAARIK_API_KEY"

POST /v2/call-lists/{list_id}/rows/sheet#

Add people from a Google Sheet shared as 'Anyone with the link can view'.

Request body: CallListSheetIn.

Plus the machine-door errors above. Full list on the errors page.

curl -sS -X POST "https://api.developers.dvaarik.com/v2/call-lists/$LIST_ID/rows/sheet" \
  -H "X-Api-Key: $DVAARIK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "<url>"
  }'

POST /v2/call-lists/{list_id}/start#

Start calling. Needs at least one person waiting, an active agent and a line that can call out.

Plus the machine-door errors above. Full list on the errors page.

curl -sS -X POST "https://api.developers.dvaarik.com/v2/call-lists/$LIST_ID/start" \
  -H "X-Api-Key: $DVAARIK_API_KEY"

GET /v2/do-not-call#

List the numbers this project never calls.

DoNotCallPage#

DoNotCallEntry#

Plus the machine-door errors above. Full list on the errors page.

curl -sS -X GET "https://api.developers.dvaarik.com/v2/do-not-call?limit=20" \
  -H "X-Api-Key: $DVAARIK_API_KEY"

POST /v2/do-not-call#

Add numbers this project must never call. Lists skip them; a single outbound call to one is refused.

Request body: DoNotCallIn.

DoNotCallIn#

DoNotCallAdded#

Plus the machine-door errors above. Full list on the errors page.

curl -sS -X POST "https://api.developers.dvaarik.com/v2/do-not-call" \
  -H "X-Api-Key: $DVAARIK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "numbers": []
  }'

DELETE /v2/do-not-call/{phone_number}#

Take one number off the do-not-call list.

Plus the machine-door errors above. Full list on the errors page.

curl -sS -X DELETE "https://api.developers.dvaarik.com/v2/do-not-call/$PHONE_NUMBER" \
  -H "X-Api-Key: $DVAARIK_API_KEY"

POST /v2/do-not-call/file#

Add do-not-call numbers from a .csv or .xlsx sent as the raw request body.

Plus the machine-door errors above. Full list on the errors page.

curl -sS -X POST "https://api.developers.dvaarik.com/v2/do-not-call/file" \
  -H "X-Api-Key: $DVAARIK_API_KEY"

Operations — account session#

The same resource through the console door. These are what the web console calls; both doors return the same shapes.

GET /console/v2/projects/{project_id}/call-lists#

List the project's call lists, newest first, with how far each has got.

Plus the account-door errors above. Full list on the errors page.

curl -sS -X GET "https://api.developers.dvaarik.com/console/v2/projects/$PROJECT_ID/call-lists?limit=20" \
  -H "Authorization: Bearer $DVAARIK_TOKEN"

POST /console/v2/projects/{project_id}/call-lists#

Make a call list for one agent and one phone line. Nobody is called until you start it.

Request body: CallListCreate.

Plus the account-door errors above. Full list on the errors page.

curl -sS -X POST "https://api.developers.dvaarik.com/console/v2/projects/$PROJECT_ID/call-lists" \
  -H "Authorization: Bearer $DVAARIK_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "agent_id": "<agent_id uuid>",
    "from": "<from>",
    "name": "<name>"
  }'

DELETE /console/v2/projects/{project_id}/call-lists/{list_id}#

Delete a list and everyone on it. Pause or cancel it first.

Plus the account-door errors above. Full list on the errors page.

curl -sS -X DELETE "https://api.developers.dvaarik.com/console/v2/projects/$PROJECT_ID/call-lists/$LIST_ID" \
  -H "Authorization: Bearer $DVAARIK_TOKEN"

GET /console/v2/projects/{project_id}/call-lists/{list_id}#

Read one call list: its settings, its counts and why it paused, if it did.

Plus the account-door errors above. Full list on the errors page.

curl -sS -X GET "https://api.developers.dvaarik.com/console/v2/projects/$PROJECT_ID/call-lists/$LIST_ID" \
  -H "Authorization: Bearer $DVAARIK_TOKEN"

PATCH /console/v2/projects/{project_id}/call-lists/{list_id}#

Change a list's name, agent, phone line or settings. Only while it is a draft or paused.

Request body: CallListUpdate.

Plus the account-door errors above. Full list on the errors page.

curl -sS -X PATCH "https://api.developers.dvaarik.com/console/v2/projects/$PROJECT_ID/call-lists/$LIST_ID" \
  -H "Authorization: Bearer $DVAARIK_TOKEN"

POST /console/v2/projects/{project_id}/call-lists/{list_id}/cancel#

End the list. Everyone not called yet is skipped; calls already ringing finish.

Plus the account-door errors above. Full list on the errors page.

curl -sS -X POST "https://api.developers.dvaarik.com/console/v2/projects/$PROJECT_ID/call-lists/$LIST_ID/cancel" \
  -H "Authorization: Bearer $DVAARIK_TOKEN"

POST /console/v2/projects/{project_id}/call-lists/{list_id}/pause#

Stop placing new calls. Calls already ringing finish.

Plus the account-door errors above. Full list on the errors page.

curl -sS -X POST "https://api.developers.dvaarik.com/console/v2/projects/$PROJECT_ID/call-lists/$LIST_ID/pause" \
  -H "Authorization: Bearer $DVAARIK_TOKEN"

POST /console/v2/projects/{project_id}/call-lists/{list_id}/preview/file#

Show how a file would be read (phone column, variables, skipped rows) without saving anything.

Plus the account-door errors above. Full list on the errors page.

curl -sS -X POST "https://api.developers.dvaarik.com/console/v2/projects/$PROJECT_ID/call-lists/$LIST_ID/preview/file" \
  -H "Authorization: Bearer $DVAARIK_TOKEN"

POST /console/v2/projects/{project_id}/call-lists/{list_id}/preview/sheet#

Show how a Google Sheet would be read without saving anything.

Request body: CallListSheetIn.

Plus the account-door errors above. Full list on the errors page.

curl -sS -X POST "https://api.developers.dvaarik.com/console/v2/projects/$PROJECT_ID/call-lists/$LIST_ID/preview/sheet" \
  -H "Authorization: Bearer $DVAARIK_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "<url>"
  }'

GET /console/v2/projects/{project_id}/call-lists/{list_id}/results.csv#

Everyone on the list with how their call went, the call id, connected seconds and cost, as a CSV.

Plus the account-door errors above. Full list on the errors page.

curl -sS -X GET "https://api.developers.dvaarik.com/console/v2/projects/$PROJECT_ID/call-lists/$LIST_ID/results.csv" \
  -H "Authorization: Bearer $DVAARIK_TOKEN"

POST /console/v2/projects/{project_id}/call-lists/{list_id}/resume#

Carry on after a pause, once whatever paused it is fixed.

Plus the account-door errors above. Full list on the errors page.

curl -sS -X POST "https://api.developers.dvaarik.com/console/v2/projects/$PROJECT_ID/call-lists/$LIST_ID/resume" \
  -H "Authorization: Bearer $DVAARIK_TOKEN"

GET /console/v2/projects/{project_id}/call-lists/{list_id}/rows#

Page through the people with their status, tries and outcome.

Plus the account-door errors above. Full list on the errors page.

curl -sS -X GET "https://api.developers.dvaarik.com/console/v2/projects/$PROJECT_ID/call-lists/$LIST_ID/rows?limit=20" \
  -H "Authorization: Bearer $DVAARIK_TOKEN"

POST /console/v2/projects/{project_id}/call-lists/{list_id}/rows#

Add up to 1,000 people as JSON. Variable names must match the agent's exactly.

Request body: CallListRowsIn.

Plus the account-door errors above. Full list on the errors page.

curl -sS -X POST "https://api.developers.dvaarik.com/console/v2/projects/$PROJECT_ID/call-lists/$LIST_ID/rows" \
  -H "Authorization: Bearer $DVAARIK_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "rows": []
  }'

POST /console/v2/projects/{project_id}/call-lists/{list_id}/rows/file#

Add people from a .csv or .xlsx sent as the raw request body (at most 5 MB, 10,000 people per list).

Plus the account-door errors above. Full list on the errors page.

curl -sS -X POST "https://api.developers.dvaarik.com/console/v2/projects/$PROJECT_ID/call-lists/$LIST_ID/rows/file" \
  -H "Authorization: Bearer $DVAARIK_TOKEN"

POST /console/v2/projects/{project_id}/call-lists/{list_id}/rows/sheet#

Add people from a Google Sheet shared as 'Anyone with the link can view'.

Request body: CallListSheetIn.

Plus the account-door errors above. Full list on the errors page.

curl -sS -X POST "https://api.developers.dvaarik.com/console/v2/projects/$PROJECT_ID/call-lists/$LIST_ID/rows/sheet" \
  -H "Authorization: Bearer $DVAARIK_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "<url>"
  }'

POST /console/v2/projects/{project_id}/call-lists/{list_id}/start#

Start calling. Needs at least one person waiting, an active agent and a line that can call out.

Plus the account-door errors above. Full list on the errors page.

curl -sS -X POST "https://api.developers.dvaarik.com/console/v2/projects/$PROJECT_ID/call-lists/$LIST_ID/start" \
  -H "Authorization: Bearer $DVAARIK_TOKEN"

GET /console/v2/projects/{project_id}/do-not-call#

List the numbers this project never calls.

Plus the account-door errors above. Full list on the errors page.

curl -sS -X GET "https://api.developers.dvaarik.com/console/v2/projects/$PROJECT_ID/do-not-call?limit=20" \
  -H "Authorization: Bearer $DVAARIK_TOKEN"

POST /console/v2/projects/{project_id}/do-not-call#

Add numbers this project must never call. Lists skip them; a single outbound call to one is refused.

Request body: DoNotCallIn.

Plus the account-door errors above. Full list on the errors page.

curl -sS -X POST "https://api.developers.dvaarik.com/console/v2/projects/$PROJECT_ID/do-not-call" \
  -H "Authorization: Bearer $DVAARIK_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "numbers": []
  }'

DELETE /console/v2/projects/{project_id}/do-not-call/{phone_number}#

Take one number off the do-not-call list.

Plus the account-door errors above. Full list on the errors page.

curl -sS -X DELETE "https://api.developers.dvaarik.com/console/v2/projects/$PROJECT_ID/do-not-call/$PHONE_NUMBER" \
  -H "Authorization: Bearer $DVAARIK_TOKEN"

POST /console/v2/projects/{project_id}/do-not-call/file#

Add do-not-call numbers from a .csv or .xlsx sent as the raw request body.

Plus the account-door errors above. Full list on the errors page.

curl -sS -X POST "https://api.developers.dvaarik.com/console/v2/projects/$PROJECT_ID/do-not-call/file" \
  -H "Authorization: Bearer $DVAARIK_TOKEN"