All Products
Search
Document Center

Short Message Service:ConversionData

Last Updated:Oct 27, 2026

Reports SMS conversion rate statistics to the Alibaba Cloud international SMS platform.

Operation description

Metric descriptions:

  • OTP sent: The number of OTP messages sent.

  • OTP conversions: The number of OTP conversions. (The user successfully receives the verification code, and the event is reported back.)

Conversion rate = OTP conversions / OTP sent.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dysms:ConversionData

update

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

ReportTime

integer

No

The time when the conversion rate is observed. The value must be a UNIX timestamp in milliseconds.

Note

If this parameter is not specified, the current timestamp is used by default.

1349055900000

ConversionRate

string

Yes

The reported value for conversion rate monitoring.

Note

The value must be of the double type and fall within the range of [0, 1].

0.53

Response elements

Element

Type

Description

Example

object

The response parameters.

ResponseCode

string

The status code. A value of OK indicates that the request is successful. For other error codes, see Error codes.

OK

ResponseDescription

string

The description of the status code.

OK

RequestId

string

The ID of the request.

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

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.