Initiate Outbound Api
curl --request POST \
--url https://apps.sarvam.ai/api/outbounds/v1/orgs/{org_id}/workspaces/{workspace_id}/outbounds \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"app_config": {
"app_id": "<string>",
"app_version": 2,
"connection_config": {
"connection_id": "<string>",
"agent_phone_number": "<string>"
},
"agent_variables": {},
"app_type": "agent",
"app_overrides": {
"initial_bot_message": "<string>",
"initial_state_name": "<string>"
}
},
"user_config": {
"user_phone_number": "<string>"
},
"webhook_config": {
"url": "<string>",
"metadata": {}
}
}
'import requests
url = "https://apps.sarvam.ai/api/outbounds/v1/orgs/{org_id}/workspaces/{workspace_id}/outbounds"
payload = {
"app_config": {
"app_id": "<string>",
"app_version": 2,
"connection_config": {
"connection_id": "<string>",
"agent_phone_number": "<string>"
},
"agent_variables": {},
"app_type": "agent",
"app_overrides": {
"initial_bot_message": "<string>",
"initial_state_name": "<string>"
}
},
"user_config": { "user_phone_number": "<string>" },
"webhook_config": {
"url": "<string>",
"metadata": {}
}
}
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({
app_config: {
app_id: '<string>',
app_version: 2,
connection_config: {connection_id: '<string>', agent_phone_number: '<string>'},
agent_variables: {},
app_type: 'agent',
app_overrides: {initial_bot_message: '<string>', initial_state_name: '<string>'}
},
user_config: {user_phone_number: '<string>'},
webhook_config: {url: '<string>', metadata: {}}
})
};
fetch('https://apps.sarvam.ai/api/outbounds/v1/orgs/{org_id}/workspaces/{workspace_id}/outbounds', 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://apps.sarvam.ai/api/outbounds/v1/orgs/{org_id}/workspaces/{workspace_id}/outbounds",
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([
'app_config' => [
'app_id' => '<string>',
'app_version' => 2,
'connection_config' => [
'connection_id' => '<string>',
'agent_phone_number' => '<string>'
],
'agent_variables' => [
],
'app_type' => 'agent',
'app_overrides' => [
'initial_bot_message' => '<string>',
'initial_state_name' => '<string>'
]
],
'user_config' => [
'user_phone_number' => '<string>'
],
'webhook_config' => [
'url' => '<string>',
'metadata' => [
]
]
]),
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://apps.sarvam.ai/api/outbounds/v1/orgs/{org_id}/workspaces/{workspace_id}/outbounds"
payload := strings.NewReader("{\n \"app_config\": {\n \"app_id\": \"<string>\",\n \"app_version\": 2,\n \"connection_config\": {\n \"connection_id\": \"<string>\",\n \"agent_phone_number\": \"<string>\"\n },\n \"agent_variables\": {},\n \"app_type\": \"agent\",\n \"app_overrides\": {\n \"initial_bot_message\": \"<string>\",\n \"initial_state_name\": \"<string>\"\n }\n },\n \"user_config\": {\n \"user_phone_number\": \"<string>\"\n },\n \"webhook_config\": {\n \"url\": \"<string>\",\n \"metadata\": {}\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://apps.sarvam.ai/api/outbounds/v1/orgs/{org_id}/workspaces/{workspace_id}/outbounds")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"app_config\": {\n \"app_id\": \"<string>\",\n \"app_version\": 2,\n \"connection_config\": {\n \"connection_id\": \"<string>\",\n \"agent_phone_number\": \"<string>\"\n },\n \"agent_variables\": {},\n \"app_type\": \"agent\",\n \"app_overrides\": {\n \"initial_bot_message\": \"<string>\",\n \"initial_state_name\": \"<string>\"\n }\n },\n \"user_config\": {\n \"user_phone_number\": \"<string>\"\n },\n \"webhook_config\": {\n \"url\": \"<string>\",\n \"metadata\": {}\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://apps.sarvam.ai/api/outbounds/v1/orgs/{org_id}/workspaces/{workspace_id}/outbounds")
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 \"app_config\": {\n \"app_id\": \"<string>\",\n \"app_version\": 2,\n \"connection_config\": {\n \"connection_id\": \"<string>\",\n \"agent_phone_number\": \"<string>\"\n },\n \"agent_variables\": {},\n \"app_type\": \"agent\",\n \"app_overrides\": {\n \"initial_bot_message\": \"<string>\",\n \"initial_state_name\": \"<string>\"\n }\n },\n \"user_config\": {\n \"user_phone_number\": \"<string>\"\n },\n \"webhook_config\": {\n \"url\": \"<string>\",\n \"metadata\": {}\n }\n}"
response = http.request(request)
puts response.read_body{
"attempt_id": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Instant Outbound
Create Instant Outbound Call
POST
/
v1
/
orgs
/
{org_id}
/
workspaces
/
{workspace_id}
/
outbounds
Initiate Outbound Api
curl --request POST \
--url https://apps.sarvam.ai/api/outbounds/v1/orgs/{org_id}/workspaces/{workspace_id}/outbounds \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"app_config": {
"app_id": "<string>",
"app_version": 2,
"connection_config": {
"connection_id": "<string>",
"agent_phone_number": "<string>"
},
"agent_variables": {},
"app_type": "agent",
"app_overrides": {
"initial_bot_message": "<string>",
"initial_state_name": "<string>"
}
},
"user_config": {
"user_phone_number": "<string>"
},
"webhook_config": {
"url": "<string>",
"metadata": {}
}
}
'import requests
url = "https://apps.sarvam.ai/api/outbounds/v1/orgs/{org_id}/workspaces/{workspace_id}/outbounds"
payload = {
"app_config": {
"app_id": "<string>",
"app_version": 2,
"connection_config": {
"connection_id": "<string>",
"agent_phone_number": "<string>"
},
"agent_variables": {},
"app_type": "agent",
"app_overrides": {
"initial_bot_message": "<string>",
"initial_state_name": "<string>"
}
},
"user_config": { "user_phone_number": "<string>" },
"webhook_config": {
"url": "<string>",
"metadata": {}
}
}
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({
app_config: {
app_id: '<string>',
app_version: 2,
connection_config: {connection_id: '<string>', agent_phone_number: '<string>'},
agent_variables: {},
app_type: 'agent',
app_overrides: {initial_bot_message: '<string>', initial_state_name: '<string>'}
},
user_config: {user_phone_number: '<string>'},
webhook_config: {url: '<string>', metadata: {}}
})
};
fetch('https://apps.sarvam.ai/api/outbounds/v1/orgs/{org_id}/workspaces/{workspace_id}/outbounds', 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://apps.sarvam.ai/api/outbounds/v1/orgs/{org_id}/workspaces/{workspace_id}/outbounds",
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([
'app_config' => [
'app_id' => '<string>',
'app_version' => 2,
'connection_config' => [
'connection_id' => '<string>',
'agent_phone_number' => '<string>'
],
'agent_variables' => [
],
'app_type' => 'agent',
'app_overrides' => [
'initial_bot_message' => '<string>',
'initial_state_name' => '<string>'
]
],
'user_config' => [
'user_phone_number' => '<string>'
],
'webhook_config' => [
'url' => '<string>',
'metadata' => [
]
]
]),
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://apps.sarvam.ai/api/outbounds/v1/orgs/{org_id}/workspaces/{workspace_id}/outbounds"
payload := strings.NewReader("{\n \"app_config\": {\n \"app_id\": \"<string>\",\n \"app_version\": 2,\n \"connection_config\": {\n \"connection_id\": \"<string>\",\n \"agent_phone_number\": \"<string>\"\n },\n \"agent_variables\": {},\n \"app_type\": \"agent\",\n \"app_overrides\": {\n \"initial_bot_message\": \"<string>\",\n \"initial_state_name\": \"<string>\"\n }\n },\n \"user_config\": {\n \"user_phone_number\": \"<string>\"\n },\n \"webhook_config\": {\n \"url\": \"<string>\",\n \"metadata\": {}\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://apps.sarvam.ai/api/outbounds/v1/orgs/{org_id}/workspaces/{workspace_id}/outbounds")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"app_config\": {\n \"app_id\": \"<string>\",\n \"app_version\": 2,\n \"connection_config\": {\n \"connection_id\": \"<string>\",\n \"agent_phone_number\": \"<string>\"\n },\n \"agent_variables\": {},\n \"app_type\": \"agent\",\n \"app_overrides\": {\n \"initial_bot_message\": \"<string>\",\n \"initial_state_name\": \"<string>\"\n }\n },\n \"user_config\": {\n \"user_phone_number\": \"<string>\"\n },\n \"webhook_config\": {\n \"url\": \"<string>\",\n \"metadata\": {}\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://apps.sarvam.ai/api/outbounds/v1/orgs/{org_id}/workspaces/{workspace_id}/outbounds")
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 \"app_config\": {\n \"app_id\": \"<string>\",\n \"app_version\": 2,\n \"connection_config\": {\n \"connection_id\": \"<string>\",\n \"agent_phone_number\": \"<string>\"\n },\n \"agent_variables\": {},\n \"app_type\": \"agent\",\n \"app_overrides\": {\n \"initial_bot_message\": \"<string>\",\n \"initial_state_name\": \"<string>\"\n }\n },\n \"user_config\": {\n \"user_phone_number\": \"<string>\"\n },\n \"webhook_config\": {\n \"url\": \"<string>\",\n \"metadata\": {}\n }\n}"
response = http.request(request)
puts response.read_body{
"attempt_id": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
Body
application/json
Response
Successful Response
⌘I