.. _phones_data_export:

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


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       |           |         |
+------------------+-------------------------------+-----------+---------+
| username         | the username of the owner of  | string    | v1      |
|                  | device profile                |           |         |
+------------------+-------------------------------+-----------+---------+
|                  | 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                       |           |         |
+------------------+-------------------------------+-----------+---------+
| lines.line_order | Line index.                   | integer   | v2      |
+------------------+-------------------------------+-----------+---------+
| device_css       | Calling search space of the   | string    | v2      |
|                  | phone                         |           |         |
+------------------+-------------------------------+-----------+---------+

Example:

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

::
 
   [                                                              
      {                                                           
       *  "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", 
          "username": "ba_user4",                                 
          "lines": [                                              
              {                                                   
       *          "line_order": 1,                                
                  "cucm_dn": "50409",                             
                  "E164": "\\+18575550409"                        
              }                                                   
          ],                                                      
          "device_name": "SEP998877777788",                       
                                                                  
           "description": "Meeting Room Phone",                   
          "device_type": "Cisco 9971",                            
          "device_css": "Cu1Si1-USADP-Emer-CSS"                   
       }                                                          
   ]