Announcements
Announcements
The N2IWF can be configured to request that announcements be played for SIP calls.
The available announcements are defined in the ANNOUNCEMENTS LogicApp service
global variable.
<global name="ANNOUNCEMENTS" type="array">
<announcement name="ann99" srf_name="OnSwitch" announcement_id="99"/>
<announcement name="ann_var1" srf_var="srf" announcement_var="announcement"/>
<announcement name="ann_var2" srf_var="srf" announcement_var="announcement"
srf_name="External" announcement_id="1"/>
</global>
Configuration Details
Each announcement definition may contain the following parameters:
| Attribute | Type | Description |
|---|---|---|
name |
String | [Required] The name of the announcement, as it is referred to in action rule. |
announcement_id |
Integer | A literal value for the announcement ID as configured on the external resource. At least one of announcement_id or announcement_var must be configured. If announcement_var is configured, the associated runtime value must be non-nil. |
announcement_var |
String | The name of a variable to read to obtain the announcement ID as configured on the external resource. At least one of announcement_id or announcement_var must be configured. If announcement_var is configured, the associated runtime value must be non-nil. |
srf_name |
String | A literal value for the SRF name to use, as defined in LhoSipApp. At least one of srf_name or srf_var must be configured. If srf_var is configured, the associated runtime value must be non-nil. |
srf_var |
String | The name of a variable to read to obtain the SRF name to use, as defined in LhoSipApp. At least one of srf_name or srf_var must be configured. If srf_var is configured, the associated runtime value must be non-nil. |
When playing an announcement, the parameters holding variable names are checked first, if present. If no variable name or value is found, the literal parameters are used instead, if configured.
If an announcement fails to be set up or played, the call will continue and no PROBLEM EDR will be raised. However, statistics and alarms will be raised to report the issue.
Each named announcement may be specified in any action rule, e.g.:
<global name="RESULT_CODES" type="array">
...
<rule code="4012" service.at_terminate="0" var="network" value="home" action="release" announcement="ann99" />
...
</global>