Skip to main content
GET
/
v2
/
admin
/
extensions
/
{id}
Get Extension Profile
curl --request GET \
  --url https://api.voxo.co/v2/admin/extensions/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": 123,
  "tenantId": 123,
  "userId": 123,
  "name": "<string>",
  "number": "<string>",
  "peerName": "<string>",
  "dnd": "<string>",
  "callerIdNumber": "<string>",
  "enableMeet": 123,
  "enableTranscription": 123,
  "type": "<string>",
  "trunk": "<string>",
  "trunkHost": "<string>",
  "trunkCallerIdSource": "<string>",
  "trunkEmergencyCallerIdOverride": "<string>",
  "callLimit": 123,
  "mailboxAddress": "<string>",
  "includeInDialByName": "<string>",
  "includeInPhonebook": "<string>",
  "recording": "<string>",
  "recordingEmail": "<string>",
  "dialTimeout": 123,
  "outboundDialPrefix": "<string>",
  "emergencyLocationComment": "<string>",
  "enableDirectFax": 123,
  "enableForwarding": "<string>",
  "efaxUser": {
    "id": 123,
    "name": "<string>",
    "email": "<string>",
    "callerIdNumber": "<string>"
  },
  "branch": {
    "id": 123,
    "name": "<string>"
  },
  "user": {
    "id": 123,
    "email": "<string>"
  },
  "emergencyLocation": {
    "id": 123,
    "address": "<unknown>"
  },
  "musicOnHold": {
    "id": 123,
    "name": "<string>"
  },
  "routingProfile": {
    "id": 123,
    "name": "<string>",
    "type": "<string>"
  },
  "devices": [],
  "noAnswerDestinations": [],
  "busyDestinations": [],
  "offlineDestinations": [],
  "forwardingDestinations": []
}

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*$

Response

Extension profile

id
number
required

Extension ID

tenantId
number
required

Tenant ID

userId
number | null
required

Linked user ID

name
string | null
required

Extension name

number
string | null
required

Extension number

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)

type
string | null
required

Extension type (routing profile type)

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

mailboxAddress
string | null
required

Mailbox address

includeInDialByName
string | null
required

Dial-by-name inclusion

includeInPhonebook
string | null
required

Phonebook inclusion

recording
string | null
required

Call recording mode

recordingEmail
string | null
required

Recording delivery email

dialTimeout
number | null
required

Inbound ring timeout (seconds)

outboundDialPrefix
string | null
required

Outbound dial prefix

emergencyLocationComment
string | null
required

Free-text emergency location comment

enableDirectFax
number
required

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

enableForwarding
string | null
required

Forwarding state

efaxUser
object
required

eFax user mapping

branch
object
required

Branch (self-healed to the tenant default)

user
object
required

Linked user

emergencyLocation
object
required

Emergency location

musicOnHold
object
required

Music on hold (self-healed to the tenant default, if any)

routingProfile
object
required

Routing profile (self-healed to id 0)

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