Make call

curl --request POST \
  --url https://www.tryunleashx.com/api/v1/global/agents/call \
  --header 'Content-Type: application/json' \
  --header 'token: <token>' \
  --data '
{
  "agent_id": 123,
  "phone_number": "<string>",
  "metadata": {}
}
'

import requests

url = "https://www.tryunleashx.com/api/v1/global/agents/call"

payload = {
    "agent_id": 123,
    "phone_number": "<string>",
    "metadata": {}
}
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({agent_id: 123, phone_number: '<string>', metadata: {}})
};

fetch('https://www.tryunleashx.com/api/v1/global/agents/call', 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/agents/call",
  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([
    'agent_id' => 123,
    'phone_number' => '<string>',
    'metadata' => [
        
    ]
  ]),
  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/agents/call"

	payload := strings.NewReader("{\n  \"agent_id\": 123,\n  \"phone_number\": \"<string>\",\n  \"metadata\": {}\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/agents/call")
  .header("token", "<token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"agent_id\": 123,\n  \"phone_number\": \"<string>\",\n  \"metadata\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://www.tryunleashx.com/api/v1/global/agents/call")

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  \"agent_id\": 123,\n  \"phone_number\": \"<string>\",\n  \"metadata\": {}\n}"

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

{
  "success": true,
  "message": "<string>",
  "data": {
    "execution_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "agent_id": 123,
    "phone_number": "<string>",
    "call_status": "<string>"
  }
}

POST

agents

call

Make call

curl --request POST \
  --url https://www.tryunleashx.com/api/v1/global/agents/call \
  --header 'Content-Type: application/json' \
  --header 'token: <token>' \
  --data '
{
  "agent_id": 123,
  "phone_number": "<string>",
  "metadata": {}
}
'

import requests

url = "https://www.tryunleashx.com/api/v1/global/agents/call"

payload = {
    "agent_id": 123,
    "phone_number": "<string>",
    "metadata": {}
}
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({agent_id: 123, phone_number: '<string>', metadata: {}})
};

fetch('https://www.tryunleashx.com/api/v1/global/agents/call', 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/agents/call",
  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([
    'agent_id' => 123,
    'phone_number' => '<string>',
    'metadata' => [
        
    ]
  ]),
  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/agents/call"

	payload := strings.NewReader("{\n  \"agent_id\": 123,\n  \"phone_number\": \"<string>\",\n  \"metadata\": {}\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/agents/call")
  .header("token", "<token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"agent_id\": 123,\n  \"phone_number\": \"<string>\",\n  \"metadata\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://www.tryunleashx.com/api/v1/global/agents/call")

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  \"agent_id\": 123,\n  \"phone_number\": \"<string>\",\n  \"metadata\": {}\n}"

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

{
  "success": true,
  "message": "<string>",
  "data": {
    "execution_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "agent_id": 123,
    "phone_number": "<string>",
    "call_status": "<string>"
  }
}

Make Call API

This documentation explains how to initiate a call using a voice agent.

Endpoint

POST /api/v1/global/agents/call

Authentication

Include your API token in the request header:

token: <your_api_token>

api_access_token: <your_api_token>

Request Body

{
  "agent_id": 123,
  "phone_number": "+1234567890",
  "metadata": {
    "customer_id": "CUST001",
    "call_reason": "Follow-up",
    "order_id": "ORD123"
  }
}

Required Fields

Field	Type	Description
`agent_id`	integer	ID of the agent to use for the call
`phone_number`	string	Phone number to call. Must include country code with `+` prefix (e.g., `+1234567890`)

Optional Fields

Field	Type	Description
`metadata`	object	Additional metadata to pass with the call. Can include any custom key-value pairs

Success Response

Status Code: 200 OK

{
  "success": true,
  "message": "Call initiated successfully",
  "data": {
    "execution_id": "550e8400-e29b-41d4-a716-446655440000",
    "agent_id": 123,
    "phone_number": "+1234567890",
    "call_status": "initiated"
  }
}

Response Fields

Field	Type	Description
`execution_id`	string	Unique identifier for this call execution. Use this to track the call
`agent_id`	integer	ID of the agent used for the call
`phone_number`	string	Phone number that was called
`call_status`	string	Status of the call (“initiated”)

Error Responses

400 Bad Request

{
  "error": true,
  "message": "Phone Number is required"
}

{
  "error": true,
  "message": "Agent ID is required"
}

401 Unauthorized

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

404 Not Found

{
  "error": true,
  "message": "Agent not found or not active"
}

422 Unprocessable Entity

{
  "error": true,
  "message": "Validation error message"
}

Example Request

curl -X POST https://www.tryunleashx.com/api/v1/global/agents/call \
  -H "Content-Type: application/json" \
  -H "token: your_api_token_here" \
  -d '{
    "agent_id": 123,
    "phone_number": "+1234567890",
    "metadata": {
      "customer_id": "CUST001",
      "call_reason": "Follow-up"
    }
  }'

Important Notes

Phone Number Format

Required: Phone numbers must include country code with + prefix
Correct: +1234567890, +919876543210
Incorrect: 1234567890, 919876543210 (missing +)

The API will automatically add the + prefix if it’s missing, but it’s recommended to include it.

Agent Requirements

The agent must be active (status = 1) to make calls
Only voice agents (agent_type = 3) can be used for calls
The agent must belong to your workspace
For outbound calls (making calls to customers), the agent should have calling_type: 1
For inbound calls (receiving calls), the agent should have calling_type: 2

Calling Types

ID	Type	Description
1	Outbound	Agent makes calls to customers. Use this when you want the agent to initiate calls to phone numbers.
2	Inbound	Agent receives calls from customers. Use this when customers call your phone numbers and the agent answers.

Note: When making calls using this API, ensure the agent’s calling_type is set to 1 (Outbound) for outbound calling scenarios.

Execution ID

Store the execution_id returned in the response for tracking purposes
This ID can be used to query call status and details later

Metadata

The metadata field is optional but useful for passing context
Common use cases:
- Customer information
- Order details
- Call reason/purpose
- Custom tracking IDs
Metadata will be available during the call for the agent to reference

Best Practices

Validate Phone Numbers: Ensure phone numbers are in correct format before making the call
Check Agent Status: Verify the agent is active before initiating calls
Store Execution IDs: Keep track of execution IDs for call monitoring and analytics
Use Metadata: Pass relevant context in metadata for better call handling
Error Handling: Implement proper error handling for failed call attempts
Rate Limiting: Be mindful of rate limits when making multiple calls

Common Issues

Issue: “Agent not found or not active”

Solution: Verify the agent exists and has status = 1 (active). Use the Get Agent API to check status.

Issue: “Phone Number is required”

Solution: Ensure phone_number is included in the request body.

Issue: Invalid phone number format

Solution: Ensure phone number includes country code with + prefix (e.g., +1234567890).

Headers

token

string

required

API token for authentication

Body

application/json

agent_id

integer

required

ID of the agent to use for the call

phone_number

string

required

Phone number to call. Must include country code with + prefix (e.g., '+1234567890')

metadata

object

Additional metadata to pass with the call. Can include any custom key-value pairs

Response

Call initiated successfully

success

boolean

message

string

data

object

Show child attributes

API Documentation

Phone Numbers

Voice AI

Click to Call

Call Logs

Campaigns

Users

Make Call

Make Call API

Endpoint

Authentication

Request Body

Required Fields

Optional Fields

Success Response

Response Fields

Error Responses

400 Bad Request

401 Unauthorized

404 Not Found

422 Unprocessable Entity

Example Request

Important Notes

Phone Number Format

Agent Requirements

Calling Types

Execution ID

Metadata

Best Practices

Common Issues

Issue: “Agent not found or not active”

Issue: “Phone Number is required”

Issue: Invalid phone number format

Headers

Body

Response

​Make Call API

​Endpoint

​Authentication

​Request Body

​Required Fields

​Optional Fields

​Success Response

​Response Fields

​Error Responses

​400 Bad Request

​401 Unauthorized

​404 Not Found

​422 Unprocessable Entity

​Example Request

​Important Notes

​Phone Number Format

​Agent Requirements

​Calling Types

​Execution ID

​Metadata

​Best Practices

​Common Issues

​Issue: “Agent not found or not active”

​Issue: “Phone Number is required”

​Issue: Invalid phone number format

Headers

Body

Response

Make Call API

Endpoint

Authentication

Request Body

Required Fields

Optional Fields

Success Response

Response Fields

Error Responses

400 Bad Request

401 Unauthorized

404 Not Found

422 Unprocessable Entity

Example Request

Important Notes

Phone Number Format

Agent Requirements

Calling Types

Execution ID

Metadata

Best Practices

Common Issues

Issue: “Agent not found or not active”

Issue: “Phone Number is required”

Issue: Invalid phone number format