Developer OpenAPI
首页Apifox官网钉钉openAPI
企业微信openAPI
  • openAPI文档
  • 官方文档
首页Apifox官网钉钉openAPI
企业微信openAPI
  • openAPI文档
  • 官方文档
服务端API
  • 历史文档(不推荐)
  • 开发钉钉应用
  • 服务端API
  • 新版服务端API(DingTalk OpenAPI)
  • 生态伙伴API
获取凭证(access_token)身份验证(免登)应用授权通讯录管理互联平台群会话管理消息通知智能工作流智能填表智能人事考勤日志签到公告钉钉运动应用管理文件存储钉盘新教育专属钉钉智能办公电话应用市场项目管理客户管理(官方CRM)培训智能硬件
获取凭证(access_token)身份验证(免登)应用授权通讯录管理互联平台群会话管理消息通知智能工作流智能填表智能人事考勤日志签到公告钉钉运动应用管理文件存储钉盘新教育专属钉钉智能办公电话应用市场项目管理客户管理(官方CRM)培训智能硬件
  1. 消息卡片管理
  • 数据统计
    • 视频直播统计
      • 获取视频直播明细列表
      • 获取视频直播观看人员列表
      • 获取企业视频直播统计列表(部门维度)
      • 获取企业视频直播统计数据
    • 视频会议统计
      • 获取企业某天的视频会议统计数据
      • 获取企业某天的所有部门视频会议统计数据
      • 获取企业视频会议明细列表
    • 电话会议统计
      • 获取企业某天的所有部门电话会议统计列表
      • 获取企业电话会议明细列表
      • 获取企业某天的电话会议数据
    • 企业其他数据统计
      • 获取企业各类群组创建情况
      • 获取企业聊天数据
      • 获取企业部门聊天数据(部门维度)
      • 获取企业应用访问情况
      • 统计企业活跃用户
      • 企业活跃用户统计列表(部门维度)
      • 查询企业通讯录未激活用户列表
      • 获取企业DING使用数据
      • 获取企业DING使用数据(部门维度)
  • 互动服务窗
    • 服务号管理
      • 新增服务号
      • 更新服务号
      • 查询服务号列表
      • 查询服务号详情
    • 文章管理
      • 新增文章
      • 删除文章
      • 更新文章
      • 查询文章列表
      • 获取文章详情
      • 发布文章
    • 消息卡片管理
      • 新增消息卡片
        POST
      • 删除消息卡片
        POST
      • 获取消息卡片详情
        POST
      • 更新消息卡片
        POST
      • 查询消息卡片列表
        POST
    • 消息群发
      • 消息撤回
      • 消息群发
    • 菜单管理
      • 服务号菜单更新
      • 查询服务号菜单
  • 获取年报数据
    • 获取年报数据
      POST
  • 查询企业内部群信息
    GET
  1. 消息卡片管理

查询消息卡片列表

POST
http://127.0.0.1/topapi/material/news/list
服务端API/专属钉钉/互动服务窗/消息卡片管理
最后修改时间:2022-08-30 09:19:24
责任人:未设置

说明#

调用本接口查询消息卡片列表。
服务地址:https://oapi.dingtalk.com

权限#

服务端API是以应用维度授权的,在调用接口前,确保已经为应用添加了接口权限。详情请参考权限申请。
应用类型是否支持调用权限申请方式API Explorer调试
企业内部应用是开发者后台申请调试
第三方企业应用否——
第三方个人应用否——

请求参数

Query 参数
access_token
string 
必需
调用服务端接口的授权凭证。企业内部应用可通过调用access_token接口获得。
示例值:
30c9a84136943eaxxxx
Body 参数application/json
unionid
string 
必需
服务号的unionid,可以通过查询服务号详情接口获取。
page_start
number 
页码,从1开始。
可选
page_size
number 
每页条数。
可选
示例
{
  "unionid": "jYdrJoCmTo0iE",
  "page_start": 1,
  "page_size": 5
}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'http://127.0.0.1/topapi/material/news/list?access_token=30c9a84136943eaxxxx' \
--header 'Content-Type: application/json' \
--data-raw '{
    "unionid": "jYdrJoCmTo0iE",
    "page_start": 1,
    "page_size": 5
}'

返回响应

🟢200成功
application/json
Body
errmsg
string 
返回码描述。
可选
errcode
number 
返回码。
可选
request_id
string 
请求ID。
可选
total_count
number 
总记录数。
可选
item_count
number 
当前返回记录数。
可选
items
array [object {3}] 
卡片列表。
可选
articles
array [object {12}] 
文章列表。
可选
update_time
number 
消息卡片更新时间。
可选
media_id
string 
可选
消息卡片的素材id。
示例
{
  "errmsg": "string",
  "errcode": 0,
  "request_id": "string",
  "total_count": 0,
  "item_count": 0,
  "items": [
    {
      "articles": [
        {
          "article_id": 0,
          "title": "string",
          "thumb_media_id": "string",
          "publish_status": 0,
          "publish_time": 0,
          "user_view_count": 0,
          "total_view_count": 0,
          "create_time": 0,
          "update_time": 0,
          "url": "string",
          "content": "string",
          "digest": "string"
        }
      ],
      "update_time": 0,
      "media_id": "string"
    }
  ]
}
上一页
更新消息卡片
下一页
消息撤回
Built with