Skip to main content
Call this API to get the executive mode settings of a user.

Request

Basic information

FieldValue
HTTP URLhttps://api.dingtalk.io/v1.0/contact/seniorSettings
HTTP MethodGET
Supported app typeappType-Internal app
Required permissionspermission-qyapi_get_member-Read permission for user information

Request header

NameTypeRequiredDescription
x-acs-dingtalk-access-tokenStringYesThe access credential for calling this API. Obtain it by calling the Get the access token of an internal app API.

Query parameters

NameTypeRequiredDescription
seniorStaffIdStringYesThe user ID. Obtain the userId by calling the Get user information by using the silent login code API.

Request example

HTTP
GET /v1.0/contact/seniorSettings?seniorStaffId=1234567 HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:afe8143b8xxx
Content-Type:application/json
Java
// This file is auto-generated, don't edit it. Thanks.
package com.aliyun.sample;

import com.aliyun.tea.*;

public class Sample {

    /**
     * Initialize the account Client with a Token
     * @return Client
     * @throws Exception
     */
    public static com.aliyun.dingtalkcontact_1_0.Client createClient() throws Exception {
        com.aliyun.teaopenapi.models.Config config = new com.aliyun.teaopenapi.models.Config();
        config.protocol = "https";
        config.regionId = "central";
        return new com.aliyun.dingtalkcontact_1_0.Client(config);
    }

    public static void main(String[] args_) throws Exception {
        java.util.List<String> args = java.util.Arrays.asList(args_);
        com.aliyun.dingtalkcontact_1_0.Client client = Sample.createClient();
        com.aliyun.dingtalkcontact_1_0.models.ListSeniorSettingsHeaders listSeniorSettingsHeaders = new com.aliyun.dingtalkcontact_1_0.models.ListSeniorSettingsHeaders();
        listSeniorSettingsHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkcontact_1_0.models.ListSeniorSettingsRequest listSeniorSettingsRequest = new com.aliyun.dingtalkcontact_1_0.models.ListSeniorSettingsRequest()
                .setSeniorStaffId("1234567");
        try {
            client.listSeniorSettingsWithOptions(listSeniorSettingsRequest, listSeniorSettingsHeaders, new com.aliyun.teautil.models.RuntimeOptions());
        } catch (TeaException err) {
            if (!com.aliyun.teautil.Common.empty(err.code) && !com.aliyun.teautil.Common.empty(err.message)) {
                // err contains code and message properties to help locate the issue
            }

        } catch (Exception _err) {
            TeaException err = new TeaException(_err.getMessage(), _err);
            if (!com.aliyun.teautil.Common.empty(err.code) && !com.aliyun.teautil.Common.empty(err.message)) {
                // err contains code and message properties to help locate the issue
            }

        }        
    }
}
Python
# -*- coding: utf-8 -*-
# This file is auto-generated, don't edit it. Thanks.
import sys

from typing import List

from alibabacloud_dingtalk.contact_1_0.client import Client as dingtalkcontact_1_0Client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_dingtalk.contact_1_0 import models as dingtalkcontact__1__0_models
from alibabacloud_tea_util import models as util_models
from alibabacloud_tea_util.client import Client as UtilClient

class Sample:
    def __init__(self):
        pass

    @staticmethod
    def create_client() -> dingtalkcontact_1_0Client:
        """
        Initialize the account Client with a Token
        @return: Client
        @throws Exception
        """
        config = open_api_models.Config()
        config.protocol = 'https'
        config.region_id = 'central'
        return dingtalkcontact_1_0Client(config)

    @staticmethod
    def main(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        list_senior_settings_headers = dingtalkcontact__1__0_models.ListSeniorSettingsHeaders()
        list_senior_settings_headers.x_acs_dingtalk_access_token = '<your access token>'
        list_senior_settings_request = dingtalkcontact__1__0_models.ListSeniorSettingsRequest(
            senior_staff_id='1234567'
        )
        try:
            client.list_senior_settings_with_options(list_senior_settings_request, list_senior_settings_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err contains code and message properties to help locate the issue
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        list_senior_settings_headers = dingtalkcontact__1__0_models.ListSeniorSettingsHeaders()
        list_senior_settings_headers.x_acs_dingtalk_access_token = '<your access token>'
        list_senior_settings_request = dingtalkcontact__1__0_models.ListSeniorSettingsRequest(
            senior_staff_id='1234567'
        )
        try:
            await client.list_senior_settings_with_options_async(list_senior_settings_request, list_senior_settings_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err contains code and message properties to help locate the issue
                pass

if __name__ == '__main__':
    Sample.main(sys.argv[1:])
PHP
<?php

// This file is auto-generated, don't edit it. Thanks.
namespace AlibabaCloud\SDK\Sample;

use AlibabaCloud\SDK\Dingtalk\Vcontact_1_0\Dingtalk;
use \Exception;
use AlibabaCloud\Tea\Exception\TeaError;
use AlibabaCloud\Tea\Utils\Utils;

use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\SDK\Dingtalk\Vcontact_1_0\Models\ListSeniorSettingsHeaders;
use AlibabaCloud\SDK\Dingtalk\Vcontact_1_0\Models\ListSeniorSettingsRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class Sample {

    /**
     * Initialize the account Client with a Token
     * @return Dingtalk Client
     */
    public static function createClient(){
        $config = new Config([]);
        $config->protocol = "https";
        $config->regionId = "central";
        return new Dingtalk($config);
    }

    /**
     * @param string[] $args
     * @return void
     */
    public static function main($args){
        $client = self::createClient();
        $listSeniorSettingsHeaders = new ListSeniorSettingsHeaders([]);
        $listSeniorSettingsHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $listSeniorSettingsRequest = new ListSeniorSettingsRequest([
            "seniorStaffId" => "1234567"
        ]);
        try {
            $client->listSeniorSettingsWithOptions($listSeniorSettingsRequest, $listSeniorSettingsHeaders, new RuntimeOptions([]));
        }
        catch (Exception $err) {
            if (!($err instanceof TeaError)) {
                $err = new TeaError([], $err->getMessage(), $err->getCode(), $err);
            }
            if (!Utils::empty_($err->code) && !Utils::empty_($err->message)) {
                // err contains code and message properties to help locate the issue
            }
        }
    }
}
$path = __DIR__ . \DIRECTORY_SEPARATOR . '..' . \DIRECTORY_SEPARATOR . 'vendor' . \DIRECTORY_SEPARATOR . 'autoload.php';
if (file_exists($path)) {
    require_once $path;
}
Sample::main(array_slice($argv, 1));
Go
// This file is auto-generated, don't edit it. Thanks.
package main

import (
  "os"
  util  "github.com/alibabacloud-go/tea-utils/service"
  dingtalkcontact_1_0  "github.com/alibabacloud-go/dingtalk/contact_1_0"
  openapi  "github.com/alibabacloud-go/darabonba-openapi/client"
  "github.com/alibabacloud-go/tea/tea"
)

/**
 * Initialize the account Client with a Token
 * @return Client
 * @throws Exception
 */
func CreateClient () (_result *dingtalkcontact_1_0.Client, _err error) {
  config := &openapi.Config{}
  config.Protocol = tea.String("https")
  config.RegionId = tea.String("central")
  _result = &dingtalkcontact_1_0.Client{}
  _result, _err = dingtalkcontact_1_0.NewClient(config)
  return _result, _err
}

func _main (args []*string) (_err error) {
  client, _err := CreateClient()
  if _err != nil {
    return _err
  }

  listSeniorSettingsHeaders := &dingtalkcontact_1_0.ListSeniorSettingsHeaders{}
  listSeniorSettingsHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  listSeniorSettingsRequest := &dingtalkcontact_1_0.ListSeniorSettingsRequest{
    SeniorStaffId: tea.String("1234567"),
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.ListSeniorSettingsWithOptions(listSeniorSettingsRequest, listSeniorSettingsHeaders, &util.RuntimeOptions{})
    if _err != nil {
      return _err
    }

    return nil
  }()

  if tryErr != nil {
    var err = &tea.SDKError{}
    if _t, ok := tryErr.(*tea.SDKError); ok {
      err = _t
    } else {
      err.Message = tea.String(tryErr.Error())
    }
    if !tea.BoolValue(util.Empty(err.Code)) && !tea.BoolValue(util.Empty(err.Message)) {
      // err contains code and message properties to help locate the issue
    }

  }
  return _err
}

func main() {
  err := _main(tea.StringSlice(os.Args[1:]))
  if err != nil {
    panic(err)
  }
}
Node.js
// This file is auto-generated, don't edit it
import Util, * as $Util from '@alicloud/tea-util';
import dingtalkcontact_1_0, * as $dingtalkcontact_1_0 from '@alicloud/dingtalk/contact_1_0';
import OpenApi, * as $OpenApi from '@alicloud/openapi-client';
import * as $tea from '@alicloud/tea-typescript';

export default class Client {

  /**
   * Initialize the account Client with a Token
   * @return Client
   * @throws Exception
   */
  static createClient(): dingtalkcontact_1_0 {
    let config = new $OpenApi.Config({ });
    config.protocol = "https";
    config.regionId = "central";
    return new dingtalkcontact_1_0(config);
  }

  static async main(args: string[]): Promise<void> {
    let client = Client.createClient();
    let listSeniorSettingsHeaders = new $dingtalkcontact_1_0.ListSeniorSettingsHeaders({ });
    listSeniorSettingsHeaders.xAcsDingtalkAccessToken = "<your access token>";
    let listSeniorSettingsRequest = new $dingtalkcontact_1_0.ListSeniorSettingsRequest({
      seniorStaffId: "1234567",
    });
    try {
      await client.listSeniorSettingsWithOptions(listSeniorSettingsRequest, listSeniorSettingsHeaders, new $Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.empty(err.code) && !Util.empty(err.message)) {
        // err contains code and message properties to help locate the issue
      }

    }    
  }

}

Client.main(process.argv.slice(2));
C#
// This file is auto-generated, don't edit it. Thanks.

using System;
using System.Collections;
using System.Collections.Generic;
using System.IO;
using System.Threading.Tasks;

using Tea;
using Tea.Utils;

namespace AlibabaCloud.SDK.Sample
{
    public class Sample 
    {

        /**
         * Initialize the account Client with a Token
         * @return Client
         * @throws Exception
         */
        public static AlibabaCloud.SDK.Dingtalkcontact_1_0.Client CreateClient()
        {
            AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config();
            config.Protocol = "https";
            config.RegionId = "central";
            return new AlibabaCloud.SDK.Dingtalkcontact_1_0.Client(config);
        }

        public static void Main(string[] args)
        {
            AlibabaCloud.SDK.Dingtalkcontact_1_0.Client client = CreateClient();
            AlibabaCloud.SDK.Dingtalkcontact_1_0.Models.ListSeniorSettingsHeaders listSeniorSettingsHeaders = new AlibabaCloud.SDK.Dingtalkcontact_1_0.Models.ListSeniorSettingsHeaders();
            listSeniorSettingsHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkcontact_1_0.Models.ListSeniorSettingsRequest listSeniorSettingsRequest = new AlibabaCloud.SDK.Dingtalkcontact_1_0.Models.ListSeniorSettingsRequest
            {
                SeniorStaffId = "1234567",
            };
            try
            {
                client.ListSeniorSettingsWithOptions(listSeniorSettingsRequest, listSeniorSettingsHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
            }
            catch (TeaException err)
            {
                if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
                {
                    // err contains code and message properties to help locate the issue
                }
            }
            catch (Exception _err)
            {
                TeaException err = new TeaException(new Dictionary<string, object>
                {
                    { "message", _err.Message }
                });
                if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
                {
                    // err contains code and message properties to help locate the issue
                }
            }
        }

    }
}

Response

Response body

NameTypeDescription
seniorStaffIdStringThe user ID.
protectScenesArray of StringThe list of interception scenarios.
seniorWhiteListArrayThe executive allowlist.
idStringThe ID of an object in the executive allowlist. Valid values: - type=1: indicates a userId. - type=2: indicates a department deptId. - type=3: indicates a role roleId.
typeIntegerThe type of the executive allowlist entry. Valid values: - 1: user - 2: department - 3: role
nameStringThe name of the object in the executive allowlist. Valid values: - type=1: the employee name. - type=2: the department name. - type=3: the role name.

Response body example

HTTP/1.1 200 OK
Content-Type:application/json

{
  "seniorStaffId" : "Executive userId",
  "protectScenes" : [ "CHAT" ],
  "seniorWhiteList" : [ {
    "id" : "1234",
    "type" : 1,
    "name" : "Test role"
  } ]
}

Error codes

If an error occurs when you call this API, find the solution in the Global error codes document based on the error message.
HttpCodeError codeError messageDescription
400parameter.errorParameter errorParameter error
500parameter.userNotExistsThe user does not existThe user does not exist
500parameter.orgNotExistsThe organization does not existThe organization does not exist
500system.errorFailed to get the settingsFailed to get the configuration