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

Metrics:

  • 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

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes SmsConversion

The operation that you want to perform. Set the value to SmsConversion.

MessageId String Yes 1008030300****

The ID of the OTP message.

Delivered Boolean Yes true

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

ConversionTime Long No 1349055900000

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

Parameter Type Example Description
ResponseCode String OK

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

ResponseDescription String OK

The description of the status code.

RequestId String F655A8D5-B967-440B-8683-DAD6FF8D****

The ID of the request.

Examples

Sample requests

http(s)://dysmsapi.ap-southeast-1.aliyuncs.com/?Action=SmsConversion
&MessageId=1008030300****
&Delivered=true
&<Common request parameters>

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<SmsConversionResponse>
    <ResponseCode>OK</ResponseCode>
    <ResponseDescription>OK</ResponseDescription>
    <RequestId>F655A8D5-B967-440B-8683-DAD6FF8D****</RequestId>
</SmsConversionResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

For a list of error codes, visit the API Error Center.