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

dingtalk.oapi.microapp.set_visible_scopes (设置微应用的可见范围)

设置微应用的可见范围

公共参数

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

请求参数

名称	类型	是否必须	示例值	描述
userVisibleScopes	String	可选	["userId1","userId2"]	设置可见的员工id列表，格式为JSON数组
deptVisibleScopes	Number	可选	[1,2]	设置可见的部门id列表，格式为JSON数组
isHidden	Boolean	可选	false	是否仅限管理员可见，true代表仅限管理员可见
agentId	Number	可选	16691682	微应用实例化id

响应参数

名称	类型	示例值	描述
errmsg	String	ok	返回码
errcode	Number	0	对返回码的文本描述内容

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/microapp/set_visible_scopes");
OapiMicroappSetVisibleScopesRequest req = new OapiMicroappSetVisibleScopesRequest();
req.setUserVisibleScopes("[\"userId1\",\"userId2\"]");
req.setDeptVisibleScopes([1,2]L);
req.setIsHidden(false);
req.setAgentId(16691682L);
OapiMicroappSetVisibleScopesResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/microapp/set_visible_scopes");
OapiMicroappSetVisibleScopesRequest req = new OapiMicroappSetVisibleScopesRequest();
req.UserVisibleScopes = "[\"userId1\",\"userId2\"]";
req.DeptVisibleScopes = [1,2]L;
req.IsHidden = false;
req.AgentId = 16691682L;
OapiMicroappSetVisibleScopesResponse 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 OapiMicroappSetVisibleScopesRequest;
$req->setUserVisibleScopes("[\"userId1\",\"userId2\"]");
$req->setDeptVisibleScopes("[1,2]");
$req->setIsHidden("false");
$req->setAgentId("16691682");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/microapp/set_visible_scopes");

curl -X POST "https://oapi.dingtalk.com/microapp/set_visible_scopes" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=061ee78b-7839-4c40-ace8-a185223a244a' \
-d 'agentId=16691682' \
-d 'deptVisibleScopes=1%2C2' \
-d 'isHidden=false' \
-d 'userVisibleScopes=%22userId1%22%2C%22userId2%22'

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

req=dingtalk.api.OapiMicroappSetVisibleScopesRequest("https://oapi.dingtalk.com/microapp/set_visible_scopes")

req.userVisibleScopes="[\"userId1\",\"userId2\"]"
req.deptVisibleScopes=[1,2]
req.isHidden=false
req.agentId=16691682
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.microapp.set_visible_scopes");
add_param(pRequest,"userVisibleScopes",""userId1","userId2"");
add_param(pRequest,"deptVisibleScopes","1,2");
add_param(pRequest,"isHidden","false");
add_param(pRequest,"agentId","16691682");
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.microapp.set_visible_scopes', {
	'userVisibleScopes':'"userId1","userId2"',
	'deptVisibleScopes':'1,2',
	'isHidden':'false',
	'agentId':'16691682'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

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

异常示例

JSON示例

{
	"error_response":{
		"msg":"Remote service error",
		"code":50,
		"sub_msg":"非法参数",
		"sub_code":"isv.invalid-parameter"
	}
}

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

用户反馈

亲，您还没填写反馈内容。

联系方式

亲，电话号码格式不正确。

验证码刷新
亲，验证码错啦！

提交反馈

用户反馈

感谢您的反馈！

用户反馈

网络异常，请重新提交！
重新提交

钉钉API

dingtalk.oapi.microapp.set_visible_scopes (设置微应用的可见范围)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈