Report OTP message status with SmsConversion - Short Message Service - Alibaba Cloud - Short Message Service

Operation description

Metric description:

OTP sent: The number of verification codes sent.
OTP conversions: The number of verification codes successfully received and reported back by users.

Conversion rate = OTP conversions / OTP sent.

Note

The conversion rate feedback feature may intrude on your business system to some extent. To prevent API call fluctuations from affecting your business logic, consider the following measures:

Use an asynchronous mode, such as a queue or event-driven approach, to call the API.
Implement a fallback mechanism to protect your business logic, such as manual fallback or automatic fallback by using a circuit breaker.

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 message ID.	1008030300****
Delivered	boolean	Yes	Specifies whether the user replied to the message you sent. Set this parameter to true if the user replied to the message. Otherwise, set this parameter to false.	true
ConversionTime	integer	No	The timestamp when the message was delivered to the recipient. The value must be a UNIX timestamp in milliseconds. If you do not specify this parameter, the current timestamp is used by default. If you specify this parameter, the timestamp must be later than the time when the message was sent and earlier than the current timestamp.	1349055900000
To	string	No	The phone number of the recipient. The number must be in the format of country code + phone number. For more information about country codes, see Country codes.	8521245567****

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 request ID.	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.