您可通过此接口获取指定直播间的直播预约信息。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | GetActivityReservationAPIV2 | 接口名称。当前 API 的名称为 GetActivityReservationAPIV2。 |
| Version | String | 是 | 2020-06-01 | 接口版本。当前 API 的版本为 2020-06-01。 |
ActivityId | Long | 是 |
| 直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。 说明 使用子账号调用接口时，确保该直播间对子账号可见。有关如何配置子账号的可见范围，详见子账号管理。 |
| Page | Integer | 否 | 1 | 分页查询页码。默认值为 1。 |
| PageSize | Integer | 否 | 10 | 分页查询数量。取值范围为 [1,500]，默认值为 10。 |
| Channel | String | 否 | 123 | 根据渠道标识进行筛选。默认查询全部渠道数据。您可以通过调用 ListChannelAPI 接口查询渠道标识。 |
| TelReserve | String | 否 | 182****5709 | 预约手机号。 |
| NickName | String | 否 | A | 用户昵称。支持模糊搜索。 |
| ExternalId | String | 否 | 1234 | 观众在第三方平台的唯一标识。您可以根据该关联用户 ID 识别企业自身的用户身份，以便于按需实现用户洞察和进行数据分析。观众通过不同方式登录直播间时，关联用户 ID 取值不同，具体取值情况详见数据统计。支持模糊搜索。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| ActivityId | Long | 1779****58280 | 直播间 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 | 观众提交直播预约的时间。Unix 时间戳，单位为秒。 |
| UserDevice | String | Windows 10 | 观众进入直播间使用的终端机型。 |
| ExternalId | String | 31210****51234 | 观众在第三方平台的唯一标识。您可以根据该关联用户 ID 识别企业自身的用户身份，以便于按需实现用户洞察和进行数据分析。观众通过不同方式登录直播间时，关联用户 ID 取值不同，具体取值情况详见数据统计。 |
| Extra | String | abc | 业务方扩展参数。 |
| Channel | String | 123 | 渠道标识。 |
| UserId | Long | 174466****361234 | 用户 ID，即观众在企业直播的唯一标识。 |
GET https://livesaas.volcengineapi.com/?Action=GetActivityReservationAPIV2&Version=2020-06-01&ActivityId=1779****58280&Page=1&PageSize=10&Channel=123&TelReserve=182****5709&NickName=A&ExternalId=1234
{ "ResponseMetadata": { "RequestId": "20230604110420****100232280022D31", "Action": "GetActivityReservationAPIV2", "Version": "2020-06-01", "Service": "livesaas", "Region": "cn-north-1", "SystemTime": 1697446406 }, "Result": { "ActivityId": 1779****58280, "Total": 1, "Page": 1, "Items": [ { "NickName": "观众 A", "UserId": 174466****361234, "Channel": "123", "Extra": "abc", "ExternalId": "31210****51234", "UserDevice": "Windows 10", "SubmitTime": 1697080167, "IpAddress": "北京", "Ip": "192.168.0.1", "TelReserve": "182****5709" } ] } }