当观众在观看页领取卡券时，企业直播会对所设置的接口地址进行回调通知。
将接收回调通知的接口地址提供给企业直播技术支持。
100 次/秒
设置回调的接口地址后，当观众在观看页领取卡券时，企业直播会将直播间 ID、卡券相关信息以及领取卡券的观众信息以 POST 方式提交给您自定义的回调接口地址。
请求示例如下所示：
POST /xxxxx HTTP/1.1
Header1: ...
Header2: ...
...
{
"AccountId": "200000****",
"ActivityId": "1813702****34379",
"CouponId": "18135890****5392",
"CouponName": "手机优惠券",
"EventType": "ActivityPickupCouponCallBack",
"ExternalUserId": "3874914****1015",
"Id": "181370****929292",
"PickupTime": "1729684725",
"RequestUuid": "ActivityPickupCouponCallBack-181369044****208",
"SendTime": "1729684719",
"Sign": "09f60f3130183c****6f307c2039fdbb",
"ThirdPartyId": "22",
"UserId": "1748822****74564",
"UserNickName": "观众 A",
"SubAccountName" : "admin@bytedance.com"
}
回调服务器在发送消息通知后，5 秒内没有收到您的服务器的响应，即认为通知失败。后续会以 5 秒为间隔继续重试 2 次。
注意
由于同一直播间内，每位观众只能领取同一张卡券一次，为避免因超时重试而接收重复的回调消息，导致卡券被重复发放，建议您在商城系统向观众发放卡券前，对 ActivityId、Id 和 UserId 的参数值去重。
说明
请联系技术支持获取鉴权 AccountSecret。
参数 | 类型 | 说明 |
|---|---|---|
ActivityId | String | 直播间 ID。 |
AccountId | String | 账号 ID。 |
Id | String | 卡券互动工具 ID。 |
CouponId | String | 卡券 ID。 |
CouponName | String | 卡券名称。 |
ThirdPartyId | String | 关联卡券 ID，即您自有商城系统中的卡券 ID。 |
SendTime | String | 卡券互动工具的发送时间。Unix 时间戳，单位为秒。 |
EventType | String | 回调通知的事件类型，固定取值为 |
UserNickName | String | 领取卡券的观众的昵称。 |
UserId | String | 领取卡券的观众的用户 ID。 |
ExternalUserId | String | 领取卡券的观众的关联用户 ID，即观众在第三方平台的唯一标识。
说明 如果您集成了观播 SDK，且 SDK 的鉴权模式为自定义模式，关联用户 ID 的取值为调用 GetSDKTokenAPI 接口时传入的 |
PickupTime | String | 卡券的领取时间。Unix 时间戳，单位为秒。 |
RequestUuid | String | 请求回调的唯一标识。 |
Sign | String | 校验签名。
|
SubAccountName | String | 创建直播间的账号。参数值 |