Call Voice Agent using Twilio custom phone number.
curl --request POST \
--url https://api.tryhamsa.com/v1/voice-agents/phone-number/call \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"toNumber": "<string>",
"phoneNumber": "+1234567890",
"voiceAgentId": "d949f13f-40d2-4e48-ac86-b66633070603",
"params": {},
"agentDetails": {
"agentName": ""
}
}
'import requests
url = "https://api.tryhamsa.com/v1/voice-agents/phone-number/call"
payload = {
"toNumber": "<string>",
"phoneNumber": "+1234567890",
"voiceAgentId": "d949f13f-40d2-4e48-ac86-b66633070603",
"params": {},
"agentDetails": { "agentName": "" }
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
toNumber: '<string>',
phoneNumber: '+1234567890',
voiceAgentId: 'd949f13f-40d2-4e48-ac86-b66633070603',
params: {},
agentDetails: {agentName: ''}
})
};
fetch('https://api.tryhamsa.com/v1/voice-agents/phone-number/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.tryhamsa.com/v1/voice-agents/phone-number/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([
'toNumber' => '<string>',
'phoneNumber' => '+1234567890',
'voiceAgentId' => 'd949f13f-40d2-4e48-ac86-b66633070603',
'params' => [
],
'agentDetails' => [
'agentName' => ''
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$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.tryhamsa.com/v1/voice-agents/phone-number/call"
payload := strings.NewReader("{\n \"toNumber\": \"<string>\",\n \"phoneNumber\": \"+1234567890\",\n \"voiceAgentId\": \"d949f13f-40d2-4e48-ac86-b66633070603\",\n \"params\": {},\n \"agentDetails\": {\n \"agentName\": \"\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<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.tryhamsa.com/v1/voice-agents/phone-number/call")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"toNumber\": \"<string>\",\n \"phoneNumber\": \"+1234567890\",\n \"voiceAgentId\": \"d949f13f-40d2-4e48-ac86-b66633070603\",\n \"params\": {},\n \"agentDetails\": {\n \"agentName\": \"\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tryhamsa.com/v1/voice-agents/phone-number/call")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"toNumber\": \"<string>\",\n \"phoneNumber\": \"+1234567890\",\n \"voiceAgentId\": \"d949f13f-40d2-4e48-ac86-b66633070603\",\n \"params\": {},\n \"agentDetails\": {\n \"agentName\": \"\"\n }\n}"
response = http.request(request)
puts response.read_body{
"success": false,
"message": "success",
"data": {
"voiceAgentId": "d949f13f-40d2-4e48-ac86-b66633070603",
"jobId": "d949f13f-40d2-4e48-ac86-b66633070603"
}
}{
"code": 123,
"message": "<string>"
}{
"code": 123,
"message": "<string>"
}{
"code": 123,
"message": "<string>"
}Phone Numbers Routes
Create an Outbound Call
POST
/
v1
/
voice-agents
/
phone-number
/
call
Call Voice Agent using Twilio custom phone number.
curl --request POST \
--url https://api.tryhamsa.com/v1/voice-agents/phone-number/call \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"toNumber": "<string>",
"phoneNumber": "+1234567890",
"voiceAgentId": "d949f13f-40d2-4e48-ac86-b66633070603",
"params": {},
"agentDetails": {
"agentName": ""
}
}
'import requests
url = "https://api.tryhamsa.com/v1/voice-agents/phone-number/call"
payload = {
"toNumber": "<string>",
"phoneNumber": "+1234567890",
"voiceAgentId": "d949f13f-40d2-4e48-ac86-b66633070603",
"params": {},
"agentDetails": { "agentName": "" }
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
toNumber: '<string>',
phoneNumber: '+1234567890',
voiceAgentId: 'd949f13f-40d2-4e48-ac86-b66633070603',
params: {},
agentDetails: {agentName: ''}
})
};
fetch('https://api.tryhamsa.com/v1/voice-agents/phone-number/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.tryhamsa.com/v1/voice-agents/phone-number/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([
'toNumber' => '<string>',
'phoneNumber' => '+1234567890',
'voiceAgentId' => 'd949f13f-40d2-4e48-ac86-b66633070603',
'params' => [
],
'agentDetails' => [
'agentName' => ''
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$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.tryhamsa.com/v1/voice-agents/phone-number/call"
payload := strings.NewReader("{\n \"toNumber\": \"<string>\",\n \"phoneNumber\": \"+1234567890\",\n \"voiceAgentId\": \"d949f13f-40d2-4e48-ac86-b66633070603\",\n \"params\": {},\n \"agentDetails\": {\n \"agentName\": \"\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<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.tryhamsa.com/v1/voice-agents/phone-number/call")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"toNumber\": \"<string>\",\n \"phoneNumber\": \"+1234567890\",\n \"voiceAgentId\": \"d949f13f-40d2-4e48-ac86-b66633070603\",\n \"params\": {},\n \"agentDetails\": {\n \"agentName\": \"\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tryhamsa.com/v1/voice-agents/phone-number/call")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"toNumber\": \"<string>\",\n \"phoneNumber\": \"+1234567890\",\n \"voiceAgentId\": \"d949f13f-40d2-4e48-ac86-b66633070603\",\n \"params\": {},\n \"agentDetails\": {\n \"agentName\": \"\"\n }\n}"
response = http.request(request)
puts response.read_body{
"success": false,
"message": "success",
"data": {
"voiceAgentId": "d949f13f-40d2-4e48-ac86-b66633070603",
"jobId": "d949f13f-40d2-4e48-ac86-b66633070603"
}
}{
"code": 123,
"message": "<string>"
}{
"code": 123,
"message": "<string>"
}{
"code": 123,
"message": "<string>"
}Authorizations
Pass the API key in the Authorization header, You need to put Token keyword before the API key. e.g. 'Authorization: Token '
Body
application/json
- Option 1
- Option 2
The number that you want to call
Example:
"+1234567890"
Example:
"d949f13f-40d2-4e48-ac86-b66633070603"
Overriding params set in the voice agent's greeting message or preamble. Send when using voiceAgentId only.
Send agentDetails instead of voiceAgentId and params.
Show child attributes
Show child attributes
Was this page helpful?
⌘I