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

dingtalk.oapi.blackboard.create (创建企业公告)

管理员可以通过该接口创建钉钉企业公告

公共参数

环境	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。

请求参数

名称	类型	是否必须	示例值	更多限制	描述
create_request	OapiCreateBlackboardVo	必须			请求入参
└ operation_userid String 必须 manager01 操作人的userId(必须是公告管理员) └ author String 可选张三公告作者 └ private_level Number 可选 0 保密等级，仅支持以下值(0:普通公告，20：保密公告) └ ding Boolean 可选 false 是否发送应用内钉提醒 blackboard_receiver BlackboardReceiverOpenVo 必须入参 └ deptid_list Number [] 可选 [123456] 接收部门id列表 └ userid_list String [] 可选 ["manager02"] 接收人userId列表 └ title String 必须入职须知公告标题 └ push_top Boolean 可选 true 公告是否置顶 └ content String 必须欢迎加入我们的大家庭公告内容 └ category_id String 可选 987uy66t5rt54er 公告分类id，可以通过公告开放接口：（获取企业公告未删除分类列表）获取有效值 └ coverpic_mediaid String 可选 @lADPDeC2ufXOeRzMqM0BLA 封面图,需要使用mediaId,可以通过钉钉开放接口：https://ding-doc.dingtalk.com/doc#/serverapi2/bcmg0i 上传图片获取mediaId └ downloadable Boolean 可选 true 附件是否允许下载，默认是true attachments BlackboardAttachmentDTO [] 可选附件信息 └ name String 可选 DingTalk 文件名 └ size Number 可选 123 文件大小，单位byte └ spaceId String 可选 3849 钉盘空间id └ fileType String 可选 pdf 文件类型 └ fileId String 可选 837 钉盘文件id └ oaNotifyDisabled Boolean 可选 false 不给接收方发工作通知消息提醒

响应参数

名称	类型	示例值	描述
result	Boolean		success为true时，该值不为空，否则值为空
success	Boolean	false	本次调用是否成功，该值为false时，根据errcode和errMsg排查失败原因
errcode	Number	400001	请求失败返回的错误码
errmsg	String	系统异常	请求失败返回的错误信息

请求示例

JAVA
.NET
PHP
CURL
Python
C/C++
NodeJS

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/blackboard/create");
OapiBlackboardCreateRequest req = new OapiBlackboardCreateRequest();
OapiCreateBlackboardVo obj1 = new OapiCreateBlackboardVo();
obj1.setOperationUserid("manager01");
obj1.setAuthor("张三");
obj1.setPrivateLevel(0L);
obj1.setDing(false);
BlackboardReceiverOpenVo obj2 = new BlackboardReceiverOpenVo();
obj2.setDeptidList(new Long[] { 123456 };
);
obj2.setUseridList(""manager02"");
obj1.setBlackboardReceiver(obj2);
obj1.setTitle("入职须知");
obj1.setPushTop(true);
obj1.setContent("欢迎加入我们的大家庭");
obj1.setCategoryId("987uy66t5rt54er");
obj1.setCoverpicMediaid("@lADPDeC2ufXOeRzMqM0BLA");
obj1.setDownloadable(true);
List<BlackboardAttachmentDTO> list4 = new ArrayList<BlackboardAttachmentDTO>();
BlackboardAttachmentDTO obj5 = new BlackboardAttachmentDTO();
list4.add(obj5);
obj5.setName("DingTalk");
obj5.setSize(123L);
obj5.setSpaceId("3849");
obj5.setFileType("pdf");
obj5.setFileId("837");
obj1.setAttachments(list4);
obj1.setOaNotifyDisabled(false);
req.setCreateRequest(obj1);
OapiBlackboardCreateResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/blackboard/create");
OapiBlackboardCreateRequest req = new OapiBlackboardCreateRequest();
OapiBlackboardCreateRequest.OapiCreateBlackboardVoDomain obj1 = new OapiBlackboardCreateRequest.OapiCreateBlackboardVoDomain();
obj1.OperationUserid = "manager01";
obj1.Author = "张三";
obj1.PrivateLevel = 0L;
obj1.Ding = false;
OapiBlackboardCreateRequest.BlackboardReceiverOpenVoDomain obj2 = new OapiBlackboardCreateRequest.BlackboardReceiverOpenVoDomain();
obj2.DeptidList = new long[] { 123456 };
;
obj2.UseridList = ""manager02"";
obj1.BlackboardReceiver= obj2;
obj1.Title = "入职须知";
obj1.PushTop = true;
obj1.Content = "欢迎加入我们的大家庭";
obj1.CategoryId = "987uy66t5rt54er";
obj1.CoverpicMediaid = "@lADPDeC2ufXOeRzMqM0BLA";
obj1.Downloadable = true;
List<OapiBlackboardCreateRequest.BlackboardAttachmentDTODomain> list4 = new List<OapiBlackboardCreateRequest.BlackboardAttachmentDTODomain>();
OapiBlackboardCreateRequest.BlackboardAttachmentDTODomain obj5 = new OapiBlackboardCreateRequest.BlackboardAttachmentDTODomain();
list4.Add(obj5);
obj5.Name = "DingTalk";
obj5.Size = 123L;
obj5.SpaceId = "3849";
obj5.FileType = "pdf";
obj5.FileId = "837";
obj1.Attachments= list4;
obj1.OaNotifyDisabled = false;
req.CreateRequest_ = obj1;
OapiBlackboardCreateResponse 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 OapiBlackboardCreateRequest;
$create_request = new OapiCreateBlackboardVo;
$create_request->operation_userid="manager01";
$create_request->author="张三";
$create_request->private_level="0";
$create_request->ding="false";
$blackboard_receiver = new BlackboardReceiverOpenVo;
$blackboard_receiver->deptid_list="[123456]";
$blackboard_receiver->userid_list="[\"manager02\"]";
$create_request->blackboard_receiver = $blackboard_receiver;
$create_request->title="入职须知";
$create_request->push_top="true";
$create_request->content="欢迎加入我们的大家庭";
$create_request->category_id="987uy66t5rt54er";
$create_request->coverpic_mediaid="@lADPDeC2ufXOeRzMqM0BLA";
$create_request->downloadable="true";
$attachments = new BlackboardAttachmentDTO;
$attachments->name="DingTalk";
$attachments->size="123";
$attachments->spaceId="3849";
$attachments->fileType="pdf";
$attachments->fileId="837";
$create_request->attachments = array($attachments);
$create_request->oaNotifyDisabled="false";
$req->setCreateRequest($create_request);
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/blackboard/create");

curl -X POST "https://oapi.dingtalk.com/topapi/blackboard/create" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=cd475721-1f9e-4f39-b69c-e5896fb8474b' \
-d 'create_request=null'

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

req=dingtalk.api.OapiBlackboardCreateRequest("https://oapi.dingtalk.com/topapi/blackboard/create")

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

响应示例

JSON示例

{
    "result":,
    "success":false,
    "errcode":400001,
    "errmsg":"系统异常"
}

异常示例

JSON示例

{
	"errcode":88,
	"errmsg":"ding talk error"
}

错误码解释

错误码	错误描述	解决方案

API工具

API测试工具错误码查询工具 SDK下载

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

钉钉API

dingtalk.oapi.blackboard.create (创建企业公告)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ