In this section:
Use the Call Notification commands to configure call notification criteria as part of the SBC's call notification feature. For deployments requiring notifications when calls are set up by the SBC, you can configure the SBC to send SIP NOTIFY messages to a specified Application Server when a call's calling party or called party matches criteria you specify. Refer to Sending Unsolicited Call Notifications to Application Servers for more information on the call notification feature.
Call Notification Criteria
Use the callNotificationCriteria
object to specify individual sets of criteria (called party, calling party, trunk group for the other call leg) that the SBC's Embedded Routing Engine (ERE) compares against calls. This object also identifies the servers, using a cnsGroupCluster
, to notify in the event of a match.
Command Syntax
% set global servers callNotificationCriteria <criteria ID> calledPartyId calledPartyType <AoR | number> callingPartyId callingPartyType <AoR | number> cnsGroupClusterId <cns group cluster ID> otherLegTG role <egress | ingress | none> userPartType <none | useCalledNumber | useCallingNumber | useConfigured> userPartValue
Command Parameters
callNotificationCriteria Parameters
Parameter | Length/Range | Description |
---|---|---|
<criteria ID> | up to 23 characters | Specifies a name for the set of call notification criteria. |
calledPartyId | up to 134 characters | Specifies the called party user to match. The value can be a specific calling number, prefix, calling uri or the "*" character. The default value is "*" which matches all. |
calledPartyType |
| Specifies the format in which the called party is identified in the criteria. The options are:
|
callingPartyId | up to 134 characters | Specifies the calling party user to match. The value can be a specific calling number, prefix, calling uri or the "*" character. The default value is "*" which matches all. |
callingPartyType |
| Specifies the format in which the calling party is identified in the criteria. The options are:
|
cnsGroupClusterId | up to 23 characters | Specifies the name of the call notification server (Cns) group cluster that should receive NOTIFY messages when a call matches this set of criteria. |
otherLegTG | up to 23 characters | Specifies the name of a SIP trunk group for the other call leg to match. The value can also be the "*" character which matches all. |
role |
| Specifies on which call leg to apply the criteria. The options are:
|
userPartType |
| Specifies what to use to populate the userpart in the Request-URI within NOTIFY messages. The options are:
|
userPartValue | up to 23 characters | Specifies a static value for the userpart of the Request-URI within NOTIFY messages, only if you specify the userPartType as useConfigured . |
Call Notification Criteria Group
Use the callNotificationCriteriaGroup
object to group up to 32 callNotificationCriteria
objects that you can then assign to a SIP trunk group. For calls on that trunk group, the ERE compares the calling number/called number and other-leg trunk group against the criteria in the group. The callNotificationCriteriaGroup
specifies the sequence in which the criteria is evaluated. Once a call matches one of the callNotificationCriteria
objects, the matching process skips the remaining criteria in the group and the SBC initiates its notification process.
Command Syntax
% set global servers callNotificationCriteriaGroup <group ID> callNotificationCriteriaGroupData <sequence: 0 - 31> callNotificationCriteriaId <call notification criteria ID> description
Command Parameters
callNotificationCriteriaGroup Parameters
Parameter | Length/Range | Description |
---|---|---|
<group ID> | up to 23 characters | Specifies a name for a group of up to 32 sets of call notification criteria. Sets of criteria are identified within the group by a sequence number. |
<sequence> | 0-31 | Specifies a sequence number for a set of call notification criteria within the group. The SBC checks for a match in sequence order until it finds a match or exhausts the list of notification criteria. |
| up to 23 characters | Specifies the name of the set of call notification criteria to associate with the sequence number. |
| up to 199 characters | Specifies an optional description for the call notification criteria group. |
For command examples, refer to Configuring the SBC to Send Unsolicited Call Notifications to Application Servers.