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

dingtalk.oapi.smartbot.msg.push (工作助理的消息推送接口)

通过工作助理机器人给企业员工发送消息

公共参数

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

请求参数

名称	类型	是否必须	示例值	更多限制	描述
msg	Msg	必须			消息体，具体见文档
└ msgtype String 必须 text 消息类型 text Text 可选文本消息 └ content String 可选 123 文本消息 markdown Markdown 可选 markdown消息 └ text String 可选 text markdown格式的消息，建议500字符以内 └ title String 可选 title 首屏会话透出的展示内容 action_card ActionCard 可选卡片消息 btn_json_list BtnJson [] 可选使用独立跳转ActionCard样式时的按钮列表；必须与btn_orientation同时设置 └ action_url String 可选 action_url 消息点击链接地址，当发送消息为小程序时支持小程序跳转链接，最长500个字符 └ title String 可选 title 使用独立跳转ActionCard样式时的按钮的标题，最长20个字符 └ btn_orientation String 可选 btn_orientation 使用独立跳转ActionCard样式时的按钮排列方式，竖直排列(0)，横向排列(1)；必须与btn_json_list同时设置 └ single_url String 可选 single_url 消息点击链接地址，当发送消息为小程序时支持小程序跳转链接，最长500个字符 └ single_title String 可选 single_title 使用整体跳转ActionCard样式时的标题，必须与single_url同时设置，最长20个字符 └ markdown String 可选 markdown 消息内容，支持markdown，语法参考标准markdown语法。建议1000个字符以内 └ title String 可选 title 透出到会话列表和通知的文案，最长64个字符
user_id_list	String []	可选	123,456	最大列表长度：5000	接收者的用户userid列表
chat_id_list	String []	可选	chatxxx,chatxxx	最大列表长度：500	接收者的会话chatid列表
to_all_user	Boolean	可选	false	默认值：false	是否发送给企业全部用户，”true“则忽略用户列表和会话列表

响应参数

名称	类型	示例值	描述
task_id	String	123	创建的异步发送任务id
errcode	Number	0	错误码
errmsg	String	ok	errorMsg

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/smartbot/msg/push");
OapiSmartbotMsgPushRequest req = new OapiSmartbotMsgPushRequest();
Msg obj1 = new Msg();
obj1.setMsgtype("text");
Text obj2 = new Text();
obj2.setContent("123");
obj1.setText(obj2);
Markdown obj3 = new Markdown();
obj3.setText("text");
obj3.setTitle("title");
obj1.setMarkdown(obj3);
ActionCard obj4 = new ActionCard();
List<BtnJson> list6 = new ArrayList<BtnJson>();
BtnJson obj7 = new BtnJson();
list6.add(obj7);
obj7.setActionUrl("action_url");
obj7.setTitle("title");
obj4.setBtnJsonList(list6);
obj4.setBtnOrientation("btn_orientation");
obj4.setSingleUrl("single_url");
obj4.setSingleTitle("single_title");
obj4.setMarkdown("markdown");
obj4.setTitle("title");
obj1.setActionCard(obj4);
req.setMsg(obj1);
req.setUserIdList("123,456");
req.setChatIdList("chatxxx,chatxxx");
req.setToAllUser(false);
OapiSmartbotMsgPushResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/smartbot/msg/push");
OapiSmartbotMsgPushRequest req = new OapiSmartbotMsgPushRequest();
OapiSmartbotMsgPushRequest.MsgDomain obj1 = new OapiSmartbotMsgPushRequest.MsgDomain();
obj1.Msgtype = "text";
OapiSmartbotMsgPushRequest.TextDomain obj2 = new OapiSmartbotMsgPushRequest.TextDomain();
obj2.Content = "123";
obj1.Text= obj2;
OapiSmartbotMsgPushRequest.MarkdownDomain obj3 = new OapiSmartbotMsgPushRequest.MarkdownDomain();
obj3.Text = "text";
obj3.Title = "title";
obj1.Markdown= obj3;
OapiSmartbotMsgPushRequest.ActionCardDomain obj4 = new OapiSmartbotMsgPushRequest.ActionCardDomain();
List<OapiSmartbotMsgPushRequest.BtnJsonDomain> list6 = new List<OapiSmartbotMsgPushRequest.BtnJsonDomain>();
OapiSmartbotMsgPushRequest.BtnJsonDomain obj7 = new OapiSmartbotMsgPushRequest.BtnJsonDomain();
list6.Add(obj7);
obj7.ActionUrl = "action_url";
obj7.Title = "title";
obj4.BtnJsonList= list6;
obj4.BtnOrientation = "btn_orientation";
obj4.SingleUrl = "single_url";
obj4.SingleTitle = "single_title";
obj4.Markdown = "markdown";
obj4.Title = "title";
obj1.ActionCard= obj4;
req.Msg_ = obj1;
req.UserIdList = "123,456";
req.ChatIdList = "chatxxx,chatxxx";
req.ToAllUser = false;
OapiSmartbotMsgPushResponse 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 OapiSmartbotMsgPushRequest;
$msg = new Msg;
$msg->msgtype="text";
$text = new Text;
$text->content="123";
$msg->text = $text;
$markdown = new Markdown;
$markdown->text="text";
$markdown->title="title";
$msg->markdown = $markdown;
$action_card = new ActionCard;
$btn_json_list = new BtnJson;
$btn_json_list->action_url="action_url";
$btn_json_list->title="title";
$action_card->btn_json_list = array($btn_json_list);
$action_card->btn_orientation="btn_orientation";
$action_card->single_url="single_url";
$action_card->single_title="single_title";
$action_card->markdown="markdown";
$action_card->title="title";
$msg->action_card = $action_card;
$req->setMsg($msg);
$req->setUserIdList("123,456");
$req->setChatIdList("chatxxx,chatxxx");
$req->setToAllUser("false");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/smartbot/msg/push");

curl -X POST "https://oapi.dingtalk.com/topapi/smartbot/msg/push" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=c8cc3425-7fff-470c-bc9f-7046f5757acd' \
-d 'chat_id_list=chatxxx%2Cchatxxx' \
-d 'msg=null' \
-d 'to_all_user=false' \
-d 'user_id_list=123%2C456'

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

req=dingtalk.api.OapiSmartbotMsgPushRequest("https://oapi.dingtalk.com/topapi/smartbot/msg/push")

req.msg=""
req.user_id_list="123,456"
req.chat_id_list="chatxxx,chatxxx"
req.to_all_user=false
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.smartbot.msg.push");
add_param(pRequest,"msg","数据结构JSON示例");
add_param(pRequest,"user_id_list","123,456");
add_param(pRequest,"chat_id_list","chatxxx,chatxxx");
add_param(pRequest,"to_all_user","false");
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.smartbot.msg.push', {
	'msg':'数据结构JSON示例',
	'user_id_list':'123,456',
	'chat_id_list':'chatxxx,chatxxx',
	'to_all_user':'false'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "task_id":"123",
    "errcode":0,
    "errmsg":"ok"
}

异常示例

JSON示例

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

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

钉钉API

dingtalk.oapi.smartbot.msg.push (工作助理的消息推送接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ