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

dingtalk.oapi.im.chat.servicegroup.notice.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。

请求参数

名称	类型	是否必须	示例值	更多限制	描述
chat_id	String	必须	chat8907098		要创建群公告的群id
userid	String	必须	9077980e275		创建者id
unique_key	String	必须	213324		唯一性key，由调用方提供，避免重复操作。
send_ding	Boolean	可选	true	默认值：false	是否发送ding提醒
title	String	必须	这里是群公告标题	最大长度：200	群公告标题
text_content	String	必须	这里是群公告内容	最大长度：2000	群公告内容
sticky	Boolean	可选	true	默认值：true	是否置顶

响应参数

名称	类型	示例值	描述
success	Boolean	true	是否创建成功
result	String	dsfga789fd7g9dfg	返回的数据id
errmsg	String	invalid	错误信息
errcode	Number	0	错误代码

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/im/chat/servicegroup/notice/create");
OapiImChatServicegroupNoticeCreateRequest req = new OapiImChatServicegroupNoticeCreateRequest();
req.setChatId("chat8907098");
req.setUserid("9077980e275");
req.setUniqueKey("213324");
req.setSendDing(true);
req.setTitle("这里是群公告标题");
req.setTextContent("这里是群公告内容");
req.setSticky(true);
OapiImChatServicegroupNoticeCreateResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/im/chat/servicegroup/notice/create");
OapiImChatServicegroupNoticeCreateRequest req = new OapiImChatServicegroupNoticeCreateRequest();
req.ChatId = "chat8907098";
req.Userid = "9077980e275";
req.UniqueKey = "213324";
req.SendDing = true;
req.Title = "这里是群公告标题";
req.TextContent = "这里是群公告内容";
req.Sticky = true;
OapiImChatServicegroupNoticeCreateResponse 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 OapiImChatServicegroupNoticeCreateRequest;
$req->setChatId("chat8907098");
$req->setUserid("9077980e275");
$req->setUniqueKey("213324");
$req->setSendDing("true");
$req->setTitle("这里是群公告标题");
$req->setTextContent("这里是群公告内容");
$req->setSticky("true");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/im/chat/servicegroup/notice/create");

curl -X POST "https://oapi.dingtalk.com/topapi/im/chat/servicegroup/notice/create" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=e328f61f-185d-415f-9198-b6bf1514c7b9' \
-d 'chat_id=chat8907098' \
-d 'send_ding=true' \
-d 'sticky=true' \
-d 'text_content=%E8%BF%99%E9%87%8C%E6%98%AF%E7%BE%A4%E5%85%AC%E5%91%8A%E5%86%85%E5%AE%B9' \
-d 'title=%E8%BF%99%E9%87%8C%E6%98%AF%E7%BE%A4%E5%85%AC%E5%91%8A%E6%A0%87%E9%A2%98' \
-d 'unique_key=213324' \
-d 'userid=9077980e275'

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

req=dingtalk.api.OapiImChatServicegroupNoticeCreateRequest("https://oapi.dingtalk.com/topapi/im/chat/servicegroup/notice/create")

req.chat_id="chat8907098"
req.userid="9077980e275"
req.unique_key="213324"
req.send_ding=true
req.title="这里是群公告标题"
req.text_content="这里是群公告内容"
req.sticky=true
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.im.chat.servicegroup.notice.create");
add_param(pRequest,"chat_id","chat8907098");
add_param(pRequest,"userid","9077980e275");
add_param(pRequest,"unique_key","213324");
add_param(pRequest,"send_ding","true");
add_param(pRequest,"title","这里是群公告标题");
add_param(pRequest,"text_content","这里是群公告内容");
add_param(pRequest,"sticky","true");
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.im.chat.servicegroup.notice.create', {
	'chat_id':'chat8907098',
	'userid':'9077980e275',
	'unique_key':'213324',
	'send_ding':'true',
	'title':'这里是群公告标题',
	'text_content':'这里是群公告内容',
	'sticky':'true'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "success":true,
    "result":"dsfga789fd7g9dfg",
    "errmsg":"invalid",
    "errcode":0
}

异常示例

JSON示例

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

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

钉钉API

dingtalk.oapi.im.chat.servicegroup.notice.create (创建群公告)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ