Skip to main content
PATCH
/
v2
/
admin
/
extensions
/
voice
/
{id}
Edit Voice Extension
curl --request PATCH \
  --url https://api.voxo.co/v2/admin/extensions/voice/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'
import requests

url = "https://api.voxo.co/v2/admin/extensions/voice/{id}"

payload = {}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({})
};

fetch('https://api.voxo.co/v2/admin/extensions/voice/{id}', 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.voxo.co/v2/admin/extensions/voice/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([

]),
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.voxo.co/v2/admin/extensions/voice/{id}"

payload := strings.NewReader("{}")

req, _ := http.NewRequest("PATCH", 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.patch("https://api.voxo.co/v2/admin/extensions/voice/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.voxo.co/v2/admin/extensions/voice/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body
{
  "id": 123,
  "name": "<string>",
  "number": "<string>",
  "email": "<string>",
  "peerName": "<string>",
  "dnd": "<string>",
  "callerIdNumber": "<string>",
  "enableMeet": 123,
  "enableTranscription": 123,
  "trunk": "<string>",
  "trunkHost": "<string>",
  "trunkCallerIdSource": "<string>",
  "trunkEmergencyCallerIdOverride": "<string>",
  "callLimit": 123,
  "mailbox": "<string>",
  "recording": "<string>",
  "dialTimeout": 123,
  "outboundDialPrefix": "<string>",
  "enableDirectFax": 123,
  "recordingEmail": "<string>",
  "includeInDialByName": "<string>",
  "includeInPhonebook": "<string>",
  "enableForwarding": "<string>",
  "emergencyLocationComment": "<string>",
  "tenant": {
    "id": 123,
    "name": "<string>"
  },
  "branch": {
    "id": 123,
    "name": "<string>"
  },
  "routingProfile": {
    "id": 123,
    "name": "<string>",
    "type": "<string>"
  },
  "musicOnHold": {
    "id": 123,
    "name": "<string>"
  },
  "user": {
    "id": 123,
    "email": "<string>"
  },
  "efaxUser": {
    "id": 123,
    "name": "<string>",
    "email": "<string>",
    "callerIdNumber": "<string>"
  },
  "emergencyLocation": {
    "id": 123,
    "address": "<unknown>"
  },
  "devices": [],
  "noAnswerDestinations": [],
  "busyDestinations": [],
  "offlineDestinations": [],
  "forwardingDestinations": []
}
{
"name": "<string>",
"message": "<string>",
"code": 123,
"validationErrors": [
"<string>"
]
}
{
"name": "<string>",
"message": "<string>",
"code": 123,
"validationErrors": [
"<string>"
]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Extension ID

Pattern: ^[1-9]\d*$

Body

application/json
name
string
Minimum string length: 3
email
Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
emergencyLocationId
number
emergencyLocation
string | null
recording
enum<string>
Available options:
yeschange,
no,
nochange
recordingEmail
Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
callerIdNumber
string | null
Pattern: ^[1-9]\d{9}$
branchId
number
enableMeet
number
Required range: 0 <= x <= 1
enableTranscription
number
Required range: 0 <= x <= 1
musicOnHoldId
number
routingProfileId
number
dialTimeout
number
Required range: x <= 180Must be a multiple of 5
outboundDialPrefix
Pattern: ^[1-9][0-9]{6}$
sendInvite
number
Required range: 0 <= x <= 1
enableVoicemailIndicator
number
Required range: 0 <= x <= 1
dnd
boolean
enableDirectFax
number
Required range: 0 <= x <= 1
faxCallerIdNumber
string | null
Pattern: ^[1-9]\d{9}$
enableForwarding
boolean
forwardingDestinations
object[]
busyDestinations
object[]
offlineDestinations
object[]
noAnswerDestinations
object[]
deviceId
number

Response

Updated voice extension

id
number
required

Extension ID

name
string | null
required

Extension name

number
string | null
required

Extension number

email
string | null
required

Extension email

peerName
string | null
required

SIP peer name

dnd
string | null
required

Do not disturb state

callerIdNumber
string | null
required

Outbound caller ID number

enableMeet
number
required

Meet enabled (1 = yes, 0 = no)

enableTranscription
number
required

Transcription enabled (1 = yes, 0 = no)

trunk
string | null
required

Trunk state

trunkHost
string | null
required

Trunk host

trunkCallerIdSource
string | null
required

Trunk caller ID source

trunkEmergencyCallerIdOverride
string | null
required

Trunk emergency caller ID override

callLimit
number | null
required

Concurrent call limit

mailbox
string | null
required

Mailbox address

recording
string | null
required

Call recording mode

dialTimeout
number | null
required

Inbound ring timeout (seconds)

outboundDialPrefix
string | null
required

Outbound dial prefix

enableDirectFax
number
required

Direct fax enabled (1 = yes, 0 = no)

recordingEmail
string | null
required

Recording delivery email

includeInDialByName
string | null
required

Dial-by-name inclusion

includeInPhonebook
string | null
required

Phonebook inclusion

enableForwarding
string | null
required

Forwarding state

emergencyLocationComment
string | null
required

Free-text emergency location comment

tenant
object
required

Owning tenant

branch
object
required

Branch

routingProfile
object
required

Routing profile

musicOnHold
object | null
required

Music on hold

user
object | null
required

Linked user

efaxUser
object | null
required

eFax user mapping

emergencyLocation
object | null
required

Emergency location

devices
object[]
required

Assigned devices

noAnswerDestinations
object[]
required

No-answer routing

busyDestinations
object[]
required

Busy routing

offlineDestinations
object[]
required

Offline routing

forwardingDestinations
object[]
required

Unconditional forwarding