您可通过此接口，获取指定直播间内指定卡券互动工具的卡券领取信息，包括领取的卡券总数、领取卡券的观众信息等。
请求频率：单用户请求频率限制为 10 次/秒。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | GetActivityCouponPickData | 接口名称。当前 API 的名称为 GetActivityCouponPickData。 |
| Version | String | 是 | 2023-08-01 | 接口版本。当前 API 的版本为 2023-08-01。 |
| PageNumber | Integer | 否 | 1 | 分页查询页码。默认值为 1。取值大于等于 1。 |
| PageSize | Integer | 否 | 10 | 分页查询数量。默认值为 10。取值范围为 [1,2000]。 |
| ActivityId | Long | 是 | 1815****1516 | 直播间 ID。您可通过调用 ListActivityAPI 接口获取 ID。 |
| Id | Long | 是 | 1815****1517 | 卡券互动工具 ID。您可通过调用 ListActivityCoupons 接口获取 ID。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| TotalCount | Long | 10000 | 领取的卡券总数。 |
| ActivityCouponPickData | Array of ActivityCouponPickData | - | 领取卡券的观众信息。 |
| Name | String | 手机优惠券 | 卡券名称。 |
| CouponId | Long | 181****6156 | 卡券 ID。 |
ThirdPartyId | String |
| 关联卡券 ID，即您自有商城系统中的卡券 ID。 |
| Id | Long | 1856****56165 | 卡券互动工具 ID。 |
| SendTime | Long | 1725851457 | 卡券互动工具的发送时间。Unix 时间戳，单位为秒。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| UserId | Long | 185****424 | 用户 ID。 |
ExternalUserId | String |
| 关联用户 ID，即观众在第三方平台的唯一标识。
说明 如果您集成了观播 SDK，且 SDK 的鉴权模式为自定义模式，关联用户 ID 的取值为调用 GetSDKTokenAPI 接口时传入的 |
| PickupTime | Long | 1725851477 | 卡券的领取时间。Unix 时间戳，单位为秒。 |
| UserNickName | String | 小明 | 昵称。 |
GET https://livesaas.volcengineapi.com/?Action=GetActivityCouponPickData&Version=2023-08-01&PageNumber=1&PageSize=10&ActivityId=1815****1516&Id=1815****1517
{ "ResponseMetadata": { "RequestId": "20230604110420****100232280022D31", "Action": "GetActivityCouponPickData", "Version": "2023-08-01", "Service": "livesaas", "Region": "cn-north-1", "SystemTime": 1825851457 }, "Result": { "TotalCount": 10000, "ActivityCouponPickData": [ { "UserId": 185****424, "PickupTime": 1725851477, "UserNickName": "小明", "ExternalUserId": "user_uuid" } ], "Name": "手机优惠券", "CouponId": 181****6156, "ThirdPartyId": "uuid1", "Id": 1856****56165, "SendTime": 1725851457 } }