🔢Move Numbers

my_api.scripter.move_numbers()

Moves a list of numbers from existing group to another group on the same broadworks instance. This can move numbers between Service Provider/ Enterprise and groups in the same Service Provider/ Enterprise.

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

The script makes use of the following methods:

api.delete.group_dns()
api.delete.service_provider_dns()
api.post.group_dns_assign_bulk()
api.post.group_dns()

Parameters

  • current_service_provider_id (str): Current Service Provider/ Enterprise where numbers are located.

  • current_group_id (str): Current Group ID where numbers are located.

  • target_service_provider_id (str): Target Service Provider/ Enterprise to move the numbers to.

  • target_group_id (str): Target Group to move numbers to.

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

  • end_of_number_range (str): Ending nummber in range of numbers you would like to move. If you need to move 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:

from odins_spear import api

my_api= api.Api(base_url="https://base_url/api/vx", username="john.smith", password="ODIN_INSTANCE_1")
my_api.authenticate()

# Moving the range 234567891-3 from GroupID-A to GroupID-B
api.scripter.move_numbers(
    current_service_provider_id="ServiceProviderID-A",
    current_group_id="GroupID-A",
    target_service_provider_id="ServiceProverID-B",
    target_group_id="GroupID-B",
    start_of_range_number="+1-234567891",
    end_of_range_number="+1-234567892"
)


# Moving the number 234567891 from GroupID-A to GroupID-B
api.scripter.move_numbers(
    current_service_provider_id="ServiceProviderID-A",
    current_group_id="GroupID-A",
    target_service_provider_id="ServiceProverID-B",
    target_group_id="GroupID-B",
    start_of_range_number="+1-234567891"
)

Last updated