users.validateVerificationCode

Syntax

bool users.validateVerificationCode ( int vhost, string verificationCode, string phone = '', int countryCode = 0, string email = '' )

Argument Info

NameTypeRequiredDefault valueDescription
vhostintRequirednoneID of the application that the media is in.
verificationCodestringRequirednoneThe code that was sent to the user via sendVerificationCode
phonestringOptional''Phone number of the user, numeric only
countryCodeintOptional0country code of the user, numeric only
emailstringOptional''Email address that was used to send the verifcationCode

Return Values

FieldDescriptionPossible Values
@param int $vhost ID of the application that the media is in.aN/A
@param int $verificationCode The code that was sent to the user via sendVerificationCodeaN/A
@param int $phone Phone number of the user, numeric onlyaN/A
@param int $countryCode country code of the user, numeric onlyaN/A
@param string $email Email address that was used to send the verifcationCodeaN/A
@return bool true for valid code, false otherwiseaN/A