API Message Guide

FC - Finished Capture

Layer CTI
Direction To CallGem
Type of Service CG
Interface ID CT
Message Purpose This message informs CallGem that the audio capture sequence has completed.
Example FC\TDtenant1\CNCustCare\ANJoe\SI123\RS0\DZ9
Explanation The CTI layer is informing CallGem that the customer has successfully entered the digit '9'
Notes The conditions for capturing digits (e.g. valid digits, terminating digits etc.) are defined in the Play Capture [PC] message
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 / \ : * ? " < > | & % + ! ' ;
DZ DigitData string false 1 4000 String containing the digits captured
RS ResourceStatus int true 0 4 This parameter may have the following values:
0Captured digits successfully
1Capture Timed Out
2Capture Aborted
SI SessionIdentifier string true 1 120 User defined parameter values may include any characters except / \ : * ? " < > | & % + ! ' ;
SZ MatchResult string false 1 4000 String containing the recognised word or phrase.
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