最近更新时间:2023.11.08 09:30:20
首次发布时间:2023.02.01 10:13:24
获取直播间的直播预约信息。
说明
企业直播新增渠道推广功能,支持创建不同的渠道。有关如何创建渠道,详见渠道推广。对于使用了渠道推广功能的直播间,请调用本接口获取不同渠道的数据信息。如果您未使用渠道推广功能,请调用 GetActivityReservationAPI 接口获取直播预约信息。
请求频率:单用户请求频率限制为 120 次/分钟。
以下请求参数列表仅列出了该接口的部分公共参数,完整公共参数列表见公共请求参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | GetActivityReservationAPIV2 | 接口名称。当前 API 的名称为 GetActivityReservationAPIV2 。 |
Version | String | 是 | 2020-06-01 | 接口版本。当前 API 的版本为 2020-06-01 。 |
ActivityId | Long | 是 | 1779187158280 | 直播间 ID。您可以通过调用 ListActivityAPI 接口查询 ID。 |
Page | Integer | 否 | 1 | 分页查询页码,默认值为 1 。 |
PageSize | Integer | 否 | 10 | 分页查询数量,默认值为 10 。 |
Channel | String | 否 | 123 | 根据渠道标识进行筛选。您可以通过调用 ListChannelAPI 接口查询渠道标识,默认查询全部渠道数据。 |
TelReserve | String | 否 | 182****5709 | 预约手机号。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
ActivityId | Long | 1779187158280 | 直播间 ID。 |
Total | Integer | 1 | 查询结果总数。 |
Page | Integer | 1 | 查询结果页数。 |
Items | Array of Items | - | 直播预约信息。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
NickName | String | 观众 A | 昵称。 |
TelReserve | String | 182****5709 | 预留手机号。 |
Ip | String | 192.168.0.1 | IP 地址。 |
IpAddress | String | 北京 | IP 地址所在地区。 |
SubmitTime | Integer | 1697080167 | 提交直播预约的时间。 |
UserDevice | String | Windows 10 | 终端类型。 |
ExternalId | String | 31210506554471 | 观众在第三方平台的唯一标识。您可以根据该关联用户 ID 识别企业自身的用户身份,以便于按需实现用户洞察和进行数据分析。观众通过不同方式登录直播间时,关联用户 ID 取值不同,具体取值情况详见数据统计。 |
Extra | String | abc | 业务方扩展参数。 |
Channel | String | 123 | 渠道标识。 |
UserId | Long | 1744663139363934 | 用户 ID。 |
GET https://livesaas.volcengineapi.com/?Action=GetActivityReservationAPIV2&Version=2020-06-01&ActivityId=1779187158280&Channel=123&Page=1&PageSize=10&TelReserve=182%2A%2A%2A%2A5709
{ "ResponseMetadata": { "RequestId": "20231012110940177345D59166C90B1971", "Action": "GetActivityReservationAPIV2", "Version": "2020-06-01", "Service": "livesaas", "Region": "cn-north-1", "SystemTime": 1697080180 }, "Result": { "ActivityId": 1779187158280, "Total": 1, "Page": 1, "Items": [ { "NickName": "观众 A", "TelReserve": "182****5709", "Ip": "192.168.0.1", "IpAddress": "北京", "SubmitTime": 1697080167, "UserDevice": "Windows 10", "ExternalId": "31210506554471", "Extra": "abc", "Channel": "123", "UserId": 1744663139363934 } ] } }
访问公共错误码获取详细信息。