curl --request POST \
--url https://app.famulor.io/api/v1/carrier-connections \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"carrier": "vonage",
"name": "My Vonage account",
"api_key": "1a2345b7",
"api_secret": "secret",
"sip_region": "eu"
}
'import requests
url = "https://app.famulor.io/api/v1/carrier-connections"
payload = {
"carrier": "vonage",
"name": "My Vonage account",
"api_key": "1a2345b7",
"api_secret": "secret",
"sip_region": "eu"
}
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({
carrier: 'vonage',
name: 'My Vonage account',
api_key: '1a2345b7',
api_secret: 'secret',
sip_region: 'eu'
})
};
fetch('https://app.famulor.io/api/v1/carrier-connections', 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.famulor.io/api/v1/carrier-connections",
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([
'carrier' => 'vonage',
'name' => 'My Vonage account',
'api_key' => '1a2345b7',
'api_secret' => 'secret',
'sip_region' => 'eu'
]),
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 := "https://app.famulor.io/api/v1/carrier-connections"
payload := strings.NewReader("{\n \"carrier\": \"vonage\",\n \"name\": \"My Vonage account\",\n \"api_key\": \"1a2345b7\",\n \"api_secret\": \"secret\",\n \"sip_region\": \"eu\"\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("https://app.famulor.io/api/v1/carrier-connections")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"carrier\": \"vonage\",\n \"name\": \"My Vonage account\",\n \"api_key\": \"1a2345b7\",\n \"api_secret\": \"secret\",\n \"sip_region\": \"eu\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.famulor.io/api/v1/carrier-connections")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"carrier\": \"vonage\",\n \"name\": \"My Vonage account\",\n \"api_key\": \"1a2345b7\",\n \"api_secret\": \"secret\",\n \"sip_region\": \"eu\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"credentials_hint": "<string>",
"sip_region": "global",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"numbers": [
{
"phone_number_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sip_trunk_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"number": "<string>",
"status": "<string>",
"assistant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"outbound_address": "<string>",
"last_error": "<string>",
"last_checked_at": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "invalid_request",
"message": "\"to_number\" is required (E.164 format, e.g. +4930123456)."
}
}{
"error": {
"code": "unauthorized",
"message": "Invalid API key."
}
}{
"error": {
"code": "forbidden",
"message": "This API key is missing the required scope \"assistants:write\"."
}
}Create a carrier connection
Validates carrier credentials and stores secrets encrypted. Provider routing is configured on the first number import. Required scope: sip_trunks:write.
curl --request POST \
--url https://app.famulor.io/api/v1/carrier-connections \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"carrier": "vonage",
"name": "My Vonage account",
"api_key": "1a2345b7",
"api_secret": "secret",
"sip_region": "eu"
}
'import requests
url = "https://app.famulor.io/api/v1/carrier-connections"
payload = {
"carrier": "vonage",
"name": "My Vonage account",
"api_key": "1a2345b7",
"api_secret": "secret",
"sip_region": "eu"
}
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({
carrier: 'vonage',
name: 'My Vonage account',
api_key: '1a2345b7',
api_secret: 'secret',
sip_region: 'eu'
})
};
fetch('https://app.famulor.io/api/v1/carrier-connections', 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.famulor.io/api/v1/carrier-connections",
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([
'carrier' => 'vonage',
'name' => 'My Vonage account',
'api_key' => '1a2345b7',
'api_secret' => 'secret',
'sip_region' => 'eu'
]),
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 := "https://app.famulor.io/api/v1/carrier-connections"
payload := strings.NewReader("{\n \"carrier\": \"vonage\",\n \"name\": \"My Vonage account\",\n \"api_key\": \"1a2345b7\",\n \"api_secret\": \"secret\",\n \"sip_region\": \"eu\"\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("https://app.famulor.io/api/v1/carrier-connections")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"carrier\": \"vonage\",\n \"name\": \"My Vonage account\",\n \"api_key\": \"1a2345b7\",\n \"api_secret\": \"secret\",\n \"sip_region\": \"eu\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.famulor.io/api/v1/carrier-connections")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"carrier\": \"vonage\",\n \"name\": \"My Vonage account\",\n \"api_key\": \"1a2345b7\",\n \"api_secret\": \"secret\",\n \"sip_region\": \"eu\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"credentials_hint": "<string>",
"sip_region": "global",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"numbers": [
{
"phone_number_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sip_trunk_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"number": "<string>",
"status": "<string>",
"assistant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"outbound_address": "<string>",
"last_error": "<string>",
"last_checked_at": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "invalid_request",
"message": "\"to_number\" is required (E.164 format, e.g. +4930123456)."
}
}{
"error": {
"code": "unauthorized",
"message": "Invalid API key."
}
}{
"error": {
"code": "forbidden",
"message": "This API key is missing the required scope \"assistants:write\"."
}
}Authorizations
API key (fam_..., created under Settings → API Keys) or an OAuth 2.0 access token (fam_at_...). Keys can be restricted to scopes such as assistants:read, calls:write, campaigns:write, automations:read, dashboards:read, dashboards:write, leads:write, segments:write, phone_numbers:write, sip_trunks:write, knowledge:write, voices:read, billing:read, settings:write, platform:read, platform:write; a *:write scope implies the matching *:read. Automation and dashboard endpoints also accept the legacy calls:* scope. Keys without scope restrictions have full access.
Body
twilio, telnyx, vonage 1 - 80Required for Twilio.
Required for Twilio; stored encrypted.
Required for Telnyx and Vonage. Telnyx keys start with KEY.
Required for Vonage; stored encrypted.
global, eu, us, uk, india, japan, aus, sa Response
Created connection.
Show child attributes
Show child attributes