Share via

Hosted Unified Messaging::DisableCustomer

  • Article

This procedure disables a customer and all the customers' users for unified messaging.

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.

<keepProperties>

No

This parameter causes the provider to keep the maiboxes unified messaging properties after the mailbox is disabled for unified messaging.

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. For each mailbox in the customer organization

    • Hosted Unified Messaging::DisableMailbox

  2. Managed Helpers::GetServicePointer_ to get the service point data.

  3. If mailbox policy was generated

    • Managed Unified Messaging::RemoveUMMailboxPolicy

  4. Managed Unified Messaging::RemoveUMDialPlan

  5. Managed Unified Messaging::RemoveUMHuntGroup

  6. Managed Helpers::DeleteServicePointer_

  7. Hosted Unified Messaging::Unsubscribe

Sample Code

Example XML Request

<request> 
  <procedure> 
    <execute namespace="Hosted Unified Messaging" procedure="DisableCustomer" impersonate="1"> 
      <executeData> 
        <path>LDAP:// OU=Alpineskihouse,OU=ConsolidatedMessenger,OU=Hosting,DC=Fabrikam,DC=Com</path> 
        <keepProperties>false</keepProperties> 
        <preferredDomainController>ad01.fabrikam.com</preferredDomainController> 
      </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