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

dingtalk.oapi.service.get_agent (获取企业的应用信息)

获取企业的应用信息

公共参数

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

请求参数

名称	类型	是否必须	示例值	描述
agentid	String	可选	123	授权企业方应用id
permanent_code	String	可选	xxxxx	永久授权码
auth_corpid	String	可选	ding1234	授权企业方corpid
suite_key	String	可选	key	应用套件key

响应参数

名称	类型	示例值	描述
agentid	Number	123	agentid
name	String	xxx	name
logo_url	String	xxx	logo_url
description	String	测试应用	description
close	Number	1	close
errmsg	String	ok	errmsg
errcode	Number	0	errcode

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/service/get_agent");
OapiServiceGetAgentRequest req = new OapiServiceGetAgentRequest();
req.setAgentid("123");
req.setPermanentCode("xxxxx");
req.setAuthCorpid("ding1234");
req.setSuiteKey("key");
OapiServiceGetAgentResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/service/get_agent");
OapiServiceGetAgentRequest req = new OapiServiceGetAgentRequest();
req.Agentid = "123";
req.PermanentCode = "xxxxx";
req.AuthCorpid = "ding1234";
req.SuiteKey = "key";
OapiServiceGetAgentResponse 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 OapiServiceGetAgentRequest;
$req->setAgentid("123");
$req->setPermanentCode("xxxxx");
$req->setAuthCorpid("ding1234");
$req->setSuiteKey("key");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/service/get_agent");

curl -X POST "https://oapi.dingtalk.com/service/get_agent" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=85f74836-6c51-4126-a2a1-837a4831c7ce' \
-d 'agentid=123' \
-d 'auth_corpid=ding1234' \
-d 'permanent_code=xxxxx' \
-d 'suite_key=key'

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

req=dingtalk.api.OapiServiceGetAgentRequest("https://oapi.dingtalk.com/service/get_agent")

req.agentid="123"
req.permanent_code="xxxxx"
req.auth_corpid="ding1234"
req.suite_key="key"
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.service.get_agent");
add_param(pRequest,"agentid","123");
add_param(pRequest,"permanent_code","xxxxx");
add_param(pRequest,"auth_corpid","ding1234");
add_param(pRequest,"suite_key","key");
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.service.get_agent', {
	'agentid':'123',
	'permanent_code':'xxxxx',
	'auth_corpid':'ding1234',
	'suite_key':'key'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "agentid":123,
    "name":"xxx",
    "logo_url":"xxx",
    "description":"测试应用",
    "close":1,
    "errmsg":"ok",
    "errcode":0
}

异常示例

JSON示例

{
	"error_response":{
		"msg":"Remote service error",
		"code":50,
		"sub_msg":"非法参数",
		"sub_code":"isv.invalid-parameter"
	}
}

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

淘宝开放平台

钉钉API

dingtalk.oapi.service.get_agent (获取企业的应用信息)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ