Telephony
Set Telephony Credentials
deprecated
Allows adding or updating telephony provider credentials to an account
PATCH
/
api
/
accounts
/
me
/
telephony_config
cURL
curl --request PATCH \
--url https://api.ultravox.ai/api/accounts/me/telephony_config \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"twilio": {
"accountSid": "<string>",
"authToken": "<string>",
"callCreationAllowedAgentIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"callCreationAllowAllAgents": false,
"requestContextMapping": {}
},
"telnyx": {
"accountSid": "<string>",
"apiKey": "<string>",
"publicKey": "<string>",
"applicationSid": "<string>",
"callCreationAllowedAgentIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"callCreationAllowAllAgents": false,
"requestContextMapping": {}
},
"plivo": {
"authId": "<string>",
"authToken": "<string>",
"callCreationAllowedAgentIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"callCreationAllowAllAgents": false,
"requestContextMapping": {}
}
}
'import requests
url = "https://api.ultravox.ai/api/accounts/me/telephony_config"
payload = {
"twilio": {
"accountSid": "<string>",
"authToken": "<string>",
"callCreationAllowedAgentIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"callCreationAllowAllAgents": False,
"requestContextMapping": {}
},
"telnyx": {
"accountSid": "<string>",
"apiKey": "<string>",
"publicKey": "<string>",
"applicationSid": "<string>",
"callCreationAllowedAgentIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"callCreationAllowAllAgents": False,
"requestContextMapping": {}
},
"plivo": {
"authId": "<string>",
"authToken": "<string>",
"callCreationAllowedAgentIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"callCreationAllowAllAgents": False,
"requestContextMapping": {}
}
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
twilio: {
accountSid: '<string>',
authToken: '<string>',
callCreationAllowedAgentIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
callCreationAllowAllAgents: false,
requestContextMapping: {}
},
telnyx: {
accountSid: '<string>',
apiKey: '<string>',
publicKey: '<string>',
applicationSid: '<string>',
callCreationAllowedAgentIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
callCreationAllowAllAgents: false,
requestContextMapping: {}
},
plivo: {
authId: '<string>',
authToken: '<string>',
callCreationAllowedAgentIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
callCreationAllowAllAgents: false,
requestContextMapping: {}
}
})
};
fetch('https://api.ultravox.ai/api/accounts/me/telephony_config', 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.ultravox.ai/api/accounts/me/telephony_config",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'twilio' => [
'accountSid' => '<string>',
'authToken' => '<string>',
'callCreationAllowedAgentIds' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'callCreationAllowAllAgents' => false,
'requestContextMapping' => [
]
],
'telnyx' => [
'accountSid' => '<string>',
'apiKey' => '<string>',
'publicKey' => '<string>',
'applicationSid' => '<string>',
'callCreationAllowedAgentIds' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'callCreationAllowAllAgents' => false,
'requestContextMapping' => [
]
],
'plivo' => [
'authId' => '<string>',
'authToken' => '<string>',
'callCreationAllowedAgentIds' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'callCreationAllowAllAgents' => false,
'requestContextMapping' => [
]
]
]),
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://api.ultravox.ai/api/accounts/me/telephony_config"
payload := strings.NewReader("{\n \"twilio\": {\n \"accountSid\": \"<string>\",\n \"authToken\": \"<string>\",\n \"callCreationAllowedAgentIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"callCreationAllowAllAgents\": false,\n \"requestContextMapping\": {}\n },\n \"telnyx\": {\n \"accountSid\": \"<string>\",\n \"apiKey\": \"<string>\",\n \"publicKey\": \"<string>\",\n \"applicationSid\": \"<string>\",\n \"callCreationAllowedAgentIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"callCreationAllowAllAgents\": false,\n \"requestContextMapping\": {}\n },\n \"plivo\": {\n \"authId\": \"<string>\",\n \"authToken\": \"<string>\",\n \"callCreationAllowedAgentIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"callCreationAllowAllAgents\": false,\n \"requestContextMapping\": {}\n }\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.ultravox.ai/api/accounts/me/telephony_config")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"twilio\": {\n \"accountSid\": \"<string>\",\n \"authToken\": \"<string>\",\n \"callCreationAllowedAgentIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"callCreationAllowAllAgents\": false,\n \"requestContextMapping\": {}\n },\n \"telnyx\": {\n \"accountSid\": \"<string>\",\n \"apiKey\": \"<string>\",\n \"publicKey\": \"<string>\",\n \"applicationSid\": \"<string>\",\n \"callCreationAllowedAgentIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"callCreationAllowAllAgents\": false,\n \"requestContextMapping\": {}\n },\n \"plivo\": {\n \"authId\": \"<string>\",\n \"authToken\": \"<string>\",\n \"callCreationAllowedAgentIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"callCreationAllowAllAgents\": false,\n \"requestContextMapping\": {}\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ultravox.ai/api/accounts/me/telephony_config")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"twilio\": {\n \"accountSid\": \"<string>\",\n \"authToken\": \"<string>\",\n \"callCreationAllowedAgentIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"callCreationAllowAllAgents\": false,\n \"requestContextMapping\": {}\n },\n \"telnyx\": {\n \"accountSid\": \"<string>\",\n \"apiKey\": \"<string>\",\n \"publicKey\": \"<string>\",\n \"applicationSid\": \"<string>\",\n \"callCreationAllowedAgentIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"callCreationAllowAllAgents\": false,\n \"requestContextMapping\": {}\n },\n \"plivo\": {\n \"authId\": \"<string>\",\n \"authToken\": \"<string>\",\n \"callCreationAllowedAgentIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"callCreationAllowAllAgents\": false,\n \"requestContextMapping\": {}\n }\n}"
response = http.request(request)
puts response.read_body{
"twilio": {
"accountSid": "<string>",
"authTokenPrefix": {
"prefix": "<string>"
},
"callCreationAllowedAgentIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"callCreationAllowAllAgents": false,
"requestContextMapping": {}
},
"telnyx": {
"accountSid": "<string>",
"apiKeyPrefix": {
"prefix": "<string>"
},
"publicKeyPrefix": {
"prefix": "<string>"
},
"applicationSid": "<string>",
"callCreationAllowedAgentIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"callCreationAllowAllAgents": false,
"requestContextMapping": {}
},
"plivo": {
"authId": "<string>",
"authTokenPrefix": {
"prefix": "<string>"
},
"callCreationAllowedAgentIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"callCreationAllowAllAgents": false,
"requestContextMapping": {}
}
}Authorizations
API key
Body
application/json
Your Twilio configuration. See https://console.twilio.com/
Show child attributes
Show child attributes
Your Telnyx configuration. See https://portal.telnyx.com/
Show child attributes
Show child attributes
Your Plivo configuration. See https://console.plivo.com/dashboard/
Show child attributes
Show child attributes
Response
200 - application/json
Your Twilio configuration. See https://console.twilio.com/
Show child attributes
Show child attributes
Your Telnyx configuration. See https://portal.telnyx.com/
Show child attributes
Show child attributes
Your Plivo configuration. See https://console.plivo.com/dashboard/
Show child attributes
Show child attributes
Previous
Get Telephony CredentialsReturns the telephony credentials associated with the active account
Next
⌘I
cURL
curl --request PATCH \
--url https://api.ultravox.ai/api/accounts/me/telephony_config \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"twilio": {
"accountSid": "<string>",
"authToken": "<string>",
"callCreationAllowedAgentIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"callCreationAllowAllAgents": false,
"requestContextMapping": {}
},
"telnyx": {
"accountSid": "<string>",
"apiKey": "<string>",
"publicKey": "<string>",
"applicationSid": "<string>",
"callCreationAllowedAgentIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"callCreationAllowAllAgents": false,
"requestContextMapping": {}
},
"plivo": {
"authId": "<string>",
"authToken": "<string>",
"callCreationAllowedAgentIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"callCreationAllowAllAgents": false,
"requestContextMapping": {}
}
}
'import requests
url = "https://api.ultravox.ai/api/accounts/me/telephony_config"
payload = {
"twilio": {
"accountSid": "<string>",
"authToken": "<string>",
"callCreationAllowedAgentIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"callCreationAllowAllAgents": False,
"requestContextMapping": {}
},
"telnyx": {
"accountSid": "<string>",
"apiKey": "<string>",
"publicKey": "<string>",
"applicationSid": "<string>",
"callCreationAllowedAgentIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"callCreationAllowAllAgents": False,
"requestContextMapping": {}
},
"plivo": {
"authId": "<string>",
"authToken": "<string>",
"callCreationAllowedAgentIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"callCreationAllowAllAgents": False,
"requestContextMapping": {}
}
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
twilio: {
accountSid: '<string>',
authToken: '<string>',
callCreationAllowedAgentIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
callCreationAllowAllAgents: false,
requestContextMapping: {}
},
telnyx: {
accountSid: '<string>',
apiKey: '<string>',
publicKey: '<string>',
applicationSid: '<string>',
callCreationAllowedAgentIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
callCreationAllowAllAgents: false,
requestContextMapping: {}
},
plivo: {
authId: '<string>',
authToken: '<string>',
callCreationAllowedAgentIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
callCreationAllowAllAgents: false,
requestContextMapping: {}
}
})
};
fetch('https://api.ultravox.ai/api/accounts/me/telephony_config', 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.ultravox.ai/api/accounts/me/telephony_config",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'twilio' => [
'accountSid' => '<string>',
'authToken' => '<string>',
'callCreationAllowedAgentIds' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'callCreationAllowAllAgents' => false,
'requestContextMapping' => [
]
],
'telnyx' => [
'accountSid' => '<string>',
'apiKey' => '<string>',
'publicKey' => '<string>',
'applicationSid' => '<string>',
'callCreationAllowedAgentIds' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'callCreationAllowAllAgents' => false,
'requestContextMapping' => [
]
],
'plivo' => [
'authId' => '<string>',
'authToken' => '<string>',
'callCreationAllowedAgentIds' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'callCreationAllowAllAgents' => false,
'requestContextMapping' => [
]
]
]),
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://api.ultravox.ai/api/accounts/me/telephony_config"
payload := strings.NewReader("{\n \"twilio\": {\n \"accountSid\": \"<string>\",\n \"authToken\": \"<string>\",\n \"callCreationAllowedAgentIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"callCreationAllowAllAgents\": false,\n \"requestContextMapping\": {}\n },\n \"telnyx\": {\n \"accountSid\": \"<string>\",\n \"apiKey\": \"<string>\",\n \"publicKey\": \"<string>\",\n \"applicationSid\": \"<string>\",\n \"callCreationAllowedAgentIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"callCreationAllowAllAgents\": false,\n \"requestContextMapping\": {}\n },\n \"plivo\": {\n \"authId\": \"<string>\",\n \"authToken\": \"<string>\",\n \"callCreationAllowedAgentIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"callCreationAllowAllAgents\": false,\n \"requestContextMapping\": {}\n }\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.ultravox.ai/api/accounts/me/telephony_config")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"twilio\": {\n \"accountSid\": \"<string>\",\n \"authToken\": \"<string>\",\n \"callCreationAllowedAgentIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"callCreationAllowAllAgents\": false,\n \"requestContextMapping\": {}\n },\n \"telnyx\": {\n \"accountSid\": \"<string>\",\n \"apiKey\": \"<string>\",\n \"publicKey\": \"<string>\",\n \"applicationSid\": \"<string>\",\n \"callCreationAllowedAgentIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"callCreationAllowAllAgents\": false,\n \"requestContextMapping\": {}\n },\n \"plivo\": {\n \"authId\": \"<string>\",\n \"authToken\": \"<string>\",\n \"callCreationAllowedAgentIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"callCreationAllowAllAgents\": false,\n \"requestContextMapping\": {}\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ultravox.ai/api/accounts/me/telephony_config")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"twilio\": {\n \"accountSid\": \"<string>\",\n \"authToken\": \"<string>\",\n \"callCreationAllowedAgentIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"callCreationAllowAllAgents\": false,\n \"requestContextMapping\": {}\n },\n \"telnyx\": {\n \"accountSid\": \"<string>\",\n \"apiKey\": \"<string>\",\n \"publicKey\": \"<string>\",\n \"applicationSid\": \"<string>\",\n \"callCreationAllowedAgentIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"callCreationAllowAllAgents\": false,\n \"requestContextMapping\": {}\n },\n \"plivo\": {\n \"authId\": \"<string>\",\n \"authToken\": \"<string>\",\n \"callCreationAllowedAgentIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"callCreationAllowAllAgents\": false,\n \"requestContextMapping\": {}\n }\n}"
response = http.request(request)
puts response.read_body{
"twilio": {
"accountSid": "<string>",
"authTokenPrefix": {
"prefix": "<string>"
},
"callCreationAllowedAgentIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"callCreationAllowAllAgents": false,
"requestContextMapping": {}
},
"telnyx": {
"accountSid": "<string>",
"apiKeyPrefix": {
"prefix": "<string>"
},
"publicKeyPrefix": {
"prefix": "<string>"
},
"applicationSid": "<string>",
"callCreationAllowedAgentIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"callCreationAllowAllAgents": false,
"requestContextMapping": {}
},
"plivo": {
"authId": "<string>",
"authTokenPrefix": {
"prefix": "<string>"
},
"callCreationAllowedAgentIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"callCreationAllowAllAgents": false,
"requestContextMapping": {}
}
}