GetPassword

Purpose

Use GetPassword to compare the password a caller enters with the password defined in the application profile for the current mailbox.

Description

GetPassword reads the <#> key as "end of password." It reads the asterisk (*) key as "stop input" and the action ends with the Input Stop result.

Before using GetPassword, you must set the Caller - Profile ID (SV20) and Caller : Mailbox - ID (SV32) system variables.

GetPassword causes an automatic fade out of any background music. You can override this by using the System : Music : Automatic fade before actions system variable (SV226).

Parameters

The parameters for GetPassword define how long the action waits for the password and how many times the application can repeat the action.

• Timeout. Specifies how many seconds the action waits for a caller to key in password information. If the Timeout input parameter is set to 0 and the Timeouts Allowed parameter is set to 20, the user is not prompted for a password but the mailbox is locked.
• Timeouts Allowed. Specifies the maximum number of timeouts allowed for this GetPassword action. When the Timeouts Allowed value is reached, the application branches to the state identified for the Last Timeout result.

  The timeout counter retains its value until a new Get action (GetPassword, GetData, GetFindData, GetFindName, GetKey, or GetText) is encountered.

  The timeout counter applies to the current line of the state table. When the Last Timeout result has been returned, the counter is reset. Also, note that the debugger treats each statement, or line, as a separate state table, so two consecutive Get actions appear as one action to Blueworx Voice Response. Last Timeout could therefore be returned when Timeout is expected. This is a limitation of the debugger.

  The Last Timeout result is returned for any GET action if fax detection is turned on, and is detected. Check SV180 to see if fax was detected.

Possible results

GetPassword can have one of the following results:

Password Found

The password keyed in by the caller matches the password defined in the application profile.

Password Not Found

The password keyed in by the caller does not match the password defined in the application profile.

Input Incomplete

The caller did not press the pound key.

Mailbox In Use

The caller’s mailbox is currently being used.

Invalid Mailbox ID

Either the caller keyed in an incorrect mailbox ID, or did not supply a mailbox ID.

Input Stop

The caller pressed the asterisk (*) key.

Timeout

The time defined by Timeout has elapsed and the caller has not entered the information.

Last Timeout

The application has repeated this GetPassword action for the number of times specified by the value of Timeouts Allowed.

Caller Hung Up

The caller has hung up.

ASCII syntax

When using an ASCII editor, code this action with these parameters in the following order:

1. Timeout
2. Timeouts allowed

For example:

label: "Check Edges"
	GetPassword(5, 12)
	  edge EDGE_GET_PASSWORD_FOUND:	  found
	  edge EDGE_GET_PASSWORD_NOT_FOUND:  not_found
	  edge EDGE_GET_PASSWORD_INCOMPLETE: incomplete
	  edge EDGE_ACCOUNT_IN_USE:		  account_in_use
	  edge EDGE_GET_PW_INVALID_BOX_ID:	invalid_box_id
	  edge EDGE_GET_PW_STOP:			  stop
	  edge EDGE_TIMEOUT: 				timeout
	  edge EDGE_LAST_TIMEOUT: 		   last_timeout
	  edge EDGE_HUP: 					hup
	;

The parameters and edges are described above under "Parameters" and "Possible results". For more information, see Testing a state table using the debugger.