GET - User Report
Retrieves a detailed report of the specified user including services and service packs assigned.
Parameters
user_id (str): Target User ID
Returns
dict: Detailed report of user including services and service packs.
How To Use:
The following code snippet demonstrates how to fetch a list of all Service Providers:
my_api.reports.get_user_report("USER12345@domain")
Example Returned Data of Device (Formatted)
{
"serviceProviderId":"SERVICE123",
"groupId":"Group1",
"userId":"[email protected]",
"lastName":"Surname",
"firstName":"Name Name",
"callingLineIdLastName":"Surname",
"callingLineIdFirstName":"Name Name",
"hiraganaLastName":"Surname",
"hiraganaFirstName":"Name Name",
"extension":"1234",
"department":{
"serviceProviderId":"SERVICE123",
"groupId":"Group1",
"name":"Name Name"
},
"departmentFullPath":"Office Office",
"language":"English",
"timeZone":"Europe/Paris",
"timeZoneDisplayName":"(GMT+02:00) (Europe) Central Time",
"defaultAlias":"[email protected]",
"accessDeviceEndpoint":{
"accessDevice":{
"deviceType":"Phone Phone",
"protocol":"SIP 2.0",
"macAddress":"DEADBEEFCAFE",
"numberOfPorts":{
"quantity":"12"
},
"numberOfAssignedPorts":1,
"status":"Online",
"configurationMode":"Default",
"transportProtocol":"Unspecified",
"useCustomUserNamePassword":false,
"version":"5.9.7.3480",
"deviceName":"deviceName",
"serviceProviderId":"ServiceID",
"groupId":"GroupID",
"deviceLevel":"Group",
"accessDeviceCredentials":{
"userName":"None"
},
"tags":[
],
"relatedServices":[
]
},
},
"linePort":"[email protected]",
"staticRegistrationCapable":"false",
"useDomain":"true",
"supportVisualDeviceManagement":"false",
"contacts":[
]
},
"countryCode":"00",
"nationalPrefix":"",
"allowVideo":true,
"callingLineIdPhoneNumber":"",
"phoneNumber":"",
"domain":"domain.com",
"endpointType":"accessDeviceEndpoint",
"aliases":[
],
"trunkAddressing":{
"trunkGroupDeviceEndpoint":{
"contacts":[
]
}
},
"departmentName":"Name Name",
"emailAddress":"",
"phoneNumberActivated":"None",
"isEnterprise":true,
"passwordExpiresDays":"00000000",
"inTrunkGroup":"None",
"premiumServices":[
],
"userServices":[
],
"servicePacks":[
"Pack-1"
],
"userLinePorts":[
"[email protected]"
]
}
Last updated
Was this helpful?