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

dingtalk.oapi.sns.conversation.member.list (获取群成员列表)

三方个人应用的isv调用获取被授权群的群成员列表. 且仅返回对isv授权的用户列表

公共参数

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

请求参数

名称	类型	是否必须	示例值	描述
cursor	String	必须	0	分页游标, 由接口返回
size	Number	必须	100	分页数量, 每页最大100
open_conversation_id	String	必须	cidK3vty2FVWaNEC7Umf3XGQg==	会话ID

响应参数

名称	类型	示例值	描述
result	SnsOpenGroupMemberResponse		结果数据
members SnsGroupMemberModel [] 成员列表 └ role Number 1 角色，1-群主 2-管理员 3-普通成员 └ unionid String f3y2ZGwHxdAOTwR0yCjhFAiEiE 用户id └ nick_name String 逸暄昵称 └ group_nick_name String 豫东战役项目组群昵称 └ portrait_url String https://static.dingtalk.com/media/lALPDgCwPJrRV-jMyMzI_200_200.png 头像url └ next_cursor String af74-534c6c5c5a2c 下一页的游标 └ has_more Boolean false 群成员是否还有下页数据
success	Boolean	true	请求成功标识
errcode	Number	1002	错误码
errmsg	String	cid is illegal	错误信息

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/sns/conversation/member/list");
OapiSnsConversationMemberListRequest req = new OapiSnsConversationMemberListRequest();
req.setCursor("0");
req.setSize(100L);
req.setOpenConversationId("cidK3vty2FVWaNEC7Umf3XGQg==");
OapiSnsConversationMemberListResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/sns/conversation/member/list");
OapiSnsConversationMemberListRequest req = new OapiSnsConversationMemberListRequest();
req.Cursor = "0";
req.Size = 100L;
req.OpenConversationId = "cidK3vty2FVWaNEC7Umf3XGQg==";
OapiSnsConversationMemberListResponse 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 OapiSnsConversationMemberListRequest;
$req->setCursor("0");
$req->setSize("100");
$req->setOpenConversationId("cidK3vty2FVWaNEC7Umf3XGQg==");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/sns/conversation/member/list");

curl -X POST "https://oapi.dingtalk.com/topapi/sns/conversation/member/list" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=c8d5d0de-2722-4c6a-b432-b0fdbf8bce04' \
-d 'cursor=0' \
-d 'open_conversation_id=cidK3vty2FVWaNEC7Umf3XGQg%3D%3D' \
-d 'size=100'

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

req=dingtalk.api.OapiSnsConversationMemberListRequest("https://oapi.dingtalk.com/topapi/sns/conversation/member/list")

req.cursor="0"
req.size=100
req.open_conversation_id="cidK3vty2FVWaNEC7Umf3XGQg=="
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.sns.conversation.member.list");
add_param(pRequest,"cursor","0");
add_param(pRequest,"size","100");
add_param(pRequest,"open_conversation_id","cidK3vty2FVWaNEC7Umf3XGQg==");
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.sns.conversation.member.list', {
	'cursor':'0',
	'size':'100',
	'open_conversation_id':'cidK3vty2FVWaNEC7Umf3XGQg=='
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "result":{
        "members":[
            {
                    "role":1,
                    "unionid":"f3y2ZGwHxdAOTwR0yCjhFAiEiE",
                    "nick_name":"逸暄",
                    "group_nick_name":"豫东战役项目组",
                    "portrait_url":"https:\/\/static.dingtalk.com\/media\/lALPDgCwPJrRV-jMyMzI_200_200.png"
            }
        ],
        "next_cursor":"af74-534c6c5c5a2c",
        "has_more":false
    },
    "success":true,
    "errcode":1002,
    "errmsg":"cid is illegal"
}

异常示例

JSON示例

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

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

钉钉API

dingtalk.oapi.sns.conversation.member.list (获取群成员列表)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ