API Reference
Start typing to search…

Update Device for User

put
https://{server}/ns-api/v2/domains//users//devices/
Path Params
string
required
length ≤ 64
Defaults to ~

This is the main organization name. This is used to link resource to its group/tenant/organization/enterprise. Then using in path for GET you can set to "~" to use the domain name linked to your token/key instead of the domain name itself when reading for your own domain.

string
required
length between 0 and 16
Defaults to ~

This is the main user extension for the user account. ~ can be used to mean "my account" which will extract the user from the token/key used for authentication.

string
required
Body Params
password

This is the password which would be used for device registration. If left unset on device create it will create a new random password with a default length of 16 characters.

string
Defaults to [*]

This is a override value for emergency caller id value that would be specific to this device and would override the user's set value.

string
enum
Defaults to no

This will enable IP checking. Default is no

Allowed:
string
enum
Defaults to no

This will enable IP checking. Default is no

Allowed:
string
enum
Defaults to yes

This allows any added configurations to specify a hostname. Default to "yes"

Allowed:
integer
Defaults to 60

This is the requested re-register perior for the device. The device will be treated as unregistered if they do not register in this window + a system wide grace period.

string
enum
Defaults to no

This will enable IP checking. Default is no

Allowed:
string
enum
Defaults to no

This will enable IP checking. Default is no

Allowed:
string
enum
Defaults to no

This will enable IP checking. Default is no

Allowed:
string
enum
Defaults to no

This setting will enable SRTP (secure/encrypted audio) on the the device. Yes will force and "opp

Allowed:
string
enum
Defaults to no

This will enable IP checking. Default is no

Allowed:
string
enum
Defaults to no

Option whether to record calls or not. Available options are "yes", "yes-with-transcription", "yes-with-transcription-and-sentiment", or "no"

Allowed:
string

This value can be used to restrict registration to a specific User Agent or partial match of User Agent. This allows for an extra layer of secutiry if you know the expected user agent.

string
enum
Defaults to automatic

This is the main nat transveral setting. In most all device cases "automatic" is the correct answe

Allowed:
string | null

This value if set will be the address-id specific to this device for emegeny calling

string

This is an optional model that when provided with device-provisioning-mac-address will link this device to the mac address in the device provisioning platform.

string

This is the mac address that has this device linked to it. This field can be used to link a mac address on device create. Must also provide a device-models-model

string

This is the SiPbx Servers primary server config from a list of valid

string
enum
Defaults to udp

This is the transport that will be requested when provising the device.

Allowed:
string | null

The provisioning username for the request to authenticate the configuration request.

string | null

The provisioning password for the request to authenticate the configuration request.

integer

Optional setting to select which line is used on the device when provisionined with device-models-model and device-provisioning-mac-address

string

This is the overrides set for the mac address in the provisioning server on the mac linked to this device.

Responses

Updated 11 months ago

Language
Credentials
Bearer
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 11 months ago