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

dingtalk.oapi.ding.send (微应用发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。

请求参数

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

响应参数

名称	类型	示例值	描述
result	CorpDingCreateResult	{"openDingId":"323992854","invalidUser":["04533363830422783"]}	返回结果
└ open_ding_id String "32EW232DVDFSFS" 发送成功的DING_ID └ invalid_users String [] 04533363830422783,033254362004288 不能接收DING的用户列表
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/send");
OapiDingSendRequest req = new OapiDingSendRequest();
OpenDingSendVo obj1 = new OpenDingSendVo();
AttachmentVo obj2 = new AttachmentVo();
obj2.setDetailType("xls");
obj2.setLinkTitle("钉钉打通扶贫工作---最后一公里");
obj2.setFileName("值班表");
obj2.setFileSize(112343L);
obj2.setLinkUrl("https://tms.dingtalk.com/markets/dingtalk/casedetail?spm=a3140.8196076.banner.1.48a7da7cL2E1c3&wh_ttid=pc&caseid=MTkwMw==");
obj2.setFileSpaceId("768320150");
obj2.setLinkText("陕西省略阳县位于秦岭南麓、嘉陵江上游、陕甘川三省交界地带，有“秦蜀襟带”、“ 故道明珠”之美誉，全县总面积2831平方公里，辖15个镇、2个街道办事处，总人口20.1万人，其中贫困人口3.19万人。略阳县扶贫开发办公室，科级规格，是略阳县政府直属事业机构，负责全县的农村扶贫开发工作");
obj2.setType("img");
obj2.setLinkPicUrl("https://gw.alicdn.com/tfs/TB1bVSOdsLJ8KJjy0FnXXcFDpXa-2000-500.png");
obj2.setFileId("996655606");
obj1.setAttachment(obj2);
obj1.setTextContent("【示例】国庆节放假通知\n根据国务院2016年节假日放假安排，国庆节放假7天(10月1日-7日)");
obj1.setReceiverUids("04533363830422783,033254362004288");
obj1.setRemindType(1L);
req.setOpenDingSendVo(obj1);
OapiDingSendResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/ding/send");
OapiDingSendRequest req = new OapiDingSendRequest();
OapiDingSendRequest.OpenDingSendVoDomain obj1 = new OapiDingSendRequest.OpenDingSendVoDomain();
OapiDingSendRequest.AttachmentVoDomain obj2 = new OapiDingSendRequest.AttachmentVoDomain();
obj2.DetailType = "xls";
obj2.LinkTitle = "钉钉打通扶贫工作---最后一公里";
obj2.FileName = "值班表";
obj2.FileSize = 112343L;
obj2.LinkUrl = "https://tms.dingtalk.com/markets/dingtalk/casedetail?spm=a3140.8196076.banner.1.48a7da7cL2E1c3&wh_ttid=pc&caseid=MTkwMw==";
obj2.FileSpaceId = "768320150";
obj2.LinkText = "陕西省略阳县位于秦岭南麓、嘉陵江上游、陕甘川三省交界地带，有“秦蜀襟带”、“ 故道明珠”之美誉，全县总面积2831平方公里，辖15个镇、2个街道办事处，总人口20.1万人，其中贫困人口3.19万人。略阳县扶贫开发办公室，科级规格，是略阳县政府直属事业机构，负责全县的农村扶贫开发工作";
obj2.Type = "img";
obj2.LinkPicUrl = "https://gw.alicdn.com/tfs/TB1bVSOdsLJ8KJjy0FnXXcFDpXa-2000-500.png";
obj2.FileId = "996655606";
obj1.Attachment= obj2;
obj1.TextContent = "【示例】国庆节放假通知\n根据国务院2016年节假日放假安排，国庆节放假7天(10月1日-7日)";
obj1.ReceiverUids = "04533363830422783,033254362004288";
obj1.RemindType = 1L;
req.OpenDingSendVo_ = obj1;
OapiDingSendResponse 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 OapiDingSendRequest;
$open_ding_send_vo = new OpenDingSendVo;
$attachment = new AttachmentVo;
$attachment->detail_type="xls";
$attachment->link_title="钉钉打通扶贫工作---最后一公里";
$attachment->file_name="值班表";
$attachment->file_size="112343";
$attachment->link_url="https://tms.dingtalk.com/markets/dingtalk/casedetail?spm=a3140.8196076.banner.1.48a7da7cL2E1c3&wh_ttid=pc&caseid=MTkwMw==";
$attachment->file_space_id="768320150";
$attachment->link_text="陕西省略阳县位于秦岭南麓、嘉陵江上游、陕甘川三省交界地带，有“秦蜀襟带”、“ 故道明珠”之美誉，全县总面积2831平方公里，辖15个镇、2个街道办事处，总人口20.1万人，其中贫困人口3.19万人。略阳县扶贫开发办公室，科级规格，是略阳县政府直属事业机构，负责全县的农村扶贫开发工作";
$attachment->type="img";
$attachment->link_pic_url="https://gw.alicdn.com/tfs/TB1bVSOdsLJ8KJjy0FnXXcFDpXa-2000-500.png";
$attachment->file_id="996655606";
$open_ding_send_vo->attachment = $attachment;
$open_ding_send_vo->text_content="【示例】国庆节放假通知\n根据国务院2016年节假日放假安排，国庆节放假7天(10月1日-7日)";
$open_ding_send_vo->receiver_uids="04533363830422783,033254362004288";
$open_ding_send_vo->remind_type="1";
$req->setOpenDingSendVo($open_ding_send_vo);
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/ding/send");

curl -X POST "https://oapi.dingtalk.com/topapi/ding/send" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=2904ff82-4e90-4311-95c5-7595ef200921' \
-d 'open_ding_send_vo=null'

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

req=dingtalk.api.OapiDingSendRequest("https://oapi.dingtalk.com/topapi/ding/send")

req.open_ding_send_vo=""
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.send");
add_param(pRequest,"open_ding_send_vo","数据结构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.send', {
	'open_ding_send_vo':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "result":{
        "open_ding_id":"\"32EW232DVDFSFS\"",
        "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.send (微应用发DING通知接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈