Methods to manage Destination Sets

addDestinationSet()

This application is used to create a destination set.

Parameters:

  • name - Name of the destination set. String. Required.
  • currency - ISO4217 currency code, i.e. 'USD'. String. Required.
  • description - String. Optional.
  • post_call_surcharge - Double. Optional.
  • connect_fee - Double. Optional.
  • free_seconds - Integer. Optional.
  • grace_period - Integer. Optional.

Returns:

  • result - OK - String.
  • i_destination_set - ID of the created destination set. Integer.
  • XMLRPC fault in case of any error.

updateDestinationSet()

This application is used to update a destination set. Available since Sippy 2024.

Parameters:

when `remote_management_key` is 2(importable), only name and two fields listed below are updated.

  • i_destination_set - ID of the destination set to update. Integer. Required.
  • remote_management_type - Integer. Required
    • 0 - DISABLED
    • 1 - EXPORTABLE: exportable destination set.
    • 2 - IMPORTABLE: importable destination set with `remote_management_key`.
  • name - Name of the destination set. String. Optional.
  • local_calling_cli_validation_rule - cli rule to validate. String. Optional.
  • local_calling - Boolean. Optional.
  • remote_management_key - String. Optional
    • Should be updated when `remote_management_type` is 2(importable) only.
  • free_seconds - Integer. Optional.
  • grace_period - Integer. Optional.
  • post_call_surcharge - Double. Optional.
  • connect_fee - Double. Optional.
  • notify_on_import_error - Boolean. Optional
    • Should be updated when `remote_management_type` is 2(importable)  only.

Returns:

  • result - OK - String.
  • i_destination_set - ID of the updated destination set. Integer.
  • XMLRPC fault in case of any error.

listDestinationSets()

This application is used to list destination sets.

Parameters:

  • name_pattern - Pattern to filter destination sets by name (SQL syntax for the LIKE operator is used). String. Optional.
  • i_destination_set - Integer. Optional.

Returns:

  • result - OK - String.
  • list - Array of dictionaries.
  • XMLRPC fault in case of any error.

deleteDestinationSet()

This application is used to remove a destination set. Available since Sippy 2024. 

Parameters:

  • i_destination_set - ID of the destination set to delete. Integer. Required.

Returns:

  • result - OK - String.
  • XMLRPC fault in case of any error.

Methods to manage Destination Set Routes


getDestinationSetRoutesList()

This application is used to list routes of a destination set. Available since Sippy 2024.

Parameters:

  • i_destination_set - Integer. Required.

Returns:

  • result - OK - String.
  • list - Array of dictionaries.
  • XMLRPC fault in case of any error.

addRouteToDestinationSet()

This application is used to add a route to a destination set.

Parameters:

  • i_destination_set - ID of the destination set to add route to. Integer. Required.
  • prefix - Route prefix. String. Required.


  • preference - Integer. Optional.
  • huntstop - Integer. Optional.
  • timeout - Integer. Optional. (timeout_2xx parameter)
  • price_1 - Double. Optional.
  • price_n - Double. Optional.
  • interval_1 - Integer. Optional.
  • interval_n - Integer. Optional.
  • timeout_1xx - Integer. Optional.
  • forbidden - Boolean. Optional.

Returns:

  • result - OK - String.
  • XMLRPC fault in case of any error.

updateRouteInDestinationSet()

This application is used to update a route in a destination set.

Parameters:

  • i_destination_set - ID of the destination set. Integer. Required.
  • prefix - Route prefix. String. Required.


  • new_prefix - String. Optional.
  • preference - Integer. Optional.
  • huntstop - Integer. Optional.
  • timeout - Integer. Optional. (timeout_2xx parameter)
  • price_1 - Double. Optional.
  • price_n - Double. Optional.
  • interval_1 - Integer. Optional.
  • interval_n - Integer. Optional.
  • timeout_1xx - Integer. Optional.
  • forbidden - Boolean. Optional.

Returns:

  • result - OK - String.
  • XMLRPC fault in case of any error.

delRouteFromDestinationSet()

This application is used to remove a route from a destination set.

Parameters:

  • i_destination_set - ID of the destination set to delete route from. Integer. Required.
  • prefix - Route prefix. String. Required.

Returns:

  • result - OK - String.
  • XMLRPC fault in case of any error.

deleteAllRoutesInDestinationSet()

This application is used to remove all routes from a destination set. Available since Sippy 2024. 

Parameters:

  • i_destination_set - ID of the destination set to delete all of the routes from. Integer. Required.

Returns:

  • result - OK - String.
  • XMLRPC fault in case of any error.