Trigger Click-to-Dial Call

curl --request POST \
  --url https://www.tryunleashx.com/api/v1/global/click-to-dial \
  --header 'Content-Type: application/json' \
  --header 'token: <token>' \
  --data '
{
  "client_number": "<string>",
  "user_number": "<string>",
  "did_number": "<string>",
  "app_id": 123,
  "object_id": 123,
  "submitted_id": "<string>",
  "slug": "<string>"
}
'

import requests

url = "https://www.tryunleashx.com/api/v1/global/click-to-dial"

payload = {
    "client_number": "<string>",
    "user_number": "<string>",
    "did_number": "<string>",
    "app_id": 123,
    "object_id": 123,
    "submitted_id": "<string>",
    "slug": "<string>"
}
headers = {
    "token": "<token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {token: '<token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    client_number: '<string>',
    user_number: '<string>',
    did_number: '<string>',
    app_id: 123,
    object_id: 123,
    submitted_id: '<string>',
    slug: '<string>'
  })
};

fetch('https://www.tryunleashx.com/api/v1/global/click-to-dial', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://www.tryunleashx.com/api/v1/global/click-to-dial",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'client_number' => '<string>',
    'user_number' => '<string>',
    'did_number' => '<string>',
    'app_id' => 123,
    'object_id' => 123,
    'submitted_id' => '<string>',
    'slug' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "token: <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://www.tryunleashx.com/api/v1/global/click-to-dial"

	payload := strings.NewReader("{\n  \"client_number\": \"<string>\",\n  \"user_number\": \"<string>\",\n  \"did_number\": \"<string>\",\n  \"app_id\": 123,\n  \"object_id\": 123,\n  \"submitted_id\": \"<string>\",\n  \"slug\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("token", "<token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://www.tryunleashx.com/api/v1/global/click-to-dial")
  .header("token", "<token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"client_number\": \"<string>\",\n  \"user_number\": \"<string>\",\n  \"did_number\": \"<string>\",\n  \"app_id\": 123,\n  \"object_id\": 123,\n  \"submitted_id\": \"<string>\",\n  \"slug\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://www.tryunleashx.com/api/v1/global/click-to-dial")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["token"] = '<token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"client_number\": \"<string>\",\n  \"user_number\": \"<string>\",\n  \"did_number\": \"<string>\",\n  \"app_id\": 123,\n  \"object_id\": 123,\n  \"submitted_id\": \"<string>\",\n  \"slug\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "call_id": "<string>",
    "client_number": "<string>",
    "caller_id": "<string>",
    "user_number": "<string>"
  },
  "message": "<string>"
}

POST

click-to-dial

Trigger Click-to-Dial Call

curl --request POST \
  --url https://www.tryunleashx.com/api/v1/global/click-to-dial \
  --header 'Content-Type: application/json' \
  --header 'token: <token>' \
  --data '
{
  "client_number": "<string>",
  "user_number": "<string>",
  "did_number": "<string>",
  "app_id": 123,
  "object_id": 123,
  "submitted_id": "<string>",
  "slug": "<string>"
}
'

import requests

url = "https://www.tryunleashx.com/api/v1/global/click-to-dial"

payload = {
    "client_number": "<string>",
    "user_number": "<string>",
    "did_number": "<string>",
    "app_id": 123,
    "object_id": 123,
    "submitted_id": "<string>",
    "slug": "<string>"
}
headers = {
    "token": "<token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {token: '<token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    client_number: '<string>',
    user_number: '<string>',
    did_number: '<string>',
    app_id: 123,
    object_id: 123,
    submitted_id: '<string>',
    slug: '<string>'
  })
};

fetch('https://www.tryunleashx.com/api/v1/global/click-to-dial', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://www.tryunleashx.com/api/v1/global/click-to-dial",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'client_number' => '<string>',
    'user_number' => '<string>',
    'did_number' => '<string>',
    'app_id' => 123,
    'object_id' => 123,
    'submitted_id' => '<string>',
    'slug' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "token: <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://www.tryunleashx.com/api/v1/global/click-to-dial"

	payload := strings.NewReader("{\n  \"client_number\": \"<string>\",\n  \"user_number\": \"<string>\",\n  \"did_number\": \"<string>\",\n  \"app_id\": 123,\n  \"object_id\": 123,\n  \"submitted_id\": \"<string>\",\n  \"slug\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("token", "<token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://www.tryunleashx.com/api/v1/global/click-to-dial")
  .header("token", "<token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"client_number\": \"<string>\",\n  \"user_number\": \"<string>\",\n  \"did_number\": \"<string>\",\n  \"app_id\": 123,\n  \"object_id\": 123,\n  \"submitted_id\": \"<string>\",\n  \"slug\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://www.tryunleashx.com/api/v1/global/click-to-dial")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["token"] = '<token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"client_number\": \"<string>\",\n  \"user_number\": \"<string>\",\n  \"did_number\": \"<string>\",\n  \"app_id\": 123,\n  \"object_id\": 123,\n  \"submitted_id\": \"<string>\",\n  \"slug\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "call_id": "<string>",
    "client_number": "<string>",
    "caller_id": "<string>",
    "user_number": "<string>"
  },
  "message": "<string>"
}

Initiate an outbound click-to-dial call that connects a customer’s number to your agent’s phone. The system first rings the customer’s phone (client_number) and, once answered, bridges the call to the agent (user_number). The customer sees the did_number as the incoming caller ID.

API Endpoint

POST /api/v1/global/click-to-dial Content-Type: application/json Authentication: Required (Token header: token or api_access_token)

Request Body

{
  "client_number": "+919876543210",
  "user_number": "+919812345678",
  "did_number": "+918068001234",
  "app_id": 123,
  "object_id": 456,
  "submitted_id": "SUB001",
  "slug": "phone"
}

Required Fields

Field	Type	Description
`client_number`	string	The customer’s phone number to dial (the callee). This number is rung first. Country code prefixes are normalized automatically, e.g. `+919876543210` and `9876543210` are treated as the same number
`user_number`	string	The calling agent’s own phone number. The call is bridged to this number once the customer answers
`did_number`	string	The DID to display as the caller ID. Must be an active DID owned by your workspace

Optional Fields

Field	Type	Description
`app_id`	integer	ID of the app to associate this call with, used for tracking and for filtering call history
`object_id`	integer	ID of the record/object this call relates to (tracking metadata)
`submitted_id`	string	Submission identifier to associate with this call (tracking metadata)
`slug`	string	Field slug to associate with the dialled number (tracking metadata)

Success Response

Status Code: 200 OK

{
  "data": {
    "call_id": "call_app_1a2b3c4d5e6f",
    "client_number": "9876543210",
    "caller_id": "+918068001234",
    "user_number": "+919812345678"
  },
  "message": "Call dialled successfully"
}

Response Fields

Field	Type	Description
`call_id`	string	Unique identifier for this call. Use it to correlate the call with entries returned by the call history endpoint
`client_number`	string	The normalized customer number that was dialled
`caller_id`	string	The DID displayed to the customer as the caller ID
`user_number`	string	The agent number the call was bridged to

Error Responses

All errors are returned in a common envelope. Always check the error field of the response body.

422 Unprocessable Entity

{
  "error": true,
  "code": 422,
  "message": "This number does not belong to your account, kindly buy it",
  "data": {}
}

Message	Cause
`Invalid client number`	`client_number` is empty or not a valid phone number
`Invalid user number`	`user_number` is empty
`Invalid DID number`	`did_number` is empty
`This number does not belong to your account, kindly buy it`	The `did_number` is not an active DID on your workspace. Purchase the DID or use one you own
`Failed to dial the call`	The telephony provider could not place the call. Retry, or contact support if it persists

401 Unauthorized

{
  "error": true,
  "code": 401,
  "message": "Invalid Auth Key or Session Expired",
  "data": {}
}

Example Request

curl -X POST "https://www.tryunleashx.com/api/v1/global/click-to-dial" \
  -H "Content-Type: application/json" \
  -H "token: YOUR_API_TOKEN" \
  -d '{
    "client_number": "+919876543210",
    "user_number": "+919812345678",
    "did_number": "+918068001234"
  }'

Important Notes

DID Ownership

The did_number must be a DID (phone number) that is already purchased and active on your workspace
Calls with a DID you do not own are rejected with This number does not belong to your account, kindly buy it

Call Flow

The customer’s phone (client_number) rings first
Once the customer answers, the call is bridged to the agent (user_number)
The customer sees the did_number as the incoming caller ID

Phone Number Format

Country code prefixes are normalized automatically, so +919876543210 and 9876543210 are treated as the same number
It is still recommended to include the country code with the + prefix

Call Tracking

Store the call_id returned in the response for tracking purposes
Use the optional app_id, object_id, submitted_id, and slug fields to attach tracking metadata to the call
Calls triggered with an app_id can later be filtered in the call history endpoint

Headers

token

string

required

API token for authentication

Body

application/json

client_number

string

required

The customer's phone number to dial (the callee). This number is rung first. Country code prefixes are normalized automatically

user_number

string

required

The calling agent's own phone number. The call is bridged to this number once the customer answers

did_number

string

required

The DID to display as the caller ID. Must be an active DID owned by your workspace

app_id

integer

ID of the app to associate this call with, used for tracking and filtering call history

object_id

integer

ID of the record/object this call relates to (tracking metadata)

submitted_id

string

Submission identifier to associate with this call (tracking metadata)

slug

string

Field slug to associate with the dialled number (tracking metadata)

Response

Call dialled successfully

data

object

Show child attributes

message

string

API Documentation

Phone Numbers

Voice AI

Click to Call

Call Logs

Campaigns

Workspaces

Users

Trigger Click-to-Dial Call

API Endpoint

Request Body

Required Fields

Optional Fields

Success Response

Response Fields

Error Responses

422 Unprocessable Entity

401 Unauthorized

Example Request

Important Notes

DID Ownership

Call Flow

Phone Number Format

Call Tracking

Headers

Body

Response

​API Endpoint

​Request Body

​Required Fields

​Optional Fields

​Success Response

​Response Fields

​Error Responses

​422 Unprocessable Entity

​401 Unauthorized

​Example Request

​Important Notes

​DID Ownership

​Call Flow

​Phone Number Format

​Call Tracking

Headers

Body

Response

API Endpoint

Request Body

Required Fields

Optional Fields

Success Response

Response Fields

Error Responses

422 Unprocessable Entity

401 Unauthorized

Example Request

Important Notes

DID Ownership

Call Flow

Phone Number Format

Call Tracking