Contribute in GitHub:

Configuring services with MRCPv2

You can configure your IBM® Voice Gateway deployment to integrate with third-party speech to text and text to speech services by using Media Resource Control Protocol Version 2 (MRCPv2) connections. Version 1.0.0.7 and later.

In your Voice Gateway installation, a UNIMRCP XML configuration file is included which contains the MRCPv2 server connection specifications. To enable MRCPv2 connections, you must include the unimrcpclient.xml filepath to your media relay configuration YAML and then use a JSON configuration for your Voice Gateway deployment. You can't configure MRCPv2 by using environment variables, only JSON configuration properties.

See Configuring MRCPv2 speech synthesizer services and Configuring MRCPv2 speech recognizer services to find setup instructions, MRCPv2 configuration parameters, code examples, and dynamic configuration examples.

Setting up your MRCPv2 configuration directory

Before you can use an MRCPv2 server with Voice Gateway, you must add the file path for your MRCPv2 configuration file, unimrcpclient.xml, to your media relay config.yml file.

Using JSON configuration

To enable MRCPv2 service connections with Voice Gateway, you must add the MRCPv2 configuration to your JSON configuration file. In this file, you can add MRCPv2 configuration to your STT or TTS sections.

Mixed service support and dynamic configuration

You can combine speech to text and text to speech services that use MRCPv2 or other connection protocols to create a mixed service support model. In addition to configuring multiple services, you can also use Dynamic configuration to change the speech to text or text to speech services used by Voice Gateway during a conversation. Use the updateMethod JSON property when you configure either the vgwActSetTTSConfig or the vgwActSetSTTConfig actions to specify your MRCPv2 connection settings.

See the following links to find information about dynamic configurations and code examples:

Security

MRCPv2 communication supports UDP and TCP transport protocols, but not TLS, for the SIP and the MRCPv2 connection. To ensure secure communication, both your Voice Gateway and the MRCPv2 server must be inside a protected network perimeter. See MRCPv2 Security considerations for more information about securing your MRCPv2 connections.