device-sip-registration-uristring
This read-only value is the full SIP uri and will often be sip:[device]@[domain]
device-sip-registration-state'registered' | 'unregistered'
This is the current registration status for the device. This value will be registered if its in the value time windoe
device-sip-registration-passwordstring 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.
caller-id-number-emergencystring
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.
device-force-notify-new-voicemails-enabled'yes' | 'no'
device-level-call-recording-enabled'yes' | 'no'
device-push-enabled'yes' | 'no'
device-sip-registration-contactstring
This is the contact value for the device from the last successfull registration.
device-sip-registration-core-serverstring hostname
This is the hostname for which the last registration was completed. This would be used to connect the device from on inbound call.
device-sip-registration-datetimestring date-time nullable
This date-time will be the last registration time of the device. This time may be slightly delayed to improve replication throughput.
device-sip-registration-expires-datetimestring date-time nullable
This date-time will be the time at which the device will be treated as unregisted and should be in the future for active registed devices.
device-sip-registration-expiry-secondsinteger
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.
device-sip-registration-ignore-for-presence-calculation'yes' | 'no'
device-sip-registration-ignore-report-enabled'yes' | 'no'
device-sip-registration-ip-addressstring i
This is the read-only value is the IP:port for the last successfull registration.
device-sip-registration-user-agentstring
This is the read-only value for the user-agent used during the last successfully registration.
device-sip-no-to-tag-in-cancel'yes' | 'no'
device-srtp-enabled'yes' | 'no' | 'opportunistic'
This setting will enable SRTP (secure/encrypted audio) on the the device. Yes will force and "opp
auto-answer-enabled'yes' | 'no'
device-sip-allowed-user-agentstring
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.
device-sip-nat-traversal-enabled'automatic' | 'none' | 'never' | 'fixed'
This is the main nat transveral setting. In most all device cases "automatic" is the correct answe
device-sip-latency-seconds-currentnumber
This is the latency from the latest registration measured in seconds from the time the core sent a 407 challenge to the 200ok with Auth.
device-sip-latency-seconds-averagenumber
This is the average of the last 5 registration attempts measured similiarly to device-sip-latency-seconds-current.
emergency-address-idstring nullable
This value if set will be the address-id specific to this device for emegeny calling
error-reading-from-endpoint-modulestring
If yes, it means the API had an issue accessing the NDP for mac specific data
login-usernamestring
This is a read-only value of the user's login for the owner of the device.
name-full-namestring
This is a read-only value of the user's full name for the owner of the device.
device-models-modelstring
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.
device-provisioning-mac-addressstring
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
device-provisioning-registration-core-serverstring
This is the SiPbx Servers primary server config from a list of valid
device-provisioning-sip-transport-protocol'udp' | 'tcp' | 'tls'
This is the transport that will be requested when provising the device.
device-provisioning-usernamestring nullable
The provisioning username for the request to authenticate the configuration request.
device-provisioning-passwordstring nullable
The provisioning password for the request to authenticate the configuration request.
device-provisioning-lineinteger
Optional setting to select which line is used on the device when provisionined with device-models-model and device-provisioning-mac-address
device-provisioning-overridesstring
This is the overrides set for the mac address in the provisioning server on the mac linked to this device.
recording-configuration'yes' | 'yes-with-transcription' | 'yes-with-transcription-and-sentiment' | 'no'
Option whether to record calls or not. Available options are "yes", "yes-with-transcription", "yes-with-transcription-and-sentiment", or "no"