FollowList - 获取已关注作者列表--内容定制-火山引擎

文档中心

立即注册

导航

FollowList - 获取已关注作者列表

最近更新时间：2024.05.28 18:13:35首次发布时间：2021.10.18 11:12:18

调用该接口，拉取用户关注的所有作者列表。

请求说明

请求方式：GET/POST(Content-Type: application/x-www-form-urlencoded)
请求地址：https://mercury.volcengineapi.com/?Action=FollowList&Version=2021-01-01
请求头：ServiceName:content

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	FollowList	要执行的操作，取值：FollowList。
Version	String	是	2021-01-01	API的版本，取值：2021-01-01。
Partner	String	是	xxx_default_content	渠道号。
AccessToken	String	是	AT6zTZuXzffKpQaxxxBKVv8mp94LR2ARdNJBp2BT86GrLpa3brqLmscGCUipuJNh2piKTT12	用户唯一标识。
Count	Integer	是	10	指定返回的条数，最多支持20条。
Cursor	Integer	否	0	索引，默认为0。首次传0，翻页（LoadMore）的时候传上一次火山引擎返回的Cursor；

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
Cursor	Integer	20	索引。当HasMore为true时，Cursor需要作为翻页请求的参数。
HasMore	Boolean	false	是否加载更多。 true：是，加载更多； false：否，已全部加载完毕，没有更多。
Total	Integer	10	已关注作者总数，表示用户总共关注了多少个作者。
Data	Array of Item		已关注作者列表。

请求示例

GET /?Action=FollowList&Version=2021-01-01&Partner=xxx_default_content&AccessToken=AT6zTZuXzffKpQaxxxBKVv8mp94LR2ARdNJBp2BT86GrLpa3brqLmscGCUipuJNh2piKTT12&Count=10 HTTP/1.1
Host: https://mercury.volcengineapi.com/?Action=FollowList&Version=2021-01-01
X-Date: 20240523T085450Z
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240523/cn-beijing/content/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20240523165506218173144239458284",
    "Action": "FollowList",
    "Version": "2021-01-01",
    "Service": "content",
    "Region": "cn-beijing"
  },
  "Result": {
    "Cursor": 20,
    "HasMore": false,
    "Total": 1,
    "Data": [
      {
        "Info": {
          "AvatarUrl": "-",
          "Description": "-",
          "HomePage": "-",
          "Name": "-",
          "Follow": true,
          "FollowerCount": 0,
          "UserId": "-",
          "UserVerified": true,
          "VerifiedContent": "-"
        },
        "Relation": {
          "FollowTime": 1692608991,
          "IsFollowing": 1,
          "FollowersCount": 100000,
          "UpdateArticleTime": 1716452570
        }
      }
    ]
  }
}

错误码

您可访问公共错误码，获取更多错误码信息。