SmsConversion - Short Message Service - Alibaba Cloud Documentation Center

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.

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.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
dysms:SmsConversion	Write	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
MessageId	string	Yes	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	long	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

Response parameters

Parameter	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

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 time

Summary of changes

Operation

2024-02-04

The internal configuration of the API is changed, but the call is not affected

see changesets

Change item	Change content
	The internal configuration of the API is changed, but the call is not affected.