dingtalk.oapi.ding.create (发DING通知)

通过此接口发DING通知给企业内部员工, 支持短信DING和应用内DING. 该接口正在灰度内测中, 暂不对外开放

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
creator_userid String 必须 04533363830422783 发送者工号
receiver_userids String [] 必须 04533363830422783,033254362004288
  • 最大列表长度:20
  • 接收者工号列表
    remind_type Number 必须 1 提醒类型:1-应用内;2-短信
    remind_time Number 必须 1513005125000 发送时间(单位:毫秒)
    text_content String 必须 【示例】国庆节放假通知\n根据国务院2016年节假日放假安排,国庆节放假7天(10月1日-7日)
  • 最大长度:5000
  • 通知内容
    attachment AttachmentVO 可选 附件内容
    • └ file_id
    • String
    • 可选
    • 996655606
    • 上传DING盘后的文件ID
    • └ file_size
    • Number
    • 可选
    • 112343
    • 文件大小(单位:Byte, 最大2G)
    • └ link_pic_url
    • String
    • 可选
    • https://gw.alicdn.com/tfs/TB1bVSOdsLJ8KJjy0FnXXcFDpXa-2000-500.png
    • 链接缩略图
    • └ detail_type
    • String
    • 可选
    • xls
    • 文件后缀, 用于展示文件对应图标
    • └ link_text
    • String
    • 可选
    • 陕西省略阳县位于秦岭南麓、嘉陵江上游、陕甘川三省交界地带,有“秦蜀襟带”、“ 故道明珠”之美誉,全县总面积2831平方公里,辖15个镇、2个街道办事处,总人口20.1万人,其中贫困人口3.19万人。略阳县扶贫开发办公室,科级规格,是略阳县政府直属事业机构,负责全县的农村扶贫开发工作
    • 链接摘要
    • └ link_url
    • String
    • 可选
    • https://tms.dingtalk.com/markets/dingtalk/casedetail?spm=a3140.8196076.banner.1.48a7da7cL2E1c3&wh_ttid=pc&caseid=MTkwMw==
    • 链接URL
    • └ file_name
    • String
    • 可选
    • 值班表
    • 文件名
    • └ link_title
    • String
    • 可选
    • 钉钉打通扶贫工作---最后一公里
    • 链接标题
    • └ type
    • String
    • 可选
    • img
    • 附件类型:img-图片,link-链接,file-文件
    • └ file_space_id
    • String
    • 可选
    • 768320150
    • 上传DING盘后的SpaceId

    响应参数

    名称 类型 示例值 描述
    result CorpDingCreateResult {"openDingId":"323992854","invalidUser":["04533363830422783"]} 返回结果
    • └ open_ding_id
    • String
    • 247AF9AF8972B258
    • openDingId
    • └ invalid_users
    • String []
    • 04533363830422783,033254362004288
    • invalidUser
    errcode Number 431038 错码码
    errmsg String sender have reached daily quota 失败原因

    请求示例

    • JAVA
    • .NET
    • PHP
    • CURL
    • Python
    • C/C++
    • NodeJS
    DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/ding/create");
    OapiDingCreateRequest req = new OapiDingCreateRequest();
    req.setCreatorUserid("04533363830422783");
    req.setReceiverUserids("04533363830422783,033254362004288");
    req.setRemindType(1L);
    req.setRemindTime(1513005125000L);
    req.setTextContent("【示例】国庆节放假通知\n根据国务院2016年节假日放假安排,国庆节放假7天(10月1日-7日)");
    AttachmentVO obj1 = new AttachmentVO();
    obj1.setFileId("996655606");
    obj1.setFileSize(112343L);
    obj1.setLinkPicUrl("https://gw.alicdn.com/tfs/TB1bVSOdsLJ8KJjy0FnXXcFDpXa-2000-500.png");
    obj1.setDetailType("xls");
    obj1.setLinkText("陕西省略阳县位于秦岭南麓、嘉陵江上游、陕甘川三省交界地带,有“秦蜀襟带”、“ 故道明珠”之美誉,全县总面积2831平方公里,辖15个镇、2个街道办事处,总人口20.1万人,其中贫困人口3.19万人。略阳县扶贫开发办公室,科级规格,是略阳县政府直属事业机构,负责全县的农村扶贫开发工作");
    obj1.setLinkUrl("https://tms.dingtalk.com/markets/dingtalk/casedetail?spm=a3140.8196076.banner.1.48a7da7cL2E1c3&wh_ttid=pc&caseid=MTkwMw==");
    obj1.setFileName("值班表");
    obj1.setLinkTitle("钉钉打通扶贫工作---最后一公里");
    obj1.setType("img");
    obj1.setFileSpaceId("768320150");
    req.setAttachment(obj1);
    OapiDingCreateResponse rsp = client.execute(req, access_token);
    System.out.println(rsp.getBody());

    响应示例

    • JSON示例
    {
        "result":{
            "open_ding_id":"247AF9AF8972B258",
            "invalid_users":{
                "string":[
                    "04533363830422783",
                    "033254362004288"
                ]
            }
        },
        "errcode":431038,
        "errmsg":"sender have reached daily quota"
    }

    异常示例

    • JSON示例
    {
    	"errcode":88,
    	"errmsg":"ding talk error"
    }

    错误码解释

    错误码 错误描述 解决方案

    API工具

    如何获得此API

    FAQ

    返回
    顶部