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.
• remote_management_type - Integer. Optional.
  • 0 - DISABLED
  • 1 - EXPORTABLE: exportable destination set.
  • 2 - IMPORTABLE: importable destination set with `remote_management_key`.
• remote_management_key - String. Optional
  • Should be required when `remote_management_type` is 2(importable) only.
• local_calling - Boolean. Optional.
• local_calling_cli_validation_rule - cli rule to validate. String. Optional.
  • Should be inserted when local_calling is True.
• description - String. Optional.
• post_call_surcharge - Double. Optional.
• notify_on_import_error - Boolean. Optional
  • Should be inserted when `remote_management_type` is 2(importable)  only.
• connect_fee - Double. Optional.
• free_seconds - Integer. Optional.
• grace_period - Integer. Optional.
• cld_translation_rule - String. Optional. Available in Sippy Freightswitch.
• cli_translation_rule - String. Optional. Available in Sippy Freightswitch.

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. Optional.
  • 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.
  • Should be updated when local_calling is True.
• 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.
• cld_translation_rule - String. Optional. Available in Sippy Freightswitch.
• cli_translation_rule - String. Optional. Available in Sippy Freightswitch.

Returns:

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

getDestinationSetInfo()

This application is used to get a destination set detail. Either i_destination_set or name should be supplied. Available since Sippy 2024. 

Parameters:

• i_destination_set - ID of the destination set. Integer. Optional.
• name - Name of destination set. String. Optional.
• include_all_fields - return all fields from both EXPORTABLE and IMPORTABLE if true. Boolean. Optional.

Returns:

• result - OK - String.
• destination_set - Structure with destination set's attributes.
  • i_destination_set - ID. Integer.
  • name - Destination Set name. String.
  • iso_4217 - currency in iso_4217 format (3 letters). String.
  • cld_translation_rule - CLD translation rule. String.
  • cli_translation_rule - CLI translation rule. String.
  • is_remote - Remote type. Boolean.
  • is_exportable - Exportable type. Boolean.

               EXPORTABLE

• post_call_surcharge - Post-call surcharge percentage. Float.
• connect_fee - Connection fee. Float.
• free_seconds - Free seconds provided at start of call. Integer.
• grace_period - Grace period in seconds. Integer.
• local_calling - Local calling enabled flag. Boolean.
• local_calling_cli_validation_rule - CLI validation rule for local calling. String.
• lock_for_upload - Lock status to indicate routes upload processing in progress. Boolean.
• export_key - Base64-encoded exportable key for secure remote access. String.

     IMPORTABLE

• import_health - Current health status of the import process. String.
• first_import_failure_ts - Timestamp of the first import failure. String/Timestamp.
• last_import_failure_ts - Timestamp of the last import failure. String/Timestamp. 
• import_error - Details of the last import error. String.
• import_health_last_notification - Last notification regarding import health. String.
• notify_on_import_error - Flag to notify on import error. Boolean.
• remote_id - Base64-encoded importable key for secure remote access. String

• 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.
• offset - skip first offset records. Integer. Optional.
• limit - return only limit records. Integer. Optional.

Returns:

• result - OK - String.
• list - Array of dictionaries. Refer to getDestinationSetInfo for a full detail of Destination Set data.
• 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.
• activation_date - The activation date. dateTime.iso8601 format in UTC. Optional. Not NULL, if not specified, defaults to now. Available starting from Sippy 2023
  
• expiration_date - The expiration date. dateTime.iso8601 format in UTC. Optional. NULL value means never, if not specified, defaults to never. Available starting from Sippy 2023

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.