Phones Data Export

Filename: <YYYY-MM-DD_HHMM>_phones.json.gz

Layout:

ELEMENT	DESCRIPTION AND SOURCE FIELD	DATA TYPE	VERSION
provider_name	Name of the Provider	string	v2
reseller_name	Name of the Reseller	string	v2
customer_name	name of the customer	string	v1
division_name	Intermediate Node (e.g Division or other node)	string	v1
location_name	Site Name	string	v1
hierarchy	The full hierarchy path for the item being exported	string	v1
usernames	list of usernames associated to the phones via Unified CM user, associated devices device/cucm/User.userid	array	v1
device_name	the name of the device (includes mac address if hardphone, softclients no mac) device/cucm/Phone.name	string	v1
description	Text field attached to the device device/cucm/Phone.description	string	v3
device_type	the model of the phone device/cucm/Phone.product	string	v1
device_css	Calling search space of the phone device/cucm/Phone.callingSearchSpaceName	string	v2
lines	Array of objects containing line information device/cucm/Phone.lines.line	array	v1
lines.line_order	Line index. device/cucm/Phone.lines.line.index	integer	v2
lines.cucm_dn	Internal Number assigned to the device profile (as configured in the PBX) device/cucm/Phone.lines.line.dirn.pattern	string	v1
lines.E164	External Number (E164 number) assigned to the device profile device/cucm/Phone.lines.line.dirn.pattern	string	v1

ELEMENT	DESCRIPTION AND SOURCE FIELD	DATA TYPE	VERSION
E164Members	Array of E164 numbers and ranges assigned to cucm_dn in the case of N-1 mapped lines	string	v4
E164Members.e164_number	E164 number in the case of N-1 mapped lines	string	v4
E164Members.e164_range	E164 range of E164Members.e164_number in the case of N-1 mapped lines	string	v4
owner_username	User ID of the assigned phone user Only in release >= 21.1 device/cucm/Phone.ownerUserName	string	v4
add_on_modules	Array of phone addon modules, incl. name, model, position Only in release >= 21.1 cache.addOnModules.addOnModule	array	v4

• ELEMENT: add_on_modules.name

  • DESCRIPTION: phone addon module name

  • SOURCE FIELD: Only in release >= 21.1

    device/cucm/Phone.addOnModules.addOnModule.loadInformation

  • DATA TYPE: string

  • VERSION: v4

• ELEMENT: add_on_modules.model

  • DESCRIPTION: phone addon module model

  • SOURCE FIELD: Only in release >= 21.1

    device/cucm/Phone.addOnModules.addOnModule.model

  • DATA TYPE: string

  • VERSION: v4

• ELEMENT: add_on_modules.position

  • DESCRIPTION: phone addon module model

  • SOURCE FIELD: Only in release >= 21.1

    device/cucm/Phone.addOnModules.addOnModule.index

  • DATA TYPE: integer

  • VERSION: v4

Example:

[
{
  "division_name": "Intermed1",
  "usernames": [
    "s1p1_user1"
  ],
  "location_name": "Site1",
  "description": "s1p1_desc",
  "hierarchy": "sys.AB707E3E6FC2.Prov1.Resel1.Cust1.Intermed1.Intermed1_1.Site1",
  "lines": [
    {
      "line_order": 0,
      "cucm_dn": "11111",
      "E164": "s1p1l1_e164"
    }
  ],
  "add_on_modules": [
    {
      "position": 0,
      "model": "add_on_module_model-01",
      "name": "add_on_module_info-01"
    }
  ],
  "device_type": "s1p1_product_value",
  "reseller_name": "Resel1",
  "provider_name": "Prov1",
  "device_name": "s1p1_name",
  "device_css": "s1p1_css",
  "customer_name": "Cust1"
},
{
  "division_name": "Intermed1",
  "usernames": [],
  "location_name": "Site1",
  "description": "",
  "hierarchy": "sys.AB707E3E6FC2.Prov1.Resel1.Cust1.Intermed1.Intermed1_1.Site1",
  "lines": [],
  "add_on_modules": [],
  "device_type": "s1p2_product_value",
  "reseller_name": "Resel1",
  "provider_name": "Prov1",
  "device_name": "s1p2_name",
  "device_css": "s1p2_css",
  "customer_name": "Cust1"
},
{
  "division_name": "Intermed2",
  "usernames": [
    "s2p1_user1",
    "s2p1_user2"
  ],
  "location_name": "Site2",
  "description": "",
  "hierarchy": "sys.AB707E3E6FC2.Prov2.Resel2.Cust2.Intermed2.Site2",
  "lines": [
    {
      "line_order": 1,
      "cucm_dn": "33333",
      "E164": "s2p1l1_e164"
    },
    {
      "line_order": 2,
      "cucm_dn": "44444",
      "E164": ""
    }
  ],
  "add_on_modules": [],
  "device_type": "s2p1_product_value",
  "reseller_name": "Resel2",
  "provider_name": "Prov2",
  "device_name": "s2p1_name",
  "device_css": "s2p1_css",
  "customer_name": "Cust2"
}
]