dingtalk.oapi.report.template.getbyname (查询模板详情)

企业可以根据模板名称获取模板详情

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
userid String 必须 12345 员工id
template_name String 必须 日报 模板名称

响应参数

名称 类型 示例值 描述
result ReportTemplateResponseVo {} result
  • default_receivers
  • DefaultReceivers []
  • 模板默认接收人
  • └ user_name
  • String
  • 用户1
  • 默认接收人名称
  • └ userid
  • String
  • 111
  • 默认接收人员工id
  • └ name
  • String
  • 周报
  • 模板名称
  • └ id
  • String
  • 12345abcde
  • 模板id
  • fields
  • Fields []
  • 模板字段
  • └ field_name
  • String
  • 字段1
  • 模板字段名称
  • └ type
  • Number
  • 1
  • 字段类型
  • └ sort
  • Number
  • 0
  • 模板字段唯一标识
  • └ user_name
  • String
  • 小明
  • 用户名称
  • └ userid
  • String
  • 12345
  • 员工id
  • default_received_convs
  • BaseConversationVo []
  • {}
  • 默认接收群
  • └ conversation_id
  • String
  • 1223445
  • 默认接收群id
  • └ title
  • String
  • 群名称
  • 群名称
errcode Number 0 系统自动生成
errmsg String ok 系统自动生成

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
1
2
3
4
5
6
DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/report/template/getbyname");
OapiReportTemplateGetbynameRequest req = new OapiReportTemplateGetbynameRequest();
req.setUserid("12345");
req.setTemplateName("日报");
OapiReportTemplateGetbynameResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

响应示例

  • JSON示例
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
{
    "result":{
        "default_receivers":[
            {
                    "user_name":"用户1",
                    "userid":"111"
            }
        ],
        "name":"周报",
        "id":"12345abcde",
        "fields":[
            {
                    "field_name":"字段1",
                    "type":1,
                    "sort":0
            }
        ],
        "user_name":"小明",
        "userid":"12345",
        "default_received_convs":[
            {
                    "conversation_id":"1223445",
                    "title":"群名称"
            }
        ]
    },
    "errcode":0,
    "errmsg":"ok"
}

异常示例

  • JSON示例
1
2
3
4
{
    "errcode":88,
    "errmsg":"ding talk error"
}

错误码解释

错误码 错误描述 解决方案

API工具

如何获得此API

FAQ

返回
顶部