文档中心 > API类目 > 用户API

qimen.alibaba.alsc.growth.interactive.standard.task.customsendprize (本地生活互动业务-任务平台自定义发奖)

任务平台自定义发奖接口

公共参数

请求地址：

环境	HTTP请求地址
正式环境	http://qimen.api.taobao.com/router/qm
测试环境	http://qimen.api.taobao.com/router/qmtest

公共请求参数：

名称	类型	是否必须	描述
method	String	是	API接口名称。
app_key	String	是	TOP分配给应用的AppKey。
session	String	否	用户登录授权成功后，TOP颁发给应用的授权信息，详细介绍请点击这里。当此API的标签上注明：“需要授权”，则此参数必传；“不需要授权”，则此参数不需要传；“可选授权”，则此参数为可选。
timestamp	String	是	时间戳，格式为yyyy-MM-dd HH:mm:ss，时区为GMT+8，例如：2015-01-01 12:00:00。淘宝API服务端允许客户端请求最大时间误差为10分钟。
format	String	否	响应格式。默认为xml格式，可选值：xml，json。
v	String	是	API协议版本，可选值：2.0。
customerId	String	是	WMS颁发给用户的ID
sign_method	String	是	签名的摘要算法，md5。
sign	String	是	API输入参数签名结果，签名算法介绍请点击这里。

请求参数

名称	类型	是否必须	示例值	描述
bizScene	String	必须	FOOD_ELIMINATE	业务场景
openId	String	必须	2205245879059	用户id
rewardInfo	String	必须	[{"ext":{"subIcon":"https://gw.alicdn.com/imgextra/i3/O1CN01xvgwd61eKih4SJ3V5_!!6000000003853-2-tps-400-400.png","unit":"g","rewardDesc":"完成可得","threshold":""},"icon":"https://gw.alicdn.com/imgextra/i2/O1CN01kpRR4W2AEMw87tvTN_!!6000000008171-2-tps-440-200.png","name":"水滴","type":"WATER","value":"10"}]	奖品信息json，这是在任务平台配置的奖品信息,ISV拿到后请按照此字段进行奖励发放。如果这个字段值是空，则供应商直接返回成功就可以，相当于空奖励（正常不会出现除非运营配置错误）
taskInfo	String	可选	{"actionDefId":62935,"actionInstanceId":12235177,"missionCollectionId":498,"stage":{"count":1},"taskDefId":8738001,"taskInstanceId":13266895}	任务信息
idomKey	String	必须	2014183406-13705132-12684591	幂等key,发奖幂等key以为我们为主,同一个幂等key如果没发奖或发奖失败可以重新发奖，同一个幂等key如果发奖成功则不需要再发奖
extInfo	String	可选	{"":""}	扩展信息,此字段为调用任务平台领奖接口的入参extInfo的透传字段，ISV 前端调任务平台领取奖励接口时可以将自定义参数传入extInfo，任务平台会将此参数透传给ISV后端。ISV后端可以根据此字段做一些逻辑

响应参数

名称	类型	示例值	描述
bizSuccess	Boolean	false	业务调用是否成功
bizErrorCode	String	SYSTEM_ERROR	业务错误码,如实是重试异常：ISV的bizErrorCode请返回QIMEN_SEND_PRIZE_RETRY_CODE，任务平台会统一重试
bizErrorMsg	String	系统异常	业务错误信息
data	String	{"rewardInfo":[{"ext":{"subIcon":"https://gw.alicdn.com/imgextra/i3/O1CN01xvgwd61eKih4SJ3V5_!!6000000003853-2-tps-400-400.png","unit":"g","rewardDesc":"完成可得","threshold":""},"icon":"https://gw.alicdn.com/imgextra/i2/O1CN01kpRR4W2AEMw87tvTN_!!6000000008171-2-tps-440-200.png","name":"水滴","type":"WATER","value":"10"}]}	返回数据，ISV自定义返回数据，如果发奖成功此字段请务必包含入参rewardInfo的key和value进行返回以便任务平台记录发放的奖品信息

请求示例

{"rewardInfo":"[{\"ext\":{\"subIcon\":\"https://gw.alicdn.com/imgextra/i3/O1CN01xvgwd61eKih4SJ3V5_!!6000000003853-2-tps-400-400.png\",\"unit\":\"g\",\"rewardDesc\":\"完成可得\",\"threshold\":\"\"},\"icon\":\"https://gw.alicdn.com/imgextra/i2/O1CN01kpRR4W2AEMw87tvTN_!!6000000008171-2-tps-440-200.png\",\"name\":\"水滴\",\"type\":\"WATER\",\"value\":\"10\"}]","openId":"2205245879059","idomKey":"2014183406-13705132-12684591","bizScene":"FOOD_ELIMINATE","taskInfo":"{\"actionDefId\":62935,\"actionInstanceId\":12235177,\"missionCollectionId\":498,\"stage\":{\"count\":1},\"taskDefId\":8738001,\"taskInstanceId\":13266895}","extInfo":"{\"\":\"\"}"}

响应示例

{
    "bizSuccess":false,
    "bizErrorCode":"SYSTEM_ERROR",
    "bizErrorMsg":"系统异常",
    "data":"{\"rewardInfo\":[{\"ext\":{\"subIcon\":\"https:\/\/gw.alicdn.com\/imgextra\/i3\/O1CN01xvgwd61eKih4SJ3V5_!!6000000003853-2-tps-400-400.png\",\"unit\":\"g\",\"rewardDesc\":\"完成可得\",\"threshold\":\"\"},\"icon\":\"https:\/\/gw.alicdn.com\/imgextra\/i2\/O1CN01kpRR4W2AEMw87tvTN_!!6000000008171-2-tps-440-200.png\",\"name\":\"水滴\",\"type\":\"WATER\",\"value\":\"10\"}]}"
}

验签示例

{"bizErrorMsg":"Illegal request","bizSuccess":"false","bizErrorCode":"sign-check-failure"}

错误码解释

错误码	错误描述	解决方案

API工具

错误码查询工具 SDK下载

FAQ

有用( 0 ) 我要提问

返回
顶部