最近更新时间:2023.06.07 15:55:43
首次发布时间:2023.02.01 10:13:24
获取直播间的直播预约信息。
说明
企业直播新增渠道推广功能,支持创建不同的渠道。有关如何创建渠道,详见渠道推广。对于使用了渠道推广功能的直播间,请调用本接口获取不同渠道的数据信息。如果您未使用渠道推广功能,请调用 GetActivityReservationAPI 接口获取直播预约信息。
以下请求参数列表仅列出了该接口的部分公共参数,完整公共参数列表见公共请求参数。
参数 | 类型 | 是否必选 | 描述 |
---|---|---|---|
Action | String | 是 | 接口名称。 |
Version | String | 是 | 接口版本。直播当前 API 的版本为 2020-06-01。 |
ActivityId | Int | 是 | 直播间 ID。您可以通过调用 ListActivityAPI 接口查询 ID。 |
Page | Int | 否 | 分页查询页码,默认值为 |
PageSize | Int | 否 | 分页查询数量,默认值为 |
Channel | String | 否 | 根据渠道标识进行筛选。您可以通过调用 ListChannelAPI 接口查询渠道标识,默认查询全部渠道数据。 |
TelReserve | String | 否 | 预约手机号。 |
参数 | 类型 | 描述 |
---|---|---|
ActivityId | Int64 | 直播间 ID。 |
Total | Int | 查询结果总数。 |
Page | Int | 查询结果页数。 |
Items | Array of ActivityReservation | 直播预约信息。 |
参数 | 类型 | 描述 |
---|---|---|
NickName | String | 昵称。 |
TelReserve | String | 预留手机号。 |
IP | String | IP 地址。 |
IpAddress | String | IP 地址所在地区。 |
SubmitTime | Int | 提交直播预约的时间。 |
UserDevice | String | 终端类型。 |
ExternalId | String | 观众在第三方平台的唯一标识。您可以根据该关联用户 ID 识别企业自身的用户身份,以便于按需实现用户洞察和进行数据分析。观众通过不同方式登录直播间时,关联用户 ID 取值不同,具体取值情况详见数据统计。 |
Extra | String | 业务方扩展参数。 |
Channel | String | 渠道标识。 |
UserId | Int | 用户 ID。 |
Get http://livesaas.volcengineapi.com/?Action=GetActivityReservationAPIV2&Version=2020-06-01&Page=1&PageSize=10&ActivityId=12311&Channel=1&TelReserve=13718780036
{ "ResponseMetadata": { "RequestId": "20220622192459010*****", "Action": "GetActivityReservationAPIV2", "Version": "2020-06-01", "Service": "livesaas", "Region": "cn-north-1", "SystemTime": 1655897099 }, "Result": { "ActivityId": 12311, "Total": 71, "Page": 1, "Items": [ { "NickName": "Cat", "TelReserve": "137***36", "IP": "2408:8207:3c28:1bb0:4940:d718:f8", "IpAddress": "北京", "SubmitTime": 16***422, "UserDevice": "Android 12", "ExternalId": "54211", "Extra": "", "Channel": "1", "UserId": 31749773402 } ] } }
{ "ResponseMetadata":{ "RequestId":"201806041104200100100232280022D30", "Action":"GetActivityReservationAPIV2", "Version":"2020-06-01", "Service":"livesaas", "Region":"cn-north-1", "SystemTime":1656067132, "Error":{ "Code":"200000", "Message":"参数异常" } } }
访问公共错误码获取详细信息。