This API, sends conversion data to the Alibaba SMS service.

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.

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 ConversionData

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

ReportTime Long No 1349055900000

Timestamp of the conversion rate observation should be a Unix timestamp, millisecond-level long integer.

Note If this field is not specified: the current timestamp is the default.
ConversionRate String Yes 0.53

Conversion rate monitoring return value.

Note The value of this parameter is of type double, and the value is between [0,1].

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=ConversionData
&ReportTime=1349055900000
&ConversionRate=0.53
&Common request parameters

Sample success responses

XML format 

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

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

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.