文档中心 > API类目 > 钉钉API

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

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

公共参数

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://gw.api.taobao.com/router/rest	https://eco.taobao.com/router/rest

名称	类型	是否必须	描述
access_token	String	是	钉钉提供的授权Token，想了解详情，ISV开发者请点击这里，企业开发者请点击这里。若有疑问，咨询邮箱dingding_open_dingtalk#list.alibaba-inc.com。

请求参数

名称	类型	是否必须	示例值	更多限制	描述
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());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/ding/create");
OapiDingCreateRequest req = new OapiDingCreateRequest();
req.CreatorUserid = "04533363830422783";
req.ReceiverUserids = "04533363830422783,033254362004288";
req.RemindType = 1L;
req.RemindTime = 1513005125000L;
req.TextContent = "【示例】国庆节放假通知\n根据国务院2016年节假日放假安排，国庆节放假7天(10月1日-7日)";
OapiDingCreateRequest.AttachmentVODomain obj1 = new OapiDingCreateRequest.AttachmentVODomain();
obj1.FileId = "996655606";
obj1.FileSize = 112343L;
obj1.LinkPicUrl = "https://gw.alicdn.com/tfs/TB1bVSOdsLJ8KJjy0FnXXcFDpXa-2000-500.png";
obj1.DetailType = "xls";
obj1.LinkText = "陕西省略阳县位于秦岭南麓、嘉陵江上游、陕甘川三省交界地带，有“秦蜀襟带”、“ 故道明珠”之美誉，全县总面积2831平方公里，辖15个镇、2个街道办事处，总人口20.1万人，其中贫困人口3.19万人。略阳县扶贫开发办公室，科级规格，是略阳县政府直属事业机构，负责全县的农村扶贫开发工作";
obj1.LinkUrl = "https://tms.dingtalk.com/markets/dingtalk/casedetail?spm=a3140.8196076.banner.1.48a7da7cL2E1c3&wh_ttid=pc&caseid=MTkwMw==";
obj1.FileName = "值班表";
obj1.LinkTitle = "钉钉打通扶贫工作---最后一公里";
obj1.Type = "img";
obj1.FileSpaceId = "768320150";
req.Attachment_ = obj1;
OapiDingCreateResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);

include "TopSdk.php";
date_default_timezone_set('Asia/Shanghai');

$c = new DingTalkClient(DingTalkConstant::$CALL_TYPE_OAPI, DingTalkConstant::$METHOD_POST , DingTalkConstant::$FORMAT_JSON);
$req = new OapiDingCreateRequest;
$req->setCreatorUserid("04533363830422783");
$req->setReceiverUserids("04533363830422783,033254362004288");
$req->setRemindType("1");
$req->setRemindTime("1513005125000");
$req->setTextContent("【示例】国庆节放假通知\n根据国务院2016年节假日放假安排，国庆节放假7天(10月1日-7日)");
$attachment = new AttachmentVO;
$attachment->file_id="996655606";
$attachment->file_size="112343";
$attachment->link_pic_url="https://gw.alicdn.com/tfs/TB1bVSOdsLJ8KJjy0FnXXcFDpXa-2000-500.png";
$attachment->detail_type="xls";
$attachment->link_text="陕西省略阳县位于秦岭南麓、嘉陵江上游、陕甘川三省交界地带，有“秦蜀襟带”、“ 故道明珠”之美誉，全县总面积2831平方公里，辖15个镇、2个街道办事处，总人口20.1万人，其中贫困人口3.19万人。略阳县扶贫开发办公室，科级规格，是略阳县政府直属事业机构，负责全县的农村扶贫开发工作";
$attachment->link_url="https://tms.dingtalk.com/markets/dingtalk/casedetail?spm=a3140.8196076.banner.1.48a7da7cL2E1c3&wh_ttid=pc&caseid=MTkwMw==";
$attachment->file_name="值班表";
$attachment->link_title="钉钉打通扶贫工作---最后一公里";
$attachment->type="img";
$attachment->file_space_id="768320150";
$req->setAttachment($attachment);
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/ding/create");

curl -X POST "https://oapi.dingtalk.com/topapi/ding/create" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=7b9fb651-7ddb-4c95-a891-40da2ea28db3' \
-d 'attachment=null' \
-d 'creator_userid=04533363830422783' \
-d 'receiver_userids=04533363830422783%2C033254362004288' \
-d 'remind_time=1513005125000' \
-d 'remind_type=1' \
-d 'text_content=%E3%80%90%E7%A4%BA%E4%BE%8B%E3%80%91%E5%9B%BD%E5%BA%86%E8%8A%82%E6%94%BE%E5%81%87%E9%80%9A%E7%9F%A5%5Cn%E6%A0%B9%E6%8D%AE%E5%9B%BD%E5%8A%A1%E9%99%A22016%E5%B9%B4%E8%8A%82%E5%81%87%E6%97%A5%E6%94%BE%E5%81%87%E5%AE%89%E6%8E%92%EF%BC%8C%E5%9B%BD%E5%BA%86%E8%8A%82%E6%94%BE%E5%81%877%E5%A4%A9%2810%E6%9C%881%E6%97%A5-7%E6%97%A5%29'

# -*- coding: utf-8 -*-
import dingtalk.api

req=dingtalk.api.OapiDingCreateRequest("https://oapi.dingtalk.com/topapi/ding/create")

req.creator_userid="04533363830422783"
req.receiver_userids="04533363830422783,033254362004288"
req.remind_type=1
req.remind_time=1513005125000
req.text_content="【示例】国庆节放假通知\n根据国务院2016年节假日放假安排，国庆节放假7天(10月1日-7日)"
req.attachment=""
try:
	resp= req.getResponse(access_token)
	print(resp)
except Exception,e:
	print(e)

pTopRequest pRequest = alloc_top_request();
pTopResponse pResponse = NULL;
pTaobaoClient pClient = alloc_taobao_client(url, appkey, appsecret);
set_api_name(pRequest,"dingtalk.oapi.ding.create");
add_param(pRequest,"creator_userid","04533363830422783");
add_param(pRequest,"receiver_userids","04533363830422783,033254362004288");
add_param(pRequest,"remind_type","1");
add_param(pRequest,"remind_time","1513005125000");
add_param(pRequest,"text_content","【示例】国庆节放假通知\n根据国务院2016年节假日放假安排，国庆节放假7天(10月1日-7日)");
add_param(pRequest,"attachment","数据结构JSON示例");
pResponse = top_execute(pClient,pRequest,sessionKey);
printf("ret code:%d\n",pResponse->code);
if(pResponse->code == 0){
	pTopResponseIterator ite = init_response_iterator(pResponse);
	pResultItem pResultItem = alloc_result_item();
	while(parseNext(ite, pResultItem) == 0){
		printf("%s:%s\n",pResultItem->key,pResultItem->value);
	}
	destroy_response_iterator(ite);
	destroy_result_item(pResultItem);
}
destroy_top_request(pRequest);
destroy_top_response(pResponse);
destroy_taobao_client(pClient);

TopClient = require('./topClient').TopClient;
var client = new TopClient({
	'appkey': 'appkey',
	'appsecret': 'secret',
	'REST_URL': 'http://gw.api.taobao.com/router/rest'
});

client.execute('dingtalk.oapi.ding.create', {
	'creator_userid':'04533363830422783',
	'receiver_userids':'04533363830422783,033254362004288',
	'remind_type':'1',
	'remind_time':'1513005125000',
	'text_content':'【示例】国庆节放假通知\n根据国务院2016年节假日放假安排，国庆节放假7天(10月1日-7日)',
	'attachment':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

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测试工具错误码查询工具 SDK下载

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

钉钉API

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

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ