Calling Party
Calling Party
The CallingParty operation selects an exit according to the best-match prefix for the
Calling Party Number. This operation is similar to a Location Routing operation with
“Calling Party Number” as source buffer. The main differences are that CallingParty operation
prefixes are operation-specific and not hierarchical.
The CallingParty operation must have at least one exit. The CallingParty operation is only
useful when it has more than one exit, although this is not enforced by the operation definition.
Config Parameters
The CallingParty 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 CallingParty operation rules Object are as follows.
| Parameter | Type | Description |
|---|---|---|
prefix
|
Telephony Digits | [Required] The prefix which must be the best match for the Calling Party Number in order to select the associated exit. |
exit_idx
|
Integer |
[Required] The zero-based index number of the exit to select when prefix is the best match for the Calling Party Number.
|
Note that if the Calling Party Number matches more than one prefix, the best-matching (longest) prefix will be used.
If the Calling Party Number does not match any prefixes, the first exit (exit index 0) will be selected.
Example Operation
Here is an example CallingParty operation in JSON representation.
{
"id": 5,
"type": "CallingParty",
"config": {
"rules": [
{ "prefix": "021", "exit_idx": 1 },
{ "prefix": "022", "exit_idx": 1 },
{ "prefix": "027", "exit_idx": 1 }
]
},
"exits": [ 4, 17 ]
}
In this example, calls for which the Calling Party Number starts with 021, 022, or 027 will be routed
via exit index 1 to the operation with ID 17. All other calls will be routed via the default 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 CallingParty operations must have at least one exit.
|
1
|
Exit #2 + | Additional exits may be present. |