curl --request POST \
--url https://api.orbit.devotel.io/api/v1/voice/queues/{id}/members \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"agentUserId": "agent_0199a2c4",
"priority": 10,
"skills": [
"billing"
],
"skillLevels": {
"billing": 3
},
"state": "offline"
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/voice/queues/{id}/members"
payload = {
"agentUserId": "agent_0199a2c4",
"priority": 10,
"skills": ["billing"],
"skillLevels": { "billing": 3 },
"state": "offline"
}
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({
agentUserId: 'agent_0199a2c4',
priority: 10,
skills: ['billing'],
skillLevels: {billing: 3},
state: 'offline'
})
};
fetch('https://api.orbit.devotel.io/api/v1/voice/queues/{id}/members', 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.orbit.devotel.io/api/v1/voice/queues/{id}/members",
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([
'agentUserId' => 'agent_0199a2c4',
'priority' => 10,
'skills' => [
'billing'
],
'skillLevels' => [
'billing' => 3
],
'state' => 'offline'
]),
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://api.orbit.devotel.io/api/v1/voice/queues/{id}/members"
payload := strings.NewReader("{\n \"agentUserId\": \"agent_0199a2c4\",\n \"priority\": 10,\n \"skills\": [\n \"billing\"\n ],\n \"skillLevels\": {\n \"billing\": 3\n },\n \"state\": \"offline\"\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://api.orbit.devotel.io/api/v1/voice/queues/{id}/members")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"agentUserId\": \"agent_0199a2c4\",\n \"priority\": 10,\n \"skills\": [\n \"billing\"\n ],\n \"skillLevels\": {\n \"billing\": 3\n },\n \"state\": \"offline\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/voice/queues/{id}/members")
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 \"agentUserId\": \"agent_0199a2c4\",\n \"priority\": 10,\n \"skills\": [\n \"billing\"\n ],\n \"skillLevels\": {\n \"billing\": 3\n },\n \"state\": \"offline\"\n}"
response = http.request(request)
puts response.read_body{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "RATE_LIMITED",
"message": "<string>",
"status": 429,
"retry_after": 2
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{}Assign an agent to a queue
Adds an agent to this queue’s membership so the ACD matcher can offer it calls. priority orders the agent’s queues (lower wins); skills and skillLevels participate in skill-based routing and proficiency weighting. The member starts in state (default offline) and goes live through the agent status surface. Requires owner/admin.
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/voice/queues/{id}/members \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"agentUserId": "agent_0199a2c4",
"priority": 10,
"skills": [
"billing"
],
"skillLevels": {
"billing": 3
},
"state": "offline"
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/voice/queues/{id}/members"
payload = {
"agentUserId": "agent_0199a2c4",
"priority": 10,
"skills": ["billing"],
"skillLevels": { "billing": 3 },
"state": "offline"
}
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({
agentUserId: 'agent_0199a2c4',
priority: 10,
skills: ['billing'],
skillLevels: {billing: 3},
state: 'offline'
})
};
fetch('https://api.orbit.devotel.io/api/v1/voice/queues/{id}/members', 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.orbit.devotel.io/api/v1/voice/queues/{id}/members",
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([
'agentUserId' => 'agent_0199a2c4',
'priority' => 10,
'skills' => [
'billing'
],
'skillLevels' => [
'billing' => 3
],
'state' => 'offline'
]),
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://api.orbit.devotel.io/api/v1/voice/queues/{id}/members"
payload := strings.NewReader("{\n \"agentUserId\": \"agent_0199a2c4\",\n \"priority\": 10,\n \"skills\": [\n \"billing\"\n ],\n \"skillLevels\": {\n \"billing\": 3\n },\n \"state\": \"offline\"\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://api.orbit.devotel.io/api/v1/voice/queues/{id}/members")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"agentUserId\": \"agent_0199a2c4\",\n \"priority\": 10,\n \"skills\": [\n \"billing\"\n ],\n \"skillLevels\": {\n \"billing\": 3\n },\n \"state\": \"offline\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/voice/queues/{id}/members")
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 \"agentUserId\": \"agent_0199a2c4\",\n \"priority\": 10,\n \"skills\": [\n \"billing\"\n ],\n \"skillLevels\": {\n \"billing\": 3\n },\n \"state\": \"offline\"\n}"
response = http.request(request)
puts response.read_body{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "RATE_LIMITED",
"message": "<string>",
"status": 429,
"retry_after": 2
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{}Authorizations
Dashboard JWT token from Clerk
Headers
Stripe-style idempotency token. Pass a stable, client-generated value (1-255 chars) to dedupe retries on transient timeouts. The same key+credential+path replays the original response for 24h on 2xx (5min on 4xx, 30s on 5xx). Returns 409 if a concurrent request with the same key is already in flight; replayed responses include the Idempotency-Replay: true response header.
1 - 255Sandbox opt-in for Clerk-session-authenticated requests — see Test mode explained for the full credential-header matrix and worked samples. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.
true, false Path Parameters
Queue identifier (queue_<hex>).
1Body
Agent identifier: either the member user UUID or a platform agent_<hex> id.
1 - 128Dispatch preference within the queue; lower wins (1 dispatches ahead of 100).
1 <= x <= 1000Skill tags intersected with the queue's skills at dispatch; empty means any skill.
641 - 64Skill-to-proficiency map (1-5); skills not listed default to 1.
Show child attributes
Show child attributes
Initial member state; typically left offline until the agent logs in.
available, busy, wrapup, offline, paused Response
Standard error envelope. error.code is machine-readable; see the error reference for the catalogue.