聆客开放平台
获取单个收藏信息
新增收藏标签
删除收藏标签
修改收藏标签
设置企业单个收藏标签数量
查询用户所有收藏标签
更新收藏标签信息
获取收藏列表
增加收藏
取消收藏

# 获取单个收藏信息

GET /v1/favorite

# 请求参数

参数名 数据类型 必填 参数位置 参数说明
favoriteId string N query 收藏ID

# 返回结果

状态码 说明 返回值 响应头
200 成功响应 ApiResultOfUamFavoriteDetail 无
401 Unauthorized 无 无
403 Forbidden 无 无
404 Not Found 无 无

# 请求示例

GET /v1/favorite?favoriteId={favoriteId}

# 返回示例

Content-Type: application/json

{
  "data" : {                              //请求返回的数据
    "sourceId" : "string",                //来源ID
    "itemId" : "string",                  //收藏资源id
    "sourceDisplayName" : "string",       //来源显示名称
    "createdDate" : "integer",            //创建时间
    "sourceType" : "integer",             //来源类型：0：系统，1：用户，2：群组，3：应用，4：部门，5：服务号，6：企业
    "sourceName" : "string",              //来源名称
    "contentType" : "integer",            //收藏类型，1：文字，2：语音，3：图片，4：视频，5：链接，6：文档，7：云盘，8：动态
    "content" : "string",                 //收藏内容
    "labelList" : [ {                     //标签列表
      "createdDate" : "string",           //创建时间
      "name" : "string",                  //标签名称
      "remark" : "string",                //备注
      "id" : "string"                     //标签ID
    } ]
  },
  "code" : "integer",                     //结果码 200:成功
  "message" : "string"                    //当状态码不是200时，错误信息
}

# 新增收藏标签

POST /v1/favorite/label

# 请求类型（Content-Type）

  • application/json

# 请求参数

参数名 数据类型 必填 参数位置 参数说明
labelParam FavoriteLabelParam Y body 标签信息

# 返回结果

状态码 说明 返回值 响应头
200 成功响应 ApiResultOfobject 无
201 Created 无 无
401 Unauthorized 无 无
403 Forbidden 无 无
404 Not Found 无 无

# 请求示例

POST /v1/favorite/label
Content-Type: application/json

{
  "sourceId" : "string",          //来源ID
  "sourceType" : "integer",       //来源类型：0：系统，1：用户，2：群组，3：应用，4：部门，5：服务号，6：企业
  "name" : "string",              //标签名称
  "sourceName" : "string"         //来源名称
}

# 返回示例

Content-Type: application/json

{
  "code" : "integer",         //结果码 200:成功
  "data" : "object",          //请求返回的数据
  "message" : "string"        //当状态码不是200时，错误信息
}

# 删除收藏标签

POST /v1/favorite/label/delete

# 请求类型（Content-Type）

  • application/json

# 请求参数

参数名 数据类型 必填 参数位置 参数说明
id string Y query 标签ID

# 返回结果

状态码 说明 返回值 响应头
200 成功响应 ApiResultOfobject 无
201 Created 无 无
401 Unauthorized 无 无
403 Forbidden 无 无
404 Not Found 无 无

# 请求示例

POST /v1/favorite/label/delete?id={id}
Content-Type: application/json

# 返回示例

Content-Type: application/json

{
  "code" : "integer",         //结果码 200:成功
  "data" : "object",          //请求返回的数据
  "message" : "string"        //当状态码不是200时，错误信息
}

# 修改收藏标签

POST /v1/favorite/label/update

# 请求类型（Content-Type）

  • application/json

# 请求参数

参数名 数据类型 必填 参数位置 参数说明
id string Y query 标签ID
name string Y query 标签名称

# 返回结果

状态码 说明 返回值 响应头
200 成功响应 ApiResultOfobject 无
201 Created 无 无
401 Unauthorized 无 无
403 Forbidden 无 无
404 Not Found 无 无

# 请求示例

POST /v1/favorite/label/update?id={id}&name={name}
Content-Type: application/json

# 返回示例

Content-Type: application/json

{
  "code" : "integer",         //结果码 200:成功
  "data" : "object",          //请求返回的数据
  "message" : "string"        //当状态码不是200时，错误信息
}

# 设置企业单个收藏标签数量

GET /v1/favorite/labelCountLimit

# 请求参数

参数名 数据类型 必填 参数位置 参数说明
count string N query 限制数量

# 返回结果

状态码 说明 返回值 响应头
200 成功响应 ApiResultOfobject 无
401 Unauthorized 无 无
403 Forbidden 无 无
404 Not Found 无 无

# 请求示例

GET /v1/favorite/labelCountLimit?count={count}

# 返回示例

Content-Type: application/json

{
  "code" : "integer",         //结果码 200:成功
  "data" : "object",          //请求返回的数据
  "message" : "string"        //当状态码不是200时，错误信息
}

# 查询用户所有收藏标签

GET /v1/favorite/labels

# 请求参数

参数名 数据类型 必填 参数位置 参数说明
limit integer N query 分页大小（为空则返回全部）
offset integer N query 分页偏移

# 返回结果

状态码 说明 返回值 响应头
200 成功响应 ApiResultPageOfobject 无
401 Unauthorized 无 无
403 Forbidden 无 无
404 Not Found 无 无

# 请求示例

GET /v1/favorite/labels?limit={limit}&offset={offset}

# 返回示例

Content-Type: application/json

{
  "data" : [ "object" ],      //请求返回的数据
  "total" : "integer",        //数据总数
  "code" : "integer",         //结果码 200:成功
  "count" : "integer",        //请求返回的数据总数
  "message" : "string"        //当状态码不是200时，错误信息
}

# 更新收藏标签信息

POST /v1/favorite/update

# 请求类型（Content-Type）

  • application/json

# 请求参数

参数名 数据类型 必填 参数位置 参数说明
favoriteId string Y query 收藏ID
labelList string[ ] N body 更新标签

# 返回结果

状态码 说明 返回值 响应头
200 成功响应 ApiResultOfobject 无
201 Created 无 无
401 Unauthorized 无 无
403 Forbidden 无 无
404 Not Found 无 无

# 请求示例

POST /v1/favorite/update?favoriteId={favoriteId}
Content-Type: application/json

[  ]

# 返回示例

Content-Type: application/json

{
  "code" : "integer",         //结果码 200:成功
  "data" : "object",          //请求返回的数据
  "message" : "string"        //当状态码不是200时，错误信息
}

# 获取收藏列表

GET /v1/favorites

# 请求参数

参数名 数据类型 必填 参数位置 参数说明
contentTypes string N query 收藏类型（逗号分隔）
cursor integer N query 上次查询的时间戳
keyword string N query 查询关键字
labelName string N query 标签名称
limit integer N query 分页大小

# 返回结果

状态码 说明 返回值 响应头
200 OK FavoriteResult[ ] 无
401 Unauthorized 无 无
403 Forbidden 无 无
404 Not Found 无 无

# 请求示例

GET /v1/favorites?contentTypes={contentTypes}&cursor={cursor}&keyword={keyword}&labelName={labelName}&limit={limit}

# 返回示例

Content-Type: */*

[ {
  "sourceId" : "string",                //来源ID
  "itemId" : "string",                  //收藏资源id
  "sourceDisplayName" : "string",       //来源显示名称
  "createdDate" : "integer",            //创建时间
  "sourceType" : "integer",             //来源类型：0：系统，1：用户，2：群组，3：应用，4：部门，5：服务号，6：企业
  "sourceName" : "string",              //来源名称
  "contentType" : "integer",            //收藏类型，1：文字，2：语音，3：图片，4：视频，5：链接，6：文档，7：云盘，8：动态
  "content" : "string"                  //收藏内容
} ]

# 增加收藏

POST /v1/favorites

# 请求类型（Content-Type）

  • application/json

# 请求参数

参数名 数据类型 必填 参数位置 参数说明
blogInfo FavoriteWithLabelParam Y body BlogInfo

# 返回结果

状态码 说明 返回值 响应头
200 OK ApiResultOfobject 无
201 Created 无 无
401 Unauthorized 无 无
403 Forbidden 无 无
404 Not Found 无 无

# 请求示例

POST /v1/favorites
Content-Type: application/json

{
  "sourceId" : "string",                //来源ID
  "syncBlogFavor" : "boolean",          //是否同步到动态收藏
  "itemId" : "string",                  //收藏资源id
  "sourceDisplayName" : "string",       //来源显示名称
  "sourceType" : "integer",             //来源类型：0：系统，1：用户，2：群组，3：应用，4：部门，5：服务号，6：企业
  "sourceName" : "string",              //来源名称
  "labelList" : [ "string" ],           //标签ID列表
  "keyword" : "string",                 //搜索关键字
  "contentType" : "integer",            //收藏类型，1：文字，2：语音，3：图片，4：视频，5：链接，6：文档，7：云盘，8：动态
  "content" : "string"                  //收藏内容
}

# 返回示例

Content-Type: */*

{
  "code" : "integer",         //结果码 200:成功
  "data" : "object",          //请求返回的数据
  "message" : "string"        //当状态码不是200时，错误信息
}

# 取消收藏

DELETE /v1/favorites/{itemId}

# 请求参数

参数名 数据类型 必填 参数位置 参数说明
id string Y path 收藏资源id
syncBlogFavor boolean N query 是否同步到动态收藏

# 返回结果

状态码 说明 返回值 响应头
200 OK ApiResultOfobject 无
204 No Content 无 无
401 Unauthorized 无 无
403 Forbidden 无 无

# 请求示例

DELETE /v1/favorites/{itemId}?syncBlogFavor={syncBlogFavor}

# 返回示例

Content-Type: */*

{
  "code" : "integer",         //结果码 200:成功
  "data" : "object",          //请求返回的数据
  "message" : "string"        //当状态码不是200时，错误信息
}

← 配置服务接口定义 →