API Message Guide

RR - Request Recording

Layer CTI
Direction From CallGem
Type of Service CG
Interface ID CT
Message Purpose This message is a companion to the Request Recording [RR] - Agent to Dialer message. The Request Recording [RR] message requests a full-duplex record session to be initiated or stopped for the specified call session. The telephony layer should respond with a Recording Acknowledge [RA] message once it has attempted to initiate or stop recording.
Example RR\TDdefault\CNCustCare\SIABC012345\ON
Explanation A request has been made to record the call with session identifier ABC012345 on the CustCare campaign.
Notes Related Links: Request Recording [RR] - Agent to CallGem
Parameters
Code Name Type Mandatory? Min Val Max Val Description
CN CampaignName string true 1 80 User defined parameter values may include any characters except / \ : * ? " < > | & % + ! ' ;
KY OperationKey string false 1 80 Recording operation key - supports concurrent call recording for a single call. The KY parameter on RR and RA messages identifies the recording to be controlled.
MF MediaFormat int false 0 1 The media format parameter tells the telephony layer exactly which format the recording is to be saved in. If a media format is not specified, the default media format supported by the gateway is used. Valid values are:
0G.711 muLaw or ALaw wav
116KBit/s Compressed wav
ON OnOff boolean false 0 0 If this parameter is specified recording will be enabled. If not specified, recording will be disabled.
RF RecordingFilename string false 1 1024 Recording Filename parameter
SI SessionIdentifier string true 1 120 Either the TN or the SI parameter must be used to identify the called party. Session Identifiers.
TD TenantDescriptor string false 1 80 This parameter is alphanumeric and identifies to which tenant this message applies.
TN TelephoneNumber string false 0 80 Either the TN or the SI parameter must be used to identify the called party. Session Identifiers.
YR RecordingUniqueIdentifier string false 1 80 From V10.6.431 - If this recording is the main recording made for this call session it will be assigned a globally unique identifier. This will propagate to the agent layer on the Recording Acknowledge message. The parameter will only be set for recording requests made without an operation key (KY) parameter.