Create a new dial
curl --request POST \
--url https://api.vogent.ai/api/dials \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"callAgentId": "61ccefdf-ea02-4f49-811b-1241f8e20d26",
"webhookUrl": "https://test.com/webhook",
"browserCall": false,
"toNumber": "+11234567890",
"fromNumberId": "1caec78c-4bba-477d-82cf-bcfce2b73856",
"fromNumberPoolId": "1caec78c-4bba-477d-82cf-bcfce2b73856",
"aiVoiceId": "61ccefdf-ea02-4f49-811b-1241f8e20d26",
"voiceOptionValues": [
{
"optionId": "<string>",
"value": "<string>"
}
],
"voiceVolumeLevel": -100,
"versionedModelId": "61ccefdf-ea02-4f49-811b-1241f8e20d26",
"ivrVersionedPromptId": "61ccefdf-ea02-4f49-811b-1241f8e20d26",
"overrideTranscriberFinalDurationMs": 500,
"timeoutMinutes": 10,
"callAgentExtractorId": "61ccefdf-ea02-4f49-811b-1241f8e20d26",
"callAgentInput": {},
"agentOverrides": {
"defaultVoiceId": "<string>",
"inboundWebhookResponse": true,
"inboundWebhookUrl": "<string>",
"maxDurationSeconds": 123,
"timeoutMessage": "<string>",
"timeoutBehaviorConfiguration": {
"transferNumber": "<string>"
},
"voiceVolumeLevel": 123,
"linkedFunctionDefinitionIds": [
"<string>"
],
"linkedFunctionDefinitionInputs": [
{
"functionDefinitionId": "<string>"
}
],
"metadata": {},
"language": "<string>",
"secondaryLanguages": [
"<string>"
],
"enableChangeLanguage": true,
"fillEmptyStringVariables": true,
"silenceHangupConfiguration": {
"silenceDurationSeconds": 123
},
"ivrSilenceHangupConfiguration": {
"silenceDurationSeconds": 123
}
},
"keywords": [
"<string>"
],
"advancedBrowserInteraction": true
}
'import requests
url = "https://api.vogent.ai/api/dials"
payload = {
"callAgentId": "61ccefdf-ea02-4f49-811b-1241f8e20d26",
"webhookUrl": "https://test.com/webhook",
"browserCall": False,
"toNumber": "+11234567890",
"fromNumberId": "1caec78c-4bba-477d-82cf-bcfce2b73856",
"fromNumberPoolId": "1caec78c-4bba-477d-82cf-bcfce2b73856",
"aiVoiceId": "61ccefdf-ea02-4f49-811b-1241f8e20d26",
"voiceOptionValues": [
{
"optionId": "<string>",
"value": "<string>"
}
],
"voiceVolumeLevel": -100,
"versionedModelId": "61ccefdf-ea02-4f49-811b-1241f8e20d26",
"ivrVersionedPromptId": "61ccefdf-ea02-4f49-811b-1241f8e20d26",
"overrideTranscriberFinalDurationMs": 500,
"timeoutMinutes": 10,
"callAgentExtractorId": "61ccefdf-ea02-4f49-811b-1241f8e20d26",
"callAgentInput": {},
"agentOverrides": {
"defaultVoiceId": "<string>",
"inboundWebhookResponse": True,
"inboundWebhookUrl": "<string>",
"maxDurationSeconds": 123,
"timeoutMessage": "<string>",
"timeoutBehaviorConfiguration": { "transferNumber": "<string>" },
"voiceVolumeLevel": 123,
"linkedFunctionDefinitionIds": ["<string>"],
"linkedFunctionDefinitionInputs": [{ "functionDefinitionId": "<string>" }],
"metadata": {},
"language": "<string>",
"secondaryLanguages": ["<string>"],
"enableChangeLanguage": True,
"fillEmptyStringVariables": True,
"silenceHangupConfiguration": { "silenceDurationSeconds": 123 },
"ivrSilenceHangupConfiguration": { "silenceDurationSeconds": 123 }
},
"keywords": ["<string>"],
"advancedBrowserInteraction": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
callAgentId: '61ccefdf-ea02-4f49-811b-1241f8e20d26',
webhookUrl: 'https://test.com/webhook',
browserCall: false,
toNumber: '+11234567890',
fromNumberId: '1caec78c-4bba-477d-82cf-bcfce2b73856',
fromNumberPoolId: '1caec78c-4bba-477d-82cf-bcfce2b73856',
aiVoiceId: '61ccefdf-ea02-4f49-811b-1241f8e20d26',
voiceOptionValues: [{optionId: '<string>', value: '<string>'}],
voiceVolumeLevel: -100,
versionedModelId: '61ccefdf-ea02-4f49-811b-1241f8e20d26',
ivrVersionedPromptId: '61ccefdf-ea02-4f49-811b-1241f8e20d26',
overrideTranscriberFinalDurationMs: 500,
timeoutMinutes: 10,
callAgentExtractorId: '61ccefdf-ea02-4f49-811b-1241f8e20d26',
callAgentInput: {},
agentOverrides: {
defaultVoiceId: '<string>',
inboundWebhookResponse: true,
inboundWebhookUrl: '<string>',
maxDurationSeconds: 123,
timeoutMessage: '<string>',
timeoutBehaviorConfiguration: {transferNumber: '<string>'},
voiceVolumeLevel: 123,
linkedFunctionDefinitionIds: ['<string>'],
linkedFunctionDefinitionInputs: [{functionDefinitionId: '<string>'}],
metadata: {},
language: '<string>',
secondaryLanguages: ['<string>'],
enableChangeLanguage: true,
fillEmptyStringVariables: true,
silenceHangupConfiguration: {silenceDurationSeconds: 123},
ivrSilenceHangupConfiguration: {silenceDurationSeconds: 123}
},
keywords: ['<string>'],
advancedBrowserInteraction: true
})
};
fetch('https://api.vogent.ai/api/dials', 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.vogent.ai/api/dials",
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([
'callAgentId' => '61ccefdf-ea02-4f49-811b-1241f8e20d26',
'webhookUrl' => 'https://test.com/webhook',
'browserCall' => false,
'toNumber' => '+11234567890',
'fromNumberId' => '1caec78c-4bba-477d-82cf-bcfce2b73856',
'fromNumberPoolId' => '1caec78c-4bba-477d-82cf-bcfce2b73856',
'aiVoiceId' => '61ccefdf-ea02-4f49-811b-1241f8e20d26',
'voiceOptionValues' => [
[
'optionId' => '<string>',
'value' => '<string>'
]
],
'voiceVolumeLevel' => -100,
'versionedModelId' => '61ccefdf-ea02-4f49-811b-1241f8e20d26',
'ivrVersionedPromptId' => '61ccefdf-ea02-4f49-811b-1241f8e20d26',
'overrideTranscriberFinalDurationMs' => 500,
'timeoutMinutes' => 10,
'callAgentExtractorId' => '61ccefdf-ea02-4f49-811b-1241f8e20d26',
'callAgentInput' => [
],
'agentOverrides' => [
'defaultVoiceId' => '<string>',
'inboundWebhookResponse' => true,
'inboundWebhookUrl' => '<string>',
'maxDurationSeconds' => 123,
'timeoutMessage' => '<string>',
'timeoutBehaviorConfiguration' => [
'transferNumber' => '<string>'
],
'voiceVolumeLevel' => 123,
'linkedFunctionDefinitionIds' => [
'<string>'
],
'linkedFunctionDefinitionInputs' => [
[
'functionDefinitionId' => '<string>'
]
],
'metadata' => [
],
'language' => '<string>',
'secondaryLanguages' => [
'<string>'
],
'enableChangeLanguage' => true,
'fillEmptyStringVariables' => true,
'silenceHangupConfiguration' => [
'silenceDurationSeconds' => 123
],
'ivrSilenceHangupConfiguration' => [
'silenceDurationSeconds' => 123
]
],
'keywords' => [
'<string>'
],
'advancedBrowserInteraction' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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.vogent.ai/api/dials"
payload := strings.NewReader("{\n \"callAgentId\": \"61ccefdf-ea02-4f49-811b-1241f8e20d26\",\n \"webhookUrl\": \"https://test.com/webhook\",\n \"browserCall\": false,\n \"toNumber\": \"+11234567890\",\n \"fromNumberId\": \"1caec78c-4bba-477d-82cf-bcfce2b73856\",\n \"fromNumberPoolId\": \"1caec78c-4bba-477d-82cf-bcfce2b73856\",\n \"aiVoiceId\": \"61ccefdf-ea02-4f49-811b-1241f8e20d26\",\n \"voiceOptionValues\": [\n {\n \"optionId\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"voiceVolumeLevel\": -100,\n \"versionedModelId\": \"61ccefdf-ea02-4f49-811b-1241f8e20d26\",\n \"ivrVersionedPromptId\": \"61ccefdf-ea02-4f49-811b-1241f8e20d26\",\n \"overrideTranscriberFinalDurationMs\": 500,\n \"timeoutMinutes\": 10,\n \"callAgentExtractorId\": \"61ccefdf-ea02-4f49-811b-1241f8e20d26\",\n \"callAgentInput\": {},\n \"agentOverrides\": {\n \"defaultVoiceId\": \"<string>\",\n \"inboundWebhookResponse\": true,\n \"inboundWebhookUrl\": \"<string>\",\n \"maxDurationSeconds\": 123,\n \"timeoutMessage\": \"<string>\",\n \"timeoutBehaviorConfiguration\": {\n \"transferNumber\": \"<string>\"\n },\n \"voiceVolumeLevel\": 123,\n \"linkedFunctionDefinitionIds\": [\n \"<string>\"\n ],\n \"linkedFunctionDefinitionInputs\": [\n {\n \"functionDefinitionId\": \"<string>\"\n }\n ],\n \"metadata\": {},\n \"language\": \"<string>\",\n \"secondaryLanguages\": [\n \"<string>\"\n ],\n \"enableChangeLanguage\": true,\n \"fillEmptyStringVariables\": true,\n \"silenceHangupConfiguration\": {\n \"silenceDurationSeconds\": 123\n },\n \"ivrSilenceHangupConfiguration\": {\n \"silenceDurationSeconds\": 123\n }\n },\n \"keywords\": [\n \"<string>\"\n ],\n \"advancedBrowserInteraction\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <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://api.vogent.ai/api/dials")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"callAgentId\": \"61ccefdf-ea02-4f49-811b-1241f8e20d26\",\n \"webhookUrl\": \"https://test.com/webhook\",\n \"browserCall\": false,\n \"toNumber\": \"+11234567890\",\n \"fromNumberId\": \"1caec78c-4bba-477d-82cf-bcfce2b73856\",\n \"fromNumberPoolId\": \"1caec78c-4bba-477d-82cf-bcfce2b73856\",\n \"aiVoiceId\": \"61ccefdf-ea02-4f49-811b-1241f8e20d26\",\n \"voiceOptionValues\": [\n {\n \"optionId\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"voiceVolumeLevel\": -100,\n \"versionedModelId\": \"61ccefdf-ea02-4f49-811b-1241f8e20d26\",\n \"ivrVersionedPromptId\": \"61ccefdf-ea02-4f49-811b-1241f8e20d26\",\n \"overrideTranscriberFinalDurationMs\": 500,\n \"timeoutMinutes\": 10,\n \"callAgentExtractorId\": \"61ccefdf-ea02-4f49-811b-1241f8e20d26\",\n \"callAgentInput\": {},\n \"agentOverrides\": {\n \"defaultVoiceId\": \"<string>\",\n \"inboundWebhookResponse\": true,\n \"inboundWebhookUrl\": \"<string>\",\n \"maxDurationSeconds\": 123,\n \"timeoutMessage\": \"<string>\",\n \"timeoutBehaviorConfiguration\": {\n \"transferNumber\": \"<string>\"\n },\n \"voiceVolumeLevel\": 123,\n \"linkedFunctionDefinitionIds\": [\n \"<string>\"\n ],\n \"linkedFunctionDefinitionInputs\": [\n {\n \"functionDefinitionId\": \"<string>\"\n }\n ],\n \"metadata\": {},\n \"language\": \"<string>\",\n \"secondaryLanguages\": [\n \"<string>\"\n ],\n \"enableChangeLanguage\": true,\n \"fillEmptyStringVariables\": true,\n \"silenceHangupConfiguration\": {\n \"silenceDurationSeconds\": 123\n },\n \"ivrSilenceHangupConfiguration\": {\n \"silenceDurationSeconds\": 123\n }\n },\n \"keywords\": [\n \"<string>\"\n ],\n \"advancedBrowserInteraction\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vogent.ai/api/dials")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"callAgentId\": \"61ccefdf-ea02-4f49-811b-1241f8e20d26\",\n \"webhookUrl\": \"https://test.com/webhook\",\n \"browserCall\": false,\n \"toNumber\": \"+11234567890\",\n \"fromNumberId\": \"1caec78c-4bba-477d-82cf-bcfce2b73856\",\n \"fromNumberPoolId\": \"1caec78c-4bba-477d-82cf-bcfce2b73856\",\n \"aiVoiceId\": \"61ccefdf-ea02-4f49-811b-1241f8e20d26\",\n \"voiceOptionValues\": [\n {\n \"optionId\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"voiceVolumeLevel\": -100,\n \"versionedModelId\": \"61ccefdf-ea02-4f49-811b-1241f8e20d26\",\n \"ivrVersionedPromptId\": \"61ccefdf-ea02-4f49-811b-1241f8e20d26\",\n \"overrideTranscriberFinalDurationMs\": 500,\n \"timeoutMinutes\": 10,\n \"callAgentExtractorId\": \"61ccefdf-ea02-4f49-811b-1241f8e20d26\",\n \"callAgentInput\": {},\n \"agentOverrides\": {\n \"defaultVoiceId\": \"<string>\",\n \"inboundWebhookResponse\": true,\n \"inboundWebhookUrl\": \"<string>\",\n \"maxDurationSeconds\": 123,\n \"timeoutMessage\": \"<string>\",\n \"timeoutBehaviorConfiguration\": {\n \"transferNumber\": \"<string>\"\n },\n \"voiceVolumeLevel\": 123,\n \"linkedFunctionDefinitionIds\": [\n \"<string>\"\n ],\n \"linkedFunctionDefinitionInputs\": [\n {\n \"functionDefinitionId\": \"<string>\"\n }\n ],\n \"metadata\": {},\n \"language\": \"<string>\",\n \"secondaryLanguages\": [\n \"<string>\"\n ],\n \"enableChangeLanguage\": true,\n \"fillEmptyStringVariables\": true,\n \"silenceHangupConfiguration\": {\n \"silenceDurationSeconds\": 123\n },\n \"ivrSilenceHangupConfiguration\": {\n \"silenceDurationSeconds\": 123\n }\n },\n \"keywords\": [\n \"<string>\"\n ],\n \"advancedBrowserInteraction\": true\n}"
response = http.request(request)
puts response.read_body{
"dialToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0ZXN0IjoidGVzdCJ9.9EQaLsDRKDVXLUVLR9JgDTjEULaT2-OMbHayQAzgZH8",
"sessionId": "61ccefdf-ea02-4f49-811b-1241f8e20d26",
"dialId": "57555c5e-5a56-49ca-8fe8-24946d2fbc3e"
}Dials
Create a new dial
Creates a one-off dial session, either for phone dials or browser dials.
POST
/
dials
Create a new dial
curl --request POST \
--url https://api.vogent.ai/api/dials \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"callAgentId": "61ccefdf-ea02-4f49-811b-1241f8e20d26",
"webhookUrl": "https://test.com/webhook",
"browserCall": false,
"toNumber": "+11234567890",
"fromNumberId": "1caec78c-4bba-477d-82cf-bcfce2b73856",
"fromNumberPoolId": "1caec78c-4bba-477d-82cf-bcfce2b73856",
"aiVoiceId": "61ccefdf-ea02-4f49-811b-1241f8e20d26",
"voiceOptionValues": [
{
"optionId": "<string>",
"value": "<string>"
}
],
"voiceVolumeLevel": -100,
"versionedModelId": "61ccefdf-ea02-4f49-811b-1241f8e20d26",
"ivrVersionedPromptId": "61ccefdf-ea02-4f49-811b-1241f8e20d26",
"overrideTranscriberFinalDurationMs": 500,
"timeoutMinutes": 10,
"callAgentExtractorId": "61ccefdf-ea02-4f49-811b-1241f8e20d26",
"callAgentInput": {},
"agentOverrides": {
"defaultVoiceId": "<string>",
"inboundWebhookResponse": true,
"inboundWebhookUrl": "<string>",
"maxDurationSeconds": 123,
"timeoutMessage": "<string>",
"timeoutBehaviorConfiguration": {
"transferNumber": "<string>"
},
"voiceVolumeLevel": 123,
"linkedFunctionDefinitionIds": [
"<string>"
],
"linkedFunctionDefinitionInputs": [
{
"functionDefinitionId": "<string>"
}
],
"metadata": {},
"language": "<string>",
"secondaryLanguages": [
"<string>"
],
"enableChangeLanguage": true,
"fillEmptyStringVariables": true,
"silenceHangupConfiguration": {
"silenceDurationSeconds": 123
},
"ivrSilenceHangupConfiguration": {
"silenceDurationSeconds": 123
}
},
"keywords": [
"<string>"
],
"advancedBrowserInteraction": true
}
'import requests
url = "https://api.vogent.ai/api/dials"
payload = {
"callAgentId": "61ccefdf-ea02-4f49-811b-1241f8e20d26",
"webhookUrl": "https://test.com/webhook",
"browserCall": False,
"toNumber": "+11234567890",
"fromNumberId": "1caec78c-4bba-477d-82cf-bcfce2b73856",
"fromNumberPoolId": "1caec78c-4bba-477d-82cf-bcfce2b73856",
"aiVoiceId": "61ccefdf-ea02-4f49-811b-1241f8e20d26",
"voiceOptionValues": [
{
"optionId": "<string>",
"value": "<string>"
}
],
"voiceVolumeLevel": -100,
"versionedModelId": "61ccefdf-ea02-4f49-811b-1241f8e20d26",
"ivrVersionedPromptId": "61ccefdf-ea02-4f49-811b-1241f8e20d26",
"overrideTranscriberFinalDurationMs": 500,
"timeoutMinutes": 10,
"callAgentExtractorId": "61ccefdf-ea02-4f49-811b-1241f8e20d26",
"callAgentInput": {},
"agentOverrides": {
"defaultVoiceId": "<string>",
"inboundWebhookResponse": True,
"inboundWebhookUrl": "<string>",
"maxDurationSeconds": 123,
"timeoutMessage": "<string>",
"timeoutBehaviorConfiguration": { "transferNumber": "<string>" },
"voiceVolumeLevel": 123,
"linkedFunctionDefinitionIds": ["<string>"],
"linkedFunctionDefinitionInputs": [{ "functionDefinitionId": "<string>" }],
"metadata": {},
"language": "<string>",
"secondaryLanguages": ["<string>"],
"enableChangeLanguage": True,
"fillEmptyStringVariables": True,
"silenceHangupConfiguration": { "silenceDurationSeconds": 123 },
"ivrSilenceHangupConfiguration": { "silenceDurationSeconds": 123 }
},
"keywords": ["<string>"],
"advancedBrowserInteraction": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
callAgentId: '61ccefdf-ea02-4f49-811b-1241f8e20d26',
webhookUrl: 'https://test.com/webhook',
browserCall: false,
toNumber: '+11234567890',
fromNumberId: '1caec78c-4bba-477d-82cf-bcfce2b73856',
fromNumberPoolId: '1caec78c-4bba-477d-82cf-bcfce2b73856',
aiVoiceId: '61ccefdf-ea02-4f49-811b-1241f8e20d26',
voiceOptionValues: [{optionId: '<string>', value: '<string>'}],
voiceVolumeLevel: -100,
versionedModelId: '61ccefdf-ea02-4f49-811b-1241f8e20d26',
ivrVersionedPromptId: '61ccefdf-ea02-4f49-811b-1241f8e20d26',
overrideTranscriberFinalDurationMs: 500,
timeoutMinutes: 10,
callAgentExtractorId: '61ccefdf-ea02-4f49-811b-1241f8e20d26',
callAgentInput: {},
agentOverrides: {
defaultVoiceId: '<string>',
inboundWebhookResponse: true,
inboundWebhookUrl: '<string>',
maxDurationSeconds: 123,
timeoutMessage: '<string>',
timeoutBehaviorConfiguration: {transferNumber: '<string>'},
voiceVolumeLevel: 123,
linkedFunctionDefinitionIds: ['<string>'],
linkedFunctionDefinitionInputs: [{functionDefinitionId: '<string>'}],
metadata: {},
language: '<string>',
secondaryLanguages: ['<string>'],
enableChangeLanguage: true,
fillEmptyStringVariables: true,
silenceHangupConfiguration: {silenceDurationSeconds: 123},
ivrSilenceHangupConfiguration: {silenceDurationSeconds: 123}
},
keywords: ['<string>'],
advancedBrowserInteraction: true
})
};
fetch('https://api.vogent.ai/api/dials', 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.vogent.ai/api/dials",
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([
'callAgentId' => '61ccefdf-ea02-4f49-811b-1241f8e20d26',
'webhookUrl' => 'https://test.com/webhook',
'browserCall' => false,
'toNumber' => '+11234567890',
'fromNumberId' => '1caec78c-4bba-477d-82cf-bcfce2b73856',
'fromNumberPoolId' => '1caec78c-4bba-477d-82cf-bcfce2b73856',
'aiVoiceId' => '61ccefdf-ea02-4f49-811b-1241f8e20d26',
'voiceOptionValues' => [
[
'optionId' => '<string>',
'value' => '<string>'
]
],
'voiceVolumeLevel' => -100,
'versionedModelId' => '61ccefdf-ea02-4f49-811b-1241f8e20d26',
'ivrVersionedPromptId' => '61ccefdf-ea02-4f49-811b-1241f8e20d26',
'overrideTranscriberFinalDurationMs' => 500,
'timeoutMinutes' => 10,
'callAgentExtractorId' => '61ccefdf-ea02-4f49-811b-1241f8e20d26',
'callAgentInput' => [
],
'agentOverrides' => [
'defaultVoiceId' => '<string>',
'inboundWebhookResponse' => true,
'inboundWebhookUrl' => '<string>',
'maxDurationSeconds' => 123,
'timeoutMessage' => '<string>',
'timeoutBehaviorConfiguration' => [
'transferNumber' => '<string>'
],
'voiceVolumeLevel' => 123,
'linkedFunctionDefinitionIds' => [
'<string>'
],
'linkedFunctionDefinitionInputs' => [
[
'functionDefinitionId' => '<string>'
]
],
'metadata' => [
],
'language' => '<string>',
'secondaryLanguages' => [
'<string>'
],
'enableChangeLanguage' => true,
'fillEmptyStringVariables' => true,
'silenceHangupConfiguration' => [
'silenceDurationSeconds' => 123
],
'ivrSilenceHangupConfiguration' => [
'silenceDurationSeconds' => 123
]
],
'keywords' => [
'<string>'
],
'advancedBrowserInteraction' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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.vogent.ai/api/dials"
payload := strings.NewReader("{\n \"callAgentId\": \"61ccefdf-ea02-4f49-811b-1241f8e20d26\",\n \"webhookUrl\": \"https://test.com/webhook\",\n \"browserCall\": false,\n \"toNumber\": \"+11234567890\",\n \"fromNumberId\": \"1caec78c-4bba-477d-82cf-bcfce2b73856\",\n \"fromNumberPoolId\": \"1caec78c-4bba-477d-82cf-bcfce2b73856\",\n \"aiVoiceId\": \"61ccefdf-ea02-4f49-811b-1241f8e20d26\",\n \"voiceOptionValues\": [\n {\n \"optionId\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"voiceVolumeLevel\": -100,\n \"versionedModelId\": \"61ccefdf-ea02-4f49-811b-1241f8e20d26\",\n \"ivrVersionedPromptId\": \"61ccefdf-ea02-4f49-811b-1241f8e20d26\",\n \"overrideTranscriberFinalDurationMs\": 500,\n \"timeoutMinutes\": 10,\n \"callAgentExtractorId\": \"61ccefdf-ea02-4f49-811b-1241f8e20d26\",\n \"callAgentInput\": {},\n \"agentOverrides\": {\n \"defaultVoiceId\": \"<string>\",\n \"inboundWebhookResponse\": true,\n \"inboundWebhookUrl\": \"<string>\",\n \"maxDurationSeconds\": 123,\n \"timeoutMessage\": \"<string>\",\n \"timeoutBehaviorConfiguration\": {\n \"transferNumber\": \"<string>\"\n },\n \"voiceVolumeLevel\": 123,\n \"linkedFunctionDefinitionIds\": [\n \"<string>\"\n ],\n \"linkedFunctionDefinitionInputs\": [\n {\n \"functionDefinitionId\": \"<string>\"\n }\n ],\n \"metadata\": {},\n \"language\": \"<string>\",\n \"secondaryLanguages\": [\n \"<string>\"\n ],\n \"enableChangeLanguage\": true,\n \"fillEmptyStringVariables\": true,\n \"silenceHangupConfiguration\": {\n \"silenceDurationSeconds\": 123\n },\n \"ivrSilenceHangupConfiguration\": {\n \"silenceDurationSeconds\": 123\n }\n },\n \"keywords\": [\n \"<string>\"\n ],\n \"advancedBrowserInteraction\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <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://api.vogent.ai/api/dials")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"callAgentId\": \"61ccefdf-ea02-4f49-811b-1241f8e20d26\",\n \"webhookUrl\": \"https://test.com/webhook\",\n \"browserCall\": false,\n \"toNumber\": \"+11234567890\",\n \"fromNumberId\": \"1caec78c-4bba-477d-82cf-bcfce2b73856\",\n \"fromNumberPoolId\": \"1caec78c-4bba-477d-82cf-bcfce2b73856\",\n \"aiVoiceId\": \"61ccefdf-ea02-4f49-811b-1241f8e20d26\",\n \"voiceOptionValues\": [\n {\n \"optionId\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"voiceVolumeLevel\": -100,\n \"versionedModelId\": \"61ccefdf-ea02-4f49-811b-1241f8e20d26\",\n \"ivrVersionedPromptId\": \"61ccefdf-ea02-4f49-811b-1241f8e20d26\",\n \"overrideTranscriberFinalDurationMs\": 500,\n \"timeoutMinutes\": 10,\n \"callAgentExtractorId\": \"61ccefdf-ea02-4f49-811b-1241f8e20d26\",\n \"callAgentInput\": {},\n \"agentOverrides\": {\n \"defaultVoiceId\": \"<string>\",\n \"inboundWebhookResponse\": true,\n \"inboundWebhookUrl\": \"<string>\",\n \"maxDurationSeconds\": 123,\n \"timeoutMessage\": \"<string>\",\n \"timeoutBehaviorConfiguration\": {\n \"transferNumber\": \"<string>\"\n },\n \"voiceVolumeLevel\": 123,\n \"linkedFunctionDefinitionIds\": [\n \"<string>\"\n ],\n \"linkedFunctionDefinitionInputs\": [\n {\n \"functionDefinitionId\": \"<string>\"\n }\n ],\n \"metadata\": {},\n \"language\": \"<string>\",\n \"secondaryLanguages\": [\n \"<string>\"\n ],\n \"enableChangeLanguage\": true,\n \"fillEmptyStringVariables\": true,\n \"silenceHangupConfiguration\": {\n \"silenceDurationSeconds\": 123\n },\n \"ivrSilenceHangupConfiguration\": {\n \"silenceDurationSeconds\": 123\n }\n },\n \"keywords\": [\n \"<string>\"\n ],\n \"advancedBrowserInteraction\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vogent.ai/api/dials")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"callAgentId\": \"61ccefdf-ea02-4f49-811b-1241f8e20d26\",\n \"webhookUrl\": \"https://test.com/webhook\",\n \"browserCall\": false,\n \"toNumber\": \"+11234567890\",\n \"fromNumberId\": \"1caec78c-4bba-477d-82cf-bcfce2b73856\",\n \"fromNumberPoolId\": \"1caec78c-4bba-477d-82cf-bcfce2b73856\",\n \"aiVoiceId\": \"61ccefdf-ea02-4f49-811b-1241f8e20d26\",\n \"voiceOptionValues\": [\n {\n \"optionId\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"voiceVolumeLevel\": -100,\n \"versionedModelId\": \"61ccefdf-ea02-4f49-811b-1241f8e20d26\",\n \"ivrVersionedPromptId\": \"61ccefdf-ea02-4f49-811b-1241f8e20d26\",\n \"overrideTranscriberFinalDurationMs\": 500,\n \"timeoutMinutes\": 10,\n \"callAgentExtractorId\": \"61ccefdf-ea02-4f49-811b-1241f8e20d26\",\n \"callAgentInput\": {},\n \"agentOverrides\": {\n \"defaultVoiceId\": \"<string>\",\n \"inboundWebhookResponse\": true,\n \"inboundWebhookUrl\": \"<string>\",\n \"maxDurationSeconds\": 123,\n \"timeoutMessage\": \"<string>\",\n \"timeoutBehaviorConfiguration\": {\n \"transferNumber\": \"<string>\"\n },\n \"voiceVolumeLevel\": 123,\n \"linkedFunctionDefinitionIds\": [\n \"<string>\"\n ],\n \"linkedFunctionDefinitionInputs\": [\n {\n \"functionDefinitionId\": \"<string>\"\n }\n ],\n \"metadata\": {},\n \"language\": \"<string>\",\n \"secondaryLanguages\": [\n \"<string>\"\n ],\n \"enableChangeLanguage\": true,\n \"fillEmptyStringVariables\": true,\n \"silenceHangupConfiguration\": {\n \"silenceDurationSeconds\": 123\n },\n \"ivrSilenceHangupConfiguration\": {\n \"silenceDurationSeconds\": 123\n }\n },\n \"keywords\": [\n \"<string>\"\n ],\n \"advancedBrowserInteraction\": true\n}"
response = http.request(request)
puts response.read_body{
"dialToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0ZXN0IjoidGVzdCJ9.9EQaLsDRKDVXLUVLR9JgDTjEULaT2-OMbHayQAzgZH8",
"sessionId": "61ccefdf-ea02-4f49-811b-1241f8e20d26",
"dialId": "57555c5e-5a56-49ca-8fe8-24946d2fbc3e"
}Authorizations
In the form Bearer <api_key_here>. You can find your api key in your dashboard.
Body
application/json
Create a new dial
Required. The ID of the agent.
Example:
"61ccefdf-ea02-4f49-811b-1241f8e20d26"
Optional. The URL for the webhook for this dial session.
Example:
"https://test.com/webhook"
Set to true if this is a browser call.
Example:
false
Required if this is a phone dial, in E.164 format.
Example:
"+11234567890"
The ID for the phone number to use to start the call. Required if this is a phone dial.
Example:
"1caec78c-4bba-477d-82cf-bcfce2b73856"
The ID of a phone number pool to use when starting the call.
Example:
"1caec78c-4bba-477d-82cf-bcfce2b73856"
The ID for the voice on the call. If not specified, the default voice for the agent will be used.
Example:
"61ccefdf-ea02-4f49-811b-1241f8e20d26"
An optional configuration for the voice being used.
Show child attributes
Show child attributes
The volume level for the voice on the call, from -300 (quiet) to 300 (loud).
Example:
-100
The prompt/model version to use for this call, if not specified, the default on the agent is used.
Example:
"61ccefdf-ea02-4f49-811b-1241f8e20d26"
The prompt/model version to use for the IVR portion of this call, if ivr nav is enabled on the agent.
Example:
"61ccefdf-ea02-4f49-811b-1241f8e20d26"
How long in ms after an utterance is complete to ignore the final/non-final status of the transcript and run inference.
Example:
500
The number of minutes before the call will be timed out. If not specified, there will be no limit on the calls, it's recommended to provide something here.
Example:
10
The ID of the extractor to use for this call, if not specified, the default on the agent is used.
Example:
"61ccefdf-ea02-4f49-811b-1241f8e20d26"
Any macros in the call agent prompt.
Show child attributes
Show child attributes
(Alpha) This feature is in Alpha testing, schemas may change slightly before GA. Please notify the Vogent team if there are any issues when using this field. Optional overrides for the call agent used for this dial.
Show child attributes
Show child attributes
A list of keywords to be used in the call.
If browserCall is false, and you want to have a more complex flow, allowing the web SDK to have transcribed barge-in lines, you should set this to true. Contact the vogent team to enable this feature.
Response
Successful operation
You can pass this dial token to Elto's web UI, or use this token to authorize any requests for this dial. It's safe to pass this token to a client -- it only allows users to run requests against the dial associated with this session.
Example:
"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0ZXN0IjoidGVzdCJ9.9EQaLsDRKDVXLUVLR9JgDTjEULaT2-OMbHayQAzgZH8"
Example:
"61ccefdf-ea02-4f49-811b-1241f8e20d26"
Example:
"57555c5e-5a56-49ca-8fe8-24946d2fbc3e"
⌘I