Methods to manage Destination Sets

All methods below support trusted mode. Supply i_customer (Integer) in that mode. The customer must have system management permissions.

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. Default is 0 (DISABLED).
    • 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 and Sippy 2025.
  • cli_translation_rule - String. Optional. Available in Sippy Freightswitch and Sippy 2025.

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_type is 2 (IMPORTABLE), the applicable fields are name, remote_management_key, notify_on_import_error, cld_translation_rule, and cli_translation_rule. Billing and local calling fields apply to DISABLED and EXPORTABLE destination sets.

  • i_destination_set - ID of the destination set to update. Integer. Required.
  • remote_management_type - Integer. Optional. Defaults to the current type. Value 2 requires remote_management_key.
    • 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 - Post-call surcharge percentage. Double. Optional. For example, 5 means 5%.
  • 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 and Sippy 2025.
  • cli_translation_rule - String. Optional. Available in Sippy Freightswitch and Sippy 2025. 

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. Supply exactly one of i_destination_set or name. 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 both billing/local calling and import fields. Boolean. Optional. Default is false.

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.

    

DISABLED and 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. Returned for EXPORTABLE sets or when include_all_fields is true, if available.

       

     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 - Case-insensitive SQL pattern to filter names. String. Optional. Default is % (all names).
  • name_not_clause - Exclude names matching name_pattern. Boolean. Optional. Default is false.
  • i_destination_set - Filter by destination set ID. Integer. Optional. Combined with the name filter.
  • offset - Number of records to skip. Non-negative integer. Optional. Default is 0.
  • limit - Maximum records to return. Non-negative integer. Optional. Default is no limit; 0 returns an empty list.

Returns:

  • result - OK - String.
  • list- Array of destination set structures, ordered by name and iso_4217. No pagination metadata is returned. Common fields are described under getDestinationSetInfo, with these differences:
    • Fields for all remote management types are included.
    • post_call_surcharge - Fraction, e.g. 0.05 for 5%.
    • first_ts, last_ts - First and last import failure times as Unix timestamps. Numeric or nil.
    • now_ts - Current Unix timestamp. Numeric.
    • export_key - Export key for EXPORTABLE sets, if available. String. Internal local_id is omitted.
  • 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.
  • i_destination_set - ID of the deleted destination set. Integer.
  • XMLRPC fault in case of any error.

Methods to manage Destination Set Routes


getDestinationSetRoutesList()

Lists all route versions, ordered by prefix ascending, then activation_date descending. Available since Sippy 2024.

Parameters:

  • i_destination_set - Integer. Required.
  • offset - Number of routes to skip. Non-negative integer. Optional. Default is 0.
  • limit - Maximum number of routes per page. Integer from 1 to 1000. Optional. Default is 50.

Returns:

  • result - OK - String.
  • routes - array of routes:
         • i_route - unique identifier of route. Integer.
         • prefix - prefix of the route. String.
         • price_1 - price 1 (per min). Double.
         • price_n - price n (per min). Double.
         • interval_1 - interval 1 (sec). Integer.
         • interval_n - interval n (sec). Integer.
         • activation_date - activation date. Time stamp dateTime.iso8601 format in UTC
         • expiration_date - expiration date. Time stamp dateTime.iso8601 format in UTC. nil means never expired.
    If local_calling is enabled on a Destination Set, additional fields are included:
         • local_price_1 - local price 1 (per min). Double.
         • local_price_n - local price n (per min). Double.
         • local_interval_1 - local interval 1 (sec). Integer.
         • local_interval_n - local interval n (sec). Integer.
         • area_name - area name (associated geographic region). String.
  • pagination - Pagination information
    • page - Current page, starting from 1. Integer.
    • items_per_page - Number of items per page. Integer.
    • total_items - Total number of routes in the destination set before pagination. Integer.
  • XMLRPC fault in case of any error.

addRouteToDestinationSet()

Adds a route version. Older versions active at the new activation time expire at that time.

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()

Updates all route versions matching i_destination_set and prefix. At least one optional parameter is required.

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()

Removes all route versions matching i_destination_set and prefix.

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.