Share via

Hosted Unified Messaging::EnableMailbox

  • Article

This produres enables a user's mailbox for unified messaging (UM). The procedure will examine the organization to ensure it has a UM Plan before proceeding and retrieve some information from the service pointer.

Arguments

Input Arguments Required Description

<preferredDomainController>

Yes

The domain controller to use for Active Directory actions.

<path>

Yes

This parameter specifies the Lightweight Directory Access Protocol (LDAP) path of the user object.

<automaticSpeechRecognitionEnabled>

No

This parameter enables automatic speech recognition for the user.

<extensions>

No

The container for the list of extensions assigned to the user.

<extension >

Yes

An extension assigned to the user, must be unique to the dial plan.

<notifyEmail>

No

The e-mail address to which notification are to be sent

<pilotNumber>

No

The telephone number which the user uses to access his voice mail box.

<pin>

No

The 4 to 24 digit number pass code to the users mailbox.

<pinExpired>

No

If this parameter is set to true, the user must change their pin on first use.

<sipResourceIdentifier>

No

This parameter specifies the sip address of the user.

<validateOnly>

No

If his parameter is set to true, the process will only verify the prerequisites have been met to successfully UM enable the user.

Remarks

Security

The caller must be at least a member of role: UserCreators.

Service Pointer parameters:

  • Name - The name of the dial plan

  • Location - The name of the hunt group

  • Property name=mailboxPolicyAutoGenerated value = that of generateUMMailboxPolicy or false if absent

  • Policy value = mailboxPolicy value = generatedmailboxpolicy if enabled or umMailboxPolicy parameter.

Provisioning Steps

  1. Managed Helpers::GetServicePointer_ to retrieve the service pointer data.

  2. Managed Unified Messaging::EnableUMMailbox, using the mailbox policy retrieved from the service pointer for the umMailboxPolicy required parameter and path as the identity.

Sample Code

Example XML Request

<request> 
  <procedure> 
    <execute namespace=" Hosted Unified Messaging" procedure="EnableMailbox" impersonate="1"> 
      <executeData> 
        <path>LDAP://CN=User@Alpineskihouse.com,OU=Alpineskihouse,OU=ConsolidatedMessenger,OU=Hosting,DC=Fabrikam,DC=Com</path> 
        <preferredDomainController>ad01.fabrikam.com</preferredDomainController> 
        <automaticSpeechRecognitionEnabled>true</automaticSpeechRecognitionEnabled> 
        <extensions> 
           <extensions>1212</extensions> 
           <extensions>2212</extensions> 
        </extensions> 
        <notifyEmail> User@Alpineskihouse.com</notifyEmail> 
        <pilotNumber>5551212</pilotNumber> 
        <pin>1234</pin> 
        <pinExpired>true</pinExpired> 
        <sipResourceIdentifier> User@Alpineskihouse.com</sipResourceIdentifier> 
        <validateOnly>false</validateOnly> 
      </executeData> 
      <after source="executeData" destination="data" /> 
    </execute> 
  </procedure> 
</request>

Applies To

Hosted Unified Messaging Namespace for:

  • Hosted Messaging and Collaboration version 4.5

  • Hosted Messaging and Collaboration version 4.0