All Products
Search
Document Center

Short Message Service:ConversionData

Last Updated:Apr 19, 2024

Reports the status of an OTP message to Alibaba Cloud SMS.

Operation description

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.

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
dysms:ConversionDataWrite
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ReportTimelongNo

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

Note If this field is not specified: the current timestamp is the default.
1349055900000
ConversionRatestringYes

Conversion rate monitoring return value.

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

Response parameters

ParameterTypeDescriptionExample
object
ResponseCodestring

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

OK
ResponseDescriptionstring

The description of the status code.

OK
RequestIdstring

The ID of the request.

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

Examples

Sample success responses

JSONformat

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

Error codes

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

Change history

Change timeSummary of changesOperation
No change history