- What it does
- Configuration
- What you need
- Setting up each announcement
- I want to…
- Play an announcement when a call fails with a response code 404
- Play a default announcement for all other failure response codes
- Only play an announcement for the specified error codes
- Play an announcement when a call fails with a response code 488 and change it to a 487 response
- Not play any announcements triggered solely by an error code
- Play the same announcement for all error codes except for 404, which has no announcement
- I want to…
What it does
When a call fails with an error response code (a SIP response code in the range 400 … 699), an announcement may be played to the caller, and the status code may be changed to 487 to hide the true status code.
Configuration
The example for sentinel-volte-gsm-config.yaml and
example for sentinel-volte-cdma-config.yaml show example configuration
relevant to call failure announcements in the sentinel-volte/mmtel/announcement/announcements/
section.
What you need
-
❏ A status code for which you want to play an announcement.
-
❏ The announcement ID of the announcement you wish to play.
-
❏ Whether you want to hide the true status code.
-
❏ Default handling of error codes.
Setting up each announcement
I want to…
Play an announcement when a call fails with a response code 404
Within
the mmtel
, announcement
section,
error-code-announcements
list,
add a new error code announcement entry like this:
error-code-announcements:
- error-code: 404
announcement-id: 24
end-call-with-487-response: false
-
Ensure that
error-code-announcements
list is present and not commented out. -
Add a new announcement. Set the values to the following:
-
error-code
to the SIP response code to play the announcement for. -
announcement-id
to theid
of the announcement to play. -
end-call-with-487-response
tofalse
to end the call with the 404 response.
-
Play a default announcement for all other failure response codes
Within
the mmtel
, announcement
section:
default-error-code-announcement:
announcement-id: 22
end-call-with-487-response: false
-
Ensure that
default-error-code-announcement
is present and not commented out. -
Set
announcement-id
to theid
of the announcement to play. -
Set
end-call-with-487-response
to:-
false
to end the call with the original response, or -
true
to force all other error codes to replaced with a487
response.
-
Only play an announcement for the specified error codes
In the mmtel
, announcement
section,
remove or comment out the entire default-error-code-announcement
section.
#default-error-code-announcement:
# announcement-id: 22
# end-call-with-487-response: false
Play an announcement when a call fails with a response code 488 and change it to a 487 response
Within
the mmtel
, announcement
section, error-code-announcements
list,
add a new announcement entry like this:
error-code-announcements:
- error-code: 488
announcement-id: 22
end-call-with-487-response: true
-
Ensure that
error-code-announcements
list is present and not commented out. -
Add a new announcement. Set the values to the following:
-
error-code
to488
. -
announcement-id
to theid
of the announcement to play. -
end-call-with-487-response
totrue
to end the call with a487
response.
-
Not play any announcements triggered solely by an error code
Directly under the mmtel
, announcement
section, completely remove or comment out both the default-error-code-announcement
and error-code-announcements
list
sections.
announcement:
#default-error-code-announcement:
# announcement-id: 22
# end-call-with-487-response: false
#error-code-announcements:
# - error-code: 486
# announcement-id: 24
# end-call-with-487-response: false
# - error-code: 488
# announcement-id: 22
# end-call-with-487-response: true
Play the same announcement for all error codes except for 404, which has no announcement
In the mmtel
, announcement
section,
set up a default-error-code-announcement
as described in Play a default announcement for all other failure response codes,
then set up an error-code-announcements
list
entry for error code 404
with disable-announcement
set to true
.
announcement:
default-error-code-announcement:
announcement-id: 22
end-call-with-487-response: false
error-code-announcements:
- error-code: 404
# announcement-id: 24
disable-announcement: true
end-call-with-487-response: false
-
Ensure that
default-error-code-announcement
exists and plays the desired announcement, as above. -
Ensure that
error-code-announcements
list exists and is not commented out. -
Add an entry for the
error-code
. -
Remove or comment out its
announcement-id
. -
Add
disable-announcement
, with the value set totrue
.