Calling Party Category

Calling Party Category

The CallingPartyCategory operation selects an exit according to the caller category. The caller category is determined by mapping protocol-specific netwok information to categories within platform configuration.

For INAP and CAMEL networks, the mapping uses InitialDP callingPartysCategory information element values. For example, calls with callingPartysCategory value 15 are generally recognised as payphone calls.

For SIP networks, the mapping uses calling party number prefixes. For example, all New Zealand telephone numbers that start with 022 are generally recognised as mobile telephone numbers.

The CallingPartyCategory operation must have at least one exit. The CallingPartyCategory operation is only useful when it has more than one exit, although this is not enforced by the operation definition.

Config Parameters

The CallingPartyCategory operation config attributes are as follows.

Parameter Type Description
rules Array of
Object
[Required] The rules Array must contain zero or more Objects.

Config Rules

The attributes for each CallingPartyCategory operation rules Object are as follows.

Parameter Type Description
type String [Required] Callers in this type (category) will be routed to the associated exit.
The value must be one of: international, landline, mobile, payphone, or default.
exit_idx Integer [Required] The zero-based index number of the exit to use for routing calls with the specified type.

Note that if the caller category matches more than one rule, the following priority order will apply: international, landline, mobile, payphone, default.

Exit index 0 will be followed if the caller category does not match any of the rules.

Example Operation

Here is an example CallingPartyCategory operation in JSON representation.

    {
        "id": 5,
        "type": "CallingPartyCategory",
        "config": {
            "rules": [
                { "type": "payphone", "exit_idx": 1 },
            ]
        },
        "exits": [ 4, 17 ]
    }

In this example, calls from payphones will proceed via exit index 1 to the operation with ID 17, while all other calls will proceed via exit index 0 to the operation with ID 4.

Exits

The first exit is always the “Default” exit.

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