中獎資訊提交回呼
更新時間: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:// 開頭。未配置回呼地址時,不會觸發回呼。
