Skip to main content
POST
/
start_outbound_call
Start Outbound Call
curl --request POST \
  --url https://api-west.millis.ai/start_outbound_call \
  --header 'Content-Type: application/json' \
  --data '
{
  "from_phone": "<string>",
  "to_phone": "<string>",
  "agent_id": "<string>",
  "agent_config": {
    "prompt": "<string>",
    "voice": {
      "voice_id": "<string>",
      "model": "<string>",
      "settings": {}
    },
    "flow": {
      "user_start_first": true,
      "interruption": {
        "allowed": true,
        "keep_interruption_message": true,
        "first_messsage": true
      },
      "response_delay": 123,
      "auto_fill_responses": {
        "response_gap_threshold": 123,
        "messages": [
          "<string>"
        ]
      },
      "agent_terminate_call": {
        "enabled": true,
        "instruction": "<string>",
        "messages": [
          "<string>"
        ]
      },
      "voicemail": {
        "message": "<string>",
        "continue_on_voice_activity": true
      },
      "call_transfer": {
        "phone": "<string>",
        "phones": [
          {
            "phone": "<string>",
            "description": "<string>"
          }
        ],
        "instruction": "<string>",
        "messages": [
          "<string>"
        ]
      },
      "inactivity_handling": {
        "idle_time": 123,
        "message": "<string>"
      },
      "dtmf_dial": {
        "enabled": false,
        "instruction": "<string>"
      }
    },
    "first_message": "<string>",
    "tools": [
      {
        "name": "<string>",
        "description": "<string>",
        "params": [
          {
            "name": "<string>",
            "required": true,
            "type": "<string>",
            "description": "<string>"
          }
        ],
        "webhook": "<string>",
        "header": {},
        "method": "<string>",
        "timeout": 123,
        "run_after_call": true,
        "messages": [
          "<string>"
        ],
        "execute_after_message": true,
        "exclude_session_id": true
      }
    ],
    "millis_functions": [
      {
        "name": "<string>",
        "description": "<string>",
        "data": {
          "param": {
            "description": "<string>",
            "name": "<string>",
            "required": true,
            "type": "<string>"
          }
        },
        "type": "<string>",
        "messages": [
          "<string>"
        ]
      }
    ],
    "app_functions": [
      {
        "name": "<string>",
        "credentials": {}
      }
    ],
    "custom_llm_websocket": "<string>",
    "language": "en-US",
    "vad_threshold": 123,
    "llm": {
      "temperature": 0,
      "history_settings": {
        "history_message_limit": 123,
        "history_tool_result_limit": 123
      }
    },
    "session_timeout": {
      "max_duration": 123,
      "max_idle": 123,
      "message": "<string>"
    },
    "session_data_webhook": "<string>",
    "privacy_settings": {
      "opt_out_data_collection": true,
      "do_not_call_detection": false
    },
    "custom_vocabulary": {
      "keywords": {}
    },
    "extra_prompt_webhook": "<string>",
    "switch_language": {
      "languages": [
        "<string>"
      ]
    },
    "knowledge_base": {
      "files": [
        "<string>"
      ],
      "messages": [
        "<string>"
      ]
    },
    "speech_to_text": {
      "multilingual": true,
      "model": "<string>"
    },
    "call_settings": {
      "enable_recording": false,
      "background": {
        "url": "<string>",
        "volume": 123
      }
    },
    "memory": {
      "user_identifier_key": ""
    },
    "timezone": "<string>"
  },
  "metadata": {},
  "include_metadata_in_prompt": true,
  "session_continuation": {
    "session_id": "<string>",
    "messages": [
      {
        "role": "user",
        "content": "<string>"
      }
    ],
    "identifier_variable": "<string>"
  }
}
'
import requests

url = "https://api-west.millis.ai/start_outbound_call"

payload = {
"from_phone": "<string>",
"to_phone": "<string>",
"agent_id": "<string>",
"agent_config": {
"prompt": "<string>",
"voice": {
"voice_id": "<string>",
"model": "<string>",
"settings": {}
},
"flow": {
"user_start_first": True,
"interruption": {
"allowed": True,
"keep_interruption_message": True,
"first_messsage": True
},
"response_delay": 123,
"auto_fill_responses": {
"response_gap_threshold": 123,
"messages": ["<string>"]
},
"agent_terminate_call": {
"enabled": True,
"instruction": "<string>",
"messages": ["<string>"]
},
"voicemail": {
"message": "<string>",
"continue_on_voice_activity": True
},
"call_transfer": {
"phone": "<string>",
"phones": [
{
"phone": "<string>",
"description": "<string>"
}
],
"instruction": "<string>",
"messages": ["<string>"]
},
"inactivity_handling": {
"idle_time": 123,
"message": "<string>"
},
"dtmf_dial": {
"enabled": False,
"instruction": "<string>"
}
},
"first_message": "<string>",
"tools": [
{
"name": "<string>",
"description": "<string>",
"params": [
{
"name": "<string>",
"required": True,
"type": "<string>",
"description": "<string>"
}
],
"webhook": "<string>",
"header": {},
"method": "<string>",
"timeout": 123,
"run_after_call": True,
"messages": ["<string>"],
"execute_after_message": True,
"exclude_session_id": True
}
],
"millis_functions": [
{
"name": "<string>",
"description": "<string>",
"data": { "param": {
"description": "<string>",
"name": "<string>",
"required": True,
"type": "<string>"
} },
"type": "<string>",
"messages": ["<string>"]
}
],
"app_functions": [
{
"name": "<string>",
"credentials": {}
}
],
"custom_llm_websocket": "<string>",
"language": "en-US",
"vad_threshold": 123,
"llm": {
"temperature": 0,
"history_settings": {
"history_message_limit": 123,
"history_tool_result_limit": 123
}
},
"session_timeout": {
"max_duration": 123,
"max_idle": 123,
"message": "<string>"
},
"session_data_webhook": "<string>",
"privacy_settings": {
"opt_out_data_collection": True,
"do_not_call_detection": False
},
"custom_vocabulary": { "keywords": {} },
"extra_prompt_webhook": "<string>",
"switch_language": { "languages": ["<string>"] },
"knowledge_base": {
"files": ["<string>"],
"messages": ["<string>"]
},
"speech_to_text": {
"multilingual": True,
"model": "<string>"
},
"call_settings": {
"enable_recording": False,
"background": {
"url": "<string>",
"volume": 123
}
},
"memory": { "user_identifier_key": "" },
"timezone": "<string>"
},
"metadata": {},
"include_metadata_in_prompt": True,
"session_continuation": {
"session_id": "<string>",
"messages": [
{
"role": "user",
"content": "<string>"
}
],
"identifier_variable": "<string>"
}
}
headers = {"Content-Type": "application/json"}

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

print(response.text)
const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
from_phone: '<string>',
to_phone: '<string>',
agent_id: '<string>',
agent_config: {
prompt: '<string>',
voice: {voice_id: '<string>', model: '<string>', settings: {}},
flow: {
user_start_first: true,
interruption: {allowed: true, keep_interruption_message: true, first_messsage: true},
response_delay: 123,
auto_fill_responses: {response_gap_threshold: 123, messages: ['<string>']},
agent_terminate_call: {enabled: true, instruction: '<string>', messages: ['<string>']},
voicemail: {message: '<string>', continue_on_voice_activity: true},
call_transfer: {
phone: '<string>',
phones: [{phone: '<string>', description: '<string>'}],
instruction: '<string>',
messages: ['<string>']
},
inactivity_handling: {idle_time: 123, message: '<string>'},
dtmf_dial: {enabled: false, instruction: '<string>'}
},
first_message: '<string>',
tools: [
{
name: '<string>',
description: '<string>',
params: [{name: '<string>', required: true, type: '<string>', description: '<string>'}],
webhook: '<string>',
header: {},
method: '<string>',
timeout: 123,
run_after_call: true,
messages: ['<string>'],
execute_after_message: true,
exclude_session_id: true
}
],
millis_functions: [
{
name: '<string>',
description: '<string>',
data: {
param: {description: '<string>', name: '<string>', required: true, type: '<string>'}
},
type: '<string>',
messages: ['<string>']
}
],
app_functions: [{name: '<string>', credentials: {}}],
custom_llm_websocket: '<string>',
language: 'en-US',
vad_threshold: 123,
llm: {
temperature: 0,
history_settings: {history_message_limit: 123, history_tool_result_limit: 123}
},
session_timeout: {max_duration: 123, max_idle: 123, message: '<string>'},
session_data_webhook: '<string>',
privacy_settings: {opt_out_data_collection: true, do_not_call_detection: false},
custom_vocabulary: {keywords: {}},
extra_prompt_webhook: '<string>',
switch_language: {languages: ['<string>']},
knowledge_base: {files: ['<string>'], messages: ['<string>']},
speech_to_text: {multilingual: true, model: '<string>'},
call_settings: {enable_recording: false, background: {url: '<string>', volume: 123}},
memory: {user_identifier_key: ''},
timezone: '<string>'
},
metadata: {},
include_metadata_in_prompt: true,
session_continuation: {
session_id: '<string>',
messages: [{role: 'user', content: '<string>'}],
identifier_variable: '<string>'
}
})
};

fetch('https://api-west.millis.ai/start_outbound_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-west.millis.ai/start_outbound_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([
'from_phone' => '<string>',
'to_phone' => '<string>',
'agent_id' => '<string>',
'agent_config' => [
'prompt' => '<string>',
'voice' => [
'voice_id' => '<string>',
'model' => '<string>',
'settings' => [

]
],
'flow' => [
'user_start_first' => true,
'interruption' => [
'allowed' => true,
'keep_interruption_message' => true,
'first_messsage' => true
],
'response_delay' => 123,
'auto_fill_responses' => [
'response_gap_threshold' => 123,
'messages' => [
'<string>'
]
],
'agent_terminate_call' => [
'enabled' => true,
'instruction' => '<string>',
'messages' => [
'<string>'
]
],
'voicemail' => [
'message' => '<string>',
'continue_on_voice_activity' => true
],
'call_transfer' => [
'phone' => '<string>',
'phones' => [
[
'phone' => '<string>',
'description' => '<string>'
]
],
'instruction' => '<string>',
'messages' => [
'<string>'
]
],
'inactivity_handling' => [
'idle_time' => 123,
'message' => '<string>'
],
'dtmf_dial' => [
'enabled' => false,
'instruction' => '<string>'
]
],
'first_message' => '<string>',
'tools' => [
[
'name' => '<string>',
'description' => '<string>',
'params' => [
[
'name' => '<string>',
'required' => true,
'type' => '<string>',
'description' => '<string>'
]
],
'webhook' => '<string>',
'header' => [

],
'method' => '<string>',
'timeout' => 123,
'run_after_call' => true,
'messages' => [
'<string>'
],
'execute_after_message' => true,
'exclude_session_id' => true
]
],
'millis_functions' => [
[
'name' => '<string>',
'description' => '<string>',
'data' => [
'param' => [
'description' => '<string>',
'name' => '<string>',
'required' => true,
'type' => '<string>'
]
],
'type' => '<string>',
'messages' => [
'<string>'
]
]
],
'app_functions' => [
[
'name' => '<string>',
'credentials' => [

]
]
],
'custom_llm_websocket' => '<string>',
'language' => 'en-US',
'vad_threshold' => 123,
'llm' => [
'temperature' => 0,
'history_settings' => [
'history_message_limit' => 123,
'history_tool_result_limit' => 123
]
],
'session_timeout' => [
'max_duration' => 123,
'max_idle' => 123,
'message' => '<string>'
],
'session_data_webhook' => '<string>',
'privacy_settings' => [
'opt_out_data_collection' => true,
'do_not_call_detection' => false
],
'custom_vocabulary' => [
'keywords' => [

]
],
'extra_prompt_webhook' => '<string>',
'switch_language' => [
'languages' => [
'<string>'
]
],
'knowledge_base' => [
'files' => [
'<string>'
],
'messages' => [
'<string>'
]
],
'speech_to_text' => [
'multilingual' => true,
'model' => '<string>'
],
'call_settings' => [
'enable_recording' => false,
'background' => [
'url' => '<string>',
'volume' => 123
]
],
'memory' => [
'user_identifier_key' => ''
],
'timezone' => '<string>'
],
'metadata' => [

],
'include_metadata_in_prompt' => true,
'session_continuation' => [
'session_id' => '<string>',
'messages' => [
[
'role' => 'user',
'content' => '<string>'
]
],
'identifier_variable' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"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-west.millis.ai/start_outbound_call"

payload := strings.NewReader("{\n \"from_phone\": \"<string>\",\n \"to_phone\": \"<string>\",\n \"agent_id\": \"<string>\",\n \"agent_config\": {\n \"prompt\": \"<string>\",\n \"voice\": {\n \"voice_id\": \"<string>\",\n \"model\": \"<string>\",\n \"settings\": {}\n },\n \"flow\": {\n \"user_start_first\": true,\n \"interruption\": {\n \"allowed\": true,\n \"keep_interruption_message\": true,\n \"first_messsage\": true\n },\n \"response_delay\": 123,\n \"auto_fill_responses\": {\n \"response_gap_threshold\": 123,\n \"messages\": [\n \"<string>\"\n ]\n },\n \"agent_terminate_call\": {\n \"enabled\": true,\n \"instruction\": \"<string>\",\n \"messages\": [\n \"<string>\"\n ]\n },\n \"voicemail\": {\n \"message\": \"<string>\",\n \"continue_on_voice_activity\": true\n },\n \"call_transfer\": {\n \"phone\": \"<string>\",\n \"phones\": [\n {\n \"phone\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"instruction\": \"<string>\",\n \"messages\": [\n \"<string>\"\n ]\n },\n \"inactivity_handling\": {\n \"idle_time\": 123,\n \"message\": \"<string>\"\n },\n \"dtmf_dial\": {\n \"enabled\": false,\n \"instruction\": \"<string>\"\n }\n },\n \"first_message\": \"<string>\",\n \"tools\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"params\": [\n {\n \"name\": \"<string>\",\n \"required\": true,\n \"type\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"webhook\": \"<string>\",\n \"header\": {},\n \"method\": \"<string>\",\n \"timeout\": 123,\n \"run_after_call\": true,\n \"messages\": [\n \"<string>\"\n ],\n \"execute_after_message\": true,\n \"exclude_session_id\": true\n }\n ],\n \"millis_functions\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"data\": {\n \"param\": {\n \"description\": \"<string>\",\n \"name\": \"<string>\",\n \"required\": true,\n \"type\": \"<string>\"\n }\n },\n \"type\": \"<string>\",\n \"messages\": [\n \"<string>\"\n ]\n }\n ],\n \"app_functions\": [\n {\n \"name\": \"<string>\",\n \"credentials\": {}\n }\n ],\n \"custom_llm_websocket\": \"<string>\",\n \"language\": \"en-US\",\n \"vad_threshold\": 123,\n \"llm\": {\n \"temperature\": 0,\n \"history_settings\": {\n \"history_message_limit\": 123,\n \"history_tool_result_limit\": 123\n }\n },\n \"session_timeout\": {\n \"max_duration\": 123,\n \"max_idle\": 123,\n \"message\": \"<string>\"\n },\n \"session_data_webhook\": \"<string>\",\n \"privacy_settings\": {\n \"opt_out_data_collection\": true,\n \"do_not_call_detection\": false\n },\n \"custom_vocabulary\": {\n \"keywords\": {}\n },\n \"extra_prompt_webhook\": \"<string>\",\n \"switch_language\": {\n \"languages\": [\n \"<string>\"\n ]\n },\n \"knowledge_base\": {\n \"files\": [\n \"<string>\"\n ],\n \"messages\": [\n \"<string>\"\n ]\n },\n \"speech_to_text\": {\n \"multilingual\": true,\n \"model\": \"<string>\"\n },\n \"call_settings\": {\n \"enable_recording\": false,\n \"background\": {\n \"url\": \"<string>\",\n \"volume\": 123\n }\n },\n \"memory\": {\n \"user_identifier_key\": \"\"\n },\n \"timezone\": \"<string>\"\n },\n \"metadata\": {},\n \"include_metadata_in_prompt\": true,\n \"session_continuation\": {\n \"session_id\": \"<string>\",\n \"messages\": [\n {\n \"role\": \"user\",\n \"content\": \"<string>\"\n }\n ],\n \"identifier_variable\": \"<string>\"\n }\n}")

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

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-west.millis.ai/start_outbound_call")
.header("Content-Type", "application/json")
.body("{\n \"from_phone\": \"<string>\",\n \"to_phone\": \"<string>\",\n \"agent_id\": \"<string>\",\n \"agent_config\": {\n \"prompt\": \"<string>\",\n \"voice\": {\n \"voice_id\": \"<string>\",\n \"model\": \"<string>\",\n \"settings\": {}\n },\n \"flow\": {\n \"user_start_first\": true,\n \"interruption\": {\n \"allowed\": true,\n \"keep_interruption_message\": true,\n \"first_messsage\": true\n },\n \"response_delay\": 123,\n \"auto_fill_responses\": {\n \"response_gap_threshold\": 123,\n \"messages\": [\n \"<string>\"\n ]\n },\n \"agent_terminate_call\": {\n \"enabled\": true,\n \"instruction\": \"<string>\",\n \"messages\": [\n \"<string>\"\n ]\n },\n \"voicemail\": {\n \"message\": \"<string>\",\n \"continue_on_voice_activity\": true\n },\n \"call_transfer\": {\n \"phone\": \"<string>\",\n \"phones\": [\n {\n \"phone\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"instruction\": \"<string>\",\n \"messages\": [\n \"<string>\"\n ]\n },\n \"inactivity_handling\": {\n \"idle_time\": 123,\n \"message\": \"<string>\"\n },\n \"dtmf_dial\": {\n \"enabled\": false,\n \"instruction\": \"<string>\"\n }\n },\n \"first_message\": \"<string>\",\n \"tools\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"params\": [\n {\n \"name\": \"<string>\",\n \"required\": true,\n \"type\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"webhook\": \"<string>\",\n \"header\": {},\n \"method\": \"<string>\",\n \"timeout\": 123,\n \"run_after_call\": true,\n \"messages\": [\n \"<string>\"\n ],\n \"execute_after_message\": true,\n \"exclude_session_id\": true\n }\n ],\n \"millis_functions\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"data\": {\n \"param\": {\n \"description\": \"<string>\",\n \"name\": \"<string>\",\n \"required\": true,\n \"type\": \"<string>\"\n }\n },\n \"type\": \"<string>\",\n \"messages\": [\n \"<string>\"\n ]\n }\n ],\n \"app_functions\": [\n {\n \"name\": \"<string>\",\n \"credentials\": {}\n }\n ],\n \"custom_llm_websocket\": \"<string>\",\n \"language\": \"en-US\",\n \"vad_threshold\": 123,\n \"llm\": {\n \"temperature\": 0,\n \"history_settings\": {\n \"history_message_limit\": 123,\n \"history_tool_result_limit\": 123\n }\n },\n \"session_timeout\": {\n \"max_duration\": 123,\n \"max_idle\": 123,\n \"message\": \"<string>\"\n },\n \"session_data_webhook\": \"<string>\",\n \"privacy_settings\": {\n \"opt_out_data_collection\": true,\n \"do_not_call_detection\": false\n },\n \"custom_vocabulary\": {\n \"keywords\": {}\n },\n \"extra_prompt_webhook\": \"<string>\",\n \"switch_language\": {\n \"languages\": [\n \"<string>\"\n ]\n },\n \"knowledge_base\": {\n \"files\": [\n \"<string>\"\n ],\n \"messages\": [\n \"<string>\"\n ]\n },\n \"speech_to_text\": {\n \"multilingual\": true,\n \"model\": \"<string>\"\n },\n \"call_settings\": {\n \"enable_recording\": false,\n \"background\": {\n \"url\": \"<string>\",\n \"volume\": 123\n }\n },\n \"memory\": {\n \"user_identifier_key\": \"\"\n },\n \"timezone\": \"<string>\"\n },\n \"metadata\": {},\n \"include_metadata_in_prompt\": true,\n \"session_continuation\": {\n \"session_id\": \"<string>\",\n \"messages\": [\n {\n \"role\": \"user\",\n \"content\": \"<string>\"\n }\n ],\n \"identifier_variable\": \"<string>\"\n }\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api-west.millis.ai/start_outbound_call")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"from_phone\": \"<string>\",\n \"to_phone\": \"<string>\",\n \"agent_id\": \"<string>\",\n \"agent_config\": {\n \"prompt\": \"<string>\",\n \"voice\": {\n \"voice_id\": \"<string>\",\n \"model\": \"<string>\",\n \"settings\": {}\n },\n \"flow\": {\n \"user_start_first\": true,\n \"interruption\": {\n \"allowed\": true,\n \"keep_interruption_message\": true,\n \"first_messsage\": true\n },\n \"response_delay\": 123,\n \"auto_fill_responses\": {\n \"response_gap_threshold\": 123,\n \"messages\": [\n \"<string>\"\n ]\n },\n \"agent_terminate_call\": {\n \"enabled\": true,\n \"instruction\": \"<string>\",\n \"messages\": [\n \"<string>\"\n ]\n },\n \"voicemail\": {\n \"message\": \"<string>\",\n \"continue_on_voice_activity\": true\n },\n \"call_transfer\": {\n \"phone\": \"<string>\",\n \"phones\": [\n {\n \"phone\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"instruction\": \"<string>\",\n \"messages\": [\n \"<string>\"\n ]\n },\n \"inactivity_handling\": {\n \"idle_time\": 123,\n \"message\": \"<string>\"\n },\n \"dtmf_dial\": {\n \"enabled\": false,\n \"instruction\": \"<string>\"\n }\n },\n \"first_message\": \"<string>\",\n \"tools\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"params\": [\n {\n \"name\": \"<string>\",\n \"required\": true,\n \"type\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"webhook\": \"<string>\",\n \"header\": {},\n \"method\": \"<string>\",\n \"timeout\": 123,\n \"run_after_call\": true,\n \"messages\": [\n \"<string>\"\n ],\n \"execute_after_message\": true,\n \"exclude_session_id\": true\n }\n ],\n \"millis_functions\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"data\": {\n \"param\": {\n \"description\": \"<string>\",\n \"name\": \"<string>\",\n \"required\": true,\n \"type\": \"<string>\"\n }\n },\n \"type\": \"<string>\",\n \"messages\": [\n \"<string>\"\n ]\n }\n ],\n \"app_functions\": [\n {\n \"name\": \"<string>\",\n \"credentials\": {}\n }\n ],\n \"custom_llm_websocket\": \"<string>\",\n \"language\": \"en-US\",\n \"vad_threshold\": 123,\n \"llm\": {\n \"temperature\": 0,\n \"history_settings\": {\n \"history_message_limit\": 123,\n \"history_tool_result_limit\": 123\n }\n },\n \"session_timeout\": {\n \"max_duration\": 123,\n \"max_idle\": 123,\n \"message\": \"<string>\"\n },\n \"session_data_webhook\": \"<string>\",\n \"privacy_settings\": {\n \"opt_out_data_collection\": true,\n \"do_not_call_detection\": false\n },\n \"custom_vocabulary\": {\n \"keywords\": {}\n },\n \"extra_prompt_webhook\": \"<string>\",\n \"switch_language\": {\n \"languages\": [\n \"<string>\"\n ]\n },\n \"knowledge_base\": {\n \"files\": [\n \"<string>\"\n ],\n \"messages\": [\n \"<string>\"\n ]\n },\n \"speech_to_text\": {\n \"multilingual\": true,\n \"model\": \"<string>\"\n },\n \"call_settings\": {\n \"enable_recording\": false,\n \"background\": {\n \"url\": \"<string>\",\n \"volume\": 123\n }\n },\n \"memory\": {\n \"user_identifier_key\": \"\"\n },\n \"timezone\": \"<string>\"\n },\n \"metadata\": {},\n \"include_metadata_in_prompt\": true,\n \"session_continuation\": {\n \"session_id\": \"<string>\",\n \"messages\": [\n {\n \"role\": \"user\",\n \"content\": \"<string>\"\n }\n ],\n \"identifier_variable\": \"<string>\"\n }\n}"

response = http.request(request)
puts response.read_body
{
  "call_id": "<string>",
  "session_id": "<string>"
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}

Headers

authorization
string | null

Private Key

Body

application/json
from_phone
string
required
to_phone
string
required
agent_id
string | null
agent_config
PartialAgentConfig · object | null
metadata
Metadata · object | null
include_metadata_in_prompt
boolean | null
session_continuation
SessionContinuation · object | null

Response

Successful Response

call_id
string
required
session_id
string
required