All Products
Document Center


Last Updated:Nov 21, 2023

Delivers one-time password (OTP) message statuses to Alibaba Cloud, which calculates and monitors OTP conversion rates.

Operation Description


  • Requested OTP messages
  • Verified OTP messages

An OTP conversion rate is calculated based on the following formula: OTP conversion rate = Number of verified OTP messages/Number of requested OTP messages.

Note If you call the SmsConversion operation to query OTP conversion rates, your business may be affected. We recommend that you perform the following operations:
  • Call the SmsConversion operation in an asynchronous manner by configuring queues or events.
  • Manually degrade your services or use a circuit breaker to automatically degrade services.
  • debugging

    You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.


    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • The required resource types are displayed in bold characters.
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
      All Resources

    Request parameters


    The ID of the OTP message.


    Specifies whether customers replied to the OTP message. Valid values: true and false.


    The time when the OTP message was delivered. The value is a UNIX timestamp. Unit: milliseconds.

    • If you leave the parameter empty, the current timestamp is specified by default.
    • If you specify the parameter, the timestamp must be greater than the message sending time and less than the current timestamp.

    Response parameters


    The status code. If OK is returned, the request is successful. For more information, see Error codes.


    The description of the status code.


    The ID of the request.



    Sample success responses


      "ResponseCode": "OK",
      "ResponseDescription": "OK",
      "RequestId": "F655A8D5-B967-440B-8683-DAD6FF8D****"

    Error codes

    For a list of error codes, visit the Service error codes.