SnapBuilder

Get Phone Configuration for specific Mac

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

Request

  • Base URL
    https://ns-api.com/ns-api/v2
  • URL
    https://ns-api.com/ns-api/v2/domains/{domain}/phoneconfiguration/{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

Response

phoneconfiguration-namestring

This is the main name for the phone configuration when used as a template

phoneconfiguration-mac-addressstring

When phone configuration is applied to a specific phone (not template) this will be a valid mac

phoneconfiguration-descriptionstring required

This is a plain description of the configuration

phoneconfiguration-brandstring required

The brand for which this phone configuration will be build for.

phoneconfiguration-modelstring required

The model specific to brand for which this phone configuration will be build for.

phoneconfiguration-domainstring required

The domain owning this phone configuration

last-modified-datetimestring

The last updated timestamp for the config

Example response

{
  "phoneconfiguration-directory": {
    "exclusions": [
      {
        "id": "user@domain"
      }
    ]
  }
}

Changes