Phones/Macs

Read Specific Mac Addresses in Domain

Changed on
get/domains/{domain}/phones/{mac}

Request

  • Base URL
    https://ns-api.com/ns-api/v2
  • URL
    https://ns-api.com/ns-api/v2/domains/{domain}/phones/{mac}
  • Auth
    HTTP bearer

Path parameters

domainstring required

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.

Example:example.com
macstring required

Query parameters

limitnumber

This is the limit of the number of objects that will be returned in the read/list API call. This can be used with pagination to help retrieve smaller chunks of data. Should be used in conjunction with Start.

Response

device-provisioning-mac-addressstring mac required
domainstring 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 (*).

resellerstring required
device-models-brand-and-modelstring required
device-provisioning-registration-core-serverstring required
notesstring required
device-provisioning-sip-uri-1string required
device-provisioning-line-1-enabled'yes' | 'no' required
device-provisioning-sip-uri-1-shared-line-enabledstring required
device-provisioning-sip-uri-2string required
device-provisioning-line-2-enabled'yes' | 'no' required
device-provisioning-sip-uri-2-shared-line-enabledstring required
device-provisioning-sip-transport-protocolstring required
device-provisioning-usernamestring required
device-provisioning-passwordstring password required
device-models-count-buttonsinteger required
device-models-fxs-support-enabledinteger required
device-models-overrides-blobstring required
device-models-resync-support-enabledstring required
device-models-shared-line-support-enabledstring required
device-models-sidecar-support-enabledstring required
device-provisioning-last-retrieved-datetimestring required
device-provisioning-directorystring required
device-provisioning-directory-supportstring required
device-provisioning-line-1-extensionsstring
device-provisioning-line-2-extensionsstring
device-provisioning-ndp-hostnamestring required
device-provisioning-presencestring required
created-datetimestring required
global-one-time-passstring required
last-modified-datetimestring date-time
redundencystring required
device-provisioning-sip-uri-3string
device-provisioning-line-3-enabledstring
device-provisioning-sip-uri-3-shared-line-enabledstring
device-provisioning-sip-uri-4string
device-provisioning-line-4-enabledstring
device-provisioning-sip-uri-4-shared-line-enabledstring
device-provisioning-sip-uri-5string
device-provisioning-line-5-enabledstring
device-provisioning-sip-uri-5-shared-line-enabledstring
device-provisioning-sip-uri-6string
device-provisioning-line-6-enabledstring
device-provisioning-sip-uri-6-shared-line-enabledstring
device-provisioning-sip-uri-7string
device-provisioning-line-7-enabledstring
device-provisioning-sip-uri-7-shared-line-enabledstring
device-provisioning-sip-uri-8string
device-provisioning-line-8-enabledstring
device-provisioning-sip-uri-8-shared-line-enabledstring
device-sip-registration-contactstring
device-sip-registration-datetimestring
device-sip-registration-expires-datetimestring
device-sip-registration-statestring nullable
device-sip-registration-user-agentstring

Example response

{
  "device-provisioning-mac-address": "000011223344",
  "domain": "example.com"
}

Changes