Jump to: navigation, search

Metadata Support for IVR Recording

SIP Server can now pass its Application name in the custom X-Genesys-sipsAppName header of the INVITE message to GVP/Media Server. This metadata—along with ANI, CallUUID, and DNIS—is used by GVP to get information about the call for a proper retrieval of recording files.

Feature Configuration

To enable this feature, set the sip-enable-ivr-metadata configuration option at the Application or DN level as required.

Note the following: If the IVR recording feature is enabled, then it is not required to explicitly enable the recording by setting the record option to true on DNs representing GVP, such as Trunk, Trunk Group, or Voice Treatment Port. Recording will be started by the VXML application running on the Media Server.

Configuration Options

sip-enable-ivr-metadata

Setting: TServer section, DN level
Default Value: No default value
Valid Values: true, false
Changes Take Effect: For the next call

Specifies whether SIP Server passes its Application name in the initial INVITE message (in the X-Genesys-sipsAppName header) to Media Server. If this option is set to true, SIP Server includes its Application name in the custom header of the INVITE that it sends to Media Server. If this option is set to false, SIP Server does not include its Application name in the initial INVITE sent to Media Server. This option applies to DNs of type Trunk, Voice over IP Service (msml), Trunk Group, and Voice Treatment Port. This DN-level setting takes priority over the Application-level setting.

sip-enable-ivr-metadata

Setting: TServer section, Application level
Default Value: false
Valid Values: true, false
Changes Take Effect: For the next call

Specifies whether SIP Server passes its Application name in the initial INVITE message (in the X-Genesys-sipsAppName header) to Media Server. If this option is set to true, SIP Server includes its Application name in the custom header of the INVITE that it sends to Media Server. It also enables the default behavior of the feature depending on the DN type, as follows:

  • Voice over IP Service (msml), Trunk Group, and Voice Treatment Port—SIP Server sends the custom header.
  • Trunk—SIP Server does not send the custom header.


If this option is set to false, SIP Server does not include its Application name in the initial INVITE sent to Media Server.

To enable this feature for a DN of type Trunk, set the sip-enable-ivr-metadata option to true on the corresponding Trunk DN.

This page was last modified on August 30, 2016, at 14:00.

Feedback

Comment on this article:

blog comments powered by Disqus