发送礼物之前回调

功能说明

App 后台可以通过该回调决定是否通过送礼前校验等场景。

注意事项

要启用回调,必须配置回调URL,并打开本条回调协议对应的开关,配置方法详见 设置回调配置
回调的方向是 Live 后台向 App 后台发起 HTTP POST 请求。
App 后台在收到回调请求之后,务必校验请求 URL 中的参数 SDKAppID 是否是自己的 SDKAppID。

可能触发该回调的场景

App 用户通过客户端发送礼物

回调发生时机

发送礼物之前。

接口说明

请求 URL 示例

以下示例中 App 配置的回调 URL 为 https://www.example.com
示例:
https://www.example.com?SdkAppid=$SDKAppID&CallbackCommand=$CallbackCommand&contenttype=json&ClientIP=$ClientIP&OptPlatform=$OptPlatform

请求参数说明

参数
说明
https
请求协议为 HTTPS,请求方式为 POST。
www.example.com
回调 URL。
SdkAppid
创建应用时在即时通信 IM 控制台分配的 SDKAppID。
CallbackCommand
固定为 Live.CallbackAfterCreateBattle。
contenttype
固定值为 json
ClientIP
客户端 IP,格式例如:127.0.0.1。
OptPlatform
客户端平台,取值参见 第三方回调简介 中 OptPlatform 的参数含义。

请求包示例

{
"CallbackCommand": "Live.CallbackBeforeSendGift",
"Operator_Account": "brennanli",
"RoomId":"room_id",
"GiftWater": {
"From_Account": "from",
"To_Account": ["to1"],
"Time": 1703589922,
"GiftId": "gift1",
"Count": 1,
"Coins": 1000
}
}

请求包字段说明

字段
类型
说明
CallbackCommand
String
回调命令。
Operator_Account
String
发起 battle 请求的操作者 UserID。
RoomId
String
房间 ID。
From_Account
String
送礼人。
To_Account
Array
被送礼人。
Time
Integer
时间戳。
GiftId
String
礼物 ID。
Count
Integer
礼物数。
Coins
Integer
单个礼物价值。

应答包示例

App 后台同步数据后,发送以下回调应答包。
{
"ActionStatus": "OK",
"ErrorInfo": "",
"ErrorCode": 0
}
如果App需要阻塞送礼,可设置应答包ErrorCode非0。如果live后台2s内未收到应答包时,则也默认阻塞送礼。
如果App需要送礼不阻塞场景(即应答包回复失败/超时时间内live后台未回到应答包,此时均会放行),可再设置 送礼前回调不阻塞配置

应答包字段说明

字段
类型
属性
说明
ActionStatus
String
必填
请求处理的结果,OK 表示处理成功,FAIL 表示失败。
ErrorCode
Integer
必填
错误码,此处填0表示忽略应答结果。
ErrorInfo
String
必填
错误信息。

参考