| Attributes |
uint16
mandatory
noNotification
restricted |
-
announcementId
-
An identity for the basic announcement.
The combination of the announcementId and languageCode attributes form a unique identity for the basic announcement.
|
string
key
mandatory
noNotification
restricted |
-
basicAnnouncementId
-
The value component of the RDN.
|
uint16 |
-
duration
=
0
-
The amount of time the announcement is to be played.
If the specified duration is greater than the overall length of the announcement, the announcement is repeated until the duration is elapsed.
The playing time is also dependent on the value of the iteration attribute. The selected playing time is always the shortest possible alternative.
= 0: Play until requested to stop (infinite)
> 0: Play x Milliseconds
Note that the value received in H.248 ( or SIP) for this parameter overrides this attribute.
Unit: 1 ms
|
string
mandatory |
-
fileName
-
The name of the announcement file.
|
string
mandatory |
-
filePath
-
The relative file path to the directory where the announcement file is stored.
The value of this attribute is relative to the announcement_storage_server_path in deployment template.
Recommended value: basic/<languageCode>/
Example: basic/en-GB/
|
uint16 |
-
iteration
=
0
-
The number of times the announcement is repeated when played to the user.
Please note that the playing time is also dependent on the value of the duration attribute. The selected playing time is always the shortest possible alternative.
= 0: Infinite loop
> 0: Repeat x Times
Note that the value received in H.248 ( or SIP) for this parameter overrides this attribute.
|
string
mandatory
noNotification
restricted |
-
languageCode
[
0..128
]
-
Language code of the basic announcement.
Language code has the format of an RFC 5646 language tag.
The combination of the announcementId and languageCode attributes form a unique identity for the basic announcement.
Example: en-GB
Valid values: [a-zA-Z]{1,8}([-_][a-zA-Z0-9]{1,8})*|^$
|
string[0..1] |
-
userLabel
[
0..128
]
-
Label for free use.
|