addRoutingGroup()
Available since: V4.5
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. Available starting from 5.1
- onnet_timeout_1xx - 1xx Timeout for On-Net calls. Integer. Optional. Default is 10. Available starting from 5.1
- onnet_timeout_2xx - 2xx Timeout for On-Net calls. Integer. Optional. Default is 60. Available starting from 5.1
Returns:
- result - OK - String.
- i_routing_group - ID of the newly created routing group. Integer.
- XMLRPC fault in case of any error.
listRoutingGroups()
Available since: V4.5
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.
- i_routing_group - Integer. Optional.
Returns:
- result - OK - String.
- list - Array of dictionaries.
- XMLRPC fault in case of any error.
updateRoutingGroup()
Available since: V4.5
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()
Available since: V4.5
This application is used to update 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()
Available since: V4.5
This application is used to add new entries to the routing group.
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.
- 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 activation 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.
Returns:
- result - OK - String.
- i_routing_group_member - The ID of the newly created entry. Integer.
- XMLRPC fault in case of any error
listRoutingGroupMembers()
Available since: V4.5
This application is used to retrieve the entries assigned to the routing group.
Parameters:
- i_routing_group - ID of the routing group. Integer. Required.
- i_routing_group_member - ID of the routing group entry. Integer. Optional.
Returns:
- result - OK - String.
- list- Array of dictionaries.
- XMLRPC fault in case of any error.
delRoutingGroupMember()
Available since: V4.5
This application is used to update a routing group.Parameters:
- i_routing_group - ID of the routing group. Integer. Required.
- i_routing_group_member - ID of the routing group entry. Integer. Required.
Returns:
- result - OK - String.
- XMLRPC fault in case of any error.
updateRoutingGroupMember()
Available since: V4.5
This application is used to update the properties of a routing group.Parameters:
- i_routing_group - ID of the routing group. Integer. Required.
- i_routing_group_member - ID of the routing group entry. Integer. Required.
Other parameters are optional. The list of parameters can be seen in the addRoutingGroupMember() method description.
Returns:
- result - OK - String.
- XMLRPC fault in case of any error.