Navigation :

PIN Authorisation

The PinAuthorisation requests the network infrastructure to prompt the caller to enter the Personal Identification Number (PIN) associated with this Service Number. The entered digits must match the PIN configured against this Service Number at the time of calling.

Note that the PIN length for each Service Number is determined automatically at the time of calling, and does not need to be configured within this operation.

The PinAuthorisation operation has two exits. If the caller abandons (i.e. hangs up) during the announcement, no further processing is performed and no exit is followed.

Note that in the case where no PIN is provisioned at the time of the call, the “Not Allowed” branch will be immediately followed, and no user interaction will occur.

Config Parameters

The PinAuthorisation 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.
`max_iterations`	Integer	The maximum number of attempts that the caller may have to enter a valid PIN. (Default = 3)

Example Operation

Here is an example PinAuthorisation operation in JSON representation.

    {
        "id": 5,
        "type": "PinAuthorisation",
        "base_node": 1,
        "config": {
            "main_announcement": { "set": "General Purpose Anns",
                                   "entry": "Please Enter PIN", "repetition": 1 },
            "reprompt_announcement": { "set": "General Purpose Anns",
                                       "entry": "Invalid PIN Please Try Again", "repetition": 1 },
            "max_iterations": 3
        },
        "exits": [ 4, 17 ]
    }

If the caller successfully enters a valid PIN, processing will continue down exit index 0 to operation ID 4.

If the caller cannot provide a valid PIN after three attempts, processing will continue down exit index 1 to operation ID 17.

Exits

There are always exactly two exits for an PinAuthorisation operation.

Exit Index	Name	Description
`0`	Caller On‑Line	[Required] This exit is followed if the caller successfully entered an acceptable PIN, and is still connected at the end of the announcement.
`1`	Not Allowed	[Required] This exit is followed if the caller failed to enter an acceptable PIN after the maximum number of iterations, and is still connected at the end of the announcement.