Appearance
读取稿件详情
1 接口名称
读取稿件详情
2 接口描述
- 无
3 请求地址
plain
{apiAddress}/openapi/v2/channel_article/detail?connectNo=cbd46dbf5e7af869&signature=d807e6e7120a76d7d8297492d56f9cde&appkey=cblzs&sessionId=5bfdfd902096f011557830ca&id=2326289&noncestr=1672901252692×tamp=1672901252692
4 请求方式
GET
5 请求参数
5.1 Query Params 参数
参数 | 类型 | 是否必须 | 字段说明 |
---|---|---|---|
connectNo | string | 是 | 约定的通信connectNo(区别用户) |
sessionId | string | 否 | 客户端用户sessionId(使用:4阅读、5分享、6点赞、7收藏等接口时该参数必传) |
id | string | 是 | 稿件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 | 栏目id | Number 栏目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 | 是否是VR | true是,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_position | integer | 专栏小标题位置,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时均为失败。