Dialer API

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

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.

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);

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

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())

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/dial", 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/dial", 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/dial')
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/dial');
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);

API Reference

All Endpoints

Dialer API

Dialer API

Claim the next preview-mode contact for an agent

Originate a preview-mode dial for a claimed contact

​Dialer API

​Claim the next preview-mode contact for an agent

​Originate a preview-mode dial for a claimed contact

Dialer API

Claim the next preview-mode contact for an agent

Originate a preview-mode dial for a claimed contact