.. _subscriber_data_export: Subscriber Data Export ---------------------- .. _21.1|VOSS-847: .. _21.1|VOSS-790: .. _20.1.1|VOSS-722: Filename: ``_subscriber.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 | +---------------------+----------------------------+-----------+---------+ | | The full hierarchy path | | | | hierarchy | for the item being | string | v1 | | | exported | | | +---------------------+----------------------------+-----------+---------+ | username | username of the user | string | v1 | +---------------------+----------------------------+-----------+---------+ | first_name | First name of the user | string | v1 | +---------------------+----------------------------+-----------+---------+ | middle_name | Middle name of the user | string | v3 | +---------------------+----------------------------+-----------+---------+ | last_name | Last name of the user | string | v1 | +---------------------+----------------------------+-----------+---------+ | email | email address of the user | string | v1 | +---------------------+----------------------------+-----------+---------+ | | the profile assigned to | | | | entitlement_profile | the user that defines the | string | v1 | | | features they are enabled | | | | | to have configured | | | +---------------------+----------------------------+-----------+---------+ | | The role assigned to the | | | | role | user - defines privileges | string | v1 | | | in the portal | | | +---------------------+----------------------------+-----------+---------+ | | The security profile | | | | | assigned to the user - | | | | credential_policy | defined credential and | string | v1 | | | other security rules for | | | | | portal access | | | +---------------------+----------------------------+-----------+---------+ | snr | Does the user have the SNR | boolean | v1 | | | service configured | | | +---------------------+----------------------------+-----------+---------+ | voicemail | Does the user have a | boolean | v1 | | | voicemail box configured | | | +---------------------+----------------------------+-----------+---------+ | title | Subscriber's title | string | v2 | +---------------------+----------------------------+-----------+---------+ | department | Subscriber's department | string | v2 | +---------------------+----------------------------+-----------+---------+ | | Subscriber's telephone | | | | telephone_number | number as configured in | string | v2 | | | the CUCM user record | | | +---------------------+----------------------------+-----------+---------+ | pager_number | Subscriber's pager number | string | v3 | +---------------------+----------------------------+-----------+---------+ Example (* marked fields are new in version 2, ** marked fields are new in 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", "first_name": "Dean", ** "middle_name": "John", "last_name": "Daniels", "voicemail": false, "entitlement_profile": "AAAGlobal-Foundation-EP", "snr": false, "credential_policy": "HcsCredentialPolicy", "role": "AAA-BostonSelfService", "email": "email@theinternet.com", * "title": "Dr.", * "department": "R&D", * "telephone_number": "0215252020" ** "pager_number": "5551234545" } ] .. _hybrid_data_export: Hybrid System Subscriber Data Export ..................................... Layout: .. tabularcolumns:: |p{4cm}|p{8cm}|p{2cm}|p{1.5cm}| +--------------+----------------------+-----------+---------+ | ELEMENT | DESCRIPTION | DATA TYPE | VERSION | +==============+======================+===========+=========+ | username | username of the user | string | v4 | +--------------+----------------------+-----------+---------+ | service_type | Hybrid type | string | v4 | +--------------+----------------------+-----------+---------+ | lines | array of lines, CoS | array | v4 | +--------------+----------------------+-----------+---------+ Example :: [ { "username": "user_1", "hierarchy": "sys.9F73F4303A93.Provider1Hierarchy.Reseller1Hierarchy.Customer1Hierarchy", "lines": [ { "e164": "\\+441184025574", "class_of_service": "International-24Hrs-Enhanced", "extension": "8445574" }, { "e164": "\\+441184025576", "class_of_service": "International-24Hrs-Enhanced", "extension": "8445576" } ], "service_type": "Cisco-MS", "reseller_name": "Reseller1Hierarchy", "provider_name": "Provider1Hierarchy", "customer_name": "Customer1Hierarchy" } ] .. _mso365_data_export: MS Office 365 Subscriber Data Export ........................................ Layout: .. tabularcolumns:: |p{4cm}|p{8cm}|p{2cm}|p{1.5cm}| +---------------+------------------------+-----------+---------+ | ELEMENT | DESCRIPTION | DATA TYPE | VERSION | +===============+========================+===========+=========+ | username | username of the user | string | v4 | +---------------+------------------------+-----------+---------+ | first_name | First name of the user | string | v4 | +---------------+------------------------+-----------+---------+ | last_name | Last name of the user | string | v4 | +---------------+------------------------+-----------+---------+ | o365_username | user name on O365 | string | v4 | +---------------+------------------------+-----------+---------+ | display_name | displayed name of user | string | v4 | +---------------+------------------------+-----------+---------+ | is_licensed | User licensing status | string | v4 | +---------------+------------------------+-----------+---------+ | licenses | List of licenses | array | v4 | +---------------+------------------------+-----------+---------+ Example :: [ { "username": "user_1", "first_name": "FirstName_1", "last_name": "LastName_1", "display_name": "DisplayName", "hierarchy": "sys.CF24424CF914.Provider1Hierarchy.Reseller1Hierarchy.Customer1Hierarchy", "is_licensed": "Y", "o365_username": "user_1@dummy-emailaccount.com", "licenses": [ { "account_sku_id": "42" } ], "reseller_name": "Reseller1Hierarchy", "provider_name": "Provider1Hierarchy", "customer_name": "Customer1Hierarchy" } ] .. _ms_teams_data_export: MS Teams Subscriber Data Export .................................... Layout: .. tabularcolumns:: |p{4cm}|p{8cm}|p{2cm}|p{1.5cm}| +----------------------+--------------------------+-----------+---------+ | ELEMENT | DESCRIPTION | DATA TYPE | VERSION | +======================+==========================+===========+=========+ | ms_teams_username | UserPrincipalName | string | v4 | +----------------------+--------------------------+-----------+---------+ | alias | user alias | string | v4 | +----------------------+--------------------------+-----------+---------+ | username | username of the user | string | v4 | +----------------------+--------------------------+-----------+---------+ | first_name | First name of user | string | v4 | +----------------------+--------------------------+-----------+---------+ | last_name | Last name of user | string | v4 | +----------------------+--------------------------+-----------+---------+ | department | User department | string | v4 | +----------------------+--------------------------+-----------+---------+ | enterprise_voice | EnterpriseVoiceEnabled | string | v4 | +----------------------+--------------------------+-----------+---------+ | line | OnPremLineURI | string | v4 | +----------------------+--------------------------+-----------+---------+ | hosted_voicemail | HostedVoiceMail | boolean | v4 | +----------------------+--------------------------+-----------+---------+ | voice_routing_policy | OnlineVoiceRoutingPolicy | string | v4 | +----------------------+--------------------------+-----------+---------+ | tenant_dialplan | TenantDialPlan | string | v4 | +----------------------+--------------------------+-----------+---------+ | voicemail_policy | HostedVoicemailPolicy | string | v4 | +----------------------+--------------------------+-----------+---------+ Example :: [ { "username": "user_1", "first_name": "FirstName_1", "last_name": "LastName_1", "enterprise_voice": false, "hierarchy": "sys.4E0EF94F90B9.Provider1Hierarchy.Reseller1Hierarchy.Customer1Hierarchy", "ms_teams_username": "user_1@dummy-emailaccount.com", "voicemail_policy": "BusinessVoice", "voice_routing_policy": "Global", "alias": "user_1", "tenant_dialplan": "", "department": "R&D", "reseller_name": "Reseller1Hierarchy", "provider_name": "Provider1Hierarchy", "hosted_voicemail": false, "line": "18694400002", "customer_name": "Customer1Hierarchy" } ] .. _pexip_data_export: Pexip Subscriber Data Export .................................. Layout: .. tabularcolumns:: |p{4cm}|p{8cm}|p{2cm}|p{1.5cm}| +---------------+---------------------------------+-----------+---------+ | ELEMENT | DESCRIPTION | DATA TYPE | VERSION | +===============+=================================+===========+=========+ | name | First name of user | string | v4 | +---------------+---------------------------------+-----------+---------+ | description | Last name of user | string | v4 | +---------------+---------------------------------+-----------+---------+ | owner_email | User email address | string | v4 | +---------------+---------------------------------+-----------+---------+ | type | service type | string | v4 | +---------------+---------------------------------+-----------+---------+ Example :: [ { "name": "user_1", "hierarchy": "sys.0ECD98831FCF.Provider1Hierarchy.Reseller1Hierarchy.Customer1Hierarchy", "description": "Description_PexIp_1", "owner_email": "user_1@dummy-emailaccount.com", "reseller_name": "Reseller1Hierarchy", "provider_name": "Provider1Hierarchy", "type": "conference", "customer_name": "Customer1Hierarchy" } ] .. _phone_server_data_export: VOSS Phone Servers Subscriber Data Export .......................................... Layout: .. tabularcolumns:: |p{4cm}|p{8cm}|p{2cm}|p{1.5cm}| +--------------+-----------------------------+-----------+---------+ | ELEMENT | DESCRIPTION | DATA TYPE | VERSION | +==============+=============================+===========+=========+ | mac | MAC address of phone server | string | v4 | +--------------+-----------------------------+-----------+---------+ | phone_vendor | Vendor name | string | v4 | +--------------+-----------------------------+-----------+---------+ | phone_model | Model Name | string | v4 | +--------------+-----------------------------+-----------+---------+ | lines | Lines names and CoS | array | v4 | +--------------+-----------------------------+-----------+---------+ Example :: [ { "phone_model": "Cisco 6921", "hierarchy": "sys.A49D7D3D9752.Provider1Hierarchy.Reseller1Hierarchy.Customer1Hierarchy", "lines": [ { "class_of_service": "International-24Hrs-Enhanced", "name": "8445574" }, { "class_of_service": "International-24Hrs-Enhanced", "name": "8445576" } ], "mac": "2C:54:91:88:C9:01", "phone_vendor": "Cisco", "reseller_name": "Reseller1Hierarchy", "provider_name": "Provider1Hierarchy", "customer_name": "Customer1Hierarchy" } ]