/enterprise/getUserDetailsByPBXUserIdOrSIPAOR/{pbxUserIdOrSIPAOR}

  • Published on Jun 17, 2025
  • 1 minute(s) read
Prev Next
Post
/enterprise/getUserDetailsByPBXUserIdOrSIPAOR/{pbxUserIdOrSIPAOR}

Operation to retrieve PBX Service and Profile details of an Enterprise User.

Security
OAuth
FlowPassword
Token URL/oauth/token
Responses
200

OK

Expand All
object
_links
object (Links)
property*
object (Link) additionalProperties
deprecation
string
href
string
hreflang
string
name
string
profile
string
templated
boolean
title
string
type
string
authUserName
string

Returns the SIP Authentication Username configured for the User

callPolicyCallerCNAM
string
Valid values[ "FROM_HEADER_VALUE", "NONE", "OTHER", "TRANSPARENT", "TRUNK_SETTINGS", "USER_CALLER_ID", "USER_TEAM_DID" ]
callPolicyCallerId
string
callPolicyCustomCNAM
string
callRecordingAdmin
boolean
callRecordingCanPause
boolean
callRecordingEnabled
boolean
codecs
string
createdTime
string
dcpprovisioned
boolean
deviceName
string

Returns the Shared Call Appearance Device Name for the PBX Service when the PBX is 'Broadworks'. Returns NULL in all other cases

did
string
directRouteId
integer (int32)
disableTeamsVoicemail
boolean Deprecated
emailID
string
enterpriseBillingReference
string
enterpriseId
integer (int64)
enterpriseName
string
extension
string
firstName
string
forwardCallsCallerId
string
Valid values[ "FROM_HEADER_VALUE", "NONE", "OTHER", "TRANSPARENT", "TRUNK_SETTINGS", "USER_CALLER_ID", "USER_TEAM_DID" ]
lastName
string
linePort
string

Returns the Shared Call Appearance Line Port for the PBX Service when the PBX is 'Broadworks'. Returns NULL otherwise.

macAddress
string
mainLicenseName
string

Returns the name of the Office 365 License assigned to the User

masterResellerBillingReference
string
masterResellerId
integer (int64)
masterResellerName
string
parkOrbit
string
partnerBillingReference
string
partnerId
integer (int64)
partnerName
string
password
string
pbxCalling
boolean
pbxLocation
string
pbxRegistration
string
pbxSIPDomain
string

Returns the SIP Domain from the PBX service setup for the User

pbxSIPDomainProxy
string

Returns the SIP Domain Proxy from the PBX service setup for the User

pbxTypeName
string
phoneNumberInNationalFormat
string

Returns the Phone Number in the National Format based on the User's License Usage Location

phoneSystemAssigned
boolean

Returns if the Phone System License is Assigned for the User

phoneSystemProvisioned
boolean

Returns if the Phone System License is Provisioned for the User

portalLoginName
string
portalPassword
string
provisioningServerPassword
string
provisioningServerProvisioned
boolean
provisioningServerUsername
string
regUpdatedAt
string
resellerBillingReference
string
resellerId
integer (int64)
resellerName
string
sbcLocation
string

Returns the deployment Region of the SBC for the User's configured Voice Route

servicePhoneNumberId
integer (int64)
sipAutoProvisioningEnabled
boolean
sipUserId
string
smsDIDs
Array of string
string
smsEnabled
boolean
status
string
teamsUserId
string
useAudioConferenceVRP
boolean
useEnterpriseDialPlan
boolean
useTeamsVoicemail
boolean
userId
string
userTag
string
userType
string