Import External Agent
curl --request POST \
--url http://127.0.0.1:8080/v1/agents/import \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"provider": "<string>",
"external_agent_id": "<string>",
"name": "<string>",
"api_key": "<string>",
"region": "<string>",
"sip_credential_id": "<string>",
"sip_uri": "<string>",
"sip_transport": "<string>",
"sip_region": "<string>",
"websocket_url": "<string>",
"did_number": "<string>"
}
'import requests
url = "http://127.0.0.1:8080/v1/agents/import"
payload = {
"provider": "<string>",
"external_agent_id": "<string>",
"name": "<string>",
"api_key": "<string>",
"region": "<string>",
"sip_credential_id": "<string>",
"sip_uri": "<string>",
"sip_transport": "<string>",
"sip_region": "<string>",
"websocket_url": "<string>",
"did_number": "<string>"
}
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({
provider: '<string>',
external_agent_id: '<string>',
name: '<string>',
api_key: '<string>',
region: '<string>',
sip_credential_id: '<string>',
sip_uri: '<string>',
sip_transport: '<string>',
sip_region: '<string>',
websocket_url: '<string>',
did_number: '<string>'
})
};
fetch('http://127.0.0.1:8080/v1/agents/import', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://127.0.0.1:8080/v1/agents/import",
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([
'provider' => '<string>',
'external_agent_id' => '<string>',
'name' => '<string>',
'api_key' => '<string>',
'region' => '<string>',
'sip_credential_id' => '<string>',
'sip_uri' => '<string>',
'sip_transport' => '<string>',
'sip_region' => '<string>',
'websocket_url' => '<string>',
'did_number' => '<string>'
]),
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 := "http://127.0.0.1:8080/v1/agents/import"
payload := strings.NewReader("{\n \"provider\": \"<string>\",\n \"external_agent_id\": \"<string>\",\n \"name\": \"<string>\",\n \"api_key\": \"<string>\",\n \"region\": \"<string>\",\n \"sip_credential_id\": \"<string>\",\n \"sip_uri\": \"<string>\",\n \"sip_transport\": \"<string>\",\n \"sip_region\": \"<string>\",\n \"websocket_url\": \"<string>\",\n \"did_number\": \"<string>\"\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("http://127.0.0.1:8080/v1/agents/import")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"provider\": \"<string>\",\n \"external_agent_id\": \"<string>\",\n \"name\": \"<string>\",\n \"api_key\": \"<string>\",\n \"region\": \"<string>\",\n \"sip_credential_id\": \"<string>\",\n \"sip_uri\": \"<string>\",\n \"sip_transport\": \"<string>\",\n \"sip_region\": \"<string>\",\n \"websocket_url\": \"<string>\",\n \"did_number\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://127.0.0.1:8080/v1/agents/import")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"provider\": \"<string>\",\n \"external_agent_id\": \"<string>\",\n \"name\": \"<string>\",\n \"api_key\": \"<string>\",\n \"region\": \"<string>\",\n \"sip_credential_id\": \"<string>\",\n \"sip_uri\": \"<string>\",\n \"sip_transport\": \"<string>\",\n \"sip_region\": \"<string>\",\n \"websocket_url\": \"<string>\",\n \"did_number\": \"<string>\"\n}"
response = http.request(request)
puts response.read_bodyAgents
Import External Agent
Pin a remote platform agent into inventory with connection_mode sip_trunk (default; our carrier/SBC dials the platform SIP edge) or media_bridge (ElevenLabs ConvAI translator; gateway keeps VAD/recording/transcription). With api_key the remote id is verified live. With did_number an inbound route (agent_provider external_bridge) is registered in the same call. The provider key is stored for call-time auth and redacted on reads.
POST
/
v1
/
agents
/
import
Import External Agent
curl --request POST \
--url http://127.0.0.1:8080/v1/agents/import \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"provider": "<string>",
"external_agent_id": "<string>",
"name": "<string>",
"api_key": "<string>",
"region": "<string>",
"sip_credential_id": "<string>",
"sip_uri": "<string>",
"sip_transport": "<string>",
"sip_region": "<string>",
"websocket_url": "<string>",
"did_number": "<string>"
}
'import requests
url = "http://127.0.0.1:8080/v1/agents/import"
payload = {
"provider": "<string>",
"external_agent_id": "<string>",
"name": "<string>",
"api_key": "<string>",
"region": "<string>",
"sip_credential_id": "<string>",
"sip_uri": "<string>",
"sip_transport": "<string>",
"sip_region": "<string>",
"websocket_url": "<string>",
"did_number": "<string>"
}
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({
provider: '<string>',
external_agent_id: '<string>',
name: '<string>',
api_key: '<string>',
region: '<string>',
sip_credential_id: '<string>',
sip_uri: '<string>',
sip_transport: '<string>',
sip_region: '<string>',
websocket_url: '<string>',
did_number: '<string>'
})
};
fetch('http://127.0.0.1:8080/v1/agents/import', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://127.0.0.1:8080/v1/agents/import",
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([
'provider' => '<string>',
'external_agent_id' => '<string>',
'name' => '<string>',
'api_key' => '<string>',
'region' => '<string>',
'sip_credential_id' => '<string>',
'sip_uri' => '<string>',
'sip_transport' => '<string>',
'sip_region' => '<string>',
'websocket_url' => '<string>',
'did_number' => '<string>'
]),
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 := "http://127.0.0.1:8080/v1/agents/import"
payload := strings.NewReader("{\n \"provider\": \"<string>\",\n \"external_agent_id\": \"<string>\",\n \"name\": \"<string>\",\n \"api_key\": \"<string>\",\n \"region\": \"<string>\",\n \"sip_credential_id\": \"<string>\",\n \"sip_uri\": \"<string>\",\n \"sip_transport\": \"<string>\",\n \"sip_region\": \"<string>\",\n \"websocket_url\": \"<string>\",\n \"did_number\": \"<string>\"\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("http://127.0.0.1:8080/v1/agents/import")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"provider\": \"<string>\",\n \"external_agent_id\": \"<string>\",\n \"name\": \"<string>\",\n \"api_key\": \"<string>\",\n \"region\": \"<string>\",\n \"sip_credential_id\": \"<string>\",\n \"sip_uri\": \"<string>\",\n \"sip_transport\": \"<string>\",\n \"sip_region\": \"<string>\",\n \"websocket_url\": \"<string>\",\n \"did_number\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://127.0.0.1:8080/v1/agents/import")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"provider\": \"<string>\",\n \"external_agent_id\": \"<string>\",\n \"name\": \"<string>\",\n \"api_key\": \"<string>\",\n \"region\": \"<string>\",\n \"sip_credential_id\": \"<string>\",\n \"sip_uri\": \"<string>\",\n \"sip_transport\": \"<string>\",\n \"sip_region\": \"<string>\",\n \"websocket_url\": \"<string>\",\n \"did_number\": \"<string>\"\n}"
response = http.request(request)
puts response.read_bodyAuthorizations
BearerAuthCookieAuth
Enter your Tenant API key (or use SANDBOX_API_KEY)
Body
application/json
Response
Imported agent (secret redacted) and optional route