The R-IM-SSF includes support for translating user-interaction requests by SIP application servers into equivalent requests to network elements in the IN (such as an IVR). For example, if a SIP application requests that a particular announcement should be played with a play-url in an INVITE, then the R-IM-SSF will map this to a PlayAnnouncement message.

Tip Type help rimssf-ui at the sis-console to see a list of commands related to subscription information.

Configuring prefix announcement mappings

Below are descriptions and examples of the commands for configuring prefix announcement mappings.

rimssf-addprefixmessageannouncementmapping

Command

 
rimssf-addprefixmessageannouncementmapping <prefix> <id> <assistingSspIpRoutingAddress> <resourceAddress>
     Add prefix -> message announcement mapping

Example

To add a message announcement mapped to prefix 351123700:

[Rhino@localhost (#1)] rimssf-addprefixmessageannouncementmapping 351123700 15 123456 12345678
Added Message announcement mapping for prefix 351123700

rimssf-addprefixtoneannouncementmapping

Command

 
rimssf-addprefixtoneannouncementmapping <prefix> <id> <assistingSspIpRoutingAddress> <resourceAddress>
     Add prefix -> tone announcement mapping

Example

To add a tone announcement mapped to prefix 351123456:

[Rhino@localhost (#1)] rimssf-addprefixtoneannouncementmapping 351123456 12 123456 12345678
Added Tone announcement mapping for prefix 351123456

rimssf-displayprefixannouncementmapping

Command

 
rimssf-displayprefixannouncementmapping <prefix>
     Display the announcement mapping for a prefix

Example

To display announcement configuration associated with prefix 351123456:

[Rhino@localhost (#1)] rimssf-displayprefixannouncementmapping 351123456
Mapping of prefix to announcement properties
AnnouncementID               : 12
AssistingSSPIPRoutingAddress : 123456
MessageType                  : TONE_ANNOUNCEMENT
Prefix                       : 351123456
ResourceAddress              : 12345678

rimssf-displayallprefixannouncementmappings

Command

 
rimssf-displayallprefixannouncementmappings
     Display all prefix -> announcement mappings

Example

To display all prefix → announcement mappings:

[Rhino@localhost (#1)] rimssf-displayallprefixannouncementmappings
Prefix      AnnouncementID   AssistingSSPIPRoutingAddress   MessageType            ResourceAddress
----------  ---------------  -----------------------------  ---------------------  ----------------
 351123456               12                         123456      TONE_ANNOUNCEMENT          12345678
 351123700               15                         123456   MESSAGE_ANNOUNCEMENT          12345678

rimssf-removeprefixannouncementmapping

Command

 
rimssf-removeprefixannouncementmapping <prefix>
     Remove a prefix -> announcement mapping

Example

To remove an announcement mapping for prefix 351123456:

[Rhino@localhost (#1)] rimssf-removeprefixannouncementmapping 351123456
Announcement mapping for prefix 351123700 has been removed

Configuring play-URL announcement mappings

Below are descriptions and examples of commands for configuring play-URL announcement mappings.

rimssf-addplayurlmessageannouncementmapping

Command

 
rimssf-addplayurlmessageannouncementmapping <playurl> <id> <assistingSspIpRoutingAddress> <resourceAddress> <mrfAddress>
     Add playurl -> message announcement mapping. The value of resourceAddress or
     mrfAddress may be 'null' if no specific value is to be configured

Example

To add a message announcement, played using an IN resource, mapped to a play-url /provisioned/19:

[Rhino@localhost (#1)] rimssf-addplayurlmessageannouncementmapping /provisioned/19 19 123456 12345678 null
Added Message announcement mapping for play url /provisioned/19

rimssf-addplayurltoneannouncementmapping

Command

 
rimssf-addplayurltoneannouncementmapping <playurl> <id> <assistingSspIpRoutingAddress> <resourceAddress>
     Add playurl -> tone announcement mapping

Example

To add a tone announcement, played using a SIP resource, mapped to a play-url /provisioned/12:

[Rhino@localhost (#1)] rimssf-addplayurltoneannouncementmapping /provisioned/12 12 123456 null 12345678@mrf.opencloud.com
Added Tone announcement mapping for play url /provisioned/12

rimssf-displayplayurlannouncementmapping

Command

 
rimssf-displayplayurlannouncementmapping <playurl>
     Display the announcement mapping for a play url

Example

To display the play-url → announcement mapping for /provisioned/12:

[Rhino@localhost (#1)] rimssf-displayplayurlannouncementmapping /provisioned/12
Mapping of PlayUrl to announcement properties
AnnouncementID               : 12
AssistingSSPIPRoutingAddress : 123456
MediaServerAddress           : 12345678@mrf.opencloud.com
MessageType                  : TONE_ANNOUNCEMENT
ResourceAddress              : null
Url                          : /provisioned/12

rimssf-displayallplayurlannouncementmappings

Command

 
rimssf-displayallplayurlannouncementmappings
     Display all play url -> announcement mappings

Example

To display all play-url → announcement mappings:

[Rhino@localhost (#1)] rimssf-displayallplayurlannouncementmappings
Url               AnnouncementID   AssistingSSPIPRoutingAddress   MediaServerAddress            MessageType            ResourceAddress
----------------  ---------------  -----------------------------  ---------------------------  ---------------------  ----------------
 /provisioned/12               12                         123456   12345678@mrf.opencloud.com   TONE_ANNOUNCEMENT
 /provisioned/15               15                         123456                                TONE_ANNOUNCEMENT          12345678
 /provisioned/19               19                         123456                                MESSAGE_ANNOUNCEMENT       12345678
3 rows

rimssf-removeplayurlannouncementmapping

Command

 
rimssf-removeplayurlannouncementmapping <playurl>
     Remove a playurl -> announcement mapping

Example

To remove an announcement mapping for play-url /provisioned/15:

[Rhino@localhost (#1)] rimssf-removeplayurlannouncementmapping /provisioned/15
Announcement mapping for play url /provisioned/15 has been removed

Configuring media XML announcement mappings

A media XML announcement mapping is used if an incoming INVITE request is not recognised as another type of announcement INVITE but contains a Content-Type header identifying the message content as application/mediaservercontrol\+xml. Media XML announcement mappings are keyed on the ServiceKey of the InitialDP that triggered the call. For SIP network initiated calls a ServiceKey value of 0 is used to look up the announcement mapping.

Below are descriptions and examples of commands for configuring media XML announcement mappings.

rimssf-addmediaxmlannouncementmapping

Command

 
rimssf-addmediaxmlannouncementmapping <service-key> <assistingSspIpRoutingAddress> <mrfAddress>
     Add media-xml announcement mapping for a service key. The value of mrfAddress
     may be 'null' if no specific value is to be configured

Example

To add a media XML announcement mapped to service key 100:

[Rhino@localhost (#1)] rimssf-addmediaxmlannouncementmapping 100 123456 mrf.opencloud.com
Added Media XML announcement mapping for service key 100

rimssf-displaymediaxmlannouncementmapping

Command

 
rimssf-displaymediaxmlannouncementmapping <service-key>
     Display the media-xml announcement mapping for a service key

Example

To display announcement configuration associated with service key 100:

[Rhino@localhost (#1)] rimssf-displaymediaxmlannouncementmapping 100
Mapping of service key to media-xml announcement properties
AssistingSSPIPRoutingAddress : 123456
MediaServerAddress           : mrf.opencloud.com
ServiceKey                   : 100

rimssf-displayallmediaxmlannouncementmappings

Command

 
rimssf-displayallmediaxmlannouncementmappings
     Display all media-xml announcement mappings

Example

To display all service key → media XML announcement mappings:

[Rhino@localhost (#1)] rimssf-displayallmediaxmlannouncementmappings
ServiceKey   AssistingSSPIPRoutingAddress   MediaServerAddress
-----------  -----------------------------  -------------------
        100                         123456    mrf.opencloud.com
         70                         123456

rimssf-removemediaxmlannouncementmapping

Command

 
rimssf-removemediaxmlannouncementmapping <service-key>
     Remove a media-xml announcement mapping for a service key

Example

To remove an announcement mapping for service key 100:

[Rhino@localhost (#1)] rimssf-removemediaxmlannouncementmapping 100
Media XML mapping for service key 100 has been removed
Previous page Next page