API error codes

Updated at:

This topic lists the error codes for API operations. You can use these error codes and their corresponding messages to troubleshoot issues.

Service error codes

API error code

Error message

Recommended actions

OK

The request was successful.

None

isp.RAM_PERMISSION_DENY

Insufficient RAM permissions.

Grant permissions to the current Resource Access Management (RAM) user. For more information, see Grant permissions to a RAM user.

isv.OUT_OF_SERVICE

The service is suspended.

Check whether your account has an overdue payment in the User Center and add funds to your account immediately.

isv.PRODUCT_UN_SUBSCRIPT

The Alibaba Cloud account has not subscribed to the cloud communications product.

Check whether the current account has activated the Voice Service product.

isv.PRODUCT_UNSUBSCRIBE

The product feature is not activated.

On the Voice Service Feature Activation page, confirm whether the feature that corresponds to the API operation is activated.

isv.TTS_TEMPLATE_ILLEGAL

The text-to-speech (TTS) template is invalid.

Log on to the Voice Service console and check whether the template exists on the Add Template page. For more information, see Create a voice template.

isv.VOICE_ROBOT_CALLEE_LIMIT

The number of callees exceeds 1,000.

Reduce the number of callees and call the operation again.

isv.BUSINESS_LIMIT_CONTROL

The call triggered a throttle. Throttles are imposed on a per-minute, per-hour, and per-day basis.

Call the operation within the throttle limits.

Note
  • The following throttles apply to the same caller for a specific qualification and purpose: 1 call per minute, 5 calls per hour, and 20 calls per 24 hours. The throttle period starts from the first successful outbound call.

  • To adjust the throttle limits, submit a request as described in Call settings.

isv.VOICE_ROBOT_NOT_PERIOD

The send time must be outside the restricted period.

Adjust the call time and call the operation again.

isv.MOBILE_COUNT_OVER_LIMIT

The number of mobile phone numbers exceeds the limit.

Reduce the number of mobile phone numbers and call the operation again.

isv.VOICE_CALL_PERIOD_ERROR

Failed to retrieve the voice call time period.

Adjust the call time and call the operation again.

isv.VOICE_CALL_FAIL

The call failed to initiate.

Log on to the Voice Service console and go to the Business Statistics page to view the reason for the voice call failure.

isv.BILLID_NOT_EXIST

The billing account does not exist.

Log on to the Voice Service console. On the Number Management page, confirm that the caller ID belongs to your account.

If the isv.DISPLAY_NUMBER_ILLEGAL (the sender ID is invalid) error is returned at the same time, verify the account that is used to call the outbound call API. You must call the outbound call API with the same Alibaba Cloud account that is logged on to the console or that configured the number. If you configure an outbound number with Account A, you must call the outbound call API with the AccessKey of Account A. Calling the API with Account B, which does not have the number configured, returns both isv.BILLID_NOT_EXIST and isv.DISPLAY_NUMBER_ILLEGAL. You can go to next.api.aliyun.com/troubleshoot and paste the RequestId to view the account that owns the AccessKey used by the request.

isv.BLACK_KEY_CONTROL_LIMIT

The template variable contains a blacklisted keyword.

Confirm whether the template contains illegal content. For more information, see Voice template specifications.

isv.COMPLAINT_REJECT

The call was blocked to prevent harassment.

The call from the caller ID was blocked. This can happen if the number is currently under complaint or has a history of complaints, which restricts calls. Change the callee number and try the call again.

isv.TEMPLATE_ILLEGAL

The template is invalid or does not exist.

Log on to the Voice Service console and check whether the template exists. For more information, see Create a voice template.

isv.TEMPLATE_PARAMS_ILLEGAL

The template variable is invalid.

Remove illegal keywords or verification codes from the template variable. For more information about variable specifications, see Voice template specifications.

isv.AMOUNT_NOT_ENOUGH

Insufficient account balance.

Add funds to your account promptly. Before you call the operation, confirm that your account balance is sufficient to cover the expected usage.

isv.ACCOUNT_NOT_EXISTS

The account does not exist.

Confirm your AccessKeyId.

isv.ACCOUNT_ABNORMAL

The account is abnormal.

Check whether your account has an overdue payment, or try to call the operation again later.

isv.DISPLAY_NUMBER_ILLEGAL

The sender ID is invalid.

Check the format of the caller or callee number for abnormal characters.

isv.INVALID_PARAMETERS

Invalid parameters.

Confirm that the parameter fields and their corresponding values are correct.

isv.PARAM_NOT_SUPPORT_URL

The variable does not support URLs.

Check whether a URL or sensitive information was passed in the variable.

isv.MOBILE_NUMBER_ILLEGAL

The number format is invalid.

Confirm that the number format is correct.

isp.RES_OWNER_ID_UNKNOWN

The Alibaba Cloud account ID of the resource owner cannot be found.

Check whether your Alibaba Cloud account is correct.

isv.VOICE_ROBOT_NOT_AUDIT

The robot did not pass the review.

You can resubmit for review.

isv.VOICE_ROBOT_ID_NULL

The robot data cannot be found.

Check whether the robot ID is missing from the parameters.

isv.RAM_CHECK_FAILED

RAM permission check failed.

Check whether the RAM configurations comply with the rules.

isv.TEMPLATE_MISSING_PARAMETERS

Template parameters are missing.

Confirm that all template parameters are specified.

100008

The data does not exist.

Confirm whether the voice API, the called robot, or the task information exists.

isv.INVALID_JSON_PARAM

The JSON parameter is invalid.

Confirm that the format of the JSON parameter is valid.

isv.VOICE_FILE_ILLEGAL

The voice file is invalid.

Confirm whether the voice file exists and has passed the review.

isv.PHONE_NUMBER_IN_BLACK_LIST

The phone number is on the blacklist.

The callee number is on a blacklist due to complaints, which prevents calls.

isv.PHONE_NUMBER_RETRIEVE

The number was forcibly revoked.

This number was forcibly revoked. Replace the number as soon as possible.

isp.USER_NOT_EXIST

The user information does not exist.

A system error occurred, or the user is on a blacklist.

isv.PARAM_LENGTH_LIMIT

The template parameter length is invalid.

Change the length of the template parameter. The parameter cannot exceed 1,000 characters.

isv.VOICE_CODE_PARAM_ILLEGAL

The VoiceCode parameter is invalid.

Confirm that the format of the VoiceCodeParam parameter for the SmartCall operation is correct.

  • The VoiceCodeParam parameter cannot exceed 1,000 characters in length.

  • The VoiceCodeParam parameter must be in JSON format.

  • The TTS parameter must be a string in JSON format and must correspond to the TTS parameter of the VoiceCode.

isp.USER_ASSERT_NOT_EXIST

Failed to retrieve user information.

Confirm whether you have activated the corresponding cloud product. If you have, call the operation again.

isv.HIT_VOICE_SECURITY_RULE

The caller ID is disabled because it hit a security control policy.

Replace the caller ID with an active number and make the outbound call again.

Note

You can query the number status on the Real Number Management page in the Voice Service console.

isv.ASR_MODEL_ERROR

You are not authorized to use the Automatic Speech Recognition (ASR) model.

The ASR model does not exist. Confirm that you own this ASR model.

isp.UNKNOWN

An unknown error occurred.

Call the operation again later.

isp.SYSTEM_ERROR

A temporary system error occurred.

Call the operation again later.

isp.GATEWAY_ERROR

A system error occurred.

Call the operation again later.

Common error codes

Error code

Error message

Recommended Actions

InvalidAccessKeyId

The AccessKey is invalid.

Log on to the RAM console to confirm whether the AccessKey exists.

InvalidAccessKeyId.NotFound

The AccessKey does not exist.

Log on to the RAM console to confirm whether the AccessKey exists.

InvalidAccessKeyId.Inactive

The AccessKey is inactive.

Log on to the RAM console to confirm whether the AccessKey is active.

InvalidAction.NotFound

The action does not exist.

The API operation does not exist.

  • If you are using an SDK to call the operation, confirm that the Action parameter is correct.

  • If you are using HTTP to call the operation, confirm that the Action parameter is correct.

InvalidVersion

The API version number is incorrect.

Use the upgraded SDK from the OpenAPI Developer Portal.

  • If you are using an SDK to call the operation, confirm that the Version parameter is specified correctly.

  • If you are using HTTP to call the operation, confirm that the Version parameter in the common request parameters is specified correctly.

InvalidTimeStamp.Expired

The TimeStamp field in the API request is invalid.

Set the TimeStamp parameter value as described in Common request parameters.

Note

If you are using an SDK to call the operation, confirm that your server time is correct.

InvalidParameters

Invalid parameters.

Confirm that the parameters are specified correctly. For more information, see Voice Service API reference.

MissingAccessKeyId

The AccessKeyId parameter is missing.

  • If you are using an SDK to call the operation, confirm that the AccessKeyId of the client is set.

  • If you are using HTTP to call the operation, confirm that the AccessKeyId is passed.

MissingVoiceCode

The VoiceCode parameter is missing.

Confirm that the VoiceCode parameter is included when you call the API operation.

MissingStartCode

The StartCode parameter is missing.

Confirm that the StartCode parameter is included when you call the API operation.

MissingCallId

The CallId parameter is missing.

Confirm that the CallId parameter is included when you call the API operation.

MissingCalledNumber

The CalledNumber parameter is missing.

Confirm that the CalledNumber parameter is included when you call the API operation.

MissingTtsCode

The TtsCode parameter is missing.

Confirm that the TtsCode parameter is included when you call the API operation.

SignatureDoesNotMatch

The signature of the API request is incorrect.

  • If you are using an SDK to call the operation, confirm that the parameters are correct. If the SDK is not the latest version, upgrade it to the latest version.

  • If you are using HTTP to call the operation, adjust the signature calculation method based on the invocation mechanism to ensure that it is consistent with the document. We recommend that you use an SDK.

SignatureNonceUsed

The SignatureNonce has been used.

  • If you are using an SDK to call an API, confirm that you are sending the request with the same signature. If the SDK is not the latest version, we recommend upgrading to the latest version.

  • If you are using HTTP to call the operation, adjust the signature calculation method based on the invocation mechanism to ensure that it is consistent with the document. We recommend that you use an SDK.

Throttling.User

The call triggered a user-level API throttle.

Find the API operation that triggered the throttle. For more information, see Throttling information.

UnauthorizedOperation

The operation is not authorized.

Confirm whether the action exists.

ServiceUnavailable

The service is unavailable.

The cloud product service is abnormal. Call the operation again later.

Note

For error codes of the MissingXX parameter type, the solution is the same: confirm that the XX parameter is included.