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

dingtalk.oapi.user.senior.setting (dingtalk.oapi.user.senior.setting)

高管模式设置接口，支持设置是否开启高管、设置高管联系人白名单、设置高管保护开关

公共参数

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

请求参数

名称	类型	是否必须	示例值	更多限制	描述
senior_staffId	String	可选	12345		高管工号
permit_staffIds	String []	可选	[123,456,678]	最大列表长度：999	高管联系人白名单
protect_scenes	String []	可选	[DING_SMS,DING_MSG,CHAT,CONFERENCE_VIDEO,CONFERENCE,VIDEO_CALL,CONFERENCE_VOIP]	最大列表长度：999	高管保护开关，例如DING_SMS，保护高管不受短信DING打扰
open	Boolean	可选	true		高管模式是否开启

响应参数

名称	类型	示例值	描述
errcode	Number	0	dingOpenErrcode
errmsg	String	成功	errorMsg

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/user/senior/setting");
OapiUserSeniorSettingRequest req = new OapiUserSeniorSettingRequest();
req.setSeniorStaffId("12345");
req.setPermitStaffIds("123,456,678");
req.setProtectScenes("DING_SMS,DING_MSG,CHAT,CONFERENCE_VIDEO,CONFERENCE,VIDEO_CALL,CONFERENCE_VOIP");
req.setOpen(true);
OapiUserSeniorSettingResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/user/senior/setting");
OapiUserSeniorSettingRequest req = new OapiUserSeniorSettingRequest();
req.SeniorStaffId = "12345";
req.PermitStaffIds = "123,456,678";
req.ProtectScenes = "DING_SMS,DING_MSG,CHAT,CONFERENCE_VIDEO,CONFERENCE,VIDEO_CALL,CONFERENCE_VOIP";
req.Open = true;
OapiUserSeniorSettingResponse 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 OapiUserSeniorSettingRequest;
$req->setSeniorStaffId("12345");
$req->setPermitStaffIds("[123,456,678]");
$req->setProtectScenes("[DING_SMS,DING_MSG,CHAT,CONFERENCE_VIDEO,CONFERENCE,VIDEO_CALL,CONFERENCE_VOIP]");
$req->setOpen("true");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/user/senior/setting");

curl -X POST "https://oapi.dingtalk.com/topapi/user/senior/setting" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=3ff17b9a-cac6-4380-932c-688ecb773af7' \
-d 'open=true' \
-d 'permit_staffIds=123%2C456%2C678' \
-d 'protect_scenes=DING_SMS%2CDING_MSG%2CCHAT%2CCONFERENCE_VIDEO%2CCONFERENCE%2CVIDEO_CALL%2CCONFERENCE_VOIP' \
-d 'senior_staffId=12345'

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

req=dingtalk.api.OapiUserSeniorSettingRequest("https://oapi.dingtalk.com/topapi/user/senior/setting")

req.senior_staffId="12345"
req.permit_staffIds="[123,456,678]"
req.protect_scenes="[DING_SMS,DING_MSG,CHAT,CONFERENCE_VIDEO,CONFERENCE,VIDEO_CALL,CONFERENCE_VOIP]"
req.open=true
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.user.senior.setting");
add_param(pRequest,"senior_staffId","12345");
add_param(pRequest,"permit_staffIds","123,456,678");
add_param(pRequest,"protect_scenes","DING_SMS,DING_MSG,CHAT,CONFERENCE_VIDEO,CONFERENCE,VIDEO_CALL,CONFERENCE_VOIP");
add_param(pRequest,"open","true");
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.user.senior.setting', {
	'senior_staffId':'12345',
	'permit_staffIds':'123,456,678',
	'protect_scenes':'DING_SMS,DING_MSG,CHAT,CONFERENCE_VIDEO,CONFERENCE,VIDEO_CALL,CONFERENCE_VOIP',
	'open':'true'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "errcode":0,
    "errmsg":"成功"
}

异常示例

JSON示例

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

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

钉钉API

dingtalk.oapi.user.senior.setting (dingtalk.oapi.user.senior.setting)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ