上报转换率

最近更新时间:2024-10-18 10:27:14

我的收藏

1. 接口描述

接口请求域名: sms.tencentcloudapi.com 。

本接口 (ReportConversion) 用于短信转化率上报。将已接收到短信的流水号上报到腾讯云短信服务。

说明:

默认接口请求频率限制:1000次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ReportConversion。
Version String 公共参数,本接口取值:2021-01-11。
Region String 公共参数,详见产品支持的 地域列表
SmsSdkAppId String 短信应用ID。在 短信控制台 添加应用后生成的实际 SdkAppId,示例如1400006666。
示例值:1400000001
SerialNo String 发送短信返回的流水号。对应SendSms接口返回的SendStatusSet参数中的SerialNo字段。
示例值:a12gb4e2-sd11-5dx6-aav9-8f3d97xa2xu7
ConversionTime Integer 用户回填时间,UNIX 时间戳(单位:秒)。
示例值:1658310430

3. 输出参数

参数名称 类型 描述
ReportConversionStatus ReportConversionStatus 转化率上报响应包体。
示例值:{"Code":"OK", "Message":"success"}
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 请求示例

输入示例

POST / HTTP/1.1
Host: sms.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ReportConversion
<公共请求参数>

{
    "SmsSdkAppId": "1400000001",
    "SerialNo": "a12gb4e2-sd11-5dx6-aav9-8f3d97xa2xu7",
    "ConversionTime": 1658310430
}

输出示例

{
    "Response": {
        "ReportConversionStatus": {
            "Code": "OK",
            "Message": "success"
        },
        "RequestId": "a0aabda6-cf91-4f3e-a81f-9198114a2279"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

签名demo

下面提供了各个语言生成签名的过程,demo 只是起到演示的作用,不具备通用性,在实际的开发中还是推荐使用 SDK。

Signature V1:

Signature V3

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InternalError.SendAndRecvFail 接口超时或短信收发包超时,请检查您的网络是否有波动,或联系 腾讯云短信小助手 解决。
UnauthorizedOperation.SmsSdkAppIdVerifyFail SmsSdkAppId 校验失败,请检查 SmsSdkAppId 是否属于 云API密钥 的关联账户。