Hosted Unified Messaging::EnableCustomer

This procedure enables a customer organization for Unified Messaging (UM) by subscribing to the service, creating a dial plan and hunt group and finally enabling all existing mailboxes within the customer organization.

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 customer organization.
<numberOfDigitsExtension>	Yes	The number of digits to use as the extension.
<umServer>	Yes	The UM-enabled Exchange server to which the dial plan the procedure will create, will be assigned.
<pilotIdentifier>	Yes	The primary telephone number to be used by the organization to reach their voicemail box.
<umIPGateway>	Yes	The IP address of the VOIP interface gateway.
<umMailboxPolicy>	Yes	The mailbox policy to be assigned to the users UM enabled mailbox.
<accessTelephoneNumbers>	No	The container for the list of access telephone numbers to be assigned to the dial plan.
<accessTelephoneNumber>	Yes	The cccess telephone number.
<faxEnabled>	No	This parameter allows user to send and receive faxes via unified messaging.
<generateUMMailboxPolicy>	No	This parameter generates a default mailbox policy for the customer and assigns it to the dial plan. This overrides umMailboxPolicy.
<ndrEnabled>	No	This parameter enables the sending of NDR's.
<dialPlanTemplateInstance>	No	The identity of a dial plan to use as a template for the dial plan to be created for the customer.
<uriType>	No	The type of URI.
<voIPSecurity>	No	This parameter sets the security level of the VOIP system.
<huntGroupTemplateInstance>	No	The identity of a hunt group to use as a template for the hunt group to be created for the customer.
<enableExistingMailboxes>	No	If this parameter is set to true, the procedure will iterate through existing mailboxes and enable them using available information.
<automaticSpeechRecogitionEnable>	No	This parameter enables or disables automated speech recognition.
<pinExpired>	No	When a mailbox is enabled for unified messaging and a pin is set, this forces the user the change their pin on first log on.
<pinLength>	No	The length of the randomly generated pin for a users mailbox. If less than 4 or larger than 24 or absent, no pin will be set and pinExpired will be ignored.

Output Arguments	Description
<enabledMailboxes>	The parent container for the list of mailbox nodes that have been UM enabled.
<mailbox>	If enableExistingMailboxes is enabled and pinLength is >= 4 and <=24, the user node will contain attributes of 'path' containing the LDAP path, and 'pin' containing the generated pin for the user.
<pin>	The randomly generated pin for the user specified in path.
<path>	This parameter contains the LDAP path of the users whose mailbox has been UM Enabled.

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 Property name=mailbox
Policy value = generatedmailboxpolicy if enabled or umMailboxPolicy parameter

Prerequisites

When setting enableExistingMailboxes to true, the following must be true of the users accounts that are to be automatically

The user must be mailbox enabled. It is beyond the scope of this procedure to create the users mailbox and the user cannot be UM enabled unless they have a mailbox.
The user must have a business telephone number set. The Enable-UMMailbox command will require an extension number unless the user already has a business phone number. Since providing an extension would require setting individual numbers on each user account, the EnableMailbox would be called directly and enableExistingMailboxes set to false.

enableExistingMailboxes is provided to ease the enabling of the organization and it's users when through the steps of a previous process these two criteria have been met.

Provisioning Steps

Generate name for dial plan and hunt group based on customer name
Managed Unified Messaging::NewUMDialPlan to create a dial plan for the customer organization.
Managed Unified Messaging::SetUMServer to set the dial plan as one being serviced by the machine named in the umServer node. It may be necessary to get the list, add the name to it and set it as the cmdlet does not appear to be able to append, only replace all.
Managed Unified Messaging::NewUMHuntGroup to create a new hunt group for the customer organization.
Hosted Unified Messaging::Subscribe to subscribe the organization to the unified messaging plan.
Managed Helpers::CreateServicesPointer_to create a service pointer in the organization to store the identity of the dial plan, mailbox policy and the hunt group. It must also store whether the mailbox policy was generated or supplied. If the mailbox policy is generated, DisableCustomer should remove it.
For each mailbox in the customer organization.
- Hosted Unified Messaging::EnableMailbox to enable each mailbox within the organization. Generating a random pin, sipResourceIdentifier, notifyEmail from their email address.

Sample Code

Example XML Request

<request>
  <procedure>
	<execute namespace="Hosted Unified Messaging" procedure="EnableCustomer" impersonate="1">
	<executeData>
		<preferredDomainController>ad01.fabrikam.com</preferredDomainController>
		<path>LDAP:// OU=Alpineskihouse,OU=ConsolidatedMessenger,OU=Hosting,DC=Fabrikam,DC=Com</path> 			
		<numberOfDigitsInExtension>5</numberOfDigitsInExtension>
		<umServer>UMServer1</umServer>
		<pilotIdentifier>5551212</pilotIdentifier>
		<umIPGateway>10.10.10.1</umIPGateway>
		<!-umMailboxPolicy is only required if generateUMMailboxPolicy is not true -->
		<umMailboxPolicy>MailboxPolicy1</umMailboxPolicy>

		<!-Dial plan related optional parameters -->
		<accessTelephoneNumbers>
			<accessTelephoneNumber>5551212</accessTelephoneNumber>
			<accessTelephoneNumber>5551213</accessTelephoneNumber>
		</accessTelephoneNumbers>
		<faxEnabled>true</faxEnabled>
		<generateUMMailboxPolicy>true</generateUMMailboxPolicy>
		<ndrEnabled>true</ndrEnabled>
		<dialPlanTemplateInstance>BaseDialPlan</dialPlanTemlateInstance>
		<uriType>uritype</uriType>
		<voIPSecurity>Secured</voIPSecurity>

		<!-Hunt group related optional parameters -->
		<huntGroupTemplateInstance>baseHuntGroup</huntGroupTemlateInstance>

		<!-Mailbox related optional parameters -->
		<!-If enableExistingMailboxes is missing false is assumed and all other
		 Optional parameters are ignored -->
		<enableExistingMailboxes>true</enableExistingMailboxes>
		<automaticSpeechRecognitionEnabled>true</automaticSpeechRecognitionEnabled>
		<pinExpired>true</pinExpired>
		<!-If pinLength is 0 or absent, no pin is set or returned -->
		<pinLength>4</pinLength>
	</executeData>
	<after source="executeData" destination="data" />
	</execute>
  </procedure>
</request>

Example XML Response

<response>
  <data>
	 <enabledMailboxes>
		<mailbox path="LDAP://CN=User@Alpineskihouse.com,OU=consolidatedmessenger,OU=Hosting,DC=fabrikam,DC=com" pin="1234"/>
	 </enabledMailboxes>
  </data>
</response>

Applies To