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

dingtalk.oapi.project.invite.data.query (开放式组织机构成员邀请关系查询)

开放式组织机构成员邀请关系查询

公共参数

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

请求参数

名称	类型	是否必须	示例值	更多限制	描述
invite_data_query	InviteDataQuery	必须			请求对象
└ cursor Number 必须 1588234428359 数据游标，初始传0。后续传入返回参数中的next_cursor值 └ status Number 必须 1 状态0:无效（包括过程数据），1:有效(默认)，不传表示查询全部 └ size Number 必须 50 每次查询数据量，最大100

响应参数

名称	类型	示例值	描述
result	Result		响应结果
└ has_more String true 是否有更多数据，如果为false，这表示本次查询没有更多的数据了。 └ next_cursor String 1588234428359 下次游标开始 data InviteDataModel [] 结果集数据 └ extension String {} 结果数据，场景ID，sence_id会放在这个地方 └ channel String MARKET 渠道，"MARKET"表示通过营销的数据，其他是通过系统的方式进入 └ status Number 1 状态.0表示无效（包括过程数据），1:表示有效 └ join_at Number 20200101 加入日期，格式：yyyyMMdd └ corp_id String yueijfdskdfknjksdnvk 组织机构id └ invite_userid String ghsghdfccc 邀请人用户id └ gmt_modified Number 1588234428359 修改时间，亦用于游标查询 └ userid String ghsghdfccc 被邀请人用户id
success	Boolean	true	是否成功
errcode	Number	0	错误码
errmsg	String	失败原因	失败原因

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/project/invite/data/query");
OapiProjectInviteDataQueryRequest req = new OapiProjectInviteDataQueryRequest();
InviteDataQuery obj1 = new InviteDataQuery();
obj1.setCursor(1588234428359L);
obj1.setStatus(1L);
obj1.setSize(50L);
req.setInviteDataQuery(obj1);
OapiProjectInviteDataQueryResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/project/invite/data/query");
OapiProjectInviteDataQueryRequest req = new OapiProjectInviteDataQueryRequest();
OapiProjectInviteDataQueryRequest.InviteDataQueryDomain obj1 = new OapiProjectInviteDataQueryRequest.InviteDataQueryDomain();
obj1.Cursor = 1588234428359L;
obj1.Status = 1L;
obj1.Size = 50L;
req.InviteDataQuery_ = obj1;
OapiProjectInviteDataQueryResponse 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 OapiProjectInviteDataQueryRequest;
$invite_data_query = new InviteDataQuery;
$invite_data_query->cursor="1588234428359";
$invite_data_query->status="1";
$invite_data_query->size="50";
$req->setInviteDataQuery($invite_data_query);
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/project/invite/data/query");

curl -X POST "https://oapi.dingtalk.com/topapi/project/invite/data/query" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=0b93cd04-e102-4c94-99d0-34f8bcf3798b' \
-d 'invite_data_query=null'

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

req=dingtalk.api.OapiProjectInviteDataQueryRequest("https://oapi.dingtalk.com/topapi/project/invite/data/query")

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

响应示例

JSON示例

{
    "result":{
        "has_more":"true",
        "next_cursor":"1588234428359",
        "data":[
            {
                    "extension":"{}",
                    "channel":"MARKET",
                    "status":1,
                    "join_at":20200101,
                    "corp_id":"yueijfdskdfknjksdnvk",
                    "invite_userid":"ghsghdfccc",
                    "gmt_modified":1588234428359,
                    "userid":"ghsghdfccc"
            }
        ]
    },
    "success":true,
    "errcode":0,
    "errmsg":"失败原因"
}

异常示例

JSON示例

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

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

淘宝开放平台

钉钉API

dingtalk.oapi.project.invite.data.query (开放式组织机构成员邀请关系查询)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ