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

dingtalk.oapi.role.visible.set (设置角色的可见角色列表)

在钉钉企业通讯录内，支持设置角色之间的可见性。这个接口的目的是用来设置/更新某个角色设置的可见角色列表。(如果之前设置过，这个API是会做覆盖更新。)

公共参数

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

请求参数

名称	类型	是否必须	示例值	更多限制	描述
role_id	Number	必须	123		roleId
visible_role_ids	Number []	必须	123,456,789	最大列表长度：50	roleId可见的roleIdList

响应参数

名称	类型	示例值	描述
errcode	Number	0	错误码
errmsg	String	OK	错误信息

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/role/visible/set");
OapiRoleVisibleSetRequest req = new OapiRoleVisibleSetRequest();
req.setRoleId(123L);
req.setVisibleRoleIds("123,456,789");
OapiRoleVisibleSetResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/role/visible/set");
OapiRoleVisibleSetRequest req = new OapiRoleVisibleSetRequest();
req.RoleId = 123L;
req.VisibleRoleIds = "123,456,789";
OapiRoleVisibleSetResponse 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 OapiRoleVisibleSetRequest;
$req->setRoleId("123");
$req->setVisibleRoleIds("123,456,789");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/role/visible/set");

curl -X POST "https://oapi.dingtalk.com/topapi/role/visible/set" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=c31cd4b5-bc71-4ed3-b194-94781a22025a' \
-d 'role_id=123' \
-d 'visible_role_ids=123%2C456%2C789'

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

req=dingtalk.api.OapiRoleVisibleSetRequest("https://oapi.dingtalk.com/topapi/role/visible/set")

req.role_id=123
req.visible_role_ids="123,456,789"
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.role.visible.set");
add_param(pRequest,"role_id","123");
add_param(pRequest,"visible_role_ids","123,456,789");
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.role.visible.set', {
	'role_id':'123',
	'visible_role_ids':'123,456,789'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "errcode":0,
    "errmsg":"OK"
}

异常示例

JSON示例

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

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

钉钉API

dingtalk.oapi.role.visible.set (设置角色的可见角色列表)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ