Navigation :

Suburb Routing

The SuburbRouting operation is a LocationRouting operation with a preliminary PrefixMapLookup operation.

The PrefixMapLookup operation finds the best match Suburb for the Calling Party in a prefix mapping set that maps Calling Party prefixes to Suburb IDs.

The LocationRouting operation then enables flexible Suburb routing logic by making use of a geography set that contains a hierarchical collection of Suburb IDs.

Config Parameters

The SuburbRouting operation config attributes are as follows.

Parameter	Type	Description
`prefix_mapping_set_name`	String	[Required] The name of a prefix mapping set that maps Calling Party prefixes to Suburb IDs.
`no_prefix_mapping_exit_idx`	Integer	[Required] The zero-based index number of the exit to use when the Calling Party has no Suburb ID mapping in the prefix mapping set specified by `prefix_mapping_set_name`.
`geography_set`	String	[Required] The name of a geography set that contains Suburb IDs, which is owned by (or accessible to) the same customer that owns the service and flow. This set must contain all of the geographic entries referenced within the operation `rules`.
`geography_set_customer_name`	String	[Required] The name of the customer that owns `geography_set`.
`rules`	Array of Object	The `rules` Array must contain zero or more Objects.
`default_location_routing_exit_idx`	Integer	[Required] The zero-based index number of the exit to use as the default exit when the Calling Party maps to a Suburb ID that does not match any `LocationRouting` `rules`.

Example Operation

Here is an example SuburbRouting operation in JSON representation.

    {
        "id": "4",
        "type": "SuburbRouting",
        "config": {
            "prefix_mapping_set_name": "Telephone Number To Suburb ID",
            "no_prefix_mapping_exit_idx": 0,
            "geography_set": "London Boroughs & Suburbs",
            "geography_set_customer_name": "Main Customer",
            "default_location_routing_exit_idx": 0,
            "rules": [
                {
                    "geography_entry": "Notting Hill",
                    "exit_idx": 1,
                },
                {
                    "geography_entry": "Croydon",
                    "exit_idx": 2
                }
            ]
        },
        "exits": [ 1, 2, 3 ]
    }

In this example the Calling Party is mapped to a Suburb ID using the Telephone Number To Suburb ID prefix mapping set.

If there is no suburb mapping, processing will continue via exit index 0 to the operation with ID 1.

If the mapped Suburb ID is anywhere below the Notting Hill entry in the London Boroughs & Suburbs geography set (i.e. if the call is from the Notting Hill suburb), processing will continue via exit index 1 to the operation with ID 2.

Likewise, if the call is from any suburb within the Croydon borough, processing will continue via exit index 2 to the operation with ID 3.

All other calls will be routed via the default location routing exit index 0 to the operation with ID 1.

Exits

The no-prefix-mapping and default-location-routing exits are explicitly specified using the no_prefix_mapping_exit_idx and default_location_routing_exit_idx configuration fields.

Exit Index	Name	Description
`0`	Exit #1	[Required] All `SuburbRouting` operations must have at least one exit.
`1`	Exit #2 +	Additional exits may be present.