Get List of M365 End Users and their M365 Teams Phone System Attributes
This request retrieves a list of M365 users and their Microsoft Teams Phone System attributes for a specific customer.
| ● | This functionality is only supported for Essentials Plus and Pro services; ensure you have a secure connection for synchronization between Live Platform and Microsoft Teams (see Secure Connection with Customer M365 Tenant Platform). |
| ● | For Hosted Essentials services, users must be managed directly in their Teams admin center. |
URI
{{baseUrl}}/api/v3/customer/{umpCustomerGuid}/userHTTP Method
GET
Request Parameters
|
Parameter |
Type |
Description |
||||||
|---|---|---|---|---|---|---|---|---|
|
customerGuid |
string($uuid) (path) |
umpCustomerGuid' value created in the Live Platformcustomer tenant SQL database directory:
Extract this value using Get Services Brief Details (V3) or Get Customers Brief Details (V2) searching for the matching Short Name of the service. |
||||||
|
Page Number |
integer Default value: 1 |
Page number in range to retrieve. |
||||||
|
Page Size |
integer Default minimum value: 2 maximum: 10000 |
Number of pages in range to retrieve. |
Example Response
{
"currentPage": 1,
"pageSize": 10,
"totalPages": 2,
"totalRecords": 18,
"data": [
{
"Identity": "223a7851-897a-4ea9-8647-baf9bcffcaa8",
"Status": "----",
"SipAddress": "sip:pradeepg@1xwzg5.onmicrosoft.com",
"LineURI": "tel:+6138485600",
"HostingProvider": "sipfed.online.lync.com",
"HybridPstnSiteName": null,
"UsageLocation": "US",
"RegistrarPool": null,
"CallForward": "",
"ObjectId": "223A7851-897A-4EA9-8647-BAF9BCFFCAA8",
"WebName": "Pradeep Gupta",
"UserType": "TeamsOnly",
"PsCount": 0,
"IsManaged": null,
"Department": "Finance",
"TenantId": "3bc57cac-5794-457f-ad36-2c88cade9dbb",
"UserPrincipalName": "PradeepG@1xwzg5.onmicrosoft.com",
"MsInterpretedUserType": "PureOnlineTeamsOnlyUser",
"EnterpriseVoiceEnabled": true,
"OnlineVoiceRoutingPolicy": "",
"OnlinePstnGateway": ""
},
{
"Identity": "25dbacc4-34df-4201-ab2a-bb1fc34e9ee7",
"Status": "----",
"SipAddress": "sip:miriamg@1xwzg5.onmicrosoft.com",
"LineURI": "tel:+6138485601",
"HostingProvider": "sipfed.online.lync.com",
"HybridPstnSiteName": null,
"UsageLocation": "US",
"RegistrarPool": null,
"CallForward": "",
"ObjectId": "25DBACC4-34DF-4201-AB2A-BB1FC34E9EE7",
"WebName": "Miriam Graham",
"UserType": "TeamsOnly",
"PsCount": 0,
"IsManaged": null,
"Department": "Sales & Marketing",
"TenantId": "3bc57cac-5794-457f-ad36-2c88cade9dbb",
"UserPrincipalName": "MiriamG@1xwzg5.onmicrosoft.com",
"MsInterpretedUserType": "PureOnlineTeamsOnlyUser",
"EnterpriseVoiceEnabled": true,
"OnlineVoiceRoutingPolicy": "",
"OnlinePstnGateway": ""
},
{
"Identity": "3a7d8987-05dd-441c-af6e-d569a342839f",
"Status": "----",
"SipAddress": "sip:isaiahl@1xwzg5.onmicrosoft.com",
"LineURI": "tel:+6138485603",
"HostingProvider": "sipfed.online.lync.com",
"HybridPstnSiteName": null,
"UsageLocation": "US",
"RegistrarPool": null,
"CallForward": "",
"ObjectId": "3A7D8987-05DD-441C-AF6E-D569A342839F",
"WebName": "Isaiah Langer",
"UserType": "TeamsOnly",
"PsCount": 0,
"IsManaged": null,
"Department": "Sales",
"TenantId": "3bc57cac-5794-457f-ad36-2c88cade9dbb",
"UserPrincipalName": "IsaiahL@1xwzg5.onmicrosoft.com",
"MsInterpretedUserType": "PureOnlineTeamsOnlyUser",
"EnterpriseVoiceEnabled": true,
"OnlineVoiceRoutingPolicy": "",
"OnlinePstnGateway": ""
},
{
"Identity": "46c2e271-3c48-4df1-861a-e01d3fb04ed5",
"Status": "----",
"SipAddress": "sip:gradya@1xwzg5.onmicrosoft.com",
"LineURI": "tel:+6138485604",
"HostingProvider": "sipfed.online.lync.com",
"HybridPstnSiteName": null,
"UsageLocation": "US",
"RegistrarPool": null,
"CallForward": "",
"ObjectId": "46C2E271-3C48-4DF1-861A-E01D3FB04ED5",
"WebName": "Grady Archie",
"UserType": "TeamsOnly",
"PsCount": 0,
"IsManaged": null,
"Department": "R&D",
"TenantId": "3bc57cac-5794-457f-ad36-2c88cade9dbb",
"UserPrincipalName": "GradyA@1xwzg5.onmicrosoft.com",
"MsInterpretedUserType": "PureOnlineTeamsOnlyUser",
"EnterpriseVoiceEnabled": true,
"OnlineVoiceRoutingPolicy": "",
"OnlinePstnGateway": ""
},
{
"Identity": "4de61c20-8830-4b8d-8764-0047ff0f0cc9",
"Status": "----",
"SipAddress": "sip:lidiah@1xwzg5.onmicrosoft.com",
"LineURI": "tel:+6138485605",
"HostingProvider": "sipfed.online.lync.com",
"HybridPstnSiteName": null,
"UsageLocation": "US",
"RegistrarPool": null,
"CallForward": "",
"ObjectId": "4DE61C20-8830-4B8D-8764-0047FF0F0CC9",
"WebName": "Lidia Holloway",
"UserType": "TeamsOnly",
"PsCount": 0,
"IsManaged": null,
"Department": "Engineering",
"TenantId": "3bc57cac-5794-457f-ad36-2c88cade9dbb",
"UserPrincipalName": "LidiaH@1xwzg5.onmicrosoft.com",
"MsInterpretedUserType": "PureOnlineTeamsOnlyUser",
"EnterpriseVoiceEnabled": true,
"OnlineVoiceRoutingPolicy": "",
"OnlinePstnGateway": ""
},
{
"Identity": "69c2f0f9-ada1-4f7a-bb08-4635ec76acd8",
"Status": "----",
"SipAddress": "sip:ump-activation-1778402320@blackburn.sandbox1.audiocodes.be",
"LineURI": null,
"HostingProvider": "sipfed.online.lync.com",
"HybridPstnSiteName": null,
"UsageLocation": "BE",
"RegistrarPool": null,
"CallForward": "",
"ObjectId": "69C2F0F9-ADA1-4F7A-BB08-4635EC76ACD8",
"WebName": "ump-activation-1778402320",
"UserType": "TeamsOnly",
"PsCount": 0,
"IsManaged": null,
"Department": null,
"TenantId": "3bc57cac-5794-457f-ad36-2c88cade9dbb",
"UserPrincipalName": "ump-activation-1778402320@Blackburn.sandbox1.audiocodes.be",
"MsInterpretedUserType": "PureOnlineTeamsOnlyUser",
"EnterpriseVoiceEnabled": false,
"OnlineVoiceRoutingPolicy": "",
"OnlinePstnGateway": ""
},
{
"Identity": "75beea47-18f2-4b2b-a005-ab82b464a8f7",
"Status": "----",
"SipAddress": "sip:bradb@1xwzg5.onmicrosoft.com",
"LineURI": "tel:+6138485606",
"HostingProvider": "sipfed.online.lync.com",
"HybridPstnSiteName": null,
"UsageLocation": "IE",
"RegistrarPool": null,
"CallForward": "",
"ObjectId": "75BEEA47-18F2-4B2B-A005-AB82B464A8F7",
"WebName": "Brad Brzezinski",
"UserType": "TeamsOnly",
"PsCount": 0,
"IsManaged": null,
"Department": null,
"TenantId": "3bc57cac-5794-457f-ad36-2c88cade9dbb",
"UserPrincipalName": "Bradb@1xwzg5.onmicrosoft.com",
"MsInterpretedUserType": "PureOnlineTeamsOnlyUser",
"EnterpriseVoiceEnabled": true,
"OnlineVoiceRoutingPolicy": "",
"OnlinePstnGateway": ""
},
{
"Identity": "89d3d96c-891a-47f0-90d3-d20af231564a",
"Status": "----",
"SipAddress": "sip:lynner@1xwzg5.onmicrosoft.com",
"LineURI": "tel:+6138485607",
"HostingProvider": "sipfed.online.lync.com",
"HybridPstnSiteName": null,
"UsageLocation": "US",
"RegistrarPool": null,
"CallForward": "",
"ObjectId": "89D3D96C-891A-47F0-90D3-D20AF231564A",
"WebName": "Lynne Robbins",
"UserType": "TeamsOnly",
"PsCount": 0,
"IsManaged": null,
"Department": "Retail",
"TenantId": "3bc57cac-5794-457f-ad36-2c88cade9dbb",
"UserPrincipalName": "LynneR@1xwzg5.onmicrosoft.com",
"MsInterpretedUserType": "PureOnlineTeamsOnlyUser",
"EnterpriseVoiceEnabled": true,
"OnlineVoiceRoutingPolicy": "",
"OnlinePstnGateway": ""
},
{
"Identity": "8e0fa707-a28b-451d-8432-97f1c67f779f",
"Status": "----",
"SipAddress": "sip:nestorw@1xwzg5.onmicrosoft.com",
"LineURI": "tel:+6138485608",
"HostingProvider": "sipfed.online.lync.com",
"HybridPstnSiteName": null,
"UsageLocation": "US",
"RegistrarPool": null,
"CallForward": "",
"ObjectId": "8E0FA707-A28B-451D-8432-97F1C67F779F",
"WebName": "Nestor Wilke",
"UserType": "TeamsOnly",
"PsCount": 0,
"IsManaged": null,
"Department": "Operations",
"TenantId": "3bc57cac-5794-457f-ad36-2c88cade9dbb",
"UserPrincipalName": "NestorW@1xwzg5.onmicrosoft.com",
"MsInterpretedUserType": "PureOnlineTeamsOnlyUser",
"EnterpriseVoiceEnabled": true,
"OnlineVoiceRoutingPolicy": "",
"OnlinePstnGateway": ""
},
{
"Identity": "aaa095a2-8000-48fd-9e5b-7d8bc1fcf9c6",
"Status": "----",
"SipAddress": "sip:leeg@1xwzg5.onmicrosoft.com",
"LineURI": "tel:+6138485609",
"HostingProvider": "sipfed.online.lync.com",
"HybridPstnSiteName": null,
"UsageLocation": "US",
"RegistrarPool": null,
"CallForward": "",
"ObjectId": "AAA095A2-8000-48FD-9E5B-7D8BC1FCF9C6",
"WebName": "Lee Gu",
"UserType": "TeamsOnly",
"PsCount": 0,
"IsManaged": null,
"Department": "Manufacturing",
"TenantId": "3bc57cac-5794-457f-ad36-2c88cade9dbb",
"UserPrincipalName": "LeeG@1xwzg5.onmicrosoft.com",
"MsInterpretedUserType": "PureOnlineTeamsOnlyUser",
"EnterpriseVoiceEnabled": true,
"OnlineVoiceRoutingPolicy": "",
"OnlinePstnGateway": ""
}
]
}Response
| ■ | 200 OK |
|
Parameter |
Type |
Description |
||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Index summary data |
integer |
|
||||||||||||
|
Identity |
string($uuid) (path) |
Live Platform generated customer Guid. |
||||||||||||
|
Status |
string |
User status within the voice/Teams service |
||||||||||||
|
SipAddress |
|
The user's SIP URI used for Teams and voice communications. Example: sip:meganb@m365x33712745.onmicrosoft.com |
||||||||||||
|
CallForward |
|
Indicates whether Call Forwarding is enabled for the user. |
||||||||||||
|
Department |
string |
Active Directory User department. |
||||||||||||
|
WebName |
string |
Name of the M365 customer tenant user. |
||||||||||||
|
SipAddress |
string |
M365 user SIP address. For example, sip:adelev@m365x21689653.onmicrosoft.com |
||||||||||||
|
LineURI |
string |
The phone number assigned to the user in E.164 format. Example: tel:+6138485600. |
||||||||||||
|
HostingProvider |
string |
The provider hosting the user's Teams/Skype service. sipfed.online.lync.com indicates Microsoft 365/Microsoft Teams Online. |
||||||||||||
|
HybridPstnSiteName |
string |
Name of the PSTN site in a hybrid deployment. Typically indicates the user is fully cloud-based. |
||||||||||||
|
UsageLocation |
string |
Usage Location as defined in the customer tenant Microsoft Entra admin center. |
||||||||||||
|
RegistrarPool |
string |
The Microsoft Teams/Skype registrar service handling the user's registration. Often null for cloud users. |
||||||||||||
|
CallForward |
string |
Indicates the call forwarding destination. Empty string indicates no forwarding configured. |
||||||||||||
|
ObjectId |
string |
Entra ID object GUID for the user. Usually the same value as Identity, but formatted differently. |
||||||||||||
|
WebName |
string |
User's display name shown in Teams and Microsoft 365. |
||||||||||||
|
PsCount |
integer |
Internal count value often related to provisioning or policy records. Usually not meaningful for reporting. |
||||||||||||
|
IsManaged |
boolean |
Indicates whether the account is synchronized/managed from on-premises Active Directory. null means not available. |
||||||||||||
|
Department |
string |
Indicates the name of the Microsoft Azure Active Directory department object. |
||||||||||||
|
OnlineVoiceRoutingPolicy |
string |
Voice routing policy assigned to the user for Direct Routing. Empty value means no custom policy assigned. Default: unrestricted or <SiteConnectionTag>-Unrestricted |
||||||||||||
|
TenantId |
string |
Microsoft Azure subscription Tenant ID of the Live Platform service of the user account. |
||||||||||||
|
MsInterpretedUserType |
string |
PureOnlineTeamsOnlyUser |
||||||||||||
|
UserPrincipalName |
string |
User's sign-in account name (UPN). Usually matches the email address. For example, MeganB@M365x33712745.OnMicrosoft.com |
||||||||||||
|
EnterpriseVoiceEnabled |
boolean |
Indicates whether the user is enabled for Teams Phone/Enterprise Voice so they can use telephony features. |
||||||||||||
|
OnlineVoiceRoutingPolicy |
string |
Name of the OnlineVoiceRoutingPolicy applied to user through LifeCycle Management templates (Direct Routing only). |
||||||||||||
|
OnlinePstnGateway |
string |
Name of the OnlinePSTNGateway of the Service Provider or Customer sub domain for connecting calls between Microsoft Teams and Calling trunk. |
| ■ | 400 Bad Request |
|
Parameter |
Type |
Description/Examples |
|---|---|---|
|
errors |
string |
Text description of the error. |
|
type |
string |
"https://tools.ietf.org/html/rfc7231#section-6.5.1" |
|
title |
string |
Email title. For example "One or more validation errors occurred." |
|
status |
error code |
HTML error code i.e. 400 |
|
detail |
string |
Additional error details. |
|
traceId |
string |
Error trace Id |
|
instance |
string |
Error instance |
|
errorTicket |
string |
This field may not appear for all return codes. |
|
errorCode |
string |
This field may not appear for all return codes. |
|
additionalProp1 |
string |
Custom Script variable argument. For example "CacProfile": "5 sessions" |
|
additionalProp2 |
string |
Custom Script argument. For example, ProxySet": "SIPTrunk", |
|
additionalProp3 |
string |
Custom Script argument. For example, "OnlinePstnGateway": "sandbox1.audiocodes.be" |
| ■ | 403 Forbidden: |
|
Parameter |
Type |
Description/Examples |
|---|---|---|
|
errors |
string |
Text description of the error. |
|
type |
string |
"https://tools.ietf.org/html/rfc7231#section-6.5.1" |
|
title |
string |
Email title. For example "One or more validation errors occurred." |
|
status |
error code |
HTML error code i.e. 400 |
|
detail |
string |
Additional error details. |
|
traceId |
string |
Error trace Id |
|
instance |
string |
Error instance |
|
errorTicket |
string |
This field may not appear for all return codes. |
|
errorCode |
string |
This field may not appear for all return codes. |
|
additionalProp1 |
string |
Custom Script variable argument. For example "CacProfile": "5 sessions" |
|
additionalProp2 |
string |
Custom Script argument. For example, ProxySet": "SIPTrunk", |
|
additionalProp3 |
string |
Custom Script argument. For example, "OnlinePstnGateway": "sandbox1.audiocodes.be" |
| ■ | 409 Conflict |
|
Parameter |
Type |
Description/Examples |
|---|---|---|
|
errors |
string |
Text description of the error. |
|
type |
string |
"https://tools.ietf.org/html/rfc7231#section-6.5.1" |
|
title |
string |
Email title. For example "One or more validation errors occurred." |
|
status |
error code |
HTML error code i.e. 400 |
|
detail |
string |
Additional error details. |
|
traceId |
string |
Error trace Id |
|
instance |
string |
Error instance |
|
errorTicket |
string |
This field may not appear for all return codes. |
|
errorCode |
string |
This field may not appear for all return codes. |
|
additionalProp1 |
string |
Custom Script variable argument. For example "CacProfile": "5 sessions" |
|
additionalProp2 |
string |
Custom Script argument. For example, ProxySet": "SIPTrunk", |
|
additionalProp3 |
string |
Custom Script argument. For example, "OnlinePstnGateway": "sandbox1.audiocodes.be" |
| ■ | 500 Internal Server Error |