Navigation :

Account Code Entry

The AccountCodeEntry operation may request the network infrastructure to prompt the caller to enter an “Account Code” (also known as an “Access Code”).

If the caller abandons (i.e. hangs up) at any point in the operation, no further processing is performed and no exit is followed.
If the configured account code set is configured to not require input, the interaction will be skipped and the “Success” exit will be selected.
If the configured account code set is configured to require input without validation, the prompt will be played, any input meeting length constraints will be accepted, and the “Success” exit will be selected.
Otherwise the exit is selected based on whether the caller input matches an Account Code in the set.

Note that the required input length is specified by the account code set, and does not need to be configured within this operation.

Config Parameters

The AccountCodeEntry operation config attributes are as follows.

Parameter	Type	Description
`main_announcement`	Announcement Object	[Required] The `main_announcement` parameter is an Object using the shared announcement configuration structure as defined in the Flow Introduction documentation. This announcement is played as the prompt on the caller's first attempt to enter input.
`reprompt_announcement`	Announcement Object	[Required] The `reprompt_announcement` parameter is an Object using the shared announcement configuration structure as defined in the Flow Introduction documentation. This announcement is played as the prompt on the caller's second and subsequent attempts to enter input.
`account_code_set_name`	String	[Required] The name of an account code set owned by the same customer that owns the service and flow. The internal configuration of this account code set is used to determine whether caller input is required, and what constitutes valid input.
`max_iterations`	Integer	The maximum number of attempts that the caller may have to enter an acceptable Account Code. (Default = 3)

Example Operation

Here is an example AccountCodeEntry operation in JSON representation.

    {
        "id": 5,
        "type": "AccountCodeEntry",
        "config": {
            "main_announcement": { "customer_name": "Main Customer", "entry": "Please Enter Account Code" },
            "reprompt_announcement": { "customer_name": "Main Customer", "entry": "Invalid Code Please Try Again" },
            "account_code_set": "Account Codes",
            "max_iterations": 3
        },
        "exits": [ 4, 17 ]
    }

If the caller successfully enters an acceptable account code (or input is not required) according to the configuration for the Account Codes account code set, processing will continue via exit index 0 to the operation with ID 4.

If the caller does not provide an acceptable account code after 3 attempts (max_iterations), processing will continue via exit index 1 to the operation with ID 17.

Exits

There are always exactly two exits for an AccountCodeEntry operation.

Exit Index	Name	Description
`0`	Success	[Required] This exit is followed if: The `account_code_set` is configured to not require input, or The `account_code_set` is configured to require input without validation, and the caller enters sufficient digits, or The `account_code_set` is configured to require and validate input, and the caller enters a valid Account Code. In all cases the caller must still be connected.
`1`	Not Allowed	[Required] This exit is followed if the caller failed to enter an acceptable account code after the maximum number of iterations, and is still connected.