Create a call
curl --request POST \
--url https://api.cozmox.cloud/v1/outbound/create-call \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"toPhone": "+1234567890",
"fromPhone": "+1234567890",
"agentId": "cx_xxxxxx",
"extras": {
"Name": "Liza",
"current_datetime": "2025-01-01 10:10:10"
}
}
'import requests
url = "https://api.cozmox.cloud/v1/outbound/create-call"
payload = {
"toPhone": "+1234567890",
"fromPhone": "+1234567890",
"agentId": "cx_xxxxxx",
"extras": {
"Name": "Liza",
"current_datetime": "2025-01-01 10:10:10"
}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
toPhone: '+1234567890',
fromPhone: '+1234567890',
agentId: 'cx_xxxxxx',
extras: {Name: 'Liza', current_datetime: '2025-01-01 10:10:10'}
})
};
fetch('https://api.cozmox.cloud/v1/outbound/create-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://api.cozmox.cloud/v1/outbound/create-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([
'toPhone' => '+1234567890',
'fromPhone' => '+1234567890',
'agentId' => 'cx_xxxxxx',
'extras' => [
'Name' => 'Liza',
'current_datetime' => '2025-01-01 10:10:10'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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://api.cozmox.cloud/v1/outbound/create-call"
payload := strings.NewReader("{\n \"toPhone\": \"+1234567890\",\n \"fromPhone\": \"+1234567890\",\n \"agentId\": \"cx_xxxxxx\",\n \"extras\": {\n \"Name\": \"Liza\",\n \"current_datetime\": \"2025-01-01 10:10:10\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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://api.cozmox.cloud/v1/outbound/create-call")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"toPhone\": \"+1234567890\",\n \"fromPhone\": \"+1234567890\",\n \"agentId\": \"cx_xxxxxx\",\n \"extras\": {\n \"Name\": \"Liza\",\n \"current_datetime\": \"2025-01-01 10:10:10\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cozmox.cloud/v1/outbound/create-call")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"toPhone\": \"+1234567890\",\n \"fromPhone\": \"+1234567890\",\n \"agentId\": \"cx_xxxxxx\",\n \"extras\": {\n \"Name\": \"Liza\",\n \"current_datetime\": \"2025-01-01 10:10:10\"\n }\n}"
response = http.request(request)
puts response.read_body{
"callId": "1234567890"
}Outbound
Create a call
This operation allows you create a call
POST
/
v1
/
outbound
/
create-call
Create a call
curl --request POST \
--url https://api.cozmox.cloud/v1/outbound/create-call \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"toPhone": "+1234567890",
"fromPhone": "+1234567890",
"agentId": "cx_xxxxxx",
"extras": {
"Name": "Liza",
"current_datetime": "2025-01-01 10:10:10"
}
}
'import requests
url = "https://api.cozmox.cloud/v1/outbound/create-call"
payload = {
"toPhone": "+1234567890",
"fromPhone": "+1234567890",
"agentId": "cx_xxxxxx",
"extras": {
"Name": "Liza",
"current_datetime": "2025-01-01 10:10:10"
}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
toPhone: '+1234567890',
fromPhone: '+1234567890',
agentId: 'cx_xxxxxx',
extras: {Name: 'Liza', current_datetime: '2025-01-01 10:10:10'}
})
};
fetch('https://api.cozmox.cloud/v1/outbound/create-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://api.cozmox.cloud/v1/outbound/create-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([
'toPhone' => '+1234567890',
'fromPhone' => '+1234567890',
'agentId' => 'cx_xxxxxx',
'extras' => [
'Name' => 'Liza',
'current_datetime' => '2025-01-01 10:10:10'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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://api.cozmox.cloud/v1/outbound/create-call"
payload := strings.NewReader("{\n \"toPhone\": \"+1234567890\",\n \"fromPhone\": \"+1234567890\",\n \"agentId\": \"cx_xxxxxx\",\n \"extras\": {\n \"Name\": \"Liza\",\n \"current_datetime\": \"2025-01-01 10:10:10\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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://api.cozmox.cloud/v1/outbound/create-call")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"toPhone\": \"+1234567890\",\n \"fromPhone\": \"+1234567890\",\n \"agentId\": \"cx_xxxxxx\",\n \"extras\": {\n \"Name\": \"Liza\",\n \"current_datetime\": \"2025-01-01 10:10:10\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cozmox.cloud/v1/outbound/create-call")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"toPhone\": \"+1234567890\",\n \"fromPhone\": \"+1234567890\",\n \"agentId\": \"cx_xxxxxx\",\n \"extras\": {\n \"Name\": \"Liza\",\n \"current_datetime\": \"2025-01-01 10:10:10\"\n }\n}"
response = http.request(request)
puts response.read_body{
"callId": "1234567890"
}Authorizations
The API key
Body
application/json
The phone number to call
Example:
"+1234567890"
From phone number
Example:
"+1234567890"
Agent ID which will communicate with user
Example:
"cx_xxxxxx"
Extra parameters needed for agent on call
Show child attributes
Show child attributes
Example:
{
"Name": "Liza",
"current_datetime": "2025-01-01 10:10:10"
}
Response
The call id
Example:
"1234567890"
⌘I