announcements-media-server-uri

The URI of the media server used to play announcements.

This node is mandatory.

Type sip-or-tel-uri-type

Description

A type allowing either a SIP URI or a Tel URI.

Value
sip-uri-type

The SIP URI type.

a string with length 0 or more matching sip:.*

or tel-uri-type

The Tel URI type.

a string with length 0 or more matching tel:\+?[-*#.()A-F0-9]+

announcements-no-response-timeout-milliseconds

The maximum time to wait (in milliseconds) for the media server to respond before cancelling an announcement.

Type uint32

Value

a number in the range 1 or more

Default value

1000

announcements list

A list containing the configuration for each announcement that the system can play.

List Structure

The key is id.

Data Validation Constraint

repeat > '-1' or interruptable = 'true'

Validation Error:

'interruptable' must be set to 'true' if 'repeat' is set to '-1'.

id

The ID for this announcement.

This node is mandatory.

Type uint32

Value

a number in the range 1 or more

description

A description of what this announcement is used for.

Type string

Value

a string

announcement-url

The file URL of this announcement on the media server.

This node is mandatory.

Type string

Value

a string

delay-milliseconds

The delay interval (in milliseconds) between repetitions of this announcement.

This node is mandatory.

Type uint32

Value

a number in the range 0 or more

duration-milliseconds

The maximum duration (in milliseconds) of this announcement.

This node is mandatory.

Type uint32

Value

a number in the range 0 or more

repeat

How many times the media server should repeat this announcement. A value of -1 will cause the announcement to repeat continuously until it is interrupted.

This node is mandatory.

Related Constraint

.. has a Data Validation Constraint which references this node. The validation expression refers to this node as repeat.

Type int32

Value

a number in the range -1 or more

mimetype

The MIME content type for this announcement, e.g audio/basic, audio/G729, audio/mpeg, video/mpeg.

Type string

Value

a string

interruptable

Determines whether this announcement can be interrupted. This only applies to announcements played after the call is established.

This node is mandatory.

Related Constraint

.. has a Data Validation Constraint which references this node. The validation expression refers to this node as interruptable.

Type boolean

Value

'true' or 'false'

suspend-charging

Determines whether online charging should be suspended while this announcement is in progress. This only applies to announcements played after the call is established.

This node is mandatory.

Type boolean

Value

'true' or 'false'

end-session-on-failure

Determines whether the session should be terminated if this announcement fails to play. This only applies to announcements played during call setup.

This node is mandatory.

Type boolean

Value

'true' or 'false'

enforce-one-way-media

Determines whether to enforce one-way media from the media server to the party hearing the announcement. This only applies to announcements played after the call is established.

This node is mandatory.

Type boolean

Value

'true' or 'false'

locale

The language/language variant used in the announcement.

Type string

Value

a string

default-error-code-announcement

Configuration for the default announcement that is played when an error response is received during call setup.

When present

Enable default error code announcement

announcement-id

The ID of the announcement to be played to the calling party when an error response is received during call setup.

This node is mandatory.

Type announcement-id-type

Description

The announcement-id type, limits use to be one of the configured SIP announcement IDs from '/sentinel-volte/mmtel/announcement/announcements/id'.

Value

one of /sentinel-volte/mmtel/announcement/announcements/id

end-call-with-487-response

Determines whether the call should be ended with a 487 error code rather than the error code that triggered the announcement.

Type boolean

Value

'true' or 'false'

error-code-announcements list

A list containing configuration for assigning specific announcements for specific SIP error response codes received during call setup.

List Structure

error-code uint16
disable-announcement boolean
announcement-id announcement-id-type
end-call-with-487-response boolean

The key is error-code.

error-code

The SIP error response code that this entry applies to.

This node is mandatory.

Type uint16

Value

a number in the range 400 to 699

disable-announcement

If set to 'true', no announcement will be played for this error code, overriding any default error code announcement that has been set.

Related Constraint

Conditional node ../announcement-id depends on this node. The Conditional expression refers to this node as ../disable-announcement.

Type boolean

Value

'true' or 'false'

Default value

false

announcement-id

ID of the announcement to play when this error code is received.

Conditional

This leaf is only valid when ../disable-announcement = 'false'.

Type announcement-id-type

Description

The announcement-id type, limits use to be one of the configured SIP announcement IDs from '/sentinel-volte/mmtel/announcement/announcements/id'.

Value

one of /sentinel-volte/mmtel/announcement/announcements/id

end-call-with-487-response

Determines whether to use the original received error code, or a 487 error code to end the call after the announcement.

Type boolean

Value

'true' or 'false'

Previous page Next page
Rhino VoLTE TAS Version 4.1