Languages: every operation supports cURL, Node.js (TypeScript), Python, Go, Ruby, and PHP. The first 15 operations on this page show all six languages; the remaining 7 show cURL and TypeScript — the two most-used.

Dialer API

Dialer endpoints exposed by the Devotel CPaaS API Base path: /api/v1/dialer Endpoint count: 22

title: “The preview-dial loop” description: “How the two preview-mode operations chain: claim a contact atomically, review it on the agent’s screen, then launch the dial.”

The preview-dial loop

Outbound-campaign operators run the dialer workspace. Progressive, predictive, and agentless campaigns fire through the pacing scheduler automatically; preview mode is the one where a human reviews each contact card before the call launches. That human loop compresses into two endpoints. First the agent’s frontend claims the next contact with GET /api/v1/dialer/next-call:

cURL

curl "https://api.orbit.devotel.io/api/v1/dialer/next-call?campaign_id=cmp_71bd" \
  -H "X-API-Key: $ORBIT_API_KEY"

{
  "data": {
    "contact": {
      "id": "dc_3f9ac42b",
      "phone_e164": "+14155552671",
      "display_name": "Dana Reyes",
      "contact_id": "ct_d2b8",
      "attempts": 1
    },
    "preview_decision_seconds": 30,
    "decision_expires_at": "2026-08-01T12:01:30.000Z"
  },
  "meta": {
    "request_id": "req_next_call",
    "timestamp": "2026-08-01T12:00:00.000Z"
  }
}

The claim is atomic — two agents polling concurrently never receive the same number — so the response is the work ticket the agent then reviews on their screen. preview_decision_seconds is the per-campaign review countdown; decision_expires_at is the server-side deadline for that countdown. 204 No Content means the campaign is progressive / predictive / agentless (calls fire automatically); 404 means the campaign is not active. A null contact means the list is drained. Once the agent clicks “Call” the dial launches:

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/dialer/dial" \
  -H "X-API-Key: $ORBIT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"campaign_id":"cmp_71bd","contact_id":"dc_3f9ac42b"}'

The contact must still be in the dialing (claimed) state, or the request rejects with 409 CLAIM_NOT_HELD. The requesting operator records as the call’s agent for the TCPA audit trail, and the call itself exits through the Devotel softswitch — the preview loop never dials a number outside the commit path.

SDK surface bridge — List outbound-dialer campaigns, queue the next hop of the campaign FIFO, or trigger one alias lane — all with the sandbox key.

These three tabs mirror SDK status and coverage. Python fronts client.request, Go fronts client.Request, and TS fronts fetch-TS — each with the sandbox key.

List dialer campaigns

fetch-TS (Node SDK style)

const res = await fetch('https://api.orbit.devotel.io/api/v1/voice/dialer/campaigns', {
  method: 'GET',
  headers: {
'X-API-Key': process.env.ORBIT_SANDBOX_KEY!,
  },
})
console.log(await res.json())

client.request

r = requests.get("https://api.orbit.devotel.io/api/v1/voice/dialer/campaigns", headers={ "X-API-Key": os.environ["ORBIT_SANDBOX_KEY"] })
print(r.json())

client.Request

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/voice/dialer/campaigns", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_SANDBOX_KEY"))
	http.DefaultClient.Do(req)
}

Queue the next campaign hop

fetch-TS (Node SDK style)

const res = await fetch('https://api.orbit.devotel.io/api/v1/voice/dialer/campaigns/cmp_demo/queue', {
  method: 'POST',
  headers: {
'X-API-Key': process.env.ORBIT_SANDBOX_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "fifo": "next"
},
})
console.log(await res.json())

client.request

r = requests.post("https://api.orbit.devotel.io/api/v1/voice/dialer/campaigns/cmp_demo/queue", json={
  "fifo": "next"
}, headers={ "X-API-Key": os.environ["ORBIT_SANDBOX_KEY"] })
print(r.json())

client.Request

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("POST", "https://api.orbit.devotel.io/api/v1/voice/dialer/campaigns/cmp_demo/queue", bytes.NewBuffer([]byte(`{
  "fifo": "next"
}`)))
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_SANDBOX_KEY"))
	req.Header.Set("Content-Type", "application/json")
	http.DefaultClient.Do(req)
}

Fire one alias lane

fetch-TS (Node SDK style)

const res = await fetch('https://api.orbit.devotel.io/api/v1/voice/dialer/campaigns/cmp_demo/alias', {
  method: 'POST',
  headers: {
'X-API-Key': process.env.ORBIT_SANDBOX_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "lane": "one"
},
})
console.log(await res.json())

client.request

r = requests.post("https://api.orbit.devotel.io/api/v1/voice/dialer/campaigns/cmp_demo/alias", json={
  "lane": "one"
}, headers={ "X-API-Key": os.environ["ORBIT_SANDBOX_KEY"] })
print(r.json())

client.Request

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("POST", "https://api.orbit.devotel.io/api/v1/voice/dialer/campaigns/cmp_demo/alias", bytes.NewBuffer([]byte(`{
  "lane": "one"
}`)))
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_SANDBOX_KEY"))
	req.Header.Set("Content-Type", "application/json")
	http.DefaultClient.Do(req)
}

Alias-lane request inbox

fetch-TS (Node SDK style)

const res = await fetch('https://api.orbit.devotel.io/api/v1/voice/dialer/campaigns/cmp_demo/request', {
  method: 'POST',
  headers: {
'X-API-Key': process.env.ORBIT_SANDBOX_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "inbox": "alias"
},
})
console.log(await res.json())

client.request

r = requests.post("https://api.orbit.devotel.io/api/v1/voice/dialer/campaigns/cmp_demo/request", json={
  "inbox": "alias"
}, headers={ "X-API-Key": os.environ["ORBIT_SANDBOX_KEY"] })
print(r.json())

client.Request

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("POST", "https://api.orbit.devotel.io/api/v1/voice/dialer/campaigns/cmp_demo/request", bytes.NewBuffer([]byte(`{
  "inbox": "alias"
}`)))
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_SANDBOX_KEY"))
	req.Header.Set("Content-Type", "application/json")
	http.DefaultClient.Do(req)
}

List dialer campaigns

GET /api/v1/dialer/campaigns

Cursor-paginated list of every non-deleted campaign the tenant owns, newest first. Each row includes rolled-up contacts_total / contacts_connected counts (bounded scan — see contacts_count_capped_at). Degrades to an empty list (never a 5xx) when the tenant’s dialer schema is not yet provisioned.

string

Page size, 1-100 (clamped server-side). Defaults to 20.

string

Opaque pagination cursor from a prior response’s next_cursor.

string

Filter by campaign status: draft, active, paused, completed, or aborted. Unrecognized values are ignored (no filter applied).

string (enum: true|false)

Sandbox opt-in for Clerk-session-authenticated requests. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/dialer/campaigns" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/dialer/campaigns', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/dialer/campaigns", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/dialer/campaigns", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/dialer/campaigns')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/dialer/campaigns');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {
    "items": [
      {}
    ],
    "next_cursor": null,
    "has_more": false,
    "contacts_count_capped_at": 0
  },
  "meta": {
    "request_id": "req_sample",
    "timestamp": "1970-01-01T00:00:00.000Z"
  }
}

Get a dialer campaign

GET /api/v1/dialer/campaigns/{id}

Fetches one non-deleted campaign by id, including every configuration column (pacing, caller-ID, script, retry policy, metadata). Returns 404 when the campaign does not exist or was soft-deleted.

string

required

Campaign id.

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/dialer/campaigns/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/dialer/campaigns/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/dialer/campaigns/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/dialer/campaigns/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/dialer/campaigns/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/dialer/campaigns/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {
    "contact": {
      "id": "dc_3f9ac42b",
      "phone_e164": "+14155552671",
      "display_name": "Dana Reyes",
      "contact_id": "ct_d2b8",
      "attempts": 1
    },
    "preview_decision_seconds": 30,
    "decision_expires_at": "2026-08-01T12:01:30.000Z"
  },
  "meta": {
    "request_id": "req_next_call",
    "timestamp": "2026-08-01T12:00:00.000Z"
  }
}

Get post-call AI sentiment + outcome scoring for a dialer attempt

GET /api/v1/dialer/campaigns/{id}/attempts/{attemptId}/outcome-scoring

Returns the post-call AI outcome-scoring blob (sentiment, 0-100 composite score, warm/engaged/neutral/cold/voicemail label, next-best-action, agent disposition) the async dialer-outcome-intelligence analyzer persisted onto the attempt’s call row. analyzed:false when the analyzer hasn’t run yet or the tenant hasn’t enabled it.

string

required

—

string

required

—

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/dialer/campaigns/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/attempts/{attemptId}/outcome-scoring" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/dialer/campaigns/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/attempts/{attemptId}/outcome-scoring', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/dialer/campaigns/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/attempts/{attemptId}/outcome-scoring", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/dialer/campaigns/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/attempts/{attemptId}/outcome-scoring", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/dialer/campaigns/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/attempts/{attemptId}/outcome-scoring')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/dialer/campaigns/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/attempts/{attemptId}/outcome-scoring');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {
    "contact": {
      "id": "dc_3f9ac42b",
      "phone_e164": "+14155552671",
      "display_name": "Dana Reyes",
      "contact_id": "ct_d2b8",
      "attempts": 1
    },
    "preview_decision_seconds": 30,
    "decision_expires_at": "2026-08-01T12:01:30.000Z"
  },
  "meta": {
    "request_id": "req_next_call",
    "timestamp": "2026-08-01T12:00:00.000Z"
  }
}

Dialer local-presence caller-ID coverage + analytics

GET /api/v1/dialer/campaigns/{id}/caller-id-coverage

Per-NPA local-presence caller-ID coverage report for one campaign. Surfaces which destination NPAs the campaign’s caller-ID pool can present, the rolling answer-rate per destination NPA over the analytics window, and the highest-volume under-covered NPAs to add a local DID for. Helps operators optimize call completion rates when using local-presence (NPA-matching) caller-ID selection.

string

required

Campaign ID

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/dialer/campaigns/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/caller-id-coverage" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/dialer/campaigns/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/caller-id-coverage', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/dialer/campaigns/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/caller-id-coverage", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/dialer/campaigns/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/caller-id-coverage", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/dialer/campaigns/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/caller-id-coverage')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/dialer/campaigns/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/caller-id-coverage');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {
    "contact": {
      "id": "dc_3f9ac42b",
      "phone_e164": "+14155552671",
      "display_name": "Dana Reyes",
      "contact_id": "ct_d2b8",
      "attempts": 1
    },
    "preview_decision_seconds": 30,
    "decision_expires_at": "2026-08-01T12:01:30.000Z"
  },
  "meta": {
    "request_id": "req_next_call",
    "timestamp": "2026-08-01T12:00:00.000Z"
  }
}

List lists

GET /api/v1/dialer/campaigns/{id}/lists

string

required

—

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/dialer/campaigns/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/lists" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/dialer/campaigns/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/lists', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/dialer/campaigns/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/lists", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/dialer/campaigns/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/lists", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/dialer/campaigns/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/lists')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/dialer/campaigns/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/lists');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {
    "contact": {
      "id": "dc_3f9ac42b",
      "phone_e164": "+14155552671",
      "display_name": "Dana Reyes",
      "contact_id": "ct_d2b8",
      "attempts": 1
    },
    "preview_decision_seconds": 30,
    "decision_expires_at": "2026-08-01T12:01:30.000Z"
  },
  "meta": {
    "request_id": "req_next_call",
    "timestamp": "2026-08-01T12:00:00.000Z"
  }
}

List penetration

GET /api/v1/dialer/campaigns/{id}/lists/{listId}/penetration

string

required

—

string

required

—

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/dialer/campaigns/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/lists/{listId}/penetration" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/dialer/campaigns/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/lists/{listId}/penetration', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/dialer/campaigns/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/lists/{listId}/penetration", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/dialer/campaigns/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/lists/{listId}/penetration", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/dialer/campaigns/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/lists/{listId}/penetration')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/dialer/campaigns/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/lists/{listId}/penetration');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {
    "contact": {
      "id": "dc_3f9ac42b",
      "phone_e164": "+14155552671",
      "display_name": "Dana Reyes",
      "contact_id": "ct_d2b8",
      "attempts": 1
    },
    "preview_decision_seconds": 30,
    "decision_expires_at": "2026-08-01T12:01:30.000Z"
  },
  "meta": {
    "request_id": "req_next_call",
    "timestamp": "2026-08-01T12:00:00.000Z"
  }
}

Dialer campaign post-call AI sentiment + outcome rollup

GET /api/v1/dialer/campaigns/{id}/sentiment

Per-campaign AI sentiment rollup for outbound dialer calls. Reports the share of placed calls the post-call AI scored as positive / neutral / negative / unscored, the mean sentiment score, and the per-carrier-outcome sentiment breakdown (connected / no-answer / voicemail / AMD / pending / …). Helps operators see if the script reads as positive on answered legs.

string

required

Campaign ID

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/dialer/campaigns/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/sentiment" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/dialer/campaigns/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/sentiment', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/dialer/campaigns/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/sentiment", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/dialer/campaigns/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/sentiment", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/dialer/campaigns/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/sentiment')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/dialer/campaigns/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/sentiment');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {
    "contact": {
      "id": "dc_3f9ac42b",
      "phone_e164": "+14155552671",
      "display_name": "Dana Reyes",
      "contact_id": "ct_d2b8",
      "attempts": 1
    },
    "preview_decision_seconds": 30,
    "decision_expires_at": "2026-08-01T12:01:30.000Z"
  },
  "meta": {
    "request_id": "req_next_call",
    "timestamp": "2026-08-01T12:00:00.000Z"
  }
}

Dialer campaign wallboard stats

GET /api/v1/dialer/campaigns/{id}/stats

Live per-status contact breakdown (pending/dialing/connected/failed/dnc/…), last-24h call-outcome aggregate with average handle time, and a rolling 30-minute abandon-rate window for one campaign’s operator wallboard. Contact counts are bounded-scan (see contacts_count_capped) so a single poll can never scan an unbounded number of rows.

string

required

Campaign id.

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/dialer/campaigns/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/stats" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/dialer/campaigns/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/stats', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/dialer/campaigns/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/stats", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/dialer/campaigns/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/stats", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/dialer/campaigns/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/stats')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/dialer/campaigns/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/stats');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {
    "id": "msg_3f6a81c2d4e5471a9b0c2d5e",
    "status": "delivered",
    "contacts_total": 0,
    "contacts_count_capped": false
  },
  "meta": {
    "request_id": "req_sample",
    "timestamp": "1970-01-01T00:00:00.000Z"
  }
}

Dialer campaign stats (tenant-wide KPI strip)

GET /api/v1/dialer/campaigns/stats

Aggregate Active / Paused / Completed-today / 30-day abandon-rate totals across every non-deleted campaign the tenant owns. Source of truth for the dialer landing-page KPI tiles — computed in a single COUNT(*) FILTER / AVG(…) FILTER pass so the numbers do not depend on how many paginated campaign rows the operator has loaded.

string

IANA timezone (e.g. ‘America/New_York’) used to compute the operator-local day boundary for the ‘completed today’ tile. Defaults to UTC when omitted or malformed.

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/dialer/campaigns/stats" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/dialer/campaigns/stats', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/dialer/campaigns/stats", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/dialer/campaigns/stats", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/dialer/campaigns/stats')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/dialer/campaigns/stats');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {
    "active": 0,
    "paused": 0,
    "completed_today": 0,
    "avg_abandon_rate": null
  },
  "meta": {
    "request_id": "req_sample",
    "timestamp": "1970-01-01T00:00:00.000Z"
  }
}

Claim the next preview-mode contact for an agent

GET /api/v1/dialer/next-call

Hands the agent frontend the next contact to review for a preview-mode campaign, atomically claiming it so two agents polling concurrently never receive the same number and double-dial. Returns the claimed contact plus the per-campaign decision countdown, 204 No Content for progressive / predictive / agentless campaigns (their calls are originated automatically by the pacing engine), or 404 when the campaign is not active. The agent then reviews the contact and launches the call via POST /api/v1/dialer/dial.

string

The active preview-mode campaign to claim the next contact from.

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/dialer/next-call" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/dialer/next-call', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/dialer/next-call", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/dialer/next-call", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/dialer/next-call')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/dialer/next-call');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {
    "contact": null,
    "preview_decision_seconds": 0,
    "decision_expires_at": null
  },
  "meta": {
    "request_id": "req_sample",
    "timestamp": "1970-01-01T00:00:00.000Z"
  }
}

List campaigns

GET /api/v1/dialer/voice-agents/{agentId}/campaigns

string

required

—

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/dialer/voice-agents/agt_7e3b9c1f/campaigns" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/dialer/voice-agents/agt_7e3b9c1f/campaigns', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/dialer/voice-agents/agt_7e3b9c1f/campaigns", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/dialer/voice-agents/agt_7e3b9c1f/campaigns", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/dialer/voice-agents/agt_7e3b9c1f/campaigns')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/dialer/voice-agents/agt_7e3b9c1f/campaigns');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {
    "contact": {
      "id": "dc_3f9ac42b",
      "phone_e164": "+14155552671",
      "display_name": "Dana Reyes",
      "contact_id": "ct_d2b8",
      "attempts": 1
    },
    "preview_decision_seconds": 30,
    "decision_expires_at": "2026-08-01T12:01:30.000Z"
  },
  "meta": {
    "request_id": "req_next_call",
    "timestamp": "2026-08-01T12:00:00.000Z"
  }
}

Create a dialer campaign

POST /api/v1/dialer/campaigns

Creates a new outbound dialer campaign in draft status (preview / progressive / predictive / agentless mode). Validates that caller_id_e164 and every caller_id_pool entry are owned by the calling org (anti-spoofing), and that voice_agent_id (when set) references a real voice agent in this workspace. Recording requires recording_consent_acknowledged=true in the same request. Requires the dialer:write scope.

string

Stripe-style idempotency token. Pass a stable, client-generated value (1-255 chars) to dedupe retries on transient timeouts. The same key+credential+path replays the original response for 24h on 2xx (5min on 4xx, 30s on 5xx). Returns 409 if a concurrent request with the same key is already in flight; replayed responses include the Idempotency-Replay: true response header.

string (enum: true|false)

string

Campaign display name.

string

Dial strategy: ‘preview’ (agent reviews + clicks to dial), ‘progressive’, ‘predictive’, or ‘agentless’ (broadcast, no agent leg).

string

Default outbound caller-ID in E.164 format. Must be a number this org owns.

number

Predictive/progressive dial-to-agent ratio. 0.8-3.0, default 1.2.

number

FCC abandon-rate ceiling for this campaign, as a fraction (e.g. 0.03 = 3%). Cannot exceed the platform’s 3% ceiling.

number

Target seconds-to-answer used by the predictive pacer. 5-120, default 20.

string

Optional explicit Jambonz voice-control-plane application override. Omit to use the mode/AMD-resolved default.

array

Required agent skills for this campaign — legacy string array (e.g. [‘french’]) or structured {skill, min_level, weight} objects.

string

Optional legacy call-script reference.

boolean

Whether calls in this campaign are recorded. Requires recording_consent_acknowledged=true.

boolean

Whether answering-machine detection runs on each dialed leg.

string

‘human’ (default, agent-fronted) or ‘voice_agent’ (each leg connects to the AI voice agent named by voice_agent_id, dispatched via POST /campaigns/:id/batch-dispatch).

string

Required when dispatch_mode='voice_agent'; must reference an existing agent in this workspace.

number

Max simultaneous in-flight legs for voice-agent batch dispatch. 1-200, default 10.

string

HTTPS URL of the message Jambonz plays on answer. Required when mode='agentless', forbidden otherwise.

string

HTTPS voicemail-drop audio URL played when AMD detects a machine. Only valid for agent-driven modes.

string

AMD detection sensitivity: ‘low’, ‘medium’, or ‘high’. Only meaningful when amd_enabled=true.

number

Per-campaign override of how long a preview-mode agent has to decide before the claim auto-skips. Only valid for mode='preview'.

object

Free-form operator metadata (e.g. TCPA quiet-hours override, disposition codes).

object

Per-outcome retry backoff schedule keyed by outcome bucket (no_answer, busy, machine, machine_silence, failed).

array

Local-presence caller-ID rotation pool. Every entry must be owned by this org. Required (non-empty) when caller_id_strategy is not ‘single’.

string

Caller-ID assignment strategy: ‘single’ (default) or ‘npa_match’ (local-presence rotation from caller_id_pool).

object

Optional human-agent guided-dialog script (sections + branches). Omitted campaigns persist the canonical empty shape.

Operator’s two-party-consent acknowledgement. Required when recording_enabled=true.

boolean

When true, contacts uploaded to this campaign are enrolled at their highest-answer-probability window instead of list order.

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/dialer/campaigns" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/dialer/campaigns', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
headers["Content-Type"] = "application/json"
r = requests.post("https://api.orbit.devotel.io/api/v1/dialer/campaigns", headers=headers, json={})
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("POST", "https://api.orbit.devotel.io/api/v1/dialer/campaigns", bytes.NewBuffer([]byte(`{}`)))
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/dialer/campaigns')
req = Net::HTTP::Post.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']
req['Content-Type'] = 'application/json'
req.body = {}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/dialer/campaigns');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),
  'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, <<<JSON
{}
JSON);
echo curl_exec($ch);

{
  "data": {
    "id": "msg_3f6a81c2d4e5471a9b0c2d5e",
    "name": "string",
    "mode": "string",
    "status": "delivered"
  },
  "meta": {
    "request_id": "req_sample",
    "timestamp": "1970-01-01T00:00:00.000Z"
  }
}

Batch-dispatch outbound calls to a voice agent

POST /api/v1/dialer/campaigns/{id}/batch-dispatch

Claims up to concurrency_limit (or the optional max_legs override, whichever is lower) pending contacts under SKIP LOCKED and originates one outbound call per contact via the softswitch, connecting each answered leg to the campaign’s AI voice agent. Only valid for dispatch_mode='voice_agent' campaigns in active status. Returns 202 when every leg originated successfully, 207 when some legs failed (per-leg detail in legs), or 204 when there were no eligible contacts to claim. Requires the dialer:write scope.

string

required

Campaign id.

string

string (enum: true|false)

number

Optional per-invocation cap on claimed legs, 1-200. Always clamped to the campaign’s own concurrency_limit.

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/dialer/campaigns/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/batch-dispatch" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/dialer/campaigns/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/batch-dispatch', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
headers["Content-Type"] = "application/json"
r = requests.post("https://api.orbit.devotel.io/api/v1/dialer/campaigns/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/batch-dispatch", headers=headers, json={})
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("POST", "https://api.orbit.devotel.io/api/v1/dialer/campaigns/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/batch-dispatch", bytes.NewBuffer([]byte(`{}`)))
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/dialer/campaigns/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/batch-dispatch')
req = Net::HTTP::Post.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']
req['Content-Type'] = 'application/json'
req.body = {}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/dialer/campaigns/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/batch-dispatch');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),
  'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, <<<JSON
{}
JSON);
echo curl_exec($ch);

{
  "data": {
    "campaign_id": "cmp_1a2b3c4d5e6f7081a2b3c4d5",
    "voice_agent_id": null,
    "claimed": 0,
    "legs": [
      {
        "contact_id": "contact_4d2f6a8c1e3b5d7f9a1c3e5b",
        "attempt_id": "string",
        "jambonz_call_sid": null,
        "ok": false,
        "error": "string"
      }
    ]
  },
  "meta": {
    "request_id": "req_sample",
    "timestamp": "1970-01-01T00:00:00.000Z"
  }
}

Create clone

POST /api/v1/dialer/campaigns/{id}/clone

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/dialer/campaigns/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/clone" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/dialer/campaigns/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/clone', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
headers["Content-Type"] = "application/json"
r = requests.post("https://api.orbit.devotel.io/api/v1/dialer/campaigns/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/clone", headers=headers, json={})
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("POST", "https://api.orbit.devotel.io/api/v1/dialer/campaigns/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/clone", bytes.NewBuffer([]byte(`{}`)))
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/dialer/campaigns/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/clone')
req = Net::HTTP::Post.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']
req['Content-Type'] = 'application/json'
req.body = {}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/dialer/campaigns/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/clone');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),
  'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, <<<JSON
{}
JSON);
echo curl_exec($ch);

{
  "data": {
    "contact": {
      "id": "dc_3f9ac42b",
      "phone_e164": "+14155552671",
      "display_name": "Dana Reyes",
      "contact_id": "ct_d2b8",
      "attempts": 1
    },
    "preview_decision_seconds": 30,
    "decision_expires_at": "2026-08-01T12:01:30.000Z"
  },
  "meta": {
    "request_id": "req_next_call",
    "timestamp": "2026-08-01T12:00:00.000Z"
  }
}

Submit a dialer call disposition

POST /api/v1/dialer/campaigns/{id}/dispositions

Records an agent’s post-call disposition for a claimed call attempt and routes the contact to its next lifecycle status (e.g. ‘callback_scheduled’, ‘dnc’, ‘wrong_number’, or ‘connected’). A ‘dnc’ or ‘wrong_number’ disposition also writes a dnc_list suppression entry so future dial attempts to that number are blocked across every campaign in this tenant. Requires the dialer:write scope.

string

required

Campaign id.

string

string (enum: true|false)

string

The call-attempt id being dispositioned.

string

Outcome label (e.g. ‘connected’, ‘callback_later’, ‘dnc’, ‘wrong_number’). Unrecognized values default to the ‘connected’ route.

string

Optional free-text agent notes.

string

Required when disposition routes to callback_scheduled. ISO-8601 with offset, must be in the future and within 90 days.

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/dialer/campaigns/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/dispositions" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/dialer/campaigns/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/dispositions', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
headers["Content-Type"] = "application/json"
r = requests.post("https://api.orbit.devotel.io/api/v1/dialer/campaigns/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/dispositions", headers=headers, json={})
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("POST", "https://api.orbit.devotel.io/api/v1/dialer/campaigns/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/dispositions", bytes.NewBuffer([]byte(`{}`)))
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/dialer/campaigns/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/dispositions')
req = Net::HTTP::Post.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']
req['Content-Type'] = 'application/json'
req.body = {}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/dialer/campaigns/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/dispositions');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),
  'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, <<<JSON
{}
JSON);
echo curl_exec($ch);

{
  "data": {
    "contact": {
      "id": "dc_3f9ac42b",
      "phone_e164": "+14155552671",
      "display_name": "Dana Reyes",
      "contact_id": "ct_d2b8",
      "attempts": 1
    },
    "preview_decision_seconds": 30,
    "decision_expires_at": "2026-08-01T12:01:30.000Z"
  },
  "meta": {
    "request_id": "req_next_call",
    "timestamp": "2026-08-01T12:00:00.000Z"
  }
}

Upload a contact list to a dialer campaign

POST /api/v1/dialer/campaigns/{id}/lists

Creates a new contact list under the campaign and bulk-inserts its contacts (batched multi-row INSERT, up to 50,000 contacts per request). Duplicate phone_e164 values are deduped both within the request and against any existing contact in the same list (ON CONFLICT DO NOTHING); the response reports how many were actually inserted vs. skipped as duplicates. Requires the dialer:write scope.

string

required

Campaign id.

string

string (enum: true|false)

string

List display name.

object[]

1-50,000 contacts to enroll.

number

Max dial attempts per contact before it’s marked exhausted. 1-20, default 5.

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/dialer/campaigns/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/lists" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/dialer/campaigns/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/lists', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "list_id": "string",
    "contacts_submitted": 0,
    "contacts_inserted": 0,
    "duplicates_skipped": 0
  },
  "meta": {
    "request_id": "req_sample",
    "timestamp": "1970-01-01T00:00:00.000Z"
  }
}

Create recycle

POST /api/v1/dialer/campaigns/{id}/lists/{listId}/recycle

string

required

—

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/dialer/campaigns/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/lists/{listId}/recycle" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/dialer/campaigns/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/lists/{listId}/recycle', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "contact": {
      "id": "dc_3f9ac42b",
      "phone_e164": "+14155552671",
      "display_name": "Dana Reyes",
      "contact_id": "ct_d2b8",
      "attempts": 1
    },
    "preview_decision_seconds": 30,
    "decision_expires_at": "2026-08-01T12:01:30.000Z"
  },
  "meta": {
    "request_id": "req_next_call",
    "timestamp": "2026-08-01T12:00:00.000Z"
  }
}

Originate a preview-mode dial for a claimed contact

POST /api/v1/dialer/dial

Launches the outbound call for a contact the agent already claimed via GET /api/v1/dialer/next-call. Call this when the agent clicks “Call” after reviewing the preview card: the contact must still be in the dialing (claimed) state or the request is rejected with 409 CLAIM_NOT_HELD. Valid only for active preview-mode campaigns — progressive / predictive / agentless campaigns dial through the pacing scheduler instead. The requesting operator is recorded as the call’s agent for the TCPA audit trail. Requires the dialer:write scope.

string

string (enum: true|false)

string

The active preview-mode campaign the contact belongs to.

string

The dialer list-contact id returned by GET /api/v1/dialer/next-call.

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/dialer/dial" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/dialer/dial', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "attempt_id": "string",
    "jambonz_call_sid": "string",
    "contact_id": "contact_4d2f6a8c1e3b5d7f9a1c3e5b",
    "campaign_id": "cmp_1a2b3c4d5e6f7081a2b3c4d5"
  },
  "meta": {
    "request_id": "req_sample",
    "timestamp": "1970-01-01T00:00:00.000Z"
  }
}

Manual-dial dialer

POST /api/v1/dialer/manual-dial

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/dialer/manual-dial" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/dialer/manual-dial', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "contact": {
      "id": "dc_3f9ac42b",
      "phone_e164": "+14155552671",
      "display_name": "Dana Reyes",
      "contact_id": "ct_d2b8",
      "attempts": 1
    },
    "preview_decision_seconds": 30,
    "decision_expires_at": "2026-08-01T12:01:30.000Z"
  },
  "meta": {
    "request_id": "req_next_call",
    "timestamp": "2026-08-01T12:00:00.000Z"
  }
}

Update a dialer campaign

PATCH /api/v1/dialer/campaigns/{id}

Partially updates a campaign (COALESCE semantics — omitted fields are left unchanged). Re-runs the same anti-spoofing / voice-agent-existence / recording-consent gates as create on any field that is present. Activating (status: 'active') is blocked by the org-wide compliance emergency stop, a missing resolvable voice application, or a prior recording-consent gap. An ‘aborted’ campaign cannot transition to any other status. Requires the dialer:write scope.

string

required

Campaign id.

string (enum: true|false)

string

Campaign display name.

string

Target status: active, paused, completed, or aborted. Cannot transition away from ‘aborted’.

number

0.8-3.0.

number

FCC abandon-rate ceiling fraction.

number

5-120.

string

Must be owned by this org.

string

—

array

—

string | null

—

boolean

Enabling requires recording_consent_acknowledged=true in the same request unless already acknowledged.

boolean

—

string

‘human’ or ‘voice_agent’.

string | null

Null clears the agent; a string must reference an existing agent.

number

1-200.

string | null

—

string | null

—

number | null

—

object

—

object

—

array

—

string

—

object

—

boolean

—

cURL

curl -X PATCH "https://api.orbit.devotel.io/api/v1/dialer/campaigns/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/dialer/campaigns/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3', {
  method: 'PATCH',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "contact": {
      "id": "dc_3f9ac42b",
      "phone_e164": "+14155552671",
      "display_name": "Dana Reyes",
      "contact_id": "ct_d2b8",
      "attempts": 1
    },
    "preview_decision_seconds": 30,
    "decision_expires_at": "2026-08-01T12:01:30.000Z"
  },
  "meta": {
    "request_id": "req_next_call",
    "timestamp": "2026-08-01T12:00:00.000Z"
  }
}

Soft-delete a dialer campaign

DELETE /api/v1/dialer/campaigns/{id}

Soft-deletes a campaign: archives its pending contacts, soft-deletes its lists, then the campaign itself, all in one transaction. Blocked with 409 DIALER_CAMPAIGN_IN_FLIGHT while any contact across any of its lists is currently dialing — pause the campaign and let in-flight legs terminate first. Terminal-state contacts (connected/failed/dnc/exhausted/timezone_blocked) are preserved for TCPA dispute defense. Requires the dialer:write scope.

string

required

Campaign id.

string (enum: true|false)

cURL

curl -X DELETE "https://api.orbit.devotel.io/api/v1/dialer/campaigns/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/dialer/campaigns/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3', {
  method: 'DELETE',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

Response: 204 No Content

Soft-delete a dialer contact list

DELETE /api/v1/dialer/campaigns/{id}/lists/{listId}

Soft-deletes one contact list scoped to its parent campaign: archives its pending contacts, then soft-deletes the list. Blocked with 409 DIALER_LIST_IN_FLIGHT while any of its contacts is currently dialing. Terminal-state contacts are preserved. Requires the dialer:write scope.

string

required

Campaign id.

string

required

List id.

string (enum: true|false)

cURL

curl -X DELETE "https://api.orbit.devotel.io/api/v1/dialer/campaigns/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/lists/{listId}" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/dialer/campaigns/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/lists/{listId}', {
  method: 'DELETE',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

Response: 204 No Content

API Reference

All Endpoints

Dialer API

Dialer API

title: “The preview-dial loop” description: “How the two preview-mode operations chain: claim a contact atomically, review it on the agent’s screen, then launch the dial.”

The preview-dial loop

SDK surface bridge — List outbound-dialer campaigns, queue the next hop of the campaign FIFO, or trigger one alias lane — all with the sandbox key.

List dialer campaigns

Queue the next campaign hop

Fire one alias lane

Alias-lane request inbox

List dialer campaigns

Get a dialer campaign

Get post-call AI sentiment + outcome scoring for a dialer attempt

Dialer local-presence caller-ID coverage + analytics

List lists

List penetration

Dialer campaign post-call AI sentiment + outcome rollup

Dialer campaign wallboard stats

Dialer campaign stats (tenant-wide KPI strip)

Claim the next preview-mode contact for an agent

List campaigns

Create a dialer campaign

Batch-dispatch outbound calls to a voice agent

Create clone

Submit a dialer call disposition

Upload a contact list to a dialer campaign

Create recycle

Originate a preview-mode dial for a claimed contact

Manual-dial dialer

Update a dialer campaign

Soft-delete a dialer campaign

Soft-delete a dialer contact list

​Dialer API

​title: “The preview-dial loop” description: “How the two preview-mode operations chain: claim a contact atomically, review it on the agent’s screen, then launch the dial.”

​The preview-dial loop

​SDK surface bridge — List outbound-dialer campaigns, queue the next hop of the campaign FIFO, or trigger one alias lane — all with the sandbox key.

​List dialer campaigns

​Queue the next campaign hop

​Fire one alias lane

​Alias-lane request inbox

​List dialer campaigns

​Get a dialer campaign

​Get post-call AI sentiment + outcome scoring for a dialer attempt

​Dialer local-presence caller-ID coverage + analytics

​List lists

​List penetration

​Dialer campaign post-call AI sentiment + outcome rollup

​Dialer campaign wallboard stats

​Dialer campaign stats (tenant-wide KPI strip)

​Claim the next preview-mode contact for an agent

​List campaigns

​Create a dialer campaign

​Batch-dispatch outbound calls to a voice agent

​Create clone

​Submit a dialer call disposition

​Upload a contact list to a dialer campaign

​Create recycle

​Originate a preview-mode dial for a claimed contact

​Manual-dial dialer

​Update a dialer campaign

​Soft-delete a dialer campaign

​Soft-delete a dialer contact list

Dialer API

title: “The preview-dial loop” description: “How the two preview-mode operations chain: claim a contact atomically, review it on the agent’s screen, then launch the dial.”

The preview-dial loop

SDK surface bridge — List outbound-dialer campaigns, queue the next hop of the campaign FIFO, or trigger one alias lane — all with the sandbox key.

List dialer campaigns

Queue the next campaign hop

Fire one alias lane

Alias-lane request inbox

List dialer campaigns

Get a dialer campaign

Get post-call AI sentiment + outcome scoring for a dialer attempt

Dialer local-presence caller-ID coverage + analytics

List lists

List penetration

Dialer campaign post-call AI sentiment + outcome rollup

Dialer campaign wallboard stats

Dialer campaign stats (tenant-wide KPI strip)

Claim the next preview-mode contact for an agent

List campaigns

Create a dialer campaign

Batch-dispatch outbound calls to a voice agent

Create clone

Submit a dialer call disposition

Upload a contact list to a dialer campaign

Create recycle

Originate a preview-mode dial for a claimed contact

Manual-dial dialer

Update a dialer campaign

Soft-delete a dialer campaign

Soft-delete a dialer contact list