Selector Rules
Selector Rules
Selector Rules are used in various configuration contexts to define rules for selecting a value for a parameter based on a list of rules.
Rules are matched based on selectors to fields in the InitialDP
(e.g. MSC address), derived from it (e.g. normalised
calling party), or configured tags. Each
rule must provide a value, either as a literal
or copied from an InitialDP
, derived, or tag field. All selectors in
a rule must match in order for the rule to be selected. If no selectors are present (e.g. only a literal
is
configured), the rule will always match, acting as a catch-all.
Rules are traversed in order, and the first matching rule found will have its value extracted.
Note that, depending on the source network and the InitialDP
→ eventTypeBCSM
, some fields may not be
available for selection. In such cases, rules using these fields will assume no value is present.
An example configuration extract might be:
<config>
<diameter>
<request>
<service_identifiers>
<rule eventTypeBCSM="3" serviceKey="1" bearerCap_itc="0" literal="201"/>
<rule serviceKey="1" bearerCap_itc="0" literal="201"/>
<rule serviceKey="1" literal="201"/>
<rule serviceKey="2" literal="202"/>
<rule bearerCap_itc="8" literal="301"/>
<rule callingPartysCategory_hex="8" literal="401"/>
<rule location="roaming" literal="402" />
<rule literal="501"/>
</service_identifiers>
<rating_groups>
<rule service_key="1" literal="2"/>
<rule literal="2"/>
</rating_groups>
<requested_times>
<rule literal="60"/>
</requested_times>
The service_identifier
rules here will attempt to assign a Diameter Service-Identifier
based
on the service key, bearer capability, calling party category, or derived location, with a fallback value if no
deeper match occurs. The rating_group
rules will check service key only, with a fallback value
used otherwise. All InitialDP
messages rececived will always use 60
as the Diameter
Requested-Service-Unit
.CC-Time
value from the fallback rule.
Match Inversion
Some fields in selector rules may have their match be made inverted. To do this, add the character !
to the start of
the match value.
If the string to be matched starts with an exclamation mark, add an additional !
, i.e. !!
for a normal match
and !!!
for an inverted match.
Some examples of using and not using inversion:
- rule specifies
abc
(match onlyabc
):- against actual value
abc
: match - against actual value
abd
: no match - against actual value
!abc
: no match - against actual value
!abd
: no match
- against actual value
- rule specifies
!abc
(match anything that is notabc
):- against actual value
abc
: no match - against actual value
abd
: match - against actual value
!abc
: match - against actual value
!abd
: match
- against actual value
- rule specifies
!!abc
(match only!abc
):- against actual value
abc
: no match - against actual value
abd
: no match - against actual value
!abc
: match - against actual value
!abd
: no match
- against actual value
- rule specifies
!!!abc
(match anything that is not!abc
):- against actual value
abc
: match - against actual value
abd
: match - against actual value
!abc
: no match - against actual value
!abd
: match
- against actual value
Refer to the specific field information for details of which fields can have their match inverted.
Configuration Details
Each rule
object for IDP selection can support the following attributes:
Attribute | Type | Can Invert? | Description |
---|---|---|---|
literal |
String | No | [Conditional] The literal value to return when the rule is selected. One of literal , idp , or from_tag must be present for each rule. |
idp |
String | No | [Conditional] An available field name to return as the value when the rule is selected. Multiple fields may be separated by a comma, and will be concatenated (if populated). One of literal , idp , or from_tag must be present for each rule. |
from_tag |
String | No | [Conditional] A tag name to return the value of when the rule is selected. Multiple tags may be separated by a comma, and will be concatenated (if populated). One of literal , idp , or from_tag must be present for each rule. |
tag |
String | No | [Conditional] Selector for a tag name to match the value for. If tag is present, value must also be present. |
r_index |
Integer | No | For idp and from_tag source selection, r_index can be used to specify the starting index for value retrieval. Positive values count from the start of the string (zero-indexed), and negative values count from the end. Used in conjunction with r_len to provide any substring of the selected value, including prefix or suffix.(Default: 0 , copy from the start of the string) |
r_len |
Positive Integer | No | For idp and from_tag source selection, r_len can be used to specify the returned length of the selected value. Used in conjunction with r_index to provide any substring of the selected value, including prefix or suffix.(Default: the selected value’s remaining length after r_index has been applied) |
tag_prefix |
String | No | [Conditional] Selector for a tag name to match the value prefix for. If tag_prefix is present, value must also be present. |
tag_x |
String | No | [Conditional] As for tag , but with x representing a unique pairing, e.g. tag_1 or tag_a . A matching value_x must also be present. |
tag_prefix_x |
String | No | [Conditional] As for tag_x , but for matching against the value prefix. A matching value_x must also be present. |
value |
(various) | Yes | [Conditional] The string or integer value to match against during rule selection. Required when either tag or tag_prefix is present. |
value_x |
(various) | Yes | [Conditional] As for value , but with x representing a unique pairing, e.g. value_1 or value_a . A matching tag_x or tag_prefix_x must also be present. |
originating |
Boolean | No | Whether this rule applies for originating calls. (Default: true ) |
forwarding |
Boolean | No | Whether this rule applies for forwarding calls. (Default: true ) |
terminating |
Boolean | No | Whether this rule applies for terminating calls. (Default: true ) |
at_initial |
Boolean | No | Whether this rule applies at the initial OCS interrogation, i.e. the Diameter CC-Request-Type is 1 (INITIAL_REQUEST ).(Default: true ) |
at_update |
Boolean | No | Whether this rule applies at interim OCS interrogations, i.e. the Diameter CC-Request-Type is 2 (UPDATE_REQUEST ).(Default: true ) |
at_terminate |
Boolean | No | Whether this rule applies at the final OCS interrogation, i.e. the Diameter CC-Request-Type is 3 (TERMINATE_REQUEST ).(Default: false ) |
(other available fields) | (various) | Yes | Any number of available fields. |
Available Fields
Literal Special Cases
For requested time rules, the literal value none
may
be specified to send a Requested-Service-Unit
AVP without any child AVPs.
Initial DP Fields
The following fields sourced from the IDP are available as parameter names for action rule selectors and for value extraction when using the idp
source type parameter.
Note that the idp
is added by default if it is not already present for the key namespace.
Attribute | Type | Description |
---|---|---|
idp.normalised_calling_party |
String | Alias for callingPartyNumber_digits_n . |
idp.normalised_called_party |
String | Alias for calledPartyNumber_digits_n or calledPartyBCDNumber_digits_n (whichever is populated) May be modified if special number translation or CUG action lookup has occurred. |
idp.normalised_redirecting_party |
String | Alias for redirectingPartyID_digits_n . |
idp.normalised_logical_party |
String | Alias for idp.normalised_calling_party , idp.normalised_called_party , or idp.normalised_redirecting_party for originating, terminating, or forwarding calls, respectively. |
idp.normalised_other_party |
String | Alias for idp.normalised_called_party or idp.normalised_calling_party for originating/forwarding or terminating calls, respectively. |
idp.eventTypeBCSM |
Integer | Selector for the InitialDP → eventTypeBCSM decoded value. |
idp.serviceKey |
Integer | Selector for the InitialDP → serviceKey decoded value. |
idp.iMSI_length_min |
String | The minimum length of the InitialDP → iMSI decoded digits. |
idp.iMSI_length_max |
String | The maximum length of the InitialDP → iMSI decoded digits. |
idp.iMSI_digits |
String | Selector for the InitialDP → iMSI decoded digits. |
idp.iMSI_prefix |
String | Selector for the InitialDP → iMSI decoded digits prefix. |
idp.iMSI_mcc_mnc |
String | Selector for the MCC and MNC digits portion of the InitialDP → iMSI decoded digits. |
idp.callingPartyNumber_length_min |
String | The minimum length of the InitialDP → callingPartyNumber decoded digits. |
idp.callingPartyNumber_length_max |
String | The maximum length of the InitialDP → callingPartyNumber decoded digits. |
idp.callingPartyNumber_digits |
String | Selector for the InitialDP → callingPartyNumber decoded digits. |
idp.callingPartyNumber_length_min_n |
String | The minimum length of the normalised InitialDP → callingPartyNumber decoded digits. |
idp.callingPartyNumber_length_max_n |
String | The maximum length of the normalised InitialDP → callingPartyNumber decoded digits. |
idp.callingPartyNumber_digits_n |
String | Selector for the normalised InitialDP → callingPartyNumber decoded digits. |
idp.callingPartyNumber_prefix |
String | Selector for the InitialDP → callingPartyNumber decoded digits prefix. |
idp.callingPartyNumber_prefix_n |
String | Selector for the normalised InitialDP → callingPartyNumber decoded digits prefix. |
idp.callingPartyNumber_noa |
Integer | Selector for the InitialDP → callingPartyNumber → Nature of address indicator decoded value. |
idp.callingPartyNumber_npi |
Integer | Selector for the InitialDP → callingPartyNumber → Numbering plan indicator decoded value. |
idp.callingPartyNumber_pri |
Integer | Selector for the InitialDP → callingPartyNumber → Address presentation restricted indicator decoded value. |
idp.callingPartyNumber_si |
Integer | Selector for the InitialDP → callingPartyNumber → Screening indicator decoded value. |
idp.callingPartyNumber_ni |
Integer | Selector for the InitialDP → callingPartyNumber → Number incomplete indicator decoded value. |
idp.callingPartysCategory_hex |
String | Selector for the InitialDP → callingPartysCategory received value. |
idp.calledPartyNumber_length_min |
String | The minimum length of the InitialDP → calledPartyNumber decoded digits. |
idp.calledPartyNumber_length_max |
String | The maximum length of the InitialDP → calledPartyNumber decoded digits. |
idp.calledPartyNumber_digits |
String | Selector for the InitialDP → calledPartyNumber decoded digits. |
idp.calledPartyNumber_length_min_n |
String | The minimum length of the normalised InitialDP → calledPartyNumber decoded digits. |
idp.calledPartyNumber_length_max_n |
String | The maximum length of the normalised InitialDP → calledPartyNumber decoded digits. |
idp.calledPartyNumber_digits_n |
String | Selector for the normalised InitialDP → calledPartyNumber decoded digits. |
idp.calledPartyNumber_prefix |
String | Selector for the InitialDP → calledPartyNumber decoded digits prefix. |
idp.calledPartyNumber_prefix_n |
String | Selector for the normalised InitialDP → calledPartyNumber decoded digits prefix. |
idp.calledPartyNumber_noa |
Integer | Selector for the InitialDP → calledPartyNumber → Nature of address indicator decoded value. |
idp.calledPartyNumber_npi |
Integer | Selector for the InitialDP → calledPartyNumber → Numbering plan indicator decoded value. |
idp.calledPartyNumber_pri |
Integer | Selector for the InitialDP → calledPartyNumber → Address presentation restricted indicator decoded value. |
idp.calledPartyNumber_si |
Integer | Selector for the InitialDP → calledPartyNumber → Screening indicator decoded value. |
idp.calledPartyNumber_inn |
Integer | Selector for the InitialDP → calledPartyNumber → Internal network number indicator decoded value. |
idp.calledPartyBCDNumber_length_min |
String | The minimum length of the InitialDP → calledPartyBCDNumber decoded digits. |
idp.calledPartyBCDNumber_length_max |
String | The maximum length of the InitialDP → calledPartyBCDNumber decoded digits. |
idp.calledPartyBCDNumber_digits |
String | Selector for the InitialDP → calledPartyBCDNumber decoded digits. |
idp.calledPartyBCDNumber_length_min_n |
String | The minimum length of the normalised InitialDP → calledPartyBCDNumber decoded digits. |
idp.calledPartyBCDNumber_length_max_n |
String | The maximum length of the normalised InitialDP → calledPartyBCDNumber decoded digits. |
idp.calledPartyBCDNumber_digits_n |
String | Selector for the normalised InitialDP → calledPartyBCDNumber decoded digits. |
idp.calledPartyBCDNumber_prefix |
String | Selector for the InitialDP → calledPartyBCDNumber decoded digits prefix. |
idp.calledPartyBCDNumber_prefix_n |
String | Selector for the normalised InitialDP → calledPartyBCDNumber decoded digits prefix. |
idp.calledPartyBCDNumber_noa |
Integer | Selector for the InitialDP → calledPartyBCDNumber → Nature of address indicator decoded value. |
idp.calledPartyBCDNumber_npi |
Integer | Selector for the InitialDP → calledPartyBCDNumber → Numbering plan indicator decoded value. |
idp.redirectionInformation_ind |
Integer | Selector for the InitialDP → redirectionInformation → Redirecting indicator decoded value. |
idp.redirectionInformation_orig |
Integer | Selector for the InitialDP → redirectionInformation → Original redirecting reason decoded value. |
idp.redirectionInformation_num |
Integer | Selector for the InitialDP → redirectionInformation → Redirection counter decoded value. |
idp.redirectionInformation_nat |
Integer | Selector for the InitialDP → redirectionInformation → National indicator decoded value. |
idp.redirectionInformation_reason |
Integer | Selector for the InitialDP → redirectionInformation → Redirecting reason decoded value. |
idp.redirectingPartyID_length_min |
String | The minimum length of the InitialDP → redirectingPartyID decoded digits. |
idp.redirectingPartyID_length_max |
String | The maximum length of the InitialDP → redirectingPartyID decoded digits. |
idp.redirectingPartyID_digits |
String | Selector for the InitialDP → redirectingPartyID decoded digits. |
idp.redirectingPartyID_length_min_n |
String | The minimum length of the normalised InitialDP → redirectingPartyID decoded digits. |
idp.redirectingPartyID_length_max_n |
String | The maximum length of the normalised InitialDP → redirectingPartyID decoded digits. |
idp.redirectingPartyID_digits_n |
String | Selector for the normalised InitialDP → redirectingPartyID decoded digits. |
idp.redirectingPartyID_prefix |
String | Selector for the InitialDP → redirectingPartyID decoded digits prefix. |
idp.redirectingPartyID_prefix_n |
String | Selector for the normalised InitialDP → callingPartyNumber . InitialDP → redirectingPartyID decoded digits prefix. |
idp.redirectingPartyID_noa |
String | Selector for the InitialDP → redirectingPartyID → Nature of address indicator decoded value. |
idp.redirectingPartyID_npi |
String | Selector for the InitialDP → redirectingPartyID → Numbering plan indicator decoded value. |
idp.redirectingPartyID_pri |
String | Selector for the InitialDP → redirectingPartyID → Address presentation restricted indicator decoded value. |
idp.originalCalledPartyID_length_min |
String | The minimum length of the InitialDP → originalCalledPartyID decoded digits. |
idp.originalCalledPartyID_length_max |
String | The maximum length of the InitialDP → originalCalledPartyID decoded digits. |
idp.originalCalledPartyID_digits |
String | Selector for the InitialDP → originalCalledPartyID decoded digits. |
idp.originalCalledPartyID_prefix |
String | Selector for the InitialDP → originalCalledPartyID decoded digits prefix. |
idp.originalCalledPartyID_noa |
Integer | Selector for the InitialDP → originalCalledPartyID → Nature of address indicator decoded value. |
idp.originalCalledPartyID_npi |
Integer | Selector for the InitialDP → originalCalledPartyID → PartyIDing plan indicator decoded value. |
idp.originalCalledPartyID_pri |
Integer | Selector for the InitialDP → originalCalledPartyID → Address presentation restricted indicator decoded value. |
idp.additionalCallingPartyNumber_length_min |
String | The minimum length of the InitialDP → additionalCallingPartyNumber decoded digits. |
idp.additionalCallingPartyNumber_length_max |
String | The maximum length of the InitialDP → additionalCallingPartyNumber decoded digits. |
idp.additionalCallingPartyNumber_digits |
String | Selector for the InitialDP → additionalCallingPartyNumber decoded digits. |
idp.additionalCallingPartyNumber_prefix |
String | Selector for the InitialDP → additionalCallingPartyNumber decoded digits prefix. |
idp.additionalCallingPartyNumber_noa |
Integer | Selector for the InitialDP → additionalCallingPartyNumber → Nature of address indicator decoded value. |
idp.additionalCallingPartyNumber_npi |
Integer | Selector for the InitialDP → additionalCallingPartyNumber → Numbering plan indicator decoded value. |
idp.additionalCallingPartyNumber_nqi |
Integer | Selector for the InitialDP → additionalCallingPartyNumber → Number qualifier indicator decoded value. |
idp.additionalCallingPartyNumber_pri |
Integer | Selector for the InitialDP → additionalCallingPartyNumber → Address presentation restricted indicator decoded value. |
idp.additionalCallingPartyNumber_si |
Integer | Selector for the InitialDP → additionalCallingPartyNumber → Screening indicator decoded value. |
idp.additionalCallingPartyNumber_ni |
Integer | Selector for the InitialDP → additionalCallingPartyNumber → Number incomplete indicator decoded value. |
idp.location |
String | Selector for derived location classification for the call. |
idp.locationNumber_length_min |
String | The minimum length of the InitialDP → locationNumber decoded digits. |
idp.locationNumber_length_max |
String | The maximum length of the InitialDP → locationNumber decoded digits. |
idp.locationNumber_digits |
String | Selector for the InitialDP → locationNumber decoded digits. |
idp.locationNumber_prefix |
String | Selector for the InitialDP → locationNumber decoded digits prefix. |
idp.locationNumber_noa |
Integer | Selector for the InitialDP → locationNumber → Nature of address indicator decoded value. |
idp.locationNumber_npi |
Integer | Selector for the InitialDP → locationNumber → Numbering plan indicator decoded value. |
idp.locationNumber_pri |
Integer | Selector for the InitialDP → locationNumber → Address presentation restricted indicator decoded value. |
idp.locationNumber_si |
Integer | Selector for the InitialDP → locationNumber → Screening indicator decoded value. |
idp.locationNumber_inn |
Integer | Selector for the InitialDP → locationNumber → Internal network number indicator decoded value. |
idp.mscAddress_length_min |
String | The minimum length of the InitialDP → mscAddress decoded digits. |
idp.mscAddress_length_max |
String | The maximum length of the InitialDP → mscAddress decoded digits. |
idp.mscAddress_digits |
String | Selector for the InitialDP → mscAddress decoded digits. |
idp.mscAddress_prefix |
String | Selector for the InitialDP → mscAddress decoded digits prefix. |
idp.mscAddress_noa |
Integer | Selector for the InitialDP → mscAddress → Nature of address indicator decoded value. |
idp.mscAddress_npi |
Integer | Selector for the InitialDP → mscAddress → Numbering plan indicator decoded value. |
idp.vlrNumber_length_min |
String | The minimum length of the InitialDP → locationInformation → vlrNumber decoded digits. |
idp.vlrNumber_length_max |
String | The maximum length of the InitialDP → locationInformation → vlrNumber decoded digits. |
idp.vlrNumber_digits |
String | Selector for the InitialDP → locationInformation → vlrNumber decoded digits. |
idp.vlrNumber_prefix |
String | Selector for the InitialDP → locationInformation → vlrNumber decoded digits prefix. |
idp.vlrNumber_noa |
Integer | Selector for the InitialDP → locationInformation → vlrNumber → Nature of address indicator decoded value. |
idp.vlrNumber_npi |
Integer | Selector for the InitialDP → locationInformation → vlrNumber → Numbering plan indicator decoded value. |
idp.ageOfLocationInformation |
Integer | Selector for the InitialDP → locationInformation → ageOfLocationInformation decoded value. |
idp.cellIdOrLAI_mcc |
String | Selector for the InitialDP → locationInformation → cellIdOrLAI → cellIdFixedLength → Mobile country code or InitialDP → locationInformation → cellGlobalIdOrServiceAreaIdOrLAI → cellGlobalIdOrServiceAreaIdFixedLength → Mobile country code decoded value. |
idp.cellIdOrLAI_mnc |
String | Selector for the InitialDP → locationInformation → cellIdOrLAI → cellIdFixedLength → Mobile country code or InitialDP → locationInformation → cellGlobalIdOrServiceAreaIdOrLAI → cellGlobalIdOrServiceAreaIdFixedLength → Mobile network code decoded value. |
idp.cellIdOrLAI_lac |
String | Selector for the InitialDP → locationInformation → cellIdOrLAI → cellIdFixedLength → Mobile country code or InitialDP → locationInformation → cellGlobalIdOrServiceAreaIdOrLAI → cellGlobalIdOrServiceAreaIdFixedLength → Location area code decoded value. |
idp.cellIdOrLAI_ci |
String | Selector for the InitialDP → locationInformation → cellIdOrLAI → cellIdFixedLength → Mobile country code or InitialDP → locationInformation → cellGlobalIdOrServiceAreaIdOrLAI → cellGlobalIdOrServiceAreaIdFixedLength → Cell ID decoded value. |
idp.cellIdOrLAI_mcc_mnc |
String | Selector for the concatenation of idp.cellIdOrLAI_mcc and idp.cellIdOrLAI_mnc . |
idp.ext-BearerService |
String | Selector for the InitialDP → ext-basicServiceCode → bearerService decoded value, in hex. |
idp.ext-Teleservice |
String | Selector for the InitialDP → ext-basicServiceCode → teleService decoded value, in hex. |
idp.bearerCap_hex |
String | Selector for the InitialDP → bearerCapability decoded value. |
idp.bearerCap_itc |
Integer | Selector for the InitialDP → bearerCapability → Information transfer capability value. |
idp.cf_pending |
Integer | Selector for the InitialDP → gsm-ForwardingPending /callForwardingSS-Pending flag value. |
idp.highLayerCompatibility_hex |
String | Selector for the InitialDP → highLayerCompatibility decoded value. |
idp.callReferenceNumber |
String | Selector for the InitialDP → callReferenceNumber decoded value. |
idp.timeAndTimezone_digits |
String | Selector for the InitialDP → timeAndTimezone decoded value. |
idp.timeAndTimezone_epoch |
Integer | Selector for the InitialDP → timeAndTimezone decoded value as a Unix epoch value. |
idp.timeAndTimezone_offset |
Integer | Selector for the InitialDP → timeAndTimezone decoded value’s timezone offset value. |
idp.ipSSPCapabilities |
Integer | Selector for the InitialDP → ipSSPCapabilities decoded value. |
idp.serviceInteractionIndicators_hex |
String | Selector for the InitialDP → serviceInteractionIndicators_hex decoded value. |
idp.forwardCallIndicators_hex |
String | Selector for the InitialDP → forwardCallIndicators decoded value. |
Dynamic Fields
The following fields are managed automatically by the system as a result of data received or actions performed.
Attribute | Type | Description |
---|---|---|
context.ssp_inap |
String | Selector for the INAP variant received from the initiating SSP, as configured in the appropriate SSP Model inap parameter. Note that the special value camel may be used to refer to any CAMEL variant. |
context.pending_tn |
String | Selector for the current pending termination number that will be used to connect to if the call is allowed. At the start of the call, defaults to normalised_called_party but may be changed by number translation, etc. |
CUG Fields
The following fields sourced from the most recent CUG query (if any) are available as parameter names for action rule selectors and for value extraction when using the idp
source type parameter:
Attribute | Type | Description |
---|---|---|
cug.user_found |
Boolean | 1 if a CUG user was found, otherwise 0 . |
cug.user_number |
String | The user number found in the CUG lookup. Note that this may be different to the match number initially provided for the CUG query. |
cug.group_id |
Integer | The database ID of the CUG group for the CUG user. |
cug.group_name |
String | The name of the CUG user’s CUG group. |
cug.user_id |
Integer | The database ID of the CUG user. |
cug.user_short_code |
String | The short code of the CUG user. |
cug.user_long_number |
String | The long number of the CUG user. |
cug.user_prefix_match |
Boolean | 1 if the CUG user was matched by prefix, otherwise 0 . |
cug.user_range_size |
Integer | The range size of the CUG user. |
cug.user_orig_on_net_allowed |
Boolean | 1 if the CUG user is allowed to make calls within the CUG group, otherwise 0 . |
cug.user_orig_off_net_allowed |
Boolean | 1 if the CUG user is allowed to make calls outside the CUG group, otherwise 0 . |
cug.user_term_on_net_allowed |
Boolean | 1 if the CUG user is allowed to receive calls from within the CUG group, otherwise 0 . |
cug.user_term_off_net_allowed |
Boolean | 1 if the CUG user is allowed to receive calls from outside the CUG group, otherwise 0 . |
cug.match_found |
Boolean | 1 if a CUG match was found, otherwise 0 . |
cug.match_id |
Integer | The database ID of the CUG match user. |
cug.match_short_code |
String | The short code of the CUG match user. |
cug.match_long_number |
String | The long number of the CUG match user. |
cug.match_is_ln |
Boolean | 1 if the match was made against the long number of the CUG match user, otherwise 0 . |
cug.match_is_prefix |
Boolean | 1 if the match was made by prefix, otherwise 0 . |
cug.match_range_size |
Integer | The range size of the CUG match user. |
cug.match_virtual |
Boolean | 1 if the CUG match user is virtual, otherwise 0 . |
cug.match_display_caller_sc |
Boolean | 1 if the caller shortcode was sent for presentation in the Connect messages, otherwise 0 . |
cug.list_found |
Boolean | 1 if a match was made to a blacklist or a whitelist, otherwise 0 . |
cug.list_disallowed |
Boolean | 1 if the applicable list disallowed the call, otherwise 0 . |
cug.list_entry_id |
Integer | The database ID of the applicable list entry number. |
cug.list_whitelist_match |
String | The match number found in the list lookup. Note that this may be different to the match number initially provided for the CUG query. |
cug.list_is_prefix |
Boolean | 1 if the applicable list is a whitelist, otherwise 0 . |