v1
latestOpenAPI 3.1.02026-07-24317911.4 MBUpdate Device for User
Path parameters
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.
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.
Request body
This read-only value is the full SIP uri and will often be sip:[device]@[domain]
This is the current registration status for the device. This value will be registered if its in the value time windoe
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.
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.
This is the contact value for the device from the last successfull registration.
This is the hostname for which the last registration was completed. This would be used to connect the device from on inbound call.
This date-time will be the last registration time of the device. This time may be slightly delayed to improve replication throughput.
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.
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.
This is the read-only value is the IP:port for the last successfull registration.
This is the read-only value for the user-agent used during the last successfully registration.
This setting will enable SRTP (secure/encrypted audio) on the the device. Yes will force and "opp
Option whether to record calls or not. Available options are "yes", "yes-with-transcription", "yes-with-transcription-and-sentiment", or "no"
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.
This is the main nat transveral setting. In most all device cases "automatic" is the correct answe
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.
This is the average of the last 5 registration attempts measured similiarly to device-sip-latency-seconds-current.
This value if set will be the address-id specific to this device for emegeny calling
If yes, it means the API had an issue accessing the NDP for mac specific data
This is a read-only value of the user's login for the owner of the device.
This is a read-only value of the user's full name for the owner of the device.
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.
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
This is the SiPbx Servers primary server config from a list of valid
This is the transport that will be requested when provising the device.
The provisioning username for the request to authenticate the configuration request.
The provisioning password for the request to authenticate the configuration request.
Optional setting to select which line is used on the device when provisionined with device-models-model and device-provisioning-mac-address
This is the overrides set for the mac address in the provisioning server on the mac linked to this device.
Example request
{
"device-sip-registration-user-agent": "Yealink T48 2.3.232"
}