API return codes

更新时间:
复制 MD 格式

This topic describes the server-side API return codes for the Phone Number Verification Service.

Return code

Return Codes

Suggestion

OK

The request was successful.

None

isv.VERIFY_SCHEME_NOT_EXIST

The verification scheme does not exist.

Confirm that you have created a scheme in the Phone Number Verification Service console. Check whether the package name and signature or the BundleID used to create the scheme match the ones in use.

isv.VERIFY_SCHEME_CONFLICT

The verification scheme conflicts with an existing one.

Check whether a scheme with the same package name and signature or the same BundleID exists in the same Alibaba Cloud account.

isv.PACK_SIGN_CONFLICT

The package signature conflicts with an existing one.

A verification scheme with the same package name and signature already exists. Modify the verification scheme.

isv.BUNDLE_ID_CONFLICT

The BundleID conflicts with an existing one.

A verification scheme with the same BundleID already exists. Modify the verification scheme.

isv.RAM_PERMISSION_DENY

You do not have access permissions.

Confirm that the Resource Access Management (RAM) user has the required permissions to call the Phone Number Verification Service.

isv.SCENE_QUERY_FAIL

Failed to query the scenario.

Enter the correct SceneCode. Make sure that you have created a scheme in the Phone Number Verification Service console.

isv.TOKEN_INVALID

The token is invalid.

The AccessToken or AccessCode has expired. Obtain a new one.

isv.TOKEN_UNAUTHORIZED_USED

The token is used without authorization.

A token for mobile number verification was used to call the one-click logon API. Use the correct token.

isv.PRODUCT_UNSUBSCRIBE

The service is not activated.

Activate the service in the Phone Number Verification Service console.

isv.PRODUCT_UN_SUBSCRIPT

The Alibaba Cloud account has not activated Alibaba Cloud Communications services.

Activate the service in the Phone Number Verification Service console.

isv.PARAMETERS_MISMATCH

The parameters do not match.

The entered mobile phone number does not match the carrier of the current data network. Check the parameters.

isv.OUT_OF_SERVICE

The service is suspended.

Check your Alibaba Cloud account balance and add funds if necessary.

isv.MOBILE_NUMBER_ILLEGAL

The mobile phone number format is invalid.

Check the mobile phone number format.

isv.INVALID_PARAMETERS

Invalid parameters.

Check the request parameters.

isv.INVALID_PARAMETERS

The request parameter VendorKey is invalid.

Check if the passed VendorKey parameter is correct.

isv.INVALID_PARAMETERS

The carrier cannot be identified.

An incorrect parameter was passed when you queried the scenario details. Check whether the AccessCode is correct.

isv.INVALID_PARAMETERS

The AccessCode parameter cannot be empty.

The passed AccessCode parameter is empty or incorrect. Check the value of the AccessCode parameter.

isv.INVALID_PARAMETERS

The os_type parameter cannot be empty.

The passed os_type parameter is empty. Check the value of the os_type parameter.

isv.INVALID_PARAMETERS

The os_type parameter is invalid.

The passed os_type parameter is invalid. Check the value of the os_type parameter.

isv.INVALID_PARAMETERS

The AccessKey parameter cannot be empty.

The passed AccessKey parameter is empty. Check the value of the AccessKey parameter.

isv.INVALID_PARAMETERS

The AccessParam parameter cannot be empty.

The passed AccessParam parameter is empty. Check the value of the AccessParam parameter.

isv.INVALID_APP

The app request is invalid.

Confirm that the Alibaba Cloud account used to create the scheme is the same as the Alibaba Cloud account used for the server-side call.

isv.FORBIDDEN_ACTION

You are not authorized to perform this operation.

Confirm that the corresponding feature is activated for your Alibaba Cloud account.

isv.CSRF_CHECK_FAILED

CSRF token check failed.

The token parameter is expired or invalid. Check the value of the token parameter.

isv.ACCOUNT_NOT_EXISTS

The account does not exist.

Check whether the account is correct.

isv.ACCOUNT_ABNORMAL

The account is abnormal.

Check whether the account status is Normal.

isv.ACCESS_CODE_ILLEGAL

The AccessCode parameter is invalid.

Check whether the AccessCode parameter is the same as the one returned by the client.

isp.UNKNOWN

An unknown error occurred.

Try again later.

isp.SYSTEM_ERROR

A system error occurred.

Try again later.

isp.RES_OWNER_ID_UNKNOWN

The Alibaba Cloud ID for resource ownership cannot be found.

Check whether the Alibaba Cloud account is correct.

isp.RAM_PERMISSION_DENY

RAM permission denied.

Confirm that the RAM user has the required permissions to call the Phone Number Verification Service.

isp.QPS_LIMIT

The QPS is throttled.

Too many requests are sent to call this API. Try again later.

isp.OPERATOR_LIMIT

This SDK version is restricted by the carrier.

Only China Telecom, China Mobile, and China Unicom are supported.

InvalidParameter.MissingCustomerId

The CustomerId parameter is missing.

The account is incorrect. Check the account information.

InvalidParameter.MissingPackageName

The PackageName parameter is missing.

When os_type is set to Android, the package name cannot be empty.

InvalidParameter.MissingSignName

The SignName parameter is missing.

When os_type is set to Android, the signature cannot be empty.

InvalidParameter.MissingBundleId

The BundleID parameter is missing.

When os_type is set to iOS, the BundleID cannot be empty.

InvalidParameter.SmsTemplateCode

The SmsTemplateCode parameter is invalid.

Confirm that a corresponding SMS template code exists in the same account.

InvalidParameter.OsType

The os_type parameter is invalid.

Confirm that os_type is set to Android or iOS.

InvalidParameter.MisMatchWithSceneCode

The SceneCode parameter does not match.

Confirm that the package name, signature, or BundleID corresponding to the scheme number is correct in the same account.

InvalidPhoneNumber.Check

Failed to validate the PhoneNumber.

Check whether the mobile phone number format is correct.

InvalidBizToken.Expired

The BizToken has expired.

Obtain a new BizToken.

LimitExceeded.SmsCode

The SmsCode limit is exceeded.

The number of verification codes generated for the same mobile phone number with the same signature and template exceeds the limit. You can modify the limit on the General Settings page in the Phone Number Verification Service console.

InvalidBizToken.Check

Failed to validate the BizToken.

Check whether the BizToken is correct.

EntityNotExist.SceneCode

You can check if a plan ID exists in the same account.

Check whether the scheme number exists in the same Alibaba Cloud account.

EntityNotExist.SmsTemplateCode

The SmsTemplateCode does not exist.

Check whether an approved SMS template code exists in the same account.

EntityNotExist.SmsSignName

The SmsSignName does not exist.

Check whether an approved SMS signature exists in the same account and is attached to this scheme number.

EncryptError.BizToken

Failed to encrypt the BizToken.

Generate a new BizToken.

QueryFail.SceneCode

Failed to query the SceneCode.

Check whether the scheme number is correct.

CreateFail.StsToken

Failed to create the StsToken.

Create a new StsToken.

CreateFail.SmsCode

Failed to create the SmsCode.

Generate a new text message verification code.

CreateFail.VerifyKey

Failed to create the VerifyKey.

Obtain a new text message verification code.

GET_MOBILE_FAILED

Failed to retrieve the number

Check whether the number entered on the H5 frontend is the same as the number of the device's active data connection.

Fusion authentication (based on atomic capabilities)

Return code

Description

Suggestion

isv.ValidateFail

Validation failed.

  • Enter the correct verification code received on the terminal.

  • The verification code has expired. Obtain a new one.

  • The verification code has been overwritten. Enter the latest verification code.

Note

Set the verification code parameter as required.

  • {"code":"##code##","min":"5"}: The verification code is dynamically generated by the API. The Alibaba Cloud API can complete the validation.

  • {"code":"123456","min":"5"}: The verification code is configured by the user and is not dynamically generated by the API. The Alibaba Cloud API cannot validate it.

FUNCTION_NOT_OPENED

You have not activated this feature.

The fusion authentication feature is not activated. Activate this feature in the Phone Number Verification Service console.

biz.FREQUENCY

Frequency check failed.

Make sure that the frequency of sending verification codes to the same mobile phone number does not exceed the limit.

Note

The field that limits the text message sending frequency is Interval.

isv.BUSINESS_LIMIT_CONTROL

Throttling is triggered for the mobile phone number.

The carrier limit is triggered for this mobile phone number. Try again later.