You need to enable JavaScript to run this app.
导航
获取直播预约信息
最近更新时间:2024.09.04 17:24:26首次发布时间:2022.07.29 09:37:54

您可通过此接口获取指定直播间的直播预约信息。

说明

该接口已经不再维护,建议调用 GetActivityReservationAPIV2 接口获取直播预约信息。

请求说明

  • 接口名称:GetActivityReservationAPI
  • 请求方式:GET
  • 接口地址:http://livesaas.volcengineapi.com/?Action=GetActivityReservationAPI&Version=2020-06-01
  • 请求频率:单用户请求频率限制为 120 次/分钟

请求参数

以下请求参数列表仅列出了该接口的部分公共参数,完整公共参数列表见公共请求参数

Query

参数

类型

是否必选

描述

Action

String

接口名称。

Version

String

接口版本。直播当前 API 的版本为 2020-06-01。

ActivityID

Int

直播间 ID。您可通过 ListActivityAPI 接口查询 ID。

Page

Int

分页查询页码,默认值为 1

PageSize

Int

分页查询数量,默认值为 10

Source

Int

观看地址来源,支持以下六种取值,默认取值为 0

  • -1:全部地址
  • 0:默认地址
  • 1:地址 A
  • 2:地址 B
  • 3:地址 C
  • 4:地址 D

TelReserve

String

预约手机号。

Extra

String

可以根据业务方扩展字段进行筛选。自定义登录时,用户行为中记录了 extra 值。

返回参数

参数

类型

描述

ActivityID

Int64

直播间 ID。

Total

Int

查询结果总数。

Page

Int

查询结果页数。

Items

Array of ActivityReservation

直播预约信息。

ActivityReservation

参数

类型

描述

NickName

String

昵称。

TelReserve

String

预留手机号。

IP

String

IP 地址。

IpAddress

String

IP 地址所在地区。

SubmitTime

Int

提交直播预约的时间。

UserDevice

String

终端类型。

ExternalId

String

观众在第三方平台的唯一标识。您可以根据该关联用户 ID 识别企业自身的用户身份,以便于按需实现用户洞察和进行数据分析。观众通过不同方式登录直播间时,关联用户 ID 取值不同,具体取值情况详见数据统计

Extra

String

业务方扩展字段。

Source

Int

观看地址来源。

  • -1:全部地址
  • 0:默认地址
  • 1:地址 A
  • 2:地址 B
  • 3:地址 C
  • 4:地址 D

UserId

Long

用户 ID。

ChannelName

String

已废弃

示例

请求示例

Get http://livesaas.volcengineapi.com/?Action=GetActivityReservationAPI&Version=2020-06-01&Page=1&PageSize=10&ActivityID=1735457089593406&Source=1&TelReserve=13367624563

正常返回示例

{ 
      "ResponseMetadata": { 
        "RequestId": "20220622192459010*****", 
        "Action": "GetActivityReservationAPI", 
        "Version": "2020-06-01", 
        "Service": "livesaas", 
        "Region": "cn-north-1", 
        "SystemTime": 1655897099 
      }, 
    "Result": { 
        "ActivityID": 1735204214782045, 
        "Total": 71, 
        "Page": 1, 
        "Items": [ 
            { 
                "NickName": "Cat", 
                "TelReserve": "13718780036", 
                "IP": "2408:8207:3c28:1bb0:4940:d718:f8", 
                "IpAddress": "北京", 
                "SubmitTime": 1655534422, 
                "UserDevice": "Android 12", 
                "ExternalId": "5479211", 
                "Extra": "", 
                "Source": 0, 
                "UserId": 3178034649773402,
                "ChannelName":"渠道1"
              }
          ]
      }
}
        

异常返回示例

{
    "ResponseMetadata":{
        "RequestId":"201806041104200100100232280022D30",
        "Action":"GetActivityReservationAPI",
        "Version":"2020-06-01",
        "Service":"livesaas",
        "Region":"cn-north-1",
        "SystemTime":1656067132,
        "Error":{
            "Code":"200000",
            "Message":"参数异常" 
        }
    }
}

错误码

访问公共错误码获取详细信息。