cURL
curl --request PATCH \
--url https://app.altheastudio.ai/api/sip \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"allowedCidrRanges": [
"<string>"
],
"allowAllAgents": false,
"allowedAgents": [
{
"agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"toUserPattern": "<string>"
}
]
}
'import requests
url = "https://app.altheastudio.ai/api/sip"
payload = {
"allowedCidrRanges": ["<string>"],
"allowAllAgents": False,
"allowedAgents": [
{
"agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"toUserPattern": "<string>"
}
]
}
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({
allowedCidrRanges: ['<string>'],
allowAllAgents: false,
allowedAgents: [{agentId: '3c90c3cc-0d44-4b50-8888-8dd25736052a', toUserPattern: '<string>'}]
})
};
fetch('https://app.altheastudio.ai/api/sip', 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://app.altheastudio.ai/api/sip",
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([
'allowedCidrRanges' => [
'<string>'
],
'allowAllAgents' => false,
'allowedAgents' => [
[
'agentId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'toUserPattern' => '<string>'
]
]
]),
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://app.altheastudio.ai/api/sip"
payload := strings.NewReader("{\n \"allowedCidrRanges\": [\n \"<string>\"\n ],\n \"allowAllAgents\": false,\n \"allowedAgents\": [\n {\n \"agentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"toUserPattern\": \"<string>\"\n }\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://app.altheastudio.ai/api/sip")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"allowedCidrRanges\": [\n \"<string>\"\n ],\n \"allowAllAgents\": false,\n \"allowedAgents\": [\n {\n \"agentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"toUserPattern\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.altheastudio.ai/api/sip")
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 \"allowedCidrRanges\": [\n \"<string>\"\n ],\n \"allowAllAgents\": false,\n \"allowedAgents\": [\n {\n \"agentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"toUserPattern\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"allowedAgents": [
{
"agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"toUserPattern": "<string>"
}
],
"domain": "<string>",
"allowedCidrRanges": [
"<string>"
],
"allowAllAgents": false
}SIP Configuration
Update Account SIP configuration
Allows updating your account’s SIP configuration
PATCH
/
api
/
sip
cURL
curl --request PATCH \
--url https://app.altheastudio.ai/api/sip \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"allowedCidrRanges": [
"<string>"
],
"allowAllAgents": false,
"allowedAgents": [
{
"agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"toUserPattern": "<string>"
}
]
}
'import requests
url = "https://app.altheastudio.ai/api/sip"
payload = {
"allowedCidrRanges": ["<string>"],
"allowAllAgents": False,
"allowedAgents": [
{
"agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"toUserPattern": "<string>"
}
]
}
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({
allowedCidrRanges: ['<string>'],
allowAllAgents: false,
allowedAgents: [{agentId: '3c90c3cc-0d44-4b50-8888-8dd25736052a', toUserPattern: '<string>'}]
})
};
fetch('https://app.altheastudio.ai/api/sip', 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://app.altheastudio.ai/api/sip",
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([
'allowedCidrRanges' => [
'<string>'
],
'allowAllAgents' => false,
'allowedAgents' => [
[
'agentId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'toUserPattern' => '<string>'
]
]
]),
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://app.altheastudio.ai/api/sip"
payload := strings.NewReader("{\n \"allowedCidrRanges\": [\n \"<string>\"\n ],\n \"allowAllAgents\": false,\n \"allowedAgents\": [\n {\n \"agentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"toUserPattern\": \"<string>\"\n }\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://app.altheastudio.ai/api/sip")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"allowedCidrRanges\": [\n \"<string>\"\n ],\n \"allowAllAgents\": false,\n \"allowedAgents\": [\n {\n \"agentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"toUserPattern\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.altheastudio.ai/api/sip")
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 \"allowedCidrRanges\": [\n \"<string>\"\n ],\n \"allowAllAgents\": false,\n \"allowedAgents\": [\n {\n \"agentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"toUserPattern\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"allowedAgents": [
{
"agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"toUserPattern": "<string>"
}
],
"domain": "<string>",
"allowedCidrRanges": [
"<string>"
],
"allowAllAgents": false
}Authorizations
API key
Body
application/json
The list of IPv4 CIDR ranges from which incoming SIP calls will be accepted.
If true, adds an implicit allowance for requests matching agent_<agent_id>@ for any of your agents.
Calls must match a pattern for one of these agents (or the global agent pattern if allowAllAgents is true) to be accepted.
Maximum array length:
20Show child attributes
Show child attributes
Response
200 - application/json
Calls must match a pattern for one of these agents (or the global agent pattern if allowAllAgents is true) to be accepted.
Maximum array length:
20Show child attributes
Show child attributes
The domain used for SIP invites for your account.
The list of IPv4 CIDR ranges from which incoming SIP calls will be accepted.
If true, adds an implicit allowance for requests matching agent_<agent_id>@ for any of your agents.
⌘I