SIPREC Metadata Profile - CLI

In this section:

The SBC supports a set of SIPREC specifications (RFC 7245, RFC 7865, RFC 7866, and RFC 8068) that include support for "dynamically programmable" selection of metadata content.

The profile sipRecMetaDataProfile provides the capability to configure the headers mapped from the target call leg to the XML and the corresponding metadata XML element name.
In a basic call scenario, all information is copied from the initial-INVITE message on the leg where the tap is located to the metadata XML. However, the "To" header and "to-tag" are also copied from the local information since the "to-tag" is not present in the INVITE).
For a SIPREC trigger during a REFER-based transfer, irrespective of the SIPREC tap location, all information is copied from the initial INVITE of the new call leg towards the transfer target (C party).
For a SIPREC trigger during an Invite with Replaces transfer, when the SIPREC tap is on the Replaces leg, the original SIPREC leg is terminated, and a new SIPREC dialog is created with metadata from the Replaces’ Invite (B party). The Invite with Replaces requires a Call Recording Criteria match, which, depending on customer call flows, may differ from the initial Invite’s criteria.

Note

The maximum size of the callData section in the metadata portion of the SIPREC INVITE sent towards SRS is 2,048 bytes.

Command Syntax

The command syntax to configure the sipRecMetadataProfile is shown below:

% set profiles services sipRecMetadataProfile <sipRecMetadataProfile>
    version <0..1>
    sipHeader <sipHeader>
        sipToXmlTagName <sipToXmlTagName>
    state <disabled | enabled>

The command syntax to attach the sipRecMetadataProfile to the SRS Trunk Group is shown below:

% set addressContext <addressContext> zone <zone> sipTrunkGroup <sipTrunkGroup> services sipRecMetadataProfile <sipRecMetadataProfile>

The sipRecMetadataProfile must be attached to the sipTrunkGroup towards the SRS.

In order to maintain the backward compatibility use the below command with metadataSource set to "fromInvite":

set profiles service sipRecMetadataProfile <name> state <enabled/disabled> metadataSource<fromInvite/fromLatest> version<0/1> sipHeader <headerName> sipToXmlTagName <corresponding xml tag Name>

To enable this feature set metadataSource to "fromLatest":

set profiles service sipRecMetadataProfile <name> state <enabled/disabled> metadataSource<fromLatest> version<1> sipHeader <headerName> sipToXmlTagName <corresponding xml tag Name>

To trigger the SIPREC metadata XML update in case of early media:

set profiles service sipRecMetadataProfile <name> state <enabled/disabled> metadataSource<fromLatest> version<1> metaDataUpdateForEarlyMedia<Enabled/Disabled> sipHeader <headerName> sipToXmlTagName <corresponding xml tag Name>

To trigger the SIPREC metadata XML update in case of refer:

set profiles service sipRecMetadataProfile <name> state <enabled/disabled> metadataSource<fromLatest>  version<1> triggerMetadataUpdateForRefer<Enabled/Disabled> sipHeader <headerName> sipToXmlTagName <corresponding xml tag Name>

Command Parameters

SIPREC Metadata Profile parameters

Parameter	Length/Range	Default	Description	M/O
`metaDataSource`	ENUM	INITIAL_INVITE	INITIAL_INVITE: Indicates to send header values from Initial INVITE Message. LATEST: Indicates to send the most recent headers value/information beginning from SIP INVITE Message till the most recent SIP Request/Response Message on that particular call leg until the SBC triggers SIPREC INVITE towards the SRS.	M
`MetaDataUpdateForEarlyMedia`	State	disabled	For the early media scenario, the SIPREC is initiated already. On reception of SIP 200 OK, The SBC triggers the "SIPREC re-INVITE" with the updated metadata in SIPREC Metadata XML using the headers from the SIP 200 OK message based on the configuration. The CLI configuration "MetaDataUpdateForEarlyMedia" under "sipRecMetaDataProfile" is used to control this behavior. `disabled`: To maintain the backward compatibility. `enabled`: Only for "metaDataSource" set to "LATEST". SBC triggers SIPREC re-INVITE towards the SRS.	M
`sipHeader <variable>`	Up to 31 characters	N/A	Indicates the SIP header, which are included in the SRS call. Note: Maximum 32 SIP headers can be created in one `sipRecMetadataProfile`.	O
`sipRecMetadataProfile <variable>`	Up to 23 characters	N/A	Indicates the name of the profile and specifies the SIP headers that are included in the SRS call.	M
`sipToXmlTagName <variable>`	Up to 31 characters	N/A	Indicates XML tag name for the configured SIP header.	O
`state`	N/A	disabled	Indicates the admin state of the SIPREC metadata profile. The options are: `disabled (default)` `enabled`	O
`triggerMetadataUpdateForRefer`	State	disabled	`disabled`: To maintain backward compatibility. `enabled`: The SBC triggers "SIPREC re-INVITE" towards the SRS on the occurrence of SIP REFER Message (The header values are taken from REFER message) to update the metadata in SIPREC Metadata XML based on the configuration in sipRecMetadataProfile.	M
`version`	0 to 1	0	Indicates the SIPREC metadata profile version. The options are: `0(default)`: When the version is set as 0, the SBC supports backward compatibility and pre-defined metadata for passing proprietary call specific information from the SRC to the SRS. `1`: When the version is set as 1, the SBC supports dynamic configuration of the metadata variables.	O

Command Examples

Configuring sipRecMetadataProfile and attaching it to the SRS Trunk Group:

% set profiles services sipRecMetadataProfile SRMP_ING version 1 sipHeader P-Preferred-Identity sipToXmlTagName xPPreferredIdentity
% set profiles services sipRecMetadataProfile SRMP_ING state enable