Menampilkan daftar pengaturan pembatasan visibilitas Kontak

Panggil API ini untuk mengambil daftar pengaturan pembatasan visibilitas Kontak.

Deskripsi panggilan API

Setelah memanggil API Menambahkan atau mengubah pengaturan pembatasan visibilitas Kontak, panggil API ini untuk menampilkan pengaturan pembatasan visibilitas yang telah dikonfigurasi untuk organisasi Anda secara berhalaman.

Permintaan

Informasi dasar

Bidang	Nilai
URL HTTP	https://api.dingtalk.io/v1.0/contact/restrictions/settings
Metode HTTP	GET
Jenis aplikasi yang didukung	appType-Aplikasi internal
Izin yang diperlukan	permission-Contact.Visibility.ReadWrite-Izin untuk mengelola visibilitas data Kontak

Header permintaan

Nama	Tipe	Wajib	Deskripsi
x-acs-dingtalk-access-token	String	Ya	Kredensial akses untuk memanggil API ini. Dapatkan dengan memanggil API Memperoleh access token aplikasi internal.

Parameter kueri

Nama	Tipe	Wajib	Deskripsi
nextToken	Long	Tidak	Cursor paginasi. - Kosongkan parameter ini untuk panggilan pertama. - Untuk panggilan berikutnya, isi parameter ini dengan nextToken yang dikembalikan oleh panggilan sebelumnya.
maxResults	Integer	Tidak	Jumlah maksimum hasil yang dikembalikan. Nilai maksimum: 100.

Contoh permintaan

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 berisi properti code dan message untuk membantu menemukan masalah
            }

        } 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 berisi properti code dan message untuk membantu menemukan masalah
            }

        }        
    }
}

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 berisi properti code dan message untuk membantu menemukan masalah
                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 berisi properti code dan message untuk membantu menemukan masalah
                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 berisi properti code dan message untuk membantu menemukan masalah
            }
        }
    }
}
$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 berisi properti code dan message untuk membantu menemukan masalah
    }

  }
  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 berisi properti code dan message untuk membantu menemukan masalah
      }

    }    
  }

}

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 berisi properti code dan message untuk membantu menemukan masalah
                }
            }
            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 berisi properti code dan message untuk membantu menemukan masalah
                }
            }
        }

    }
}

Respons

Isi respons

Nama	Tipe	Deskripsi
hasMore	Boolean	Apakah masih ada data lain. - true: Ya - false: Tidak
nextToken	Long	Cursor paginasi.
list	Array	Daftar pengaturan pembatasan visibilitas Kontak.
id	Long	ID pengaturan.
name	String	Nama pengaturan pembatasan visibilitas Kontak.
description	String	Deskripsi pembatasan visibilitas Kontak.
subjectUserIds	Array of String	Daftar userId yang dikenai pembatasan visibilitas Kontak.
subjectDeptIds	Array of Long	Daftar deptId yang dikenai pembatasan visibilitas Kontak.
subjectTagIds	Array of Long	Daftar roleId yang dikenai pembatasan visibilitas Kontak.
type	String	Tipe pembatasan. - excludeNode: Hanya pengguna dan departemen dalam daftar izin yang terlihat. - onlySelf: Hanya pengguna itu sendiri yang terlihat. - onlySelfDeptAndChild: Hanya departemen pengguna sendiri beserta sub-departemennya yang terlihat.
excludeUserIds	Array of String	Daftar userId dalam daftar izin.
excludeDeptIds	Array of Long	Daftar deptId dalam daftar izin.
excludeTagIds	Array of Long	Daftar roleId dalam daftar izin.
active	Boolean	Apakah pengaturan sedang berlaku. - true: Berlaku - false: Tidak berlaku
restrictInUserProfile	Boolean	Apakah juga membatasi tampilan halaman Profil. - true: Ya - false: Tidak
restrictInSearch	Boolean	Apakah juga membatasi pencarian. - true: Ya - false: Tidak

Contoh isi respons

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

{
  "hasMore" : true,
  "nextToken" : 200001100,
  "list" : [ {
    "id" : 1001,
    "name" : "Pengaturan pembatasan visibilitas untuk departemen xxx",
    "description" : "Departemen xxx hanya dapat melihat xxx, departemen xxx, dan peran xxx",
    "subjectUserIds" : [ "10002" ],
    "subjectDeptIds" : [ 11222 ],
    "subjectTagIds" : [ 222333 ],
    "type" : "excludeNode",
    "excludeUserIds" : [ "0141040080" ],
    "excludeDeptIds" : [ 100200 ],
    "excludeTagIds" : [ 112233 ],
    "active" : true,
    "restrictInUserProfile" : true,
    "restrictInSearch" : true
  } ]
}

Kode error

Jika terjadi error saat memanggil API ini, cari solusinya di dokumen Kode error global berdasarkan pesan error.

HttpCode	Kode error	Pesan error	Deskripsi
500	system.error	Query service error	Kesalahan layanan kueri

Panduan pemanggilan API

Autentikasi & otorisasi

Kontak

Kalender

Konferensi

AI Table

Dokumen & file

IM

Menampilkan daftar pengaturan pembatasan visibilitas Kontak

Deskripsi panggilan API

Permintaan

Informasi dasar

Header permintaan

Parameter kueri

Contoh permintaan

Respons

Isi respons

Contoh isi respons

Kode error

​Deskripsi panggilan API

​Permintaan

​Informasi dasar

​Header permintaan

​Parameter kueri

​Contoh permintaan

​Respons

​Isi respons

​Contoh isi respons

​Kode error

Deskripsi panggilan API

Permintaan

Informasi dasar

Header permintaan

Parameter kueri

Contoh permintaan

Respons

Isi respons

Contoh isi respons

Kode error