VALIDATENOTIFYCODEVERIF()`¶

About ValidateNotifyCodeVerification¶

Validates a one-time passcode that a recipient submitted. Validation succeeds when the passcode matches, the validity period has not elapsed, and the maximum number of attempts has not been exceeded.

Method Signature¶

METHODS /AWS1/IF_PPU~VALIDATENOTIFYCODEVERIF
  IMPORTING
    !IV_DESTINATIONIDENTITY TYPE /AWS1/PPUDESTINATIONIDENTITY OPTIONAL
    !IV_REFERENCEID TYPE /AWS1/PPUREFERENCEID OPTIONAL
    !IV_CODE TYPE /AWS1/PPUVERIFICATIONCODE OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ppuvldtntfcodeverfout
  RAISING
    /AWS1/CX_PPUACCESSDENIEDEX
    /AWS1/CX_PPUINTERNALSERVEREX
    /AWS1/CX_PPUTHROTTLINGEX
    /AWS1/CX_PPUVLDTNEXCEPTION
    /AWS1/CX_PPUCLIENTEXC
    /AWS1/CX_PPUSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_destinationidentity` `TYPE /AWS1/PPUDESTINATIONIDENTITY` `/AWS1/PPUDESTINATIONIDENTITY`¶

The recipient identifier. For the TEXT and VOICE channels, specify an E.164 phone number. For the WhatsApp channel, specify a WhatsApp address.

`iv_code` `TYPE /AWS1/PPUVERIFICATIONCODE` `/AWS1/PPUVERIFICATIONCODE`¶

The one-time passcode that the recipient submitted for validation.

Optional arguments:¶

`iv_referenceid` `TYPE /AWS1/PPUREFERENCEID` `/AWS1/PPUREFERENCEID`¶

The caller-supplied reference identifier used to locate the verification. This value must match the value that you supplied to the SendNotifyCodeVerification operation.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_ppuvldtntfcodeverfout` `/AWS1/CL_PPUVLDTNTFCODEVERFOUT`¶

Examples¶

Syntax Example¶

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->validatenotifycodeverif(
  iv_code = |string|
  iv_destinationidentity = |string|
  iv_referenceid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_verificationstatus = lo_result->get_status( ).
ENDIF.

Validate a submitted one-time passcode¶

Validate a submitted one-time passcode

DATA(lo_result) = lo_client->validatenotifycodeverif(
  iv_code = |123456|
  iv_destinationidentity = |+14255550100|
  iv_referenceid = |signup-flow-42|
).

/AWS1/IF_PPU=>VALIDATENOTIFYCODEVERIF()¶