Announcement Strings

During pricing configuration, you can configure an announcement string as a results value in a normalizer. The announcement string is copied to the ServiceInfo.VcsInfo.Announcement field in the MtxDiamRoMsg MATRIXX Data Container (MDC). MATRIXX Call Control Framework (CCF) can construct TCAP PlayAnnouncement operations based on the information in the ServiceInfo.VcsInfo.Announcement field.

Announcement String Format

The ServiceInfo.VcsInfo.Announcement field in the MtxDiamRoMsg MDC specifies the ID of the announcement pod on which to play announcements, and the IDs of the announcements to play. Figure 1 shows an example announcement string:
Figure 1. Announcement String

Announcement strings have the following format:

announcement_server;announcement[;announcement...]

where:
  • announcement_server defines properties of the Interactive Voice Response (IVR) system to be used to play the announcement, such as whether the IVR is external or internal. It is defined as follows:

    resource_type|np|noa|address|scfid|correlation_id_in_address

  • announcement defines properties of the announcement, such as the announcement ID and language. It is defined as follows:

    default_elementary_message_id|[language=elementary_message_id...]|timeout_in_seconds

For example, the following announcement string defines a list of English and French announcements to play on an external IVR:

"ext|1|3|555555|1234abcd|0;101|English=101|French=201|20;102|English=102|French=202|30"

Announcement Server (IVR) Properties describes the announcement_server properties:
Table 1. Announcement Server (IVR) Properties
Property Description
resource_type Sets whether the IVR is internal or external, one of:
  • ext — The IVR is external.
  • int — The IVR is internal.
np (Applicable only for external servers) The numbering plan of the IVR.
noa (Applicable only for external servers) The nature of address of the IVR.
address The address of the IVR. An empty string means that there is no address.
scfid (Applicable only for external servers) The ID of the SCF in HEX digits. An empty string means that the SCF ID is part of the address parameter.
correlation_id_in_address (Applicable only for external servers) One of:
  • 0 — The correlation ID is in a separate parameter.
  • 1 — The correlation ID is part of the address parameter.
Announcement Properties describes announcement properties:
Table 2. Announcement Properties
Property Description
default_elementary_message_id The ID of the default announcement to play if there is no announcement specified for the subscriber’s preferred language.
language The language to use for playing the announcement.
elementary_message_id The ID of the announcement on the IVR.
timeout_in_seconds The number of seconds allowed for playing the announcement before the announcement times out.