API 呼び出し説明
DingTalk OA 管理バックエンドでは、部門に対して非表示設定を行うことができます。本 API の機能は部門の非表示設定の拡張であり、部門の非表示だけでなく、社員およびロールの非表示も実現できます。本 API の非表示設定と OA バックエンドの非表示設定は独立して保存されており、最終的に有効となる結果は両者の設定の OR 関係となります。例えば、同一部門に対して本 API または OA バックエンドのいずれかで非表示に設定されていれば、最終的にその部門は非表示となります。
リクエスト
基本情報
| フィールド | 値 |
|---|---|
| HTTP URL | https://api.dingtalk.io/v1.0/contact/contactHideSettings |
| HTTP Method | PUT |
| サポートするアプリタイプ | appType-社内アプリ |
| 権限要件 | permission-Contact.Visibility.ReadWrite-連絡先データの可視範囲管理権限 |
リクエストヘッダー
| 名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
| x-acs-dingtalk-access-token | String | はい | この API を呼び出すためのアクセス認証情報。社内アプリのアクセストークンを取得 API を呼び出して取得します。 |
リクエストボディ
| 名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
| name | String | いいえ | 設定名。 |
| description | String | いいえ | 設定の説明情報。 |
| objectStaffIds | Array of String | いいえ | 非表示にする社員の userid リスト。サイレントログインコードによるユーザー情報取得 で userid パラメータ値を取得できます。 objectStaffIds、objectDeptIds、objectTagIds の 3 パラメータ内の要素数の合計は 50 を超えることはできません。 |
| objectDeptIds | Array of Long | いいえ | 非表示にする部門 ID リスト。部門リストの取得 API で dept_id パラメータ値を取得できます。 objectStaffIds、objectDeptIds、objectTagIds の 3 パラメータ内の要素数の合計は 50 を超えることはできません。 |
| objectTagIds | Array of Long | いいえ | 非表示にするロールの roleId リスト。ロールリストの取得 API で id パラメータ値を取得できます。 objectStaffIds、objectDeptIds、objectTagIds の 3 パラメータ内の要素数の合計は 50 を超えることはできません。 |
| excludeStaffIds | Array of String | いいえ | 本非表示設定の影響を受けない社員の userid リスト。サイレントログインコードによるユーザー情報取得 で userid パラメータ値を取得できます。 excludeStaffIds、excludeDeptIds、excludeTagIds の 3 パラメータ内の要素数の合計は 50 を超えることはできません。 |
| excludeDeptIds | Array of Long | いいえ | 本非表示設定の影響を受けない部門 ID リスト。部門リストの取得 API で dept_id パラメータ値を取得できます。 excludeStaffIds、excludeDeptIds、excludeTagIds の 3 パラメータ内の要素数の合計は 50 を超えることはできません。 |
| excludeTagIds | Array of Long | いいえ | 本非表示設定の影響を受けないロール ID リスト。ロールリストの取得 API で id パラメータ値を取得できます。 excludeStaffIds、excludeDeptIds、excludeTagIds の 3 パラメータ内の要素数の合計は 50 を超えることはできません。 |
| active | Boolean | いいえ | 本設定を有効化するかどうか。値: - true:有効化 - false:無効化 |
| id | Long | いいえ | 設定 ID。 - 新規追加時は ID を空にします。 - 修正時は ID を修正対象の ID に設定します。 |
| hideInUserProfile | Boolean | いいえ | プロフィール閲覧時に同時に非表示にするかどうか。値: - true:はい - false:いいえ |
| hideInSearch | Boolean | いいえ | 検索時に同時に非表示にするかどうか。値: - true:はい - false:いいえ |
リクエスト例
HTTPPUT /v1.0/contact/contactHideSettings HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:c2c5bxxx
Content-Type:application/json
{
"name" : "設定名サンプル",
"description" : "これは説明文です",
"objectStaffIds" : [ "userId" ],
"objectDeptIds" : [ 12345 ],
"objectTagIds" : [ 112233 ],
"excludeStaffIds" : [ "54321-1122" ],
"excludeDeptIds" : [ 123987 ],
"excludeTagIds" : [ 223344 ],
"active" : true,
"id" : 11234,
"hideInUserProfile" : true,
"hideInSearch" : true
}
// This file is auto-generated, don't edit it. Thanks.
package com.aliyun.sample;
import com.aliyun.tea.*;
public class Sample {
/**
* トークンを使用してアカウント Client を初期化
* @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.UpdateContactHideSettingHeaders updateContactHideSettingHeaders = new com.aliyun.dingtalkcontact_1_0.models.UpdateContactHideSettingHeaders();
updateContactHideSettingHeaders.xAcsDingtalkAccessToken = "<your access token>";
com.aliyun.dingtalkcontact_1_0.models.UpdateContactHideSettingRequest updateContactHideSettingRequest = new com.aliyun.dingtalkcontact_1_0.models.UpdateContactHideSettingRequest()
.setName("設定名サンプル")
.setDescription("これは説明文です")
.setObjectStaffIds(java.util.Arrays.asList(
"userId"
))
.setObjectDeptIds(java.util.Arrays.asList(
12345L
))
.setObjectTagIds(java.util.Arrays.asList(
112233L
))
.setExcludeStaffIds(java.util.Arrays.asList(
"54321-1122"
))
.setExcludeDeptIds(java.util.Arrays.asList(
123987L
))
.setExcludeTagIds(java.util.Arrays.asList(
223344L
))
.setActive(true)
.setId(11234L)
.setHideInUserProfile(true)
.setHideInSearch(true);
try {
client.updateContactHideSettingWithOptions(updateContactHideSettingRequest, updateContactHideSettingHeaders, 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 には code と message 属性が含まれており、開発者の問題特定に役立ちます
}
} 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 には code と message 属性が含まれており、開発者の問題特定に役立ちます
}
}
}
}
# -*- 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:
"""
トークンを使用してアカウント Client を初期化
@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()
update_contact_hide_setting_headers = dingtalkcontact__1__0_models.UpdateContactHideSettingHeaders()
update_contact_hide_setting_headers.x_acs_dingtalk_access_token = '<your access token>'
update_contact_hide_setting_request = dingtalkcontact__1__0_models.UpdateContactHideSettingRequest(
name='設定名サンプル',
description='これは説明文です',
object_staff_ids=[
'userId'
],
object_dept_ids=[
12345
],
object_tag_ids=[
112233
],
exclude_staff_ids=[
'54321-1122'
],
exclude_dept_ids=[
123987
],
exclude_tag_ids=[
223344
],
active=True,
id=11234,
hide_in_user_profile=True,
hide_in_search=True
)
try:
client.update_contact_hide_setting_with_options(update_contact_hide_setting_request, update_contact_hide_setting_headers, util_models.RuntimeOptions())
except Exception as err:
if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
# err には code と message 属性が含まれており、開発者の問題特定に役立ちます
pass
@staticmethod
async def main_async(
args: List[str],
) -> None:
client = Sample.create_client()
update_contact_hide_setting_headers = dingtalkcontact__1__0_models.UpdateContactHideSettingHeaders()
update_contact_hide_setting_headers.x_acs_dingtalk_access_token = '<your access token>'
update_contact_hide_setting_request = dingtalkcontact__1__0_models.UpdateContactHideSettingRequest(
name='設定名サンプル',
description='これは説明文です',
object_staff_ids=[
'userId'
],
object_dept_ids=[
12345
],
object_tag_ids=[
112233
],
exclude_staff_ids=[
'54321-1122'
],
exclude_dept_ids=[
123987
],
exclude_tag_ids=[
223344
],
active=True,
id=11234,
hide_in_user_profile=True,
hide_in_search=True
)
try:
await client.update_contact_hide_setting_with_options_async(update_contact_hide_setting_request, update_contact_hide_setting_headers, util_models.RuntimeOptions())
except Exception as err:
if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
# err には code と message 属性が含まれており、開発者の問題特定に役立ちます
pass
if __name__ == '__main__':
Sample.main(sys.argv[1:])
<?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\UpdateContactHideSettingHeaders;
use AlibabaCloud\SDK\Dingtalk\Vcontact_1_0\Models\UpdateContactHideSettingRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;
class Sample {
/**
* トークンを使用してアカウント Client を初期化
* @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();
$updateContactHideSettingHeaders = new UpdateContactHideSettingHeaders([]);
$updateContactHideSettingHeaders->xAcsDingtalkAccessToken = "<your access token>";
$updateContactHideSettingRequest = new UpdateContactHideSettingRequest([
"name" => "設定名サンプル",
"description" => "これは説明文です",
"objectStaffIds" => [
"userId"
],
"objectDeptIds" => [
12345
],
"objectTagIds" => [
112233
],
"excludeStaffIds" => [
"54321-1122"
],
"excludeDeptIds" => [
123987
],
"excludeTagIds" => [
223344
],
"active" => true,
"id" => 11234,
"hideInUserProfile" => true,
"hideInSearch" => true
]);
try {
$client->updateContactHideSettingWithOptions($updateContactHideSettingRequest, $updateContactHideSettingHeaders, 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 には code と message 属性が含まれており、開発者の問題特定に役立ちます
}
}
}
}
$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"
)
/**
* トークンを使用してアカウント Client を初期化
* @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
}
updateContactHideSettingHeaders := &dingtalkcontact_1_0.UpdateContactHideSettingHeaders{}
updateContactHideSettingHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
updateContactHideSettingRequest := &dingtalkcontact_1_0.UpdateContactHideSettingRequest{
Name: tea.String("設定名サンプル"),
Description: tea.String("これは説明文です"),
ObjectStaffIds: []*string{tea.String("userId")},
ObjectDeptIds: []*int64{tea.Int64(12345)},
ObjectTagIds: []*int64{tea.Int64(112233)},
ExcludeStaffIds: []*string{tea.String("54321-1122")},
ExcludeDeptIds: []*int64{tea.Int64(123987)},
ExcludeTagIds: []*int64{tea.Int64(223344)},
Active: tea.Bool(true),
Id: tea.Int64(11234),
HideInUserProfile: tea.Bool(true),
HideInSearch: tea.Bool(true),
}
tryErr := func()(_e error) {
defer func() {
if r := tea.Recover(recover()); r != nil {
_e = r
}
}()
_, _err = client.UpdateContactHideSettingWithOptions(updateContactHideSettingRequest, updateContactHideSettingHeaders, &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 には code と message 属性が含まれており、開発者の問題特定に役立ちます
}
}
return _err
}
func main() {
err := _main(tea.StringSlice(os.Args[1:]))
if err != nil {
panic(err)
}
}
// 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 {
/**
* トークンを使用してアカウント Client を初期化
* @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 updateContactHideSettingHeaders = new $dingtalkcontact_1_0.UpdateContactHideSettingHeaders({ });
updateContactHideSettingHeaders.xAcsDingtalkAccessToken = "<your access token>";
let updateContactHideSettingRequest = new $dingtalkcontact_1_0.UpdateContactHideSettingRequest({
name: "設定名サンプル",
description: "これは説明文です",
objectStaffIds: [
"userId"
],
objectDeptIds: [
12345
],
objectTagIds: [
112233
],
excludeStaffIds: [
"54321-1122"
],
excludeDeptIds: [
123987
],
excludeTagIds: [
223344
],
active: true,
id: 11234,
hideInUserProfile: true,
hideInSearch: true,
});
try {
await client.updateContactHideSettingWithOptions(updateContactHideSettingRequest, updateContactHideSettingHeaders, new $Util.RuntimeOptions({ }));
} catch (err) {
if (!Util.empty(err.code) && !Util.empty(err.message)) {
// err には code と message 属性が含まれており、開発者の問題特定に役立ちます
}
}
}
}
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
{
/**
* トークンを使用してアカウント Client を初期化
* @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.UpdateContactHideSettingHeaders updateContactHideSettingHeaders = new AlibabaCloud.SDK.Dingtalkcontact_1_0.Models.UpdateContactHideSettingHeaders();
updateContactHideSettingHeaders.XAcsDingtalkAccessToken = "<your access token>";
AlibabaCloud.SDK.Dingtalkcontact_1_0.Models.UpdateContactHideSettingRequest updateContactHideSettingRequest = new AlibabaCloud.SDK.Dingtalkcontact_1_0.Models.UpdateContactHideSettingRequest
{
Name = "設定名サンプル",
Description = "これは説明文です",
ObjectStaffIds = new List<string>
{
"userId"
},
ObjectDeptIds = new List<long?>
{
12345
},
ObjectTagIds = new List<long?>
{
112233
},
ExcludeStaffIds = new List<string>
{
"54321-1122"
},
ExcludeDeptIds = new List<long?>
{
123987
},
ExcludeTagIds = new List<long?>
{
223344
},
Active = true,
Id = 11234,
HideInUserProfile = true,
HideInSearch = true,
};
try
{
client.UpdateContactHideSettingWithOptions(updateContactHideSettingRequest, updateContactHideSettingHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
}
catch (TeaException err)
{
if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
{
// err には code と message 属性が含まれており、開発者の問題特定に役立ちます
}
}
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 には code と message 属性が含まれており、開発者の問題特定に役立ちます
}
}
}
}
}
レスポンス
レスポンスボディ
| 名前 | タイプ | 説明 |
|---|---|---|
| result | Long | 設定 ID。 |
レスポンスボディ例
HTTP/1.1 200 OK
Content-Type:application/json
{
"result" : 1234001
}
エラーコード
この API の呼び出しでエラーが発生した場合、エラーメッセージに基づいて グローバルエラーコード ドキュメントで解決策を確認してください。| HttpCode | エラーコード | エラーメッセージ | 説明 |
|---|---|---|---|
| 400 | parameter.error | パラメータエラー | パラメータエラー |
| 500 | system.error | 設定の更新エラー | 設定の更新エラー |