addRoutingGroup()

This application is used to create a routing group.

Parameters:

  • name - Name of the routing group. String. Required.
  • policy - Comma separated list of policies. A policy can be "prefix", "preference", "order", "least_cost", "weight". String. Required. Can be empty.
  • description - String. Optional.
  • i_media_relay - Integer. References the i_service key in the services table, only values with i_service_type = 1 (RTPProxy) could be used. Value 1 means built-in RTPProxy, nil corresponds From Connection value. Optional.
  • disable_onnet_routing - Boolean. Optional. Default is true.
  • onnet_i_connection - Integer. References the i_connection key in the connections table. Optional. Default is NULL.
  • disable_onnet_voicemail - Bool. Optional. Default is true.
  • onnet_voicemail_i_connection - Integer. References the i_connection key in the connections table. Optional. Default is NULL.
  • onnet_scope - Integer. Optional. Default is 1. Possible values:
    • 1 - All Accounts
    • 2 - Customer and Sub-Customers
    • 3 - Customer only.
  • lrn_enabled - Boolean. Optional. Default is false.
  • lrn_translation_rule - String. Optional.
  • timeout_2xx - The final 2xx timeout in seconds. Integer. Optional. Default is 300.
  • onnet_timeout_100 - Reply Timeout for On-Net calls. Integer. Optional. Default is 5.
  • onnet_timeout_1xx - 1xx Timeout for On-Net calls. Integer. Optional. Default is 10.
  • onnet_timeout_2xx - 2xx Timeout for On-Net calls. Integer. Optional. Default is 60.
  • stir_shaken_enabled - Whether Stir/Shaken should be enabled for the Routing Group. Boolean. Optional. The default value is false.

Returns:

  • result - OK - String.
  • i_routing_group - ID of the newly created routing group. Integer.
  • XMLRPC fault in case of any error.

listRoutingGroups()

This application is used to retrieve the list of the routing groups with all parameters per each.

Parameters:

  • name_pattern - Pattern to filter routing groups by name (SQL syntax for the LIKE operator is used). String. Optional.
  • name_pattern_not - Pattern to exclude routing groups by name (SQL syntax for the LIKE operator is used). String. Available since version 2025.
  • i_routing_group - Integer. Optional.
  • include_members_count - Boolean. Optional. If true, each list item includes members_count. Available since version 2025.

Returns:

  • result - OK - String.
  • list - Array of dictionaries. Available since version 2025: each item includes safe_to_delete (Boolean). If include_members_count=true, each item also includes members_count (Integer).
  • XMLRPC fault in case of any error.

getRoutingGroupInfo()

This application is used to get a routing group detail. Available since version 2025.

Parameters:

  • i_routing_group - Id of a routing group. Integer. Required.

Returns:

  • result - OK - String.
  • routing_group - Structure with routing group attributes. Available since version 2025: includes safe_to_delete.

XMLRPC fault is returned in case of any error.

updateRoutingGroup()

This application is used to update the properties of a routing group.

Parameters:

  • i_routing_group - ID of the routing group. Integer. Required.

Other parameters are optional. The list of parameters can be seen in the addRoutingGroup() method description.

Returns:

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

delRoutingGroup()

This application is used to delete a routing group.

Parameters:

  • i_routing_group - ID of the routing group. Integer. Required.

Returns:

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

addRoutingGroupMember()

This application is used to add new entries to the routing group. Available since version 2025.

Parameters:

  • i_routing_group - ID of the routing group where the new entry should be added. Integer. Required.
  • i_connection - ID of a vendor connection. Integer. Required in <=2024 and optional since 2025 version.
  • i_connection_group - ID of a connection group. Integer. Optional. Available since version 2025.
  • i_destination_set - ID of a destination set. Integer. Required.
  • preference - The order # of the new record. Integer. Required.
  • activation_date - The activation date. Either dateTime.iso8601 format in UTC or String in format '%H:%M:%S.000 GMT %a %b %d %Y' (e.g. 09:57:29.000 GMT Mon May 29 2017). Optional. Not NULL, if not specified, defaults to now.
  • expiration_date - The expiration date. Either dateTime.iso8601 format in UTC or String in format '%H:%M:%S.000 GMT %a %b %d %Y' (e.g. 13:57:29.000 GMT Mon May 29 2017). Optional. NULL value means never, if not specified, defaults to never.
  • weight - The weight for the weighed distribution policy. Integer. Optional.
  • stir_shaken_as_mode - Stir/Shaken Authentication mode. It can be one of 'supported', 'required', 'preferred', or 'disabled'. String. Optional. The default value is 'supported'.

Returns:

  • result - OK - String.
  • i_routing_group_member - The ID of the newly created entry. Integer.
  • XMLRPC fault in case of any error.

listRoutingGroupMembers()

This application is used to retrieve the entries assigned to the routing group. Available since version 2025.

Parameters:

  • i_routing_group - ID of the routing group. Required.

Returns:

  • result - OK - String.
  • routing_group_members - Array of dictionaries. Each item includes i_routing_group_member, i_routing_group, i_connection, i_connection_group, i_vendor, i_destination_set, preference, activation_date, expiration_date, weight, and stir_shaken_as_mode. Date values use the legacy GMT string format.
  • XMLRPC fault in case of any error.

getRoutingGroupMemberInfo()

This application is used to get a routing group member detail. Available since version 2025.

Parameters:

  • i_routing_group_member - ID of a routing group member. Integer. Required.

Returns:

  • result - OK - String.
  • routing_group_member - Structure with routing group member attributes:
    • i_routing_group_member - Integer.
    • i_routing_group - Integer.
    • i_connection - Integer.
    • i_connection_group - Integer.
    • i_vendor - Integer.
    • i_destination_set - Integer.
    • preference - Integer.
    • activation_date - String.
    • expiration_date - String.
    • weight - Integer.
    • stir_shaken_as_mode - String.

XMLRPC fault is returned in case of any error.

updateRoutingGroupMember()

This application is used to update the properties of a routing group member. Available since version 2025.

Parameters:

  • i_routing_group_member - ID of the routing group entry. Integer. Required.
  • i_routing_group - ID of the routing group. Integer. Required for <=2024 and optional since 2025 version.
  • i_connection - ID of a vendor connection. Integer. Optional.
  • i_connection_group - ID of a connection group. Integer. Optional. Available since version 2025.
  • i_destination_set - ID of a destination set. Integer. Optional.
  • preference - The order # of the entry. Integer. Optional.
  • activation_date - The activation date. Either dateTime.iso8601 format in UTC or String in format '%H:%M:%S.000 GMT %a %b %d %Y'. Optional.
  • expiration_date - The expiration date. Either dateTime.iso8601 format in UTC or String in format '%H:%M:%S.000 GMT %a %b %d %Y'. Optional.
  • weight - The weight for the weighed distribution policy. Integer. Optional.
  • stir_shaken_as_mode - Stir/Shaken Authentication mode. One of 'supported', 'required', 'preferred', or 'disabled'. String. Optional.

Returns:

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

delRoutingGroupMember()

This application is used to delete a routing group member. Available since version 2025.

Parameters:

  • i_routing_group_member - ID of the routing group entry. Integer. Required.
  • i_routing_group - ID of the routing group. Integer. Required for <=2024 and optional since 2025 version.

Returns:

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