Skip to main content
POST
/
v2
/
admin
/
extensions
/
sip
/
Create SIP Extension
curl --request POST \
  --url https://api.voxo.co/v2/admin/extensions/sip/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "tenantId": 123,
  "number": "<string>",
  "name": "<string>",
  "emergencyLocationId": 123,
  "callLimit": 123
}
'
{
  "id": 123,
  "tenant": {
    "id": 123,
    "name": "<string>"
  },
  "name": "<string>",
  "number": "<string>",
  "email": "<string>",
  "peerName": "<string>",
  "callerIdNumber": "<string>",
  "recording": "<string>",
  "trunk": "<string>",
  "trunkHost": "<string>",
  "trunkCallerIdSource": "<string>",
  "trunkEmergencyCallerIdOverride": "<string>",
  "callLimit": 123,
  "dialTimeout": 123,
  "routingProfileId": 123,
  "musicOnHoldId": 123,
  "emergencyLocationId": 123,
  "outboundDialPrefix": "<string>",
  "includeInDialByName": "<string>",
  "includeInPhonebook": "<string>",
  "emergencyLocationComment": "<string>",
  "branch": {
    "id": 123,
    "name": "<string>"
  },
  "emergencyLocation": {
    "id": 123,
    "address": "<unknown>"
  },
  "musicOnHold": {
    "id": 123,
    "name": "<string>"
  },
  "routingProfile": {
    "id": 123,
    "name": "<string>",
    "type": "<string>"
  }
}

Authorizations

Authorization
string
header
required

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

Body

application/json
tenantId
number
required
number
string
required
Required string length: 2 - 10
Pattern: ^\d+$
name
string
required
Minimum string length: 3
emergencyLocationId
number
required
authMethod
enum<string>
required
Available options:
NORMAL,
IP
callLimit
number
required
trunkCallerIdSource
enum<string>
required
Available options:
PAI,
RPID,
FROM
emergencyLocation
string | null
branchId
number
publicIp
string<ipv4>
Pattern: ^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])\.){3}(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])$
callerIdNumber
string
Pattern: ^[1-9]\d{9}$

Response

Created SIP extension

id
number
required

Extension ID

tenant
object
required

Owning tenant

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

callerIdNumber
string | null
required

Outbound caller ID number

recording
string | null
required

Call recording mode

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

dialTimeout
number | null
required

Inbound ring timeout (seconds)

routingProfileId
number | null
required

Routing profile ID

musicOnHoldId
number | null
required

Music on hold ID

emergencyLocationId
number | null
required

Emergency location ID

outboundDialPrefix
string | null
required

Outbound dial prefix

includeInDialByName
string | null
required

Dial-by-name inclusion

includeInPhonebook
string | null
required

Phonebook inclusion

emergencyLocationComment
string | null
required

Free-text emergency location comment

branch
object
required

Branch)

emergencyLocation
object
required

Emergency location

musicOnHold
object
required

Music on hold

routingProfile
object
required

Routing profile