Layer | Agent |
Direction | From CallGem |
Type of Service | CG |
Interface ID | AG |
Message Purpose | This message is sent in response to a valid Request Recording [RR] message. 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\AN24\ON\RS0 |
Explanation | Recording has successfully started for the call with the session identifier 0123456 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.
Recording Acknowledge [RA] - Telephony to CallGem |
Parameters | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Code | Name | Type | Mandatory? | Min Val | Max Val | Description | ||||||
AN | AgentIdentifier | string | true | 1 | 80 | User defined parameter values may include any characters except / \ : * ? " < > | & % + ! ' ; | ||||||
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.
|
||||||
TD | TenantDescriptor | string | false | 1 | 80 | This parameter is alphanumeric and identifies to which tenant this message applies. | ||||||
YR | RecordingUniqueIdentifier | string | false | 1 | 80 | From V10.6.431 - If this recording is the main recording made for this agent's current call session, this field contains the globally unique identifier assigned. |