Remove Numbers

Removes a singular or range of numbers from the entire Broadworks instance.

Numbers need to be strings and follow this format: +{country code}-{number}.

The script makes use of the following methods:

api.dns.delete_group_dns()
api.dns.delete_service_provider_dns()

Parameters

• service_provider_id (str): Service Provider/ Enterprise ID where Group is located which hosts target numbers.

• group_id (str): Group ID where target numbers are located.

• start_of_number_range (str): Starting number in range of numbers you would like to remove.

• end_of_number_range (str): Ending nummber in range of numbers you would like to remove. If you need to remove only one number do not enter a value for this paramter. Defaults to None.

Return

• Bool: Returns a True value once complete.

How To Use:

This method requires keyword arguments i.e. group_id="group_id"

assistant = Scripter(my_api)

assistant.move_numbers(
    service_provider_id="ServiceProviderID-A",
    group_id="GroupID-A",
    start_of_range_number="[phone]",
    end_of_range_number="[phone]"
)

# Removes the range 234567891 from Broadworks instance.
assistant.move_numbers(
    service_provider_id="ServiceProviderID-A",
    group_id="GroupID-A",
    start_of_range_number="[phone]"
)