中奖信息提交回调
更新时间:2026-07-10 17:18:41
作用
观众在直播抽奖中奖并成功提交中奖信息(收货信息)后,服务端会对客户所设置的接口地址,以POST方式将中奖信息提交到用户自定义的回调接口,便于客户侧系统同步收货、发货等业务。
回调失败重试
- 接口如果没有返回 http status 200 状态码,会认为用户处理本次回调失败,针对失败的情况,会重试3次回调。
- 回调失败不影响观众端中奖信息的提交结果。
回调参数说明
- 请求方式: POST
URL参数
| 参数名 | 类型及范围 | 说明 |
|---|---|---|
| timestamp | long | 13位时间戳 |
| sign | string | 签名,签名生成的规则是 MD5(appSecret + timestamp),为防止回调请求伪造,请务必校验 sign 值的正确性。appSecret 为直播系统的密钥(开发者设置中查看)。 |
BODY参数:
| 参数名 | 类型及范围 | 说明 |
|---|---|---|
| recordId | String | 中奖ID(中奖记录主键,唯一标识一条中奖记录) |
| lotteryId | String | 抽奖ID |
| channelId | Integer | 频道号 |
| winnerTime | Long | 中奖时间(13位毫秒时间戳) |
| viewerId | String | 中奖观众用户ID |
| viewerName | String | 中奖观众昵称 |
| winnerCode | String | 中奖码 |
| prize | String | 中奖礼品名称 |
| name | String | 姓名(从领奖信息中提取) |
| mobile | String | 手机(从领奖信息中提取) |
| address | String | 地址(合并字段,省市区/乡镇街道与详细地址已合并,从领奖信息中提取) |
| customFields | Object | 领奖信息全部字段,key 为字段名、value 为字段值(含姓名、手机、地址及自定义字段,字段名以后台抽奖采集字段配置为准)。name/mobile/address 即从此对象中按字段名提取,与对应字段值一致,作为便捷访问 |
| groupNames | Array<String> | 分组名称列表 |
| presetEnabled | String | 是否预设中奖(Y:是,N:否) |
回调数据示例
请求地址示例: https://www.example.com/xxx/callback?sign=d5079f2e8ba19e49bfd3d9575866d80f×tamp=1701964858687
请求体(body参数: application/json)示例
{
"recordId": "zyNfUVnaAZ",
"lotteryId": "hjzf98qa0n",
"channelId": 8017543,
"winnerTime": 1782896361000,
"viewerId": "viewer123",
"viewerName": "张三",
"winnerCode": "hpbVp66y",
"prize": "二等奖",
"name": "张三",
"mobile": "13900000000",
"address": "广东省深圳市福田区XX街道XX号",
"customFields": {
"姓名": "张三",
"手机": "13900000000",
"地址": "广东省深圳市福田区XX街道XX号",
"备注": "尽快发货"
},
"groupNames": ["A组"],
"presetEnabled": "N"
}
说明:
name/mobile/address是从customFields中按字段名关键字提取的便捷字段,与customFields中对应字段值一致;customFields保留全部领奖字段,建议以customFields为准取值。customFields的字段名(如"姓名"、"手机"、"地址")以后台抽奖活动「采集字段」配置为准,自定义字段的字段名由配置决定。
如何设置
通过后台设置:
登录账户 - 进入【云直播】 - 点击【开发设置】- 点击【回调设置】- 中奖信息提交回调
注意:提交的接口地址必须要以 http:// 或者 https:// 开头。未配置回调地址时,不会触发回调。
