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

dingtalk.oapi.service.get_auth_info (获取企业基本信息)

获取企业基本信息

公共参数

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

请求参数

名称	类型	是否必须	示例值	更多限制	描述
suite_key	String	可选	key		套件key
auth_corpid	String	可选	ding1234		授权方corpid

响应参数

名称	类型	描述
auth_info	AuthInfo	auth_info
agent Agent [] agent └ agentid Number agentid └ logo_url String logo_url └ appid Number appid └ admin_list String [] admin_list └ agent_name String agent_name
auth_user_info	AuthUserInfo	auth_user_info
└ userId String userId
auth_corp_info	AuthCorpInfo	auth_corp_info
└ corpid String corpid └ invite_code String invite_code └ industry String industry └ corp_name String corp_name └ license_code String license_code └ auth_channel String auth_channel └ auth_channel_type String auth_channel_type └ is_authenticated Boolean is_authenticated └ auth_level Number auth_level └ invite_url String invite_url └ corp_logo_url String corp_logo_url └ belong_corp_id String belong_corp_id └ unifiedSocialCredit String unifiedSocialCredit └ full_corp_name String full_corp_name
errmsg	String	errmsg
errcode	Number	errcode
channel_auth_info	ChannelAuthInfo	channel_auth_info
channelAgent Channelagent [] channelAgent └ agent_name String agent_name └ agentid Number agentid └ logo_url String logo_url └ appid Number appid

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/service/get_auth_info");
OapiServiceGetAuthInfoRequest req = new OapiServiceGetAuthInfoRequest();
req.setSuiteKey("key");
req.setAuthCorpid("ding1234");
OapiServiceGetAuthInfoResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/service/get_auth_info");
OapiServiceGetAuthInfoRequest req = new OapiServiceGetAuthInfoRequest();
req.SuiteKey = "key";
req.AuthCorpid = "ding1234";
OapiServiceGetAuthInfoResponse 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 OapiServiceGetAuthInfoRequest;
$req->setSuiteKey("key");
$req->setAuthCorpid("ding1234");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/service/get_auth_info");

curl -X POST "https://oapi.dingtalk.com/service/get_auth_info" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=67bc152d-724d-4009-94b9-18e9b101a432' \
-d 'auth_corpid=ding1234' \
-d 'suite_key=key'

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

req=dingtalk.api.OapiServiceGetAuthInfoRequest("https://oapi.dingtalk.com/service/get_auth_info")

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

响应示例

JSON示例

{
    "auth_info":{
        "agent":[
            {
                    "agentid":,
                    "logo_url":"",
                    "appid":,
                    "admin_list":{
                        "string":[
                            ""
                        ]
                    },
                    "agent_name":""
            }
        ]
    },
    "auth_user_info":{
        "userId":""
    },
    "auth_corp_info":{
        "corpid":"",
        "invite_code":"",
        "industry":"",
        "corp_name":"",
        "license_code":"",
        "auth_channel":"",
        "auth_channel_type":"",
        "is_authenticated":,
        "auth_level":,
        "invite_url":"",
        "corp_logo_url":"",
        "belong_corp_id":"",
        "unifiedSocialCredit":"",
        "full_corp_name":""
    },
    "errmsg":"",
    "errcode":,
    "channel_auth_info":{
        "channelAgent":[
            {
                    "agent_name":"",
                    "agentid":,
                    "logo_url":"",
                    "appid":
            }
        ]
    }
}

异常示例

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_auth_info (获取企业基本信息)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ