.. _phones_data_export:

Phones Data Export
------------------

.. _21.1|EKB-9459:
.. _19.3.4-PB5|EKB-9459:
.. _19.3.4-PB5|EKB-8547:
.. _21.2|EKB-8547:



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

Layout:

.. tabularcolumns:: |p{4cm}|p{8cm}|p{2cm}|p{1.5cm}


+-------------------------------+----------------------------------------------------+-----------+---------+
| ELEMENT                       | DESCRIPTION                                        | 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                             | string    | v1      |
|                               | Division or other node)                            |           |         |
+-------------------------------+----------------------------------------------------+-----------+---------+
| location_name                 | Site Name                                          | string    | v1      |
+-------------------------------+----------------------------------------------------+-----------+---------+
| hierarchy                     | The full hierarchy path for                        | string    | v1      |
|                               | the item being exported                            |           |         |
+-------------------------------+----------------------------------------------------+-----------+---------+
| usernames                     | list of usernames associated to                    | array     | v1      |
|                               | the phones via Unified CM user, associated devices |           |         |
+-------------------------------+----------------------------------------------------+-----------+---------+
|                               | the name of the device                             |           |         |
| device_name                   | (includes mac address if                           | string    | v1      |
|                               | hardphone, softclients no                          |           |         |
|                               | mac)                                               |           |         |
+-------------------------------+----------------------------------------------------+-----------+---------+
| description                   | Text field attached to the                         | string    | v3      |
|                               | device                                             |           |         |
+-------------------------------+----------------------------------------------------+-----------+---------+
| device_type                   | the model of the phone                             | string    | v1      |
+-------------------------------+----------------------------------------------------+-----------+---------+
| lines                         | Array of objects containing                        | array     | v1      |
|                               | line information                                   |           |         |
+-------------------------------+----------------------------------------------------+-----------+---------+
|                               | Internal Number assigned to                        |           |         |
| lines.cucm_dn                 | the device profile (as                             | string    | v1      |
|                               | configured in the PBX)                             |           |         |
+-------------------------------+----------------------------------------------------+-----------+---------+
|                               | External Number (E164 number)                      |           |         |
| lines.E164                    | assigned to the device                             | string    | v1      |
|                               | profile                                            |           |         |
+-------------------------------+----------------------------------------------------+-----------+---------+
|                               | Array of E164 numbers and                          |           |         |
| lines.E164Members             | ranges assigned to ``cucm_dn``                     | string    | v4      |
|                               | in the case of N-1 mapped lines                    |           |         |
+-------------------------------+----------------------------------------------------+-----------+---------+
| lines.E164Members.e164_number | E164 number in the case of N-1 mapped lines        | string    | v4      |
+-------------------------------+----------------------------------------------------+-----------+---------+
|                               | E164 range of ``lines.E164Members.e164_number``    |           |         |
| lines.E164Members.e164_range  | in the case of N-1 mapped lines                    | string    | v4      |
+-------------------------------+----------------------------------------------------+-----------+---------+
| lines.line_order              | Line index.                                        | integer   | v2      |
+-------------------------------+----------------------------------------------------+-----------+---------+
| device_css                    | Calling search space of the                        | string    | v2      |
|                               | phone                                              |           |         |
+-------------------------------+----------------------------------------------------+-----------+---------+
| add_on_modules                | Array of phone addon modules, incl. name, model,   | array     | v4      |
|                               | position                                           |           |         |
+-------------------------------+----------------------------------------------------+-----------+---------+

Example:

(* marked fields are new in version 2 and version 3)

(** marked fields are new in version 4)

::
 
   [                                                              
      {                                                           
       *  "provider_name": "CS-P",                                
       *  "reseller_name": "CS-NB",                               
          "customer_name": "AAAGlobal",                           
          "division_name": "",                                    
          "location_name": "AAA-Boston",                          
          "hierarchy": "sys.hcs.CS-P.CS-NB.AAAGlobal.AAA-Boston", 
          "usernames": [
              "ba_user4"
          ],
          "lines": [
                     {
                       "E164": "\\+494074371101",
                       "cucm_dn": "8201101",
       *               "line_order": 1
                     },
                     {
      **               "E164Members": [
                         {
      **                   "e164_number": "\\+335077280",
      **                   "e164_range": "10"
                         }
                       ],
                       "E164": "<primary>",
                       "cucm_dn": "8206001",
       *               "line_order": 2
                     }
                 ],
      **  "add_on_modules": [
            {
              "position": "1",
              "name": "Cisco Unified IP Color Key Expansion Module",
              "model": "CP-CKEM-C"
            }
          ],
          "device_name": "SEP998877777788",                       
                                                                  
           "description": "Meeting Room Phone",                   
          "device_type": "Cisco 9971",                            
          "device_css": "Cu1Si1-USADP-Emer-CSS"                   
       }                                                          
   ]