该接口主要用于客户侧构建作者主页,获取作者发文内容列表。当前接口有5-10分钟的延迟,即作者发文后,在5-10分钟以内可以通过这个接口拿到内容。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必填 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | GetArticlesByAuthorId | 要执行的操作,取值:GetArticlesByAuthorId |
Version | String | 是 | 2022-01-01 | API的版本,取值:2022-01-01 |
参数 | 类型 | 是否必填 | 示例值 | 描述 | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
UniqUserId | String | 是 | 用户唯一标识,由客户根据设备标识或用户账号脱敏得到。 | |||||||||||
Category | String | 是 | 非集合类投放场景唯一标识,可以在场景中获取。 | |||||||||||
AuthorId | Long | 是 | 作者ID。 | |||||||||||
GroupType | String | 否 | 内容体裁,不传时,返回所有体裁。枚举值:
| |||||||||||
PageSize | Integer | 否 | 分页大小,默认10,最大20。 | |||||||||||
Cursor | String | 否 | 偏移量,下一页的查询可以由当前接口返回Cursor,格式不正确时会有报错。 | |||||||||||
GroupTypes | Array of String | 否 | 体裁,可以传多个,不传时,返回所有体裁。 |
下表仅列出本接口特有的返回参数。更多信息请参见返回结构
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Data | AuthorArticleList | 响应数据 |
{ "UniqUserId": "123", "Category": "ee2e6666", "AuthorId": 1729351955000000, "GroupType": "article", "Cursor":"", "PageSize": 5 }
{ "ResponseMetadata": { "RequestId": "2022110318344201020209302717B0F***", "Action": "GetArticlesByAuthorId", "Version": "2022-01-01", "Service": "volc_content_api", "Region": "cn-north-1" }, "Data": { "ArticleList": [ { "GroupId": 1748275173700000, "Title": "示例title", "Author": { "AuthorName": "authorName", "AuthorAvatarUrl": "...", "AuthorId": "authorId", "Description": "..", "AuthorBizId": "" }, "GroupType": "article", "GenerateType": "test", "PublishTime": 1667285098, "Abstract": "示例abstract", "OpenId": "", "Tags": [ "示例tag1", "示例tag2" ], "CoverImages": [ { "Url": "url", "Height": 718, "Weight": 926, "Width": 926 } ], "Extra": "", "Link": "", "DiggCount": 0, "CommentCount": 0, "CommentUrl": "" } ], "Cursor": "示例cursor" }, "BaseResp": { "StatusMessage": "success", "StatusCode": 1000 } }
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。
状态码 | 错误码 | 错误信息 | 说明 |
---|---|---|---|
200 | 1001 | 参数错误 | 返回具体的参数错误描述 |
200 | 1002 | 服务未知错误 | 请联系火山引擎技术人员 |
200 | 1026 | 场景类型使用错误:请使用非集合类场景 | 使用非集合类场景 |