Usage of the SMS Conversion API allow our customers to feedback OTP conversion data to the Alibaba Cloud SMS service to enable proactive monitoring and action for route stability.

Notes:

  • OTP SMS Sent: Number of OTP SMS sent.
  • OTP Conversion Number: Number of successful backfill response from end users.

OTP Conversion rate = OTP Conversion Number/OTP SMS Sent.

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 text message.

Delivered Boolean Yes true

Set to true if your user replies to a message you sent. Otherwise, set to false.

ConversionTime Long No 1349055900000

The timestamp when the sending destination is reached. Must be a Unix timestamp, millisecond-level long integer.

  • If this field is not specified: the current timestamp is the default.
  • If this field is specified: the timestamp must be greater than the sending time and smaller than the current timestamp.

Response parameters

Parameter Type Example Description
ResponseCode String OK

Status code. Returning OK means the request was successful. For other error codes, please refer to the error codes list.

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.