Calling Party
N2FE Flow Operation - Calling Party
The CallingParty
selects an exit according to best-matching of the Calling Party’s
logical address against a list of prefixes defined in the operation instance. This operation is
similar to the CallerLocation
operation, but with two key differences:
- In the case of a ported number, this operation uses the “logical address”.
- The matching prefixes are specific to this particular operation instance.
The “logical address” is the caller’s “directory number” or public phone number associated with the caller. In many cases, the caller’s “logical address” is the same as their “network address” (physical handset routing number), although in some networks with number porting logic present, these addresses may differ.
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 none or more Objects.
|
Config Rules
A CallingParty
operation rules
Object is as follows.
Parameter | Type | Description |
---|---|---|
prefix
|
String | The prefix which must match in order to branch down the associated exit. |
exit_idx
|
Integer | The zero-based index number down which to route calls from callers with address matching this prefix. |
Note that if one or more prefixes match, then the longest (best match) prefix will be used.
If no prefix matches, then the first exit (index zero) will be followed for Default processing.
Example Operation
Here is an example CallingParty
operation in JSON representation.
{
"id": 5,
"type": "CallingParty",
"base_node": 1,
"config": {
"rules": [
{ "prefix": "021", "exit_idx": 1 },
{ "prefix": "022", "exit_idx": 1 },
{ "prefix": "027", "exit_idx": 1 }
]
},
"exits": [ 4, 17 ]
}
In this example, calls from a calling party with a prefix of 021
, 022
or 027
will proceed
down exit 1
to operation ID 17
, while all other calls will down exit index 0
to operation 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.
|