Create a routing group
curl --request POST \
--url https://core-api.getaptly.com/api/routing-groups/create \
--header 'Content-Type: application/json' \
--header 'x-token: <api-key>' \
--data '
{
"name": "Support Queue",
"type": "simultaneous",
"destination": {
"ringType": "multi",
"ringToList": []
},
"ringDurationSeconds": 20,
"callerExperience": {
"mode": "ring"
}
}
'import requests
url = "https://core-api.getaptly.com/api/routing-groups/create"
payload = {
"name": "Support Queue",
"type": "simultaneous",
"destination": {
"ringType": "multi",
"ringToList": []
},
"ringDurationSeconds": 20,
"callerExperience": { "mode": "ring" }
}
headers = {
"x-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Support Queue',
type: 'simultaneous',
destination: {ringType: 'multi', ringToList: []},
ringDurationSeconds: 20,
callerExperience: {mode: 'ring'}
})
};
fetch('https://core-api.getaptly.com/api/routing-groups/create', 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://core-api.getaptly.com/api/routing-groups/create",
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' => 'Support Queue',
'type' => 'simultaneous',
'destination' => [
'ringType' => 'multi',
'ringToList' => [
]
],
'ringDurationSeconds' => 20,
'callerExperience' => [
'mode' => 'ring'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-token: <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://core-api.getaptly.com/api/routing-groups/create"
payload := strings.NewReader("{\n \"name\": \"Support Queue\",\n \"type\": \"simultaneous\",\n \"destination\": {\n \"ringType\": \"multi\",\n \"ringToList\": []\n },\n \"ringDurationSeconds\": 20,\n \"callerExperience\": {\n \"mode\": \"ring\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-token", "<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.post("https://core-api.getaptly.com/api/routing-groups/create")
.header("x-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Support Queue\",\n \"type\": \"simultaneous\",\n \"destination\": {\n \"ringType\": \"multi\",\n \"ringToList\": []\n },\n \"ringDurationSeconds\": 20,\n \"callerExperience\": {\n \"mode\": \"ring\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://core-api.getaptly.com/api/routing-groups/create")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Support Queue\",\n \"type\": \"simultaneous\",\n \"destination\": {\n \"ringType\": \"multi\",\n \"ringToList\": []\n },\n \"ringDurationSeconds\": 20,\n \"callerExperience\": {\n \"mode\": \"ring\"\n }\n}"
response = http.request(request)
puts response.read_body{
"_id": "<string>"
}{
"error": "<string>",
"message": "<string>"
}RoutingGroups
Create a routing group
Creates a new routing group for the authenticated company. Returns the new group’s ID.
POST
/
api
/
routing-groups
/
create
Create a routing group
curl --request POST \
--url https://core-api.getaptly.com/api/routing-groups/create \
--header 'Content-Type: application/json' \
--header 'x-token: <api-key>' \
--data '
{
"name": "Support Queue",
"type": "simultaneous",
"destination": {
"ringType": "multi",
"ringToList": []
},
"ringDurationSeconds": 20,
"callerExperience": {
"mode": "ring"
}
}
'import requests
url = "https://core-api.getaptly.com/api/routing-groups/create"
payload = {
"name": "Support Queue",
"type": "simultaneous",
"destination": {
"ringType": "multi",
"ringToList": []
},
"ringDurationSeconds": 20,
"callerExperience": { "mode": "ring" }
}
headers = {
"x-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Support Queue',
type: 'simultaneous',
destination: {ringType: 'multi', ringToList: []},
ringDurationSeconds: 20,
callerExperience: {mode: 'ring'}
})
};
fetch('https://core-api.getaptly.com/api/routing-groups/create', 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://core-api.getaptly.com/api/routing-groups/create",
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' => 'Support Queue',
'type' => 'simultaneous',
'destination' => [
'ringType' => 'multi',
'ringToList' => [
]
],
'ringDurationSeconds' => 20,
'callerExperience' => [
'mode' => 'ring'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-token: <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://core-api.getaptly.com/api/routing-groups/create"
payload := strings.NewReader("{\n \"name\": \"Support Queue\",\n \"type\": \"simultaneous\",\n \"destination\": {\n \"ringType\": \"multi\",\n \"ringToList\": []\n },\n \"ringDurationSeconds\": 20,\n \"callerExperience\": {\n \"mode\": \"ring\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-token", "<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.post("https://core-api.getaptly.com/api/routing-groups/create")
.header("x-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Support Queue\",\n \"type\": \"simultaneous\",\n \"destination\": {\n \"ringType\": \"multi\",\n \"ringToList\": []\n },\n \"ringDurationSeconds\": 20,\n \"callerExperience\": {\n \"mode\": \"ring\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://core-api.getaptly.com/api/routing-groups/create")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Support Queue\",\n \"type\": \"simultaneous\",\n \"destination\": {\n \"ringType\": \"multi\",\n \"ringToList\": []\n },\n \"ringDurationSeconds\": 20,\n \"callerExperience\": {\n \"mode\": \"ring\"\n }\n}"
response = http.request(request)
puts response.read_body{
"_id": "<string>"
}{
"error": "<string>",
"message": "<string>"
}Authorizations
ApiKeyHeaderDelegateToken
Body
application/json
Display name for the routing group.
Ring mode. simultaneous rings all members at once; sequential tries each in order.
Available options:
simultaneous, sequential Ring target configuration. Supports ringType of user, phone, browser, agent, or multi.
How long (in seconds) to ring each target before moving on. Defaults to 20.
Caller-side experience config. Set mode to ring (default) or hold-music.
Maximum time (in seconds) a caller will wait before overflow handling triggers.
Overflow/voicemail config. Supports greetingText and voicemailNotification (array of emails).
Response
Routing group created.
ID of the created routing group.
⌘I