Each Attribute Entry object is a child of an Attribute Set object.
Each object defines a single attribute (consisting of a type and a value) that may be added to the routing request during the number validation process.
![]() |
Note that when the grandparent Config Set is active, this object cannot be modified; all fields are read only and all actions are disabled. You must deactivate the grandparent Config Set before you can modify the object. |
Parameter |
Access |
Description |
Attribute type | Change | Type of the attribute defined in this object. See the description of each Attribute value parameter below for more details of each attribute type. Values:
|
Attribute value - allowed carrier call type | Change | This attribute is not valid in the UK. |
Attribute value - allowed dialing pattern | Change | This attribute is not valid in the UK. |
Attribute value - ANI II digits | Change | This attribute is not valid in the UK. |
Attribute value - ANI Screening lookup type | Change | This field appears only if Attribute type is set to ANI Screening lookup. This field is valid only in the US. |
Attribute value - ANI Screening lookup table | Change | This field appears only if Attribute value - ANI Screening lookup type is visible and set to Lookup in specific table. This field is valid only in the US. |
Attribute value - announcement ID | Change | This field appears only if Attribute type is set to Announcement ID.
The announcement ID is optional, and can be set on failure of routing or number validation to request playing of a specific announcement. You cannot set both an Announcement ID and a Customer Announcement ID in the same attribute set. If no announcement ID is specified, and the call cannot be released immediately, the default announcement associated with the error code will be played.
After the announcement has been played, the caller will get dial tone or reorder based on the value of the Line treatment after call disconnect field on the Line Signaling object.
Values:
|
Attribute value - announcement parameter 1 | Change | This field appears only if Attribute type is set to Announcement Parameter 1. Numeric string for the first parameter to be included in the error announcement. This attribute is valid only in an Attribute Set that includes the Announcement ID or Customer Announcement ID attribute. Specify a string of up to 32 digits. Only ASCII digits 0 - 9 are valid. |
Attribute value - announcement parameter 2 | Change | This field appears only if Attribute type is set to Announcement Parameter 2. Numeric string for the second parameter to be included in the error announcement. This attribute is valid only in an Attribute Set that includes the Announcement ID or Customer Announcement ID attribute. Specify a string of up to 32 digits. Only ASCII digits 0 - 9 are valid. |
Attribute value - area code dialed | Change | This field appears only if Attribute type is set to Area code dialed.
Attribute used at an originating exchange to indicate whether the calling subscriber dialed an area code as part of the called number. This is subsequently used by billing. Values:
|
Attribute value - Authorization Code Operation | Change | This field appears only if Attribute type is set to Authorization Code Service. This field is valid only in the US. |
Attribute value - Authorization Code Table | Change | This field appears only if Attribute value - Authorization Code Operation is visible and set to On-Switch Calling Card / Hotline. This field is valid only in the US. |
Attribute value - Valid Authorization Codes | Change | This field appears only if Attribute value - Authorization Code Operation is visible and set to On-Switch Calling Card / Hotline. This field is valid only in the US. |
Attribute value - Authorization Code | Change | This field appears only if Attribute value - Valid Authorization Codes is visible and set to Specific code. This field is valid only in the US. |
Attribute value - Authorization Code Prefix | Change | This field appears only if Attribute type is set to Authorization Code Service. This field is valid only in the US. |
Attribute value - billing - call type | Change | This field appears only if Attribute type is set to Billing - call type. If you need to override the call type in the first billing record for this call, set this attribute in Number Validation to specify the call type to be used. Values:
|
Attribute value - billing - override AIN billing | Change | This field appears only if Attribute type is set to Billing - override AIN billing. This field is valid only in the US. |
Attribute value - billing - structure code | Change | This field appears only if Attribute type is set to Billing - structure code. If you need to override the structure code in the first billing record for this call, specify the structure code to be used. Values:
|
Attribute value - called address complete | Read only | This field appears only if Attribute type is set to Called address complete. In this case, the only valid value is Yes, so this is a read-only field and you cannot specify a value. For calls originating on the switch, line signaling sets the Called address complete attribute to Yes if a digit map match cannot be found or occurred only on timer expiry. Number validation sets the Called address complete attribute to Yes if it knows a number is complete (which is normally always the case unless overlap addressing is being used). |
Attribute value - called address scope | Change | This field appears only if Attribute type is set to Called address scope.
Area within which the called address is unique.
|
Attribute value - called address type | Change | This field appears only if Attribute type is set to Called address type.
Address type of the called address. Number validation uses this to determine which number validation table to use initially, and normally converts "dialed digits" addresses into E164 addresses. Values:
|
Attribute value - call hold allowed | Change | This field appears only if Attribute type is set to Call hold allowed.
Indicates whether holding this call is allowed. At a call originating exchange, call holding is normally allowed, but may be disallowed during number validation processing (typically when the call is routed to a carrier with whom there is no agreement to support call hold for operator calls). Values:
|
Attribute value - calling category | Change | This field appears only if Attribute type is set to Calling category.
The category of call being placed by the calling party. The output value of this attribute is used in the Calling Party Category field in an ISUP IAM. Values:
|
Attribute value - call type | Change | This attribute is not valid in the UK. |
Attribute value - carrier call type | Change | This attribute is not valid in the UK. |
Attribute value - carrier type | Change | This attribute is not valid in the UK. |
Attribute value - country code length | Change | This field appears only if Attribute type is set to Country code length. Length of the country code for an international call. It may be used by signaling stacks in order to extract the country code prefix from the called number. This attribute is used only at an originating exchange. Non-zero values are used only for international calls. Range: 0 - 3. The default is 0. |
Attribute value - customer announcement ID | Change | This field appears only if Attribute type is set to Customer announcement ID. Identifies a customer-specific announcement that is to be played to the subscriber on Number Validation failure. You cannot set both a Customer Announcement ID and an Announcement ID in the same attribute set. You will need to set up an entry in the customer-specific message catalog to include the appropriate announcement; see the Integration and Customization Manual for more information about customizing announcements. Set this field to specify the message number for the appropriate announcement in the customized message catalog file. Each customer announcement may take up to two parameters, as specified by Announcement Parameter 1 and Announcement Parameter 2. If no Announcement ID or Customer Announcement ID is specified, and the call cannot be released immediately, the default announcement associated with the error code is played. |
Attribute value - dialed prefix | Change | This attribute is not valid in the UK. |
Attribute value - dialing pattern | Change | This attribute is not valid in the UK. |
Attribute value - echo cancellation | Change | This field is visible only if Attribute type is set to Echo cancellation.
Echo cancellation requirements for this call. This is normally configured in number validation, determined by analysis of the called address. For example, international calls often meet sufficient delay to require echo cancellation. Echo cancellation can also be set up for each media channel in ISUP Signaling. This is normally required if the media channel is known to have a long delay, for example if it represents a satellite link. Values:
|
Attribute value - FGD carrier dialing allowed | Change | This attribute is not valid in the UK. |
Attribute value - FGD carrier ID | Change | This attribute is not valid in the UK. |
Attribute value - FGD carrier requirement | Change | This attribute is not valid in the UK. |
Attribute value - force LNP lookup | Change | This field appears only if Attribute type is set to Force LNP lookup. This field is valid only in the US. |
Attribute value - force on-switch lookup | Change | This field appears only if Attribute type is set to Force on-switch lookup. Specifies whether the NE should always look up the called address in the database of subscribers on this switch, and allow routing to the associated subscriber if found. This overrides the default behavior for some calls, avoiding the use of a long-distance carrier when both subscribers are on the same NE. For example, if a call is classed as an InterLATA or IntraLATA call it would normally be routed to an IXC even if the calling and called parties are co-located on the same switch.
Forcing on-switch lookup suppresses billing records for the call; if you want to ensure that these records are created, set the Billing - call type and Billing - structure code attributes in the same Attribute Set. Typical call type / structure code combinations are 6 / 1 for intraLATA calls and 110 / 625 for intraLATA calls; see Call Type / Structure Code Combinations at the end of this section for the valid combinations of call type and structure code.
Note that setting this attribute is against equal access regulations in some circumstances, but in others, notably in VoIP networks, the regulations are more relaxed. Values:
|
Attribute value - IN query ANI 1st preference | Change | This field appears only if Attribute type is set to IN query ANI 1st preference. This field is valid only in the US. |
Attribute value - IN query ANI 2nd preference | Change | This field appears only if Attribute type is set to IN query ANI 2nd preference. This field is valid only in the US. |
Attribute value - IN query ANI 3rd preference | Change | This field appears only if Attribute type is set to IN query ANI 3rd preference. This field is valid only in the US. |
Attribute value - IN query ANI NPA | Change | This field is valid only in the US. |
Attribute value - IN query ANI NPA-NXX | Change | This field is valid only in the US. |
Attribute value - ISUP called address prefix | Change | This field appears only if Attribute type is set to ISUP called address prefix; it is used only for long-distance calls in Canada that are routed over ISUP trunks, and is not required for deployments elsewhere. |
Attribute value - maximum call duration | Change | This field appears only if Attribute type is set to Maximum call duration.
Maximum permitted duration for a call. If this attribute (MCD) is set, the call will be terminated if it is still in progress when the specified limit is reached. This is typically used to prevent excessive call charges arising from calls to expensive destinations (for example long-distance or international calls). The MCD attribute can be set in either Number Validation or Routing, and the duration is measured from the time when Number Validation or Routing completes with the MCD attribute set. This means that, if the specified duration is too short, the call may be terminated before it has been answered or before an announcement being played to it has completed. A multi-party call can have the MCD attribute set on some branches of the call but not on others. If all MCD-controlled branches of the call end before the specified duration is reached, any remaining call branches are not affected by the MCD. However, if the MCD is reached on one branch of the call, all branches of the call are terminated at the same time, including those that do not have an MCD set. The MCD attribute is ignored if any part of the call is identified as an emergency call; these calls will not be terminated when the MCD expires. Specify the duration in minutes, in the range 1 - 1440 (1 minute - 24 hours), or specify zero to indicate no limit. |
Attribute value - message billing index | Change | This field appears only if Attribute type is set to Message Billing Index. Message Billing Index associated with the call. If this index is included, a billing record containing the MBI is recorded in billing files. Enter the index as 3 decimal digits. |
Attribute value - number type for ANI lookup | Change | This field appears only if Attribute type is set to Number type for ANI lookup. This field is valid only in the US. |
Attribute value - operator call | Change | This field appears only if Attribute type is set to Operator call.
Indicates whether some kind of operator involvement is required for this call. This is set by the number validation component at an originating exchange for direct calls to an operator, calls which require operator involvement and operator services calls. Currently this indicator is ignored at a non-originating exchange.
Values:
|
Attribute value - outgoing ISUP/ISDN release cause | Change | This field appears only if Attribute type is set to Outgoing ISUP/ISDN Release Cause. Indicates whether a specific release cause is to be reported to the originating switch if the call could not be routed on this switch, or if it was routed to another switch and was rejected there. The release cause will be reported only if the call was received over an ISUP trunk. Note that setting a release cause does not in itself cause the call to be rejected. The valid values for this attribute are a subset of those defined in Q.850; the other values defined in Q.850 are not supported, generally because they do not apply to ISUP trunks. See Outgoing Release Causes at the end of this section for a full list of values and some restrictions on their use. Alternatively, you can specify Auto (the default) to indicate that the NE should use the release cause that it determined, or the release cause signaled by the terminating switch if the call was routed to another switch and was rejected there. |
Attribute value - permit when service suspended | Change | This field appears only if Attribute type is set to Permit when service suspended.
Specifies whether the NE should allow calls to this number even when the subscriber's telephone service is suspended. In general, a suspended subscriber can make calls to the emergency service number 999 and to one other number defined in the General Call Service Controls object. If you need to allow access to other numbers, set this attribute during number validation on all numbers for which access is required. Values:
|
Attribute value - priority call | Change | This field appears only if Attribute type is set to Priority call.
Indicates whether the call requires priority handling. At an originating exchange, this defaults to No but can be set by number validation processing if required. Whether or not a call is a priority call may affect how it is routed. Values:
|
Attribute value - pseudo ANI egress signaling types | Change | This field appears only if Attribute type is set to Pseudo ANI egress signaling types. This field is valid only in the US. |
Attribute value - pseudo ANI presentation indicator | Change | This field appears only if Attribute type is set to Pseudo ANI presentation indicator. This field is valid only in the US. |
Attribute value - region code | Change | This attribute is not valid in the UK. |
Attribute value - release control mode | Change | This field appears only if Attribute type is set to Release control mode.
Specifies the release controlling party for a call at the originating and terminating exchanges. This may be overridden by operator hold functionality. Currently, this attribute is used only at UK call originating exchanges. Values:
|
Attribute value - restricted line 950 call | Change | This attribute is not valid in the UK. |
Attribute value - routing control | Change | This field appears only if Attribute type is set to Routing control.
Indicates how routing retries should be controlled at different levels in the UK network. It is a routing input and output attribute and plays no role in number validation. Values:
|
Attribute value - signal access signaling for operator call | Change | This attribute is not valid in the UK. |
Attribute value - signal FGD carrier ID | Change | This attribute is not valid in the UK. |
Attribute value - Signaling Gateway | Change | This field appears only if Attribute type is set to Signaling Gateway. Specifies the Signaling Gateway associated with this call. Select from the displayed list of configured Signaling Gateways. |
Attribute value - test call | Change | This field appears only if Attribute type is set to Test call.
Indicates whether the call is a test call. This is set by number validation based on the dialed number, and may be used in routing the call. Values:
|
Attribute value - Transit Network ID | Change | This attribute is not valid in the UK. |
Attribute value - UK call type | Change | This field appears only if Attribute type is set to UK call type.
Type of the call being established. This is set by the number validation component at the call originating exchange to indicate the type of the call, and is used for Billing and Call Barring. Values:
|
Attribute value - use modified operator NOA encoding | Change | This attribute is not valid in the UK. |
Attribute value - use operator requested NOA encoding | Change | This attribute is not valid in the UK. |
Attribute value - Use Pseudo ANI (pANI) | Change | This field appears only if Attribute type is set to Use Pseudo ANI (pANI). This field is valid only in the US. |
Attribute value - user defined | Change | This field appears only if Attribute type is set to one of the User Defined Attribute values (UDA 1 - UDA 20) or to User defined MF call type.
Specifies a user-defined numeric value that should be added to this routing request for use later in the routing process. User Defined Attributes are provided as an extension to allow you to perform routing that is specific to your deployment and cannot be controlled by other attributes; many deployments may not require them. They are configured using the User Defined Attribute objects. The MetaSwitch Class 4/5 Softswitch does not assign a specific meaning to any particular User Defined Attribute or its value; you can use any of these attributes and assign values as required. For each attribute, you can specify an optional name to identify the attribute's meaning. In Number Validation, you can specify a User Defined attribute as an integer value; you can then match on one or more of these values later in Number Validation or during Routing to determine how to route the call. |
Requested status | Read only | Specifies whether an administrator has attempted to enable the Attribute Entry. Values:
|
Actual status | Read only | Specifies the current status of the Attribute Entry. Values:
|
Announcement Parameters
Some announcements played to subscribers require one or more parameters that are inserted into the announcement; for example, an announcement informing the subscriber of an area code change requires a parameter specifying the new area code. Other announcements require no parameters (for example a "number disconnected" announcement). For more information about how parameters are included in announcements, see the Integration and Customization Manual.
If you have set up an Attribute Entry with Attribute type set to Announcement ID, and the specific announcement ID you have selected requires one or two parameters, any Attribute Set that includes this Attribute Entry must also include one or two additional Attribute Entries for these parameters. In these entries, Attribute type must be set to Announcement parameter 1 for the first parameter, and Announcement parameter 2 for the second.
In the delivered system, the announcement IDs requiring parameters are as follows. Note that the requirement for parameters with specific announcement IDs may be different if you have customized the announcements as described in the Integration and Customization Manual.
No announcement parameters:
|
One announcement parameter:
|
Call Type / Structure Code Combinations
The parameters Attribute value - billing - call type and Attribute value - billing - structure code allow you to override the contents of the billing records generated by the MetaSwitch NE. You are recommended to use combinations of call type and structure code shown in the list below; the MetaSwitch NE supports other combinations of the valid values, but these do not correspond to standard billing records and you will need to ensure that your billing systems can deal with them.
For more information about the format of billing records that the MetaSwitch NE generates, see Operations Manual: Billing.
Call type |
Description |
Supported structure codes |
1 | Detailed Message Rate, with MBI | 20 |
5 | Detailed Message Rate, no MBI | 1, 220, 500 |
6 | Station paid (InterLATA) | 1, 500 |
9 | 411 DA | 28 |
33 | 555 DA | 28 |
45 | ISDN User Service | 0001, 0220, 0221, 0500 |
47 | Default AIN | 221 |
88 | 555 non-DA | 1, 500 |
110 | InterLATA Station Paid | 625 |
119 | Terminating Access Record | 625, 653 |
131 | FGA - Originating | 79 |
132 | FGA - Terminating | 1, 500 |
134 | FGB - Originating | 625 |
141 | Interexchange Carrier Number Services | 360 |
142 | Local Exchange Carrier Number Services | 364 |
710 | Originating Toll AMA Recording | 625 |
711 | Terminating Toll AMA Recording | 625 |
720 | Connecting Network Access Incoming | 625 |
721 | Default LNP | 1, 500 |
800 - 999 | LEC defined | Any |
Outgoing Release Causes
When an incoming call attempt received over an ISUP trunk is to be rejected because it cannot be routed, you can specify a release cause as an attribute to be signaled to the originating switch, which may help that switch to determine how to re-route the call.
The MetaSwitch NE supports the release cause values listed below, which are defined in the Q.850 specification. However, you should note the following restrictions.
Value |
Description |
ISUP mapping |
Extra info? |
1 | Unallocated number | Unchanged | Yes |
2 | No route to specified transit network (national use) | Unchanged | Yes |
3 | No route to destination | Unchanged | Yes |
4 | Send special info tone | Unchanged | No |
5 | Misdialed trunk prefix | Unchanged | No |
6 | Channel unacceptable | 31 | No |
7 | Call awarded to established channel | 31 | No |
8 | Call pre-empted | Unchanged | No |
9 | Call pre-empted, circuit reserved | Unchanged | No |
16 | Normal call clearing | Unchanged | Yes |
17 | User busy | Unchanged | Yes |
18 | User not responding | Unchanged | No |
19 | User not answering | Unchanged | No |
20 | Subscriber absent | Unchanged | No |
21 | Call rejected | Unchanged | Yes |
22 | Number changed | Unchanged | Yes |
27 | Destination out of order | Unchanged | No |
28 | Invalid number format | Unchanged | No |
29 | Facilities rejected | Unchanged | Yes |
30 | Response to status inquiry | 31 | No |
31 | Normal, unspecified | Unchanged | No |
34 | No circuit / channel available | Unchanged | No |
38 | Network out of order | Unchanged | No |
41 | Temporary failure | Unchanged | No |
42 | Switching equipment congestion | Unchanged | No |
43 | Access information discarded | Unchanged | Yes |
44 | Requested circuit / channel not available | Unchanged | No |
46 | Precedence call blocked | Unchanged | No |
47 | Resource unavailable, unspecified | Unchanged | No |
50 | Requested facility not subscribed | Unchanged | Yes |
53 | Outgoing calls barred within CUG | Unchanged | No |
55 | Incoming calls barred within CUG | Unchanged | No |
57 | Bearer capability not authorized | Unchanged | Yes |
58 | Bearer capability not presently available | Unchanged | Yes |
62 | Inconsistency in outgoing information element | Unchanged | No |
63 | Service or option not available, unspecified | Unchanged | No |
65 | Bearer capability not implemented | 79 | Yes |
66 | Channel type not implemented | 79 | Yes |
69 | Requested facility not implemented | Unchanged | Yes |
70 | Only restricted digital information bearer capability is available (national use) | Unchanged | No |
79 | Service option not implemented, unspecified | Unchanged | No |
87 | User is not a member of CUG | Unchanged | No |
88 | Incompatible destination | Unchanged | No |
90 | Non existent CUG | Unchanged | No |
91 | Invalid transit network selection (national use) | Unchanged | No |
95 | Invalid message, unspecified | Unchanged | No |
97 | Message type non-existent or not implemented | Unchanged | Yes |
98 | Message not compatible with call state | Unchanged | Yes |
99 | Information element / parameter non-existent or not implemented | 111 | No |
102 | Recovery on timer expiry | Unchanged | Yes |
103 | Parameter non-existent or not implemented - passed on (national use) | Unchanged | Yes |
110 | Unrecognized parameter discarded | Unchanged | Yes |
111 | Protocol error, unspecified | Unchanged | No |
127 | Interworking, unspecified | Unchanged | No |