文档中心 > API类目 > 淘宝小程序API

qimen.taobao.miniapp.task.award.send (任务奖励发放)

小程序或小游戏内,通过广告或互动任务,任务完成后,需要触发ISV对应的自定义奖励发放

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
openId String 必须 ADEGEG 要发放用户的openId
appId Number 必须 3000007654321 小程序的appId
actionId String 必须 te3434fad 幂等唯一ID
awards String 必须 [{"toolId":"1","count":3}] 具体发放的奖励信息,toolId:配置的道具id;count:配置的道具数量
isRisk Boolean 可选 false 是否是风险请求,如果为true,由开发者自行决定奖励的处理逻辑
taskDefineExtra String 可选 {"zoneId":"xxxxxx"} 用户发起前台请求时,传入的透传的自定义参数。比如广告链路,则对应调用my.createRewardedAd时传入的pReportExtra。

响应参数

名称 类型 示例值 描述
result ResultDTO 发放的结果result
  • └ success
  • Boolean
  • true
  • 是否发放成功,如果是幂等请求、或是风险请求不发奖,需要给平台返回成功
  • └ errMsg
  • String
  • 错误码对应的详细信息
  • 失败的详细信息
  • └ errCode
  • String
  • FAIL_XXX
  • 错误码,可重试失败返回: FAIL_XXX ;不可重试失败返回: ERR_XXX ;系统错误原样返回

请求示例

{"isRisk":false,"taskDefineExtra":"{\"zoneId\":\"xxxxxx\"}","openId":"ADEGEG","awards":"[{\"toolId\":\"1\",\"count\":3}]","appId":0,"actionId":"te3434fad"}

响应示例

{
    "result":{
        "success":true,
        "errMsg":"错误码对应的详细信息",
        "errCode":"FAIL_XXX"
    }
}

验签示例

{"result":{"success":"false","errCode":"sign-check-failure","errMsg":"Illegal request"}}

错误码解释

错误码 错误描述 解决方案

API工具

FAQ

返回
顶部