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

dingtalk.oapi.training.groupinfo.get (根据群id获取班级群邀请链接和群是否可用的状态)

根据群id获取班级群的可用状态，及班级邀请链接，每次最多获取100个群。

公共参数

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

请求参数

名称	类型	是否必须	示例值	更多限制	描述
request	RequestVO	可选			系统自动生成
└ ids String [] 可选 ["1","2"] 群id └ corp_id String 可选 dd343222 组织唯一标识corpid

响应参数

名称	类型	示例值	描述
result	GroupInfo	GroupInfo[]	返回群信息
└ corp_id String dingdae6f8c74df6201d 组织corpid └ org_name String 久久小学组织名称 group_info_list GroupInfo [] GroupInfo[] 群信息列表 └ conversation_id String 401000363 群id └ member_count Number 4 群成员数 └ create_at Number 1587883550000 群创建时间 └ icon_url String https://static.dingtalk.com/media/lADPEgqHHMB25ejNAljNAlg_600_600.jpg 群头像 └ title String 绘画班群名称 └ invite_url String https://h5.dingtalk.test/edu/join.html?inviteId=2f5679f442b0448eae9820b551447cd2 邀请链接 └ status String available 群状态：1、available（可用），2、dismiss(解散），3、full（已满）
errcode	Number	1004	错误码
errmsg	String	获取失败	错误信息

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/training/groupinfo/get");
OapiTrainingGroupinfoGetRequest req = new OapiTrainingGroupinfoGetRequest();
RequestVO obj1 = new RequestVO();
obj1.setIds(""1","2"");
obj1.setCorpId("dd343222");
req.setRequest(obj1);
OapiTrainingGroupinfoGetResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/training/groupinfo/get");
OapiTrainingGroupinfoGetRequest req = new OapiTrainingGroupinfoGetRequest();
OapiTrainingGroupinfoGetRequest.RequestVODomain obj1 = new OapiTrainingGroupinfoGetRequest.RequestVODomain();
obj1.Ids = ""1","2"";
obj1.CorpId = "dd343222";
req.Request_ = obj1;
OapiTrainingGroupinfoGetResponse 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 OapiTrainingGroupinfoGetRequest;
$request = new RequestVO;
$request->ids="[\"1\",\"2\"]";
$request->corp_id="dd343222";
$req->setRequest($request);
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/training/groupinfo/get");

curl -X POST "https://oapi.dingtalk.com/topapi/training/groupinfo/get" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=ab6499b9-c28d-4466-94d4-8318620d3027' \
-d 'request=null'

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

req=dingtalk.api.OapiTrainingGroupinfoGetRequest("https://oapi.dingtalk.com/topapi/training/groupinfo/get")

req.request=""
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.training.groupinfo.get");
add_param(pRequest,"request","数据结构JSON示例");
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.training.groupinfo.get', {
	'request':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "result":{
        "corp_id":"dingdae6f8c74df6201d",
        "org_name":"久久小学",
        "group_info_list":[
            {
                    "conversation_id":"401000363",
                    "member_count":4,
                    "create_at":1587883550000,
                    "icon_url":"https:\/\/static.dingtalk.com\/media\/lADPEgqHHMB25ejNAljNAlg_600_600.jpg",
                    "title":"绘画班",
                    "invite_url":"https:\/\/h5.dingtalk.test\/edu\/join.html?inviteId=2f5679f442b0448eae9820b551447cd2",
                    "status":"available"
            }
        ]
    },
    "errcode":1004,
    "errmsg":"获取失败"
}

异常示例

JSON示例

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

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

钉钉API

dingtalk.oapi.training.groupinfo.get (根据群id获取班级群邀请链接和群是否可用的状态)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ