Navigation :

PIN Authorisation

The PinAuthorisation operation requests the network infrastructure to prompt the caller to enter the Personal Identification Number (PIN) associated with the current service.

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 no PIN is provisioned for the service at the time of the call, the “Not Allowed” exit will be selected, and no interaction will occur.
Otherwise the exit is selected based on whether the service PIN is successfully entered by the caller.

Note that the required PIN length is determined automatically from the service PIN at the time of calling, and does not need to be configured within this operation.

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 the correct service PIN. (Default = 3)

Example Operation

Here is an example PinAuthorisation operation in JSON representation.

    {
        "id": 5,
        "type": "PinAuthorisation",
        "config": {
            "main_announcement": { "customer_name": "Main Customer", "entry": "Please Enter PIN" },
            "reprompt_announcement": { "customer_name": "Main Customer", "entry": "Invalid PIN Please Try Again" },
            "max_iterations": 3
        },
        "exits": [ 4, 17 ]
    }

If the caller successfully enters the correct service PIN, processing will continue via exit index 0 to the operation with ID 4.

If the caller fails to provide the correct service PIN 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 a PinAuthorisation operation.

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