Difference between revisions of "PromptAndCollectUserInformation"

Latest revision as of 15:24, 28 August 2013

[edit] Capability: Camel

[edit] Usage

This operation is used to interact with a user to collect information. When the gsmSRF is colocated with the gsmSSF, this operation is relayed from the gsmSCF to the gsmSRF via the gsmSSF.

[edit] Expected actions

[edit] Invoke parameters

• CollectedInfo – contains the following list:
  • collectedDigits
    • minimumNbOfDigits – minimum number of digits to be collected. Defaults to 1.
    • maximumNbOfDigits – maximum number of digits to be collected.
    • endofReplyDigit – indicates the digit(s) to signal end of input. It can be one or 2 digits.
    • cancelDigit – indicates the cancel digit for a possible retry. It can be one or 2 digits.
    • startDigit – indicates the start digit for collecting valid digits. It can be one or 2 digits.
    • firstDigitTimeOut – timer value for the first digit to be received.
    • InterDigitTimeOut – timer value for maximum interval at which digits should be received.
    • errorTreatment – indicates the error treatment to the gsmSRF. It can have the following values:
      • stdErrorAndInfo
      • help
      • repeatPrompt
    • interruptableAnnInd – if this parametes is set to true, the announcement is interrupted after the first digit received by the gsmSRF, otherwise the digits received during the announcement are discarded.
    • voiceInformation – if this parametes is set to false, all valid/invalid digits are entered by DTMF, otherwise the user is required to provide information by speech.
    • voiceBack – if this parameter is set to true, the valid input digits received by the gsmSRF are announced back to the user immediately. Invalid digits or an end digits are not reported back.
• disconnectFromIPForbidden – indicates whether the gsmSRF shall be disconnected from the user when all information has been sent.
• informationToSend - indicates an announcement or tone to be sent to the end user by the gsmSRF. It's a choice between the following parameters:
  • inbandInfo – specifies the inband information to be sent:
    • • messageID – the message to be sent and can be one of the following:
        • elementaryMessageID – indicates a single announcement.
        • text – indicates a text to be sent. The text will be transformed to inband information by the gsmSRF....
        • elementaryMessageIDs – indicates a series of announcements. ..
        • variableMessage – indicates a message with one or more variable parts...
      • numberOfRepetitions – the maximum number of times the message shall be sent to the user.
      • duration – the maximum duration in seconds that the message shall be played. A value of zero indicates endless repetition.
      • interval – indicates interval in seconds between repetitions.
    • tone – indicates a tone to be sent to the user by:
      • toneID – the id of the tone to be sent
      • toneDuration – duration in seconds of the tone to be sent. Zero indicates infinite duration.

• extensions

[edit] Result parameters

This operation does not expect a result.

[edit] Example

	<component localCID="1" type="Invoke" operationCode="promptAndCollectUserInformation">
    		<collectedInfo>
      		<collectedDigits>
        			<minimumNbOfDigits>3</minimumNbOfDigits>
        			<maximumNbOfDigits>10</maximumNbOfDigits>
        			<endOfReplyDigit>22</endOfReplyDigit>
        			<cancelDigit>84</cancelDigit>
        			<startDigit>57</startDigit>
        			<firstDigitTimeOut>2</firstDigitTimeOut>
        			<interDigitTimeOut>1</interDigitTimeOut>
        			<errorTreatment>help</errorTreatment>
        			<interruptableAnnInd>true</interruptableAnnInd>
        			<voiceInformation>true</voiceInformation>
        			<voiceBack>false</voiceBack>
      		</collectedDigits>
    		</collectedInfo>
    		<disconnectFromIPForbidden>true</disconnectFromIPForbidden>
    		<informationToSend>
      		<inbandInfo>
        			<messageID>
          				<text>
            				<messageContent>Text</messageContent>
            				<attributes>84 79 32 01 25</attributes>
          				</text>
        			</messageID>
        			<numberOfRepetitions>3</numberOfRepetitions>
        			<duration>5</duration>
        			<interval>10</interval>
      		</inbandInfo>
    		</informationToSend>
 	</component>