Skip to content

读取稿件详情

1 接口名称

读取稿件详情

2 接口描述

3 请求地址

plain
{apiAddress}/openapi/v2/channel_article/detail?connectNo=cbd46dbf5e7af869&signature=d807e6e7120a76d7d8297492d56f9cde&appkey=cblzs&sessionId=5bfdfd902096f011557830ca&id=2326289&noncestr=1672901252692&timestamp=1672901252692

4 请求方式

GET

5 请求参数

5.1 Query Params 参数

参数类型是否必须字段说明
connectNostring约定的通信connectNo(区别用户)
sessionIdstring客户端用户sessionId(使用:4阅读、5分享、6点赞、7收藏等接口时该参数必传)
idstring稿件ID

6 返回参数

6.1参数描述

字段描述说明
id稿件id稿件id,用于标识全局唯一稿件id
mlf_id媒立方metadata id
list_type列表展示类型1-表示纯文本,
2-代表单图文类型,
3-代表多图(三张图)类型,
4-代表大图模式,
5-代表专栏,
6-代表多图(四张图)类型,
104-代表专题,
105-代表话题,
106-代表活动,
107-代表直播,
108-代表视频,
109-代表widget,
110-推荐位 ,
111-视频专辑,
112-横幅 ,
113-代表轮播图
list_pics列表图片数组
list_tag列表标签独家、原创等
doc_type稿件类型doc_type: 分别代表
1-未知
2-普通
3-链接、
4-图集、
5-专题、
6-话题、
7-活动、
8-直播、
9-视频
10- 视频专题
11-音频专辑
21-专栏/推荐位/轮播图
22-横幅
doc_title稿件详情页标题
read_count阅读数
like_count点赞数
comment_count评论数
read_count_general大概的阅读数,如1万+,如果read_count是0返回空字符串
like_count_general大概的点赞数,如1万+,如果like_count是0返回空字符串
comment_count_general大概的评论数,如1万+,如果comment_count是0返回空字符串
channel_id频道id
channel_name频道名称
source_channel_id新闻来源频道id字符串可为空
source_channel_name新闻原始频道名称字符串可为空
channel_category_id频道所属分类 1为数采频道,2为地市频道,3为地方号频道,4.mcn频道(5.7)
parent_channel_id父级频道id可为空,channel_category_id=3(地方号)时,会返回(5.7)
parent_channel_name父级频道名称可为空,channel_category_id=3(地方号)时,会返回(5.7)
column_id栏目idNumber 栏目id 可为空
column_name栏目名称String 可为空
column_logo栏目图标栏目图标url
sort_number排序值客户端在做分页时需要把最后一条的sortnumber值传入作为分页参数
url新闻详情页url
share_url分享的新闻详情url
source稿件来源可为空
author稿件署名作者可为空
article_pic稿件详情页题图(话题/专题/新闻题图均使用该字段)可为空,为空时表示题图不存在
published_at签发时间戳详情页稿件签发时间
timeline时间线1小时前、2小时前、2天前
summary稿件摘要如普通正文摘要/专题详情页摘要
content稿件html内容可为空,个别不需要html内容的稿件可以为空
web_link链接稿的url地址可为空,当稿件类型为链接稿时存在
album_image_count图集稿图片数可为空,当稿件类型为图集时存在,用于新闻列表展示图集图片数
album_image_list图集稿内容详情可为空,当稿件类型为图集时存在
activity_status活动状态可为空,当稿件类型为活动时存在,0未开始,1进行中,2已结束,3.名单公布
activity_start活动开始时间可为空,当稿件类型为活动时存在
activity_end活动结束时间可为空,当稿件类型为活动时存在
activity_register_count活动注册人数可为空,当稿件类型为活动时存在
activity_announced活动是否公布名单可为空,当稿件类型为活动时存在
live_type直播类型可为空,当稿件类型为直播时存在 0,图文直播 1,视频直播
live_status直播状态可为空,当稿件类型为直播时存在 0直播回顾;1正在直播,2直播预告,3直播结束
live_url直播url可为空,当稿件类型为直播时存在
live_notice直播预告信息可为空,当稿件类型为直播时存在,当live_status等于1或2时有值
live_reminder_set直播开播提醒设置可为空,当稿件类型为直播时存在
当live_status等于2时有值,且在直播开始时间的2小时前展示
1-未设置,2-已设置
live_show_type直播展示类型0-原声,1-H5
video_url视频url可为空,当稿件类型为视频时存在
video_duration视频时长可为空,当稿件类型为视频时存在
video_size视频大小可为空,当稿件类型为视频时存在
topic_start话题开始时间可为空,当稿件类型为话题时存在
topic_end话题结束时间可为空,当稿件类型为话题时存在
topic_hosts话题主持人可为空,当稿件类型为话题时存在
topic_guests话题嘉宾可为空,当稿件类型为话题时存在
topic_status话题转状态可为空,当稿件类型为话题时存在,0未开始,1进行中,2已结束
topic_comment_list话题互动评论列表结构与其他评论节点保持一致,增加account_type. 话题主持人/嘉宾/普通用户 分别为 1/2/3 , 话题互动评论列表页接口调用评论列表接口
topic_comment_has_more话题互动评论精选是否有更多true:有更多 false:没有更多
topic_comment_select话题互动评论精选结构与其他评论节点保持一致,增加account_type. 话题主持人/嘉宾/普通用户 分别为 1/2/3 , 话题精选评论列表页接口详情, 参考链接
subject_focusl_url专题焦点图地址可为空,当稿件类型为专题且设置了专题焦点图时存在
subject_focus_image专题焦点图图片可为空,当稿件类型为专题且设置了专题焦点图时存在
subject_focus_description专题描述说明可为空,当稿件类型为专题且设置了专题焦点图时存在
subject_pic专题官网展示题图(供官网使用)可为空,当稿件类型为专题时存在
subject_groups专题分组新闻可为空,当稿件类型为专题时存在,增加group_articles
followed用户是否收藏新闻true 用户已经收藏稿件 false 用户没有收藏
column_subscribed用户是否订阅新闻对应的栏目true 用户已经订阅 false 用户没有订阅
liked用户是否点赞true 用户已经点赞过 false,用户没有点赞
comment_level评论等级0 禁止评论 1 先审后发 2 先发后审
like_enabled新闻是否开启点赞功能true 开启 false关闭
hot_comments新闻评论热门评论列表
related_news相关新闻列表相关新闻列表或者相关图集列表(应客户端要求,字段做适当改动)
related_subjects相关专题列表相关专题列表
score_notify任务完成情况完成情况概述(3.0修改)
frequency任务完成次数任务完成次数(3.0修改)
experience任务奖励经验任务奖励经验(3.0修改)
integral任务奖励积分任务奖励积分(3.0修改)
name任务名称任务名称(3.0修改)
illustration文末插图当文末插图存在时存在(3.0新增字段)
head_illustration文章上方插图4.6新增
down_illustration文章下方插图4.6新增
id文末插图id
name文末插图名称
image_url文末插图图片地址
type文末插图的关联类型0-无链接,1-外部链接地址,2-新闻的url地址
relation_data文末插图的关联数据关联地址 为空时表示该文章插图无链接
status文末插图的状态只会为1
updated_at更新时间
updated_by更新人
created_at创建时间
created_by创建人
deleted是否删除只会为false
column_news_list专栏稿件关联文章列表专栏文章才有的属性(是一个list集合) 专栏信息的数据结构和稿件列表的稿件数据结构一致
channel_url专栏配置了频道,新增的路由专栏文章才会有
forbidden用户是否被禁言false 未禁言 true 已禁言(3.0新增)
content_js_list组件列表js组件列表
content_css_list组件路径css组件列表
support_share是否支持分享true:支持,false:不支持
display展示规则展示规则
parent_area_id地市/所属父导航信息该稿件属于地市导航下时会返回该字段(3.4新增)
play_count播放数视频专辑稿有
play_count_general大概的播放数,如1万+,为0不返回视频专辑稿有
other_type栏目类型非必有
conabstract自定义介绍非必有
type_play_conabstract栏目类型/播放数/自定义介绍拼接非必有
article_video_album视频专辑信息非必有
article_video_rels视频专辑分集信息集合(详细信息描述如下)
mu_jing_id目镜id
mark_read标记阅读状态0-未读 1-已读
live_show_type直播展示类型0-原声,1-H5
vr是否是VRtrue是,false不是
documents.file_url附件路径
documents.name附件名称
documents.size附件大小
documents.file_type附件类型
hearder_img_width题图宽非必有
hearder_img_height题图高非必有
img_width非必有
img_height非必有
card_url分享卡片地址非必有
cycle_carousel是否开启循环轮播false-关闭 true-开启 默认false
audio_url音频地址http://dsdfad.mp3
custom_show_num专栏展示数专栏稿使用
custom_title_positioninteger专栏小标题位置,0-图片底部悬浮,1-图片下方展示
related_count关联音频数量关联音频数量
custom_style专栏样式 0,默认老的 1,稿件合集(根据这个判断子字段的样式)

6.2参数示例

json
{
  "code": 0,
  "data": {
    "article": {
      "id": 1970,
      "mlf_id": 67323,
      "list_title": "视频列表标题",
      "list_pics": [
        "https://preimg.tmuyun.com/assets/20190129/1548727690092_5c4fb58a83c76663b2af5c3c.jpeg"
      ],
      "list_tag": "最长的电影最长的电影",
      "list_type": 108,
      "doc_type": 9,
      "read_count": 172,
      "read_count_general": "172",
      "like_count": 0,
      "comment_count": 0,
      "comment_count_general": "",
      "url": "https://preapp.tmuyun.com/webDetails/video?id=1970&tenantId=6&vr=false",
      "share_url": "https://preapp.tmuyun.com/webDetails/video?id=1970&tenantId=6",
      "fixed_number": 0,
      "display": "-1",
      "original_id": 0,
      "src_metadata_id": 0,
      "followed": false,
      "liked": false,
      "like_enabled": true,
      "comment_level": 1,
      "forbidden": false,
      "channel_category_id": 2,
      "channel_id": "5c34198f83c7666577e98565",
      "channel_name": "宁波",
      "channel_code": "3",
      "parent_area_id": 623,
      "source_channel_id": "",
      "doc_title": "视频啊",
      "article_pic": "",
      "source": "",
      "author": "",
      "summary": "",
      "content": "<p>视频</p><script type=\"text/javascript\" src=\"null\"></script> \n<link rel=\"stylesheet\" type=\"text/css\" href=\"null\">",
      "web_link": "https://testmeizi02.tmuyun.com/pu1548727646623aijianji-22_1546931484060_shadow.mp4?ref_aid=1970",
      "sort_number": 1548727605019,
      "published_at": 1548727605000,
      "created_at": 1548727596000,
      "updated_at": 1622000018000,
      "subject_display_like_enabled": false,
      "vr": false,
      "video_url": "https://testmeizi02.tmuyun.com/pu1548727646623aijianji-22_1546931484060_shadow.mp4",
      "video_duration": 23,
      "video_size": 1122372,
      "head_illustration": [
        {
          "id": 72,
          "name": "个城市",
          "image_url": "https://preimg.tmuyun.com/assets/20221209/1670579462770_639305066304405fd9d07030.png",
          "type": 0,
          "relation_data": "",
          "status": 1,
          "tenant_id": 6,
          "created_by": "5bf6694083c7664d036e16f2",
          "created_at": 1670579466000,
          "updated_by": "5bf6694083c7664d036e16f2",
          "updated_at": 1670579488000,
          "deleted": false,
          "show_place": 1,
          "sort_number": 1670579466122
        }
      ],
      "down_illustration": [],
      "hot_comments": [],
      "tenant_id": 6,
      "read_count_config": 163,
      "like_count_config": 0,
      "read_count_addition": -1,
      "fixed_read_count": -1,
      "like_count_addition": -1,
      "fixed_like_count": -1,
      "support_share": true,
      "status": 4,
      "content_js_list": [
        "https://pre-tool.tmuyun.com/style/public/front/js/zjrb-elements.js?t=11?t=1672108434970",
        "https://preapp.tmuyun.com/client/js/iframes.js?t=1672108434970"
      ],
      "custom_show_num": 2,
      "custom_title_position": 0,
      "custom_style": 0,
      "type": 0,
      "card_url": "",
      "cycle_carousel": false,
      "audio_url": "",
      "show_type": 0
    }
  }
}

7 备注

成功返回code是0,非0时均为失败。