将每一条消息ID(MessageId) 对应短信的接收情况反馈给阿里云国际短信平台。
接口说明
指标说明:
-
OTP 发送量:验证码发送量。
-
OTP 转化量:验证码转换量。(用户成功获取验证码,并进行回传)
转化率=OTP 转化量/OTP 发送量。
说明
转化率反馈功能会对业务系统有一定的侵入性,为了防止调用转化率 API 的抖动影响业务逻辑,请考虑: - 使用异步模式(例如:队列或事件驱动)调用 API。 - 添加可降级的方案保护业务逻辑(例如:手动降级开工或者使用断路器自动降级)。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
dysms:SmsConversion | update | *全部资源 * |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
MessageId | string | 否 | 消息 ID。 | 1008030300**** |
Delivered | boolean | 是 | 如果您的用户回复了您发送的消息,则设置为 true。否则,设置为 false。 | true |
ConversionTime | long | 否 | 触达发送目标的时间戳。必须是 Unix 时间戳,毫秒级别长整型。
| 1349055900000 |
To | string | 否 | 短信手机号 |
返回参数
示例
正常返回示例
JSON
格式
{
"ResponseCode": "OK",
"ResponseDescription": "OK",
"RequestId": "F655A8D5-B967-440B-8683-DAD6FF8D****"
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-12-05 | OpenAPI 入参发生变更 | 查看变更详情 |
2024-02-04 | API 内部配置变更,不影响调用 | 查看变更详情 |