API Message Reference

PC - Play Capture

Layer CTI
Direction From CallGem
Type of Service CG
Interface ID CT
Message Purpose This message instructs the CTI layer to commence an audio capture sequence.
Example
Explanation
Notes
Last Changed V9.2.0.40
Parameters
Code Name Type Mandatory? Min Val Max Val Description
CC ChoicesCount int false 1 999 The number of possibilities from the MP parameter that can be matched together.
CN CampaignName string true 1 80 User defined parameter values may include any characters except / \ : * ? " < > | & % + ! ' ;
CX CaptureTimeout int false 1 99 Default value is 10 seconds. If more than CX seconds have elapsed since the playback has finished or the last digit capture event then the capture is finished.
DH DigitsHigh int false 1 99 Parameter's default value is 1.
ED EndingDigits string false 1 80 String containing a set of digits, any of which will terminate the capture. There is no default for this optional parameter.
MP MatchPossibilities string false 1 4000 String containing a set of comma separated choices of words or phrases that could be recognised using speech recognition.
SI SessionIdentifier string true 1 120 Session Identifier parameter
SN SymbolicName string false 1 80 This parameter is alphanumeric. The SN parameter contains the path to the sound file.
SP Speech string false 1 4000 This parameter is alphanumeric. The SP parameter contains the text to be played to the customer through the TTS engine
TD TenantDescriptor string false 1 80 This parameter is alphanumeric and identifies to which tenant this message applies.
VD ValidDigits string false 1 80 Parameter represents a string containing set of valid digits. If, for example, the menu only allows 1 through 4 and 0 for main menu, then this string would contain 01234. Default value is "0123456789ABCD#*"
YS SessionUUID string false 20 50 From V10.7.596 - Each media session has a universally unique identifier assigned on creation. The UUID can be used by telephony layer messaging as an alternative unique form of reference to the SI parameter.

 

Copyright © 2004 - 2019  Sytel Limited