Layer | CTI |
Direction | To CallGem |
Type of Service | CG |
Interface ID | CT |
Message Purpose | This message is sent in response to a valid Request Recording [RR] message from CallGem. The telephony layer should attempt to start or stop recording the current call session. On receipt of a Request Recording [RR] message, Softdial initiates or terminates call recording through the telephony layer. This will usually succeed but may fail due to resource shortage or some other telephony issue. The RA message provides feedback to the agent about the state of the request to start or stop recording. |
Example | RA\CNCustCare\SIAA001122\RS0 |
Explanation | Recording has started for the call with session identifier AA001122 on the CustCare campaign. |
Notes |
The start or termination acknowledgement may occur unsolicited. If the campaign
or agent is set to blanket record calls, CallGem will generate the acknowledgements
as a means to drive application state machine logic consistently.
Related Links: Recording Acknowledge [RA] - CallGem to Agent |
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 | ||||||
ON | OnOff | boolean | false | 0 | 0 | If specified, recording will be intiated. If not specified, recording will be terminated. | ||||||
RF | RecordingFilename | string | false | 1 | 1024 | Recording Filename parameter | ||||||
RS | ResourceStatus | int | true | 0 | 4 |
The parameter may have the value 0, 1 or 2.
|
||||||
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. | ||||||
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. | ||||||
YR | RecordingUniqueIdentifier | string | false | 1 | 80 | From V10.6.439 - This field contains the globally unique identifier assigned by CallGem on the RR message. It needs to be reflected here by way of acknowledgement. |