Open topic with navigation

API Message Reference

RR - Request Recording

Layer Agent
Direction To CallGem
Type of Service CG
Interface ID AG
Message Purpose This message requests a full-duplex recording session to be initiated for the current agent's call session, or the session identified by the SI or TN parameters. This API can be used to initiate recording's for an agent's session, or for a given session which may or may not be associated with an agent.
Example RR\CNCustCare\AN2\SIABC4321\ON
Explanation A request has been made to record the call session with session identifier ABC4321 for the agent with identifier number 2 on the CustCare campaign.
Notes Related Links: Request Recording [RR] - CallGem to Telephony
Parameters
Code Name Type Mandatory? Min Val Max Val Description
AE AgentExtensionIdentifier string false 1 120 Required by the telephony layer to give each agent extension a unique identifier.
AN AgentIdentifier string 1 80 User defined parameter values may include any characters except / \ : * ? " < > | & % + ! ' ;
CN CampaignName string 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.
QI UserIdentifier string false 1 80 From V10.7.28 - Mutually exclusive with AN Parameter. If the user ID is specified, CallGem will treat this as a request to record the media session associated with the current active login session. User defined parameter values may include any characters except / \ : * ? " < > | & % + ! ' ;
RF RecordingFilename string false 1 1024 Recording Filename parameter
SI SessionIdentifier string false 1 120 Either the TN or the SI parameter must be used to identify the called party.

Used to give each called party a unique key. If omitted, CallGem assumes this parameter to be the same as the TN parameter. See Session Identifiers.

TD TenantDescriptor string false 1 80 This parameter is alphanumeric and identifies to which tenant this message applies.
TK Token string false 1 80 Token parameter
TN TelephoneNumber string false 0 80 Either the TN or the SI parameter must be used to identify the called party. See Session Identifiers.

 

Copyright © 2004 - 2019  Sytel Limited