Get Specifc Device

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

domain

string

required

Example:

user

string

required

Example:

device

string

required

Example:

{{user}}x

Responses

🟢200OK

application/json

Body

device

string

required

This is the "device" id which will be the first part of the device-sip-registration-uri which can be used to read specific device information.

user

string

required

This is the main user extension for the user account.

Examples:

1000200

domain

string

required

This is the main organization name. This is used to link resource to its group/tenant/organization/enterprise. ~ and * can be used alone in special cases to mean My Domain (~) and All Domains (*).

<= 64 characters

Examples:

example.commyDomaintest.12123

Match pattern:

^[A-Za-z0-9._-]+|\*

device-sip-registration-uri

string

read-onlyoptional

This read-only value is the full SIP uri and will often be sip:[device]@[domain]

device-sip-registration-state

enum<string>

read-onlyoptional

This is the current registration status for the device. This value will be registered if its in the value time windoe

Allowed values:

registeredunregistered

device-sip-registration-password

string <password>

optional

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-emergency

string

optional

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.

Default:

[*]

device-force-notify-new-voicemails-enabled

enum<string>

optional

When enabled this setting will send a NOTIFY with an MWI (message waiting indication) after a complete registrtion. This is a bit of a hack for older devices that do not SUBSCRIBE properly.

Allowed values:

yesno

Default:

device-level-call-recording-enabled

enum<string>

optional

This setting will allow recording to be enabled on this specific device.

Allowed values:

yesno

Default:

device-push-enabled

enum<string>

optional

This setting will enable "Push" for a specific device. Push should be used with mobile or other devices that support a quick registration after a push message sent from a supported vendor push network (apple, google)

Allowed values:

yesno

Default:

yes

device-sip-registration-contact

string

read-onlyoptional

This is the contact value for the device from the last successfull registration.

device-sip-registration-core-server

string <hostname>

read-onlyoptional

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-datetime

string <date-time> | null

read-onlyoptional

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-datetime

string <date-time> | null

read-onlyoptional

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-seconds

integer

optional

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.

Default:

device-sip-registration-ignore-for-presence-calculation

enum<string>

optional

This setting when enabled will exclude this device from presence calculations. Used for some applications like shared or video bridge devices that you might not want to be included in presence calculation in terms of being on a call or registered.

Allowed values:

yesno

Default:

device-sip-registration-ignore-report-enabled

enum<string>

optional

When enabled r-port on registration will be ignored. Keep disabled in most cases.

Allowed values:

yesno

Default:

device-sip-registration-ip-address

string <i>

read-onlyoptional

This is the read-only value is the IP:port for the last successfull registration.

device-sip-registration-user-agent

string

read-onlyoptional

This is the read-only value for the user-agent used during the last successfully registration.

Examples:

Yealink T48 2.3.232SnapMobile Web 44.0.2

device-sip-no-to-tag-in-cancel

enum<string>

optional

When enabled this setting will supress the to: tag in the cancel on a forward invite. This should not be enabled unless needing it for a specific interop

Allowed values:

yesno

Default:

device-srtp-enabled

enum<string>

optional

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

Allowed values:

yesnoopportunistic

Default:

auto-answer-enabled

enum<string>

optional

This setting when enabled will trigger forward INVITEs to the device to include auto answer headers. This would be for all calls.

Allowed values:

yesno

Default:

recording-configuration

enum<string>

optional

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

Allowed values:

yesyes-with-transcriptionyes-with-transcription-and-sentimentno

Default:

device-sip-allowed-user-agent

string

optional

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

enum<string>

optional

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

Allowed values:

automaticnoneneverfixed

Default:

automatic

device-sip-latency-seconds-current

number

read-onlyoptional

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-average

number

read-onlyoptional

This is the average of the last 5 registration attempts measured similiarly to device-sip-latency-seconds-current.

emergency-address-id

string | null

optional

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

error-reading-from-endpoint-module

string

read-onlyoptional

If yes, it means the API had an issue accessing the NDP for mac specific data

string

read-onlyoptional

This is a read-only value of the user's login for the owner of the device.

name-full-name

string

read-onlyoptional

This is a read-only value of the user's full name for the owner of the device.

device-models-model

string

optional

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-address

string

optional

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-server

string

optional

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

device-provisioning-sip-transport-protocol

enum<string>

optional

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

Allowed values:

udptcptls

Default:

udp

device-provisioning-username

string | null

optional

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

device-provisioning-password

string | null

optional

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

device-provisioning-line

integer

optional

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

device-provisioning-overrides

string

optional

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

Example

{
  "device": "string",
  "user": "1000",
  "domain": "example.com",
  "device-sip-registration-uri": "string",
  "device-sip-registration-state": "registered",
  "device-sip-registration-password": "pa$$word",
  "caller-id-number-emergency": "[*]",
  "device-force-notify-new-voicemails-enabled": "no",
  "device-level-call-recording-enabled": "no",
  "device-push-enabled": "yes",
  "device-sip-registration-contact": "string",
  "device-sip-registration-core-server": "example.com",
  "device-sip-registration-datetime": "2019-08-24T14:15:22Z",
  "device-sip-registration-expires-datetime": "2019-08-24T14:15:22Z",
  "device-sip-registration-expiry-seconds": 60,
  "device-sip-registration-ignore-for-presence-calculation": "no",
  "device-sip-registration-ignore-report-enabled": "no",
  "device-sip-registration-ip-address": "string",
  "device-sip-registration-user-agent": "Yealink T48 2.3.232",
  "device-sip-no-to-tag-in-cancel": "no",
  "device-srtp-enabled": "no",
  "auto-answer-enabled": "no",
  "recording-configuration": "no",
  "device-sip-allowed-user-agent": "string",
  "device-sip-nat-traversal-enabled": "automatic",
  "device-sip-latency-seconds-current": 0,
  "device-sip-latency-seconds-average": 0,
  "emergency-address-id": "string",
  "error-reading-from-endpoint-module": "string",
  "login-username": "string",
  "name-full-name": "string",
  "device-models-model": "string",
  "device-provisioning-mac-address": "string",
  "device-provisioning-registration-core-server": "string",
  "device-provisioning-sip-transport-protocol": "udp",
  "device-provisioning-username": "string",
  "device-provisioning-password": "string",
  "device-provisioning-line": 0,
  "device-provisioning-overrides": "string"
}

Request

Request samples

Responses