提交任务事件

最近更新时间:2025-02-13 01:55:35

我的收藏

1. 接口描述

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

提交任务事件接口

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:SubmitTaskEvent。
Version String 公共参数,本接口取值:2020-12-03。
Region String 公共参数,详见产品支持的 地域列表
AccountId String 用户唯一标识,最大长度为64
示例值:5Gsl****VfPd
DeviceId String 用户设备ID,最大长度为64
示例值:oPD5****G0zr
OrderId String 任务的唯一订单号,只能是数字、大小写字母,且在同一个产品ID下唯一,最大长度为64
示例值:xFUDBDgn4lv403u5
Code String 任务事件Code,在腾讯安心用户运营平台下的任务事件列表中设置并获取
示例值:addType
Async Integer 任务结果是否异步通知。0表示任务结果在返回信息中同步返回;1表示任务结果通过回调结果异步通知。
示例值:0
ProductId Integer 产品ID,可在腾讯安心用户运营平台的企业管理中获取
示例值:7999
NotifyURL String 异步接收任务结果通知的回调地址。在Async为1的时候,会将任务结果通过该回调地址进行通知。
示例值:https://gmall.m.qq.com/api/ReceiveTaskNotify

3. 输出参数

参数名称 类型 描述
OrderId String 任务的唯一订单号
示例值:xFUDBDgn4lv403u5
Code Integer 信息码。0表示成功,-1标识失败
示例值:0
Message String 提示信息
示例值:success
Data Array of TaskEventData 任务处理结果列表
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 SubmitTaskEvent

提交任务事件

输入示例

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

{
    "AccountId": "5Gsl****VfPd",
    "DeviceId": "oPD5****G0zr",
    "OrderId": "xFUDBDgn4lv403u5",
    "Code": "addType",
    "Async": 1,
    "NotifyURL": "https://gmall.m.qq.com/api/ReceiveTaskNotify",
    "ProductId": 7999
}

输出示例

{
    "Response": {
        "OrderId": "xFUDBDgn4lv403u5",
        "Code": 0,
        "Message": "success",
        "Data": [
            {
                "Code": 0,
                "Message": "success",
                "TaskId": 11100,
                "TaskOrderId": "3772179646188093549",
                "TaskCode": 1,
                "TaskCoinNumber": 10,
                "TaskType": 1151,
                "TotalCoin": 100,
                "Attach": "自定义数据说明",
                "DoneTimes": 1,
                "TotalTimes": 3,
                "TaskName": "自定义任务",
                "GrowScore": 100
            }
        ],
        "RequestId": "afc7e79d-b282-154e-5389-f5a6592d2408"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码