Create a department voicemail box
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/voice/voicemail-boxes/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"label": "<string>",
"members": [
"<string>"
],
"retention_days": 1278
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/voice/voicemail-boxes/"
payload = {
"name": "<string>",
"label": "<string>",
"members": ["<string>"],
"retention_days": 1278
}
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>',
label: '<string>',
members: ['<string>'],
retention_days: 1278
})
};
fetch('https://api.orbit.devotel.io/api/v1/voice/voicemail-boxes/', 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/voicemail-boxes/",
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>',
'label' => '<string>',
'members' => [
'<string>'
],
'retention_days' => 1278
]),
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/voicemail-boxes/"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"label\": \"<string>\",\n \"members\": [\n \"<string>\"\n ],\n \"retention_days\": 1278\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/voicemail-boxes/")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"label\": \"<string>\",\n \"members\": [\n \"<string>\"\n ],\n \"retention_days\": 1278\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/voice/voicemail-boxes/")
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 \"label\": \"<string>\",\n \"members\": [\n \"<string>\"\n ],\n \"retention_days\": 1278\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"organization_id": "<string>",
"name": "<string>",
"label": "<string>",
"members": [
"<string>"
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"inbound_route_id": "<string>",
"retention_days": 1278
}
}Voice
Create a department voicemail box
Creates a new department voicemail box scoped to the caller’s organization. name MUST be unique within the org and is slug-shaped. Every members[*] id is validated against the org’s user roster — leaked ids from other tenants are rejected with 422. Returns 201 with the created row.
POST
/
api
/
v1
/
voice
/
voicemail-boxes
/
Create a department voicemail box
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/voice/voicemail-boxes/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"label": "<string>",
"members": [
"<string>"
],
"retention_days": 1278
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/voice/voicemail-boxes/"
payload = {
"name": "<string>",
"label": "<string>",
"members": ["<string>"],
"retention_days": 1278
}
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>',
label: '<string>',
members: ['<string>'],
retention_days: 1278
})
};
fetch('https://api.orbit.devotel.io/api/v1/voice/voicemail-boxes/', 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/voicemail-boxes/",
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>',
'label' => '<string>',
'members' => [
'<string>'
],
'retention_days' => 1278
]),
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/voicemail-boxes/"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"label\": \"<string>\",\n \"members\": [\n \"<string>\"\n ],\n \"retention_days\": 1278\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/voicemail-boxes/")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"label\": \"<string>\",\n \"members\": [\n \"<string>\"\n ],\n \"retention_days\": 1278\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/voice/voicemail-boxes/")
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 \"label\": \"<string>\",\n \"members\": [\n \"<string>\"\n ],\n \"retention_days\": 1278\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"organization_id": "<string>",
"name": "<string>",
"label": "<string>",
"members": [
"<string>"
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"inbound_route_id": "<string>",
"retention_days": 1278
}
}Authorizations
BearerApiKey
Dashboard JWT token from Clerk
Body
application/json
Slug-shape name; UNIQUE within the org.
Required string length:
1 - 64Pattern:
^[a-z0-9][a-z0-9_-]*$Required string length:
1 - 120Initial roster of subscribed user ids (max 50).
Maximum array length:
50Minimum string length:
1Required range:
1 <= x <= 2555Response
201 - application/json
Default Response
Show child attributes
Show child attributes
⌘I