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

dingtalk.oapi.im.chat.servicegroup.member.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。

请求参数

名称	类型	是否必须	示例值	更多限制	描述
chat_id	String	必须	chatxxx	最大长度：128	开放的chatId
page_size	Number	必须	20	最小值：1 最大值：100	每页大小，最大100
page_num	Number	必须	1	最小值：1	页码，从1开始
include_owner	Number	可选	0	默认值：0	0- 不包含群主，1-包含群主

响应参数

名称	类型	示例值	描述
result	ServiceGroupMemberQueryResponse	result	结果
members Members [] members 成员列表 └ dingtalk_id String XXX 成员的ID └ role String 2 角色，2-管理员、3-普通成员 └ nick_name String XXX 昵称 └ group_nick_name String XXX 群昵称 └ userid String abc1234 员工Id └ total_count Number 12 成员总数
errcode	Number	0	错误代码
errmsg	String	成功	错误描述
success	Boolean	true	是否成功

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/im/chat/servicegroup/member/query");
OapiImChatServicegroupMemberQueryRequest req = new OapiImChatServicegroupMemberQueryRequest();
req.setChatId("chatxxx");
req.setPageSize(20L);
req.setPageNum(1L);
req.setIncludeOwner(0L);
OapiImChatServicegroupMemberQueryResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/im/chat/servicegroup/member/query");
OapiImChatServicegroupMemberQueryRequest req = new OapiImChatServicegroupMemberQueryRequest();
req.ChatId = "chatxxx";
req.PageSize = 20L;
req.PageNum = 1L;
req.IncludeOwner = 0L;
OapiImChatServicegroupMemberQueryResponse 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 OapiImChatServicegroupMemberQueryRequest;
$req->setChatId("chatxxx");
$req->setPageSize("20");
$req->setPageNum("1");
$req->setIncludeOwner("0");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/im/chat/servicegroup/member/query");

curl -X POST "https://oapi.dingtalk.com/topapi/im/chat/servicegroup/member/query" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=baaf186a-8376-4bee-9334-4029dcf3c56a' \
-d 'chat_id=chatxxx' \
-d 'include_owner=0' \
-d 'page_num=1' \
-d 'page_size=20'

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

req=dingtalk.api.OapiImChatServicegroupMemberQueryRequest("https://oapi.dingtalk.com/topapi/im/chat/servicegroup/member/query")

req.chat_id="chatxxx"
req.page_size=20
req.page_num=1
req.include_owner=0
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.im.chat.servicegroup.member.query");
add_param(pRequest,"chat_id","chatxxx");
add_param(pRequest,"page_size","20");
add_param(pRequest,"page_num","1");
add_param(pRequest,"include_owner","0");
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.im.chat.servicegroup.member.query', {
	'chat_id':'chatxxx',
	'page_size':'20',
	'page_num':'1',
	'include_owner':'0'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "result":{
        "members":[
            {
                    "dingtalk_id":"XXX",
                    "role":"2",
                    "nick_name":"XXX",
                    "group_nick_name":"XXX",
                    "userid":"abc1234"
            }
        ],
        "total_count":12
    },
    "errcode":0,
    "errmsg":"成功",
    "success":true
}

异常示例

JSON示例

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

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

钉钉API

dingtalk.oapi.im.chat.servicegroup.member.query (获取服务群成员列表)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ