List visibility restriction settings for Contacts

Call this API to retrieve the list of visibility restriction settings for Contacts.

API call description

After calling the Add or modify visibility restriction settings for Contacts API, call this API to paginate through the visibility restriction settings configured for your organization.

Request

Basic information

Field	Value
HTTP URL	https://api.dingtalk.io/v1.0/contact/restrictions/settings
HTTP Method	GET
Supported app type	appType-Internal app
Permissions required	permission-Contact.Visibility.ReadWrite-Permission to manage Contacts data visibility

Request headers

Name	Type	Required	Description
x-acs-dingtalk-access-token	String	Yes	The access credential for calling this API. Obtain it by calling the Obtain the access token of an internal app API.

Query parameters

Name	Type	Required	Description
nextToken	Long	No	The pagination cursor. - Leave this parameter empty for the first call. - For subsequent calls, set this parameter to the nextToken returned by the previous call.
maxResults	Integer	No	The maximum number of results to return. Maximum value: 100.

Request example

HTTP

GET /v1.0/contact/restrictions/settings?nextToken=1&maxResults=100 HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:xxxxx
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.ListContactRestrictSettingHeaders listContactRestrictSettingHeaders = new com.aliyun.dingtalkcontact_1_0.models.ListContactRestrictSettingHeaders();
        listContactRestrictSettingHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkcontact_1_0.models.ListContactRestrictSettingRequest listContactRestrictSettingRequest = new com.aliyun.dingtalkcontact_1_0.models.ListContactRestrictSettingRequest()
                .setNextToken(1L)
                .setMaxResults(100);
        try {
            client.listContactRestrictSettingWithOptions(listContactRestrictSettingRequest, listContactRestrictSettingHeaders, 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_contact_restrict_setting_headers = dingtalkcontact__1__0_models.ListContactRestrictSettingHeaders()
        list_contact_restrict_setting_headers.x_acs_dingtalk_access_token = '<your access token>'
        list_contact_restrict_setting_request = dingtalkcontact__1__0_models.ListContactRestrictSettingRequest(
            next_token=1,
            max_results=100
        )
        try:
            client.list_contact_restrict_setting_with_options(list_contact_restrict_setting_request, list_contact_restrict_setting_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_contact_restrict_setting_headers = dingtalkcontact__1__0_models.ListContactRestrictSettingHeaders()
        list_contact_restrict_setting_headers.x_acs_dingtalk_access_token = '<your access token>'
        list_contact_restrict_setting_request = dingtalkcontact__1__0_models.ListContactRestrictSettingRequest(
            next_token=1,
            max_results=100
        )
        try:
            await client.list_contact_restrict_setting_with_options_async(list_contact_restrict_setting_request, list_contact_restrict_setting_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\ListContactRestrictSettingHeaders;
use AlibabaCloud\SDK\Dingtalk\Vcontact_1_0\Models\ListContactRestrictSettingRequest;
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();
        $listContactRestrictSettingHeaders = new ListContactRestrictSettingHeaders([]);
        $listContactRestrictSettingHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $listContactRestrictSettingRequest = new ListContactRestrictSettingRequest([
            "nextToken" => 1,
            "maxResults" => 100
        ]);
        try {
            $client->listContactRestrictSettingWithOptions($listContactRestrictSettingRequest, $listContactRestrictSettingHeaders, 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));

// This file is auto-generated, don't edit it. Thanks.
package main

import (
  "os"
  util  "github.com/alibabacloud-go/tea-utils/v2/service"
  dingtalkcontact_1_0  "github.com/alibabacloud-go/dingtalk/contact_1_0"
  openapi  "github.com/alibabacloud-go/darabonba-openapi/v2/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
  }

  listContactRestrictSettingHeaders := &dingtalkcontact_1_0.ListContactRestrictSettingHeaders{}
  listContactRestrictSettingHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  listContactRestrictSettingRequest := &dingtalkcontact_1_0.ListContactRestrictSettingRequest{
    NextToken: tea.Int64(1),
    MaxResults: tea.Int32(100),
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.ListContactRestrictSettingWithOptions(listContactRestrictSettingRequest, listContactRestrictSettingHeaders, &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 listContactRestrictSettingHeaders = new $dingtalkcontact_1_0.ListContactRestrictSettingHeaders({ });
    listContactRestrictSettingHeaders.xAcsDingtalkAccessToken = "<your access token>";
    let listContactRestrictSettingRequest = new $dingtalkcontact_1_0.ListContactRestrictSettingRequest({
      nextToken: 1,
      maxResults: 100,
    });
    try {
      await client.listContactRestrictSettingWithOptions(listContactRestrictSettingRequest, listContactRestrictSettingHeaders, 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));

// 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.ListContactRestrictSettingHeaders listContactRestrictSettingHeaders = new AlibabaCloud.SDK.Dingtalkcontact_1_0.Models.ListContactRestrictSettingHeaders();
            listContactRestrictSettingHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkcontact_1_0.Models.ListContactRestrictSettingRequest listContactRestrictSettingRequest = new AlibabaCloud.SDK.Dingtalkcontact_1_0.Models.ListContactRestrictSettingRequest
            {
                NextToken = 1,
                MaxResults = 100,
            };
            try
            {
                client.ListContactRestrictSettingWithOptions(listContactRestrictSettingRequest, listContactRestrictSettingHeaders, 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

Name	Type	Description
hasMore	Boolean	Whether more data is available. - true: Yes - false: No
nextToken	Long	The pagination cursor.
list	Array	The list of visibility restriction settings for Contacts.
id	Long	The setting ID.
name	String	The name of the visibility restriction setting for Contacts.
description	String	The description of the visibility restriction for Contacts.
subjectUserIds	Array of String	The list of userIds subject to the Contacts visibility restriction.
subjectDeptIds	Array of Long	The list of deptIds subject to the Contacts visibility restriction.
subjectTagIds	Array of Long	The list of roleIds subject to the Contacts visibility restriction.
type	String	The restriction type. - excludeNode: Only users and departments in the allowlist are visible. - onlySelf: Only the user themselves is visible. - onlySelfDeptAndChild: Only the user’s own department and its sub-departments are visible.
excludeUserIds	Array of String	The list of userIds in the allowlist.
excludeDeptIds	Array of Long	The list of deptIds in the allowlist.
excludeTagIds	Array of Long	The list of roleIds in the allowlist.
active	Boolean	Whether the setting is in effect. - true: In effect - false: Not in effect
restrictInUserProfile	Boolean	Whether to also restrict viewing of the Profile page. - true: Yes - false: No
restrictInSearch	Boolean	Whether to also restrict Search. - true: Yes - false: No

Response body example

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

{
  "hasMore" : true,
  "nextToken" : 200001100,
  "list" : [ {
    "id" : 1001,
    "name" : "Visibility restriction setting for the xxx department",
    "description" : "The xxx department can only see xxx, the xxx department, and the xxx role",
    "subjectUserIds" : [ "10002" ],
    "subjectDeptIds" : [ 11222 ],
    "subjectTagIds" : [ 222333 ],
    "type" : "excludeNode",
    "excludeUserIds" : [ "0141040080" ],
    "excludeDeptIds" : [ 100200 ],
    "excludeTagIds" : [ 112233 ],
    "active" : true,
    "restrictInUserProfile" : true,
    "restrictInSearch" : true
  } ]
}

Error codes

If an error occurs when calling this API, look up the solution in the Global error codes document based on the error message.

HttpCode	Error code	Error message	Description
500	system.error	Query service error	Query service error

​API call description

​Request

​Basic information

​Request headers

​Query parameters

​Request example

​Response

​Response body

​Response body example

​Error codes