curl --request POST \
--url https://app.famulor.io/api/v1/loop/ring-groups \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"ring_timeout_seconds": 62,
"presence_required": true,
"active": true,
"member_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"members": [
{
"membership_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"delay_seconds": 60
}
]
}
'import requests
url = "https://app.famulor.io/api/v1/loop/ring-groups"
payload = {
"name": "<string>",
"ring_timeout_seconds": 62,
"presence_required": True,
"active": True,
"member_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"members": [
{
"membership_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"delay_seconds": 60
}
]
}
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({
name: '<string>',
ring_timeout_seconds: 62,
presence_required: true,
active: true,
member_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
members: [{membership_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a', delay_seconds: 60}]
})
};
fetch('https://app.famulor.io/api/v1/loop/ring-groups', 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/loop/ring-groups",
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([
'name' => '<string>',
'ring_timeout_seconds' => 62,
'presence_required' => true,
'active' => true,
'member_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'members' => [
[
'membership_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'delay_seconds' => 60
]
]
]),
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/loop/ring-groups"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"ring_timeout_seconds\": 62,\n \"presence_required\": true,\n \"active\": true,\n \"member_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"members\": [\n {\n \"membership_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"delay_seconds\": 60\n }\n ]\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/loop/ring-groups")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"ring_timeout_seconds\": 62,\n \"presence_required\": true,\n \"active\": true,\n \"member_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"members\": [\n {\n \"membership_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"delay_seconds\": 60\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.famulor.io/api/v1/loop/ring-groups")
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 \"name\": \"<string>\",\n \"ring_timeout_seconds\": 62,\n \"presence_required\": true,\n \"active\": true,\n \"member_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"members\": [\n {\n \"membership_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"delay_seconds\": 60\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"strategy": "simultaneous",
"ring_timeout_seconds": 123,
"presence_required": true,
"active": true,
"members": [
{
"membership_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"position": 1,
"delay_seconds": 1
}
]
}
}{
"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\"."
}
}{
"error": {
"code": "conflict",
"message": "Campaign is not running."
}
}Create a Loop ring group
Creates a Loop ring group. Requires loop:write and a workspace owner or admin credential.
curl --request POST \
--url https://app.famulor.io/api/v1/loop/ring-groups \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"ring_timeout_seconds": 62,
"presence_required": true,
"active": true,
"member_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"members": [
{
"membership_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"delay_seconds": 60
}
]
}
'import requests
url = "https://app.famulor.io/api/v1/loop/ring-groups"
payload = {
"name": "<string>",
"ring_timeout_seconds": 62,
"presence_required": True,
"active": True,
"member_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"members": [
{
"membership_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"delay_seconds": 60
}
]
}
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({
name: '<string>',
ring_timeout_seconds: 62,
presence_required: true,
active: true,
member_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
members: [{membership_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a', delay_seconds: 60}]
})
};
fetch('https://app.famulor.io/api/v1/loop/ring-groups', 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/loop/ring-groups",
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([
'name' => '<string>',
'ring_timeout_seconds' => 62,
'presence_required' => true,
'active' => true,
'member_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'members' => [
[
'membership_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'delay_seconds' => 60
]
]
]),
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/loop/ring-groups"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"ring_timeout_seconds\": 62,\n \"presence_required\": true,\n \"active\": true,\n \"member_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"members\": [\n {\n \"membership_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"delay_seconds\": 60\n }\n ]\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/loop/ring-groups")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"ring_timeout_seconds\": 62,\n \"presence_required\": true,\n \"active\": true,\n \"member_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"members\": [\n {\n \"membership_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"delay_seconds\": 60\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.famulor.io/api/v1/loop/ring-groups")
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 \"name\": \"<string>\",\n \"ring_timeout_seconds\": 62,\n \"presence_required\": true,\n \"active\": true,\n \"member_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"members\": [\n {\n \"membership_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"delay_seconds\": 60\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"strategy": "simultaneous",
"ring_timeout_seconds": 123,
"presence_required": true,
"active": true,
"members": [
{
"membership_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"position": 1,
"delay_seconds": 1
}
]
}
}{
"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\"."
}
}{
"error": {
"code": "conflict",
"message": "Campaign is not running."
}
}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, loop:read, loop: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
1 - 120simultaneous, sequential, round_robin 5 <= x <= 120Legacy member list. Use members for ordered delay settings.
100Members in ringing order with an optional pre-ring delay.
100Show child attributes
Show child attributes
Response
Created ring group.
Show child attributes
Show child attributes