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

dingtalk.oapi.message.corpconversation.getsendresult (获取异步向企业会话发送消息的结果)

获取异步向企业会话发送消息的结果

公共参数

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

请求参数

名称	类型	是否必须	示例值	更多限制	描述
agent_id	Number	可选	123		微应用的agentid
task_id	Number	可选	456		异步任务的id

响应参数

名称	类型	示例值	描述
send_result	AsyncSendResult	{}	result
└ invalid_user_id_list String [] zhangsan,lisi 无效的用户id └ forbidden_user_id_list String [] zhangsan,lisi 因发送消息过于频繁或超量而被流控过滤后实际未发送的userid。未被限流的接收者仍会被成功发送。限流规则包括：1、给同一用户发相同内容消息一天仅允许一次；2、如果是ISV接入方式，给同一用户发消息一天不得超过100次；如果是企业接入方式，此上限为500。 └ failed_user_id_list String [] zhangsan,lisi 发送失败的用户id └ read_user_id_list String [] zhangsan,lisi 已读消息的用户id └ unread_user_id_list String [] zhangsan,lisi 未读消息的用户id └ invalid_dept_id_list Number [] 1,2,3 无效的部门id forbidden_list SendForbiddenModel [] 推送被禁止的具体原因 └ code String 流控code └ count Number 流控阀值 └ userid String 员工userId
errcode	Number	0	errcode
errmsg	String	ok	errmsg

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/message/corpconversation/getsendresult");
OapiMessageCorpconversationGetsendresultRequest req = new OapiMessageCorpconversationGetsendresultRequest();
req.setAgentId(123L);
req.setTaskId(456L);
OapiMessageCorpconversationGetsendresultResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/message/corpconversation/getsendresult");
OapiMessageCorpconversationGetsendresultRequest req = new OapiMessageCorpconversationGetsendresultRequest();
req.AgentId = 123L;
req.TaskId = 456L;
OapiMessageCorpconversationGetsendresultResponse 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 OapiMessageCorpconversationGetsendresultRequest;
$req->setAgentId("123");
$req->setTaskId("456");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/message/corpconversation/getsendresult");

curl -X POST "https://oapi.dingtalk.com/topapi/message/corpconversation/getsendresult" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=0b5d383c-b8ac-4aeb-8f1c-e28f7c622737' \
-d 'agent_id=123' \
-d 'task_id=456'

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

req=dingtalk.api.OapiMessageCorpconversationGetsendresultRequest("https://oapi.dingtalk.com/topapi/message/corpconversation/getsendresult")

req.agent_id=123
req.task_id=456
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.message.corpconversation.getsendresult");
add_param(pRequest,"agent_id","123");
add_param(pRequest,"task_id","456");
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.message.corpconversation.getsendresult', {
	'agent_id':'123',
	'task_id':'456'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "send_result":{
        "invalid_user_id_list":{
            "string":[
                "zhangsan",
                "lisi"
            ]
        },
        "forbidden_user_id_list":{
            "string":[
                "zhangsan",
                "lisi"
            ]
        },
        "failed_user_id_list":{
            "string":[
                "zhangsan",
                "lisi"
            ]
        },
        "read_user_id_list":{
            "string":[
                "zhangsan",
                "lisi"
            ]
        },
        "unread_user_id_list":{
            "string":[
                "zhangsan",
                "lisi"
            ]
        },
        "invalid_dept_id_list":{
            "number":[
                1,
                2,
                3
            ]
        },
        "forbidden_list":[
            {
                    "code":"",
                    "count":,
                    "userid":""
            }
        ]
    },
    "errcode":0,
    "errmsg":"ok"
}

异常示例

JSON示例

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

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

淘宝开放平台

钉钉API

dingtalk.oapi.message.corpconversation.getsendresult (获取异步向企业会话发送消息的结果)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ