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

dingtalk.oapi.dingmi.common.o2o.push (服务窗通用o2o消息推送)

服务窗通用o2o消息推送

公共参数

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

请求参数

名称	类型	是否必须	示例值	描述
chatbot_id	String	可选	customerRobot	机器人id
staff_id	String	必须	manager0712	用户在服务号所在企业的用户id
msg_key	String	必须	sampleText	模板key
msg_param	String	必须	{"content":"helloworld"}	模块替换值

响应参数

名称	类型	示例值	描述
result	String	msgqwewe1	推送key
errcode	Number	400	错误码
errmsg	String	success	错误信息

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/dingmi/common/o2o/push");
OapiDingmiCommonO2oPushRequest req = new OapiDingmiCommonO2oPushRequest();
req.setChatbotId("customerRobot");
req.setStaffId("manager0712");
req.setMsgKey("sampleText");
req.setMsgParam("{\"content\":\"helloworld\"}");
OapiDingmiCommonO2oPushResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/dingmi/common/o2o/push");
OapiDingmiCommonO2oPushRequest req = new OapiDingmiCommonO2oPushRequest();
req.ChatbotId = "customerRobot";
req.StaffId = "manager0712";
req.MsgKey = "sampleText";
req.MsgParam = "{\"content\":\"helloworld\"}";
OapiDingmiCommonO2oPushResponse 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 OapiDingmiCommonO2oPushRequest;
$req->setChatbotId("customerRobot");
$req->setStaffId("manager0712");
$req->setMsgKey("sampleText");
$req->setMsgParam("{\"content\":\"helloworld\"}");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/dingmi/common/o2o/push");

curl -X POST "https://oapi.dingtalk.com/topapi/dingmi/common/o2o/push" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=0a3c2a7b-e679-4f09-a7dd-c6229bf6eb3f' \
-d 'chatbot_id=customerRobot' \
-d 'msg_key=sampleText' \
-d 'msg_param=%7B%5C%22content%5C%22%3A%5C%22helloworld%5C%22%7D' \
-d 'staff_id=manager0712'

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

req=dingtalk.api.OapiDingmiCommonO2oPushRequest("https://oapi.dingtalk.com/topapi/dingmi/common/o2o/push")

req.chatbot_id="customerRobot"
req.staff_id="manager0712"
req.msg_key="sampleText"
req.msg_param="{\"content\":\"helloworld\"}"
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.dingmi.common.o2o.push");
add_param(pRequest,"chatbot_id","customerRobot");
add_param(pRequest,"staff_id","manager0712");
add_param(pRequest,"msg_key","sampleText");
add_param(pRequest,"msg_param","{\"content\":\"helloworld\"}");
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.dingmi.common.o2o.push', {
	'chatbot_id':'customerRobot',
	'staff_id':'manager0712',
	'msg_key':'sampleText',
	'msg_param':'{\"content\":\"helloworld\"}'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "result":"msgqwewe1",
    "errcode":400,
    "errmsg":"success"
}

异常示例

JSON示例

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

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

钉钉API

dingtalk.oapi.dingmi.common.o2o.push (服务窗通用o2o消息推送)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ