SmsConversion - Short Message Service - Alibaba Cloud Documentation Center

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.

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.

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:SmsConversion

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
MessageId	string	No	The ID of the OTP message.	1008030300****
Delivered	boolean	Yes	Specifies whether customers replied to the OTP message. Valid values: true and false.	true
ConversionTime	integer	No	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.	1349055900000
To	string	No	The mobile phone number of the recipient. You must add the dialing code to the beginning of the mobile phone number. For more information, see Dialing codes.	8521245567****

Response elements

Element	Type	Description	Example
	object
ResponseCode	string	The status code. If OK is returned, the request is successful. For more information, 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.