优惠券领取成功回调

更新时间：2025-07-25 11:25:18

作用

使用本功能，观众在直播间领取优惠券后，服务端会对客户所设置的接口地址，以POST方式提交到给用户自定义的回调接口进行通知。

超时重试

1、回调服务器在发送消息通知后，5秒内没有收到您的服务器的响应，即认为通知失败。后续失败会以5秒间隔继续重试2次。 2、接口返回json对象，如果回调没有返回200，会重试2次，超过2次则丢弃日志

回调消息格式

事件回调消息以 HTTP/HTTPS POST 请求发送给您的服务器，其中：

字符编码格式：UTF-8。
请求：body 格式为 JSON。
应答要求：响应头需指定Content-Type: application/json；
正确应答：http status code: 200为正确业务接收处理，其他状态一律视为失败重试处理。

回调参数说明

参数名	类型	说明
couponInfo	Object: UserCoupon	优惠券信息
receiveInfos	Array: ReceiveInfo	频道名称

UserCoupon结构

参数名	类型	说明
couponId	string	优惠券ID
name	string	优惠券名称
type	string	优惠券类型: MAX_OUT-满减券、DISCOUNT-折扣券
receiveStartTime	long	领券开始时间，13位毫秒数时间戳
receiveEndTime	long	领券结束时间，13位毫秒数时间戳
useTimeType	string	用券时间类型，RANGE-时间范围，DAY-天数
dayOfUse	int	领取后多少天内可用
availableAmount	string	发放数量，大于等于0
useStartTime	long	用券开始时间，13位毫秒数时间戳
useEndTime	long	用券结束时间，13位毫秒数时间戳
rule	Object: UserCouponRule	优惠券规则

UserCouponRule结构

参数名	类型	说明
condition	string	优惠券使用条件 (UNCONDITIONAL-无门槛、FULL_REDUCE-满减)
unconditional	Object: Unconditional	无门槛
fullReduce	Object: FullReduceBO	满减
limitPerPerson	int	每人限领数量: -1-不限制

Unconditional结构

参数名	类型	说明
enable	boolean	是否可用
value	double	数值
unit	string	单位: MONEY-元、DISCOUNT-折

FullReduce结构

参数名	类型	说明
enable	boolean	是否可用
full	double	满多少
reduce	double	减多少
unit	string	单位: MONEY-元、DISCOUNT-折

ReceiveInfo结构

参数名	类型	说明
viewerId	string	观众ID
externalViewerId	string	外部授权，外部用户ID
receiveTime	long	领取时间，13位毫秒数时间戳
refId	string	引用对象ID(频道ID、页面ID等)
receiveSource	string	领取来源:CHANNEL-频道，AGGREGATE_PAGE-聚合页，INFO_FLOW-信息流

响应体：

{
    "couponInfo": {
        "availableAmount": 10,
        "couponId": "dd95z8jtjgwqxkakxxqjk4vlarb5zupi",
        "dayOfUse": 1,
        "name": "优惠券1号",
        "receiveEndTime": 1740585600000,
        "receiveStartTime": 1740538277000,
        "rule": {
            "condition": "UNCONDITIONAL",
            "fullReduce": {
                "enable": false,
                "full": 0.0,
                "reduce": 0.0,
                "unit": "DISCOUNT"
            },
            "limitPerPerson": -1,
            "unconditional": {
                "enable": true,
                "unit": "DISCOUNT",
                "value": 1.0
            }
        },
        "type": "DISCOUNT",
        "useTimeType": "DAY"
    },
    "receiveInfos": [
        {
            "receiveSource": "CHANNEL",
            "receiveTime": 1740540297284,
            "refId": "5461212",
            "viewerId": "d_4z74veo374b5u8c1aubpb8yl3x875xcx",
            "externalViewerId": "externalViewerId1234"
        },
        {
            "receiveSource": "CHANNEL",
            "receiveTime": 1740540296798,
            "refId": "5461212",
            "viewerId": "d_16qa575b49p89pvj0k6267t1t69q2v43"
        },
        {
            "receiveSource": "CHANNEL",
            "receiveTime": 1740540296118,
            "refId": "5461212",
            "viewerId": "d_eh4v9k26ay60qu1umnxb89cv9f64s46k"
        }
    ]
}

如何设置

通过后台设置：

登录账户 - 进入【云直播】 - 点击【开发设置】- 点击【回调设置】- 优惠券领取成功回调

注意：提交的接口地址必须要以 http:// 或者 https:// 开头

直播服务端 API