部門詳細を取得する

本 API を呼び出して、部門 ID に基づいて指定された部門の詳細を取得します。

リクエスト

基本情報
HTTP URL	https://api.dingtalk.io/topapi/v2/department/get
HTTP Method	POST
サポートするアプリタイプ	appType-社内アプリappType-サードパーティ社内アプリ
権限要件	permission-qyapi_get_department_list-連絡先部門情報の読み取り権限

クエリパラメータ

名前	タイプ	必須	例	説明
access_token	String	はい	bE74xxxx	この API を呼び出すためのアプリ認証情報。 - 社内アプリの場合、社内アプリの access_token を取得する API から取得します。 - サードパーティ社内アプリの場合、サードパーティ企業の access_token を取得する API から取得します。

リクエストボディ

名前	タイプ	必須	例	説明
dept_id	Number	はい	100	部門 ID。ルート部門 ID は 1 です。部門リストを取得する API を呼び出して dept_id の値を取得できます。
language	String	いいえ	zh_CN	連絡先の言語： - zh_CN（デフォルト）：中国語 - en_US：英語

リクエスト例

curl -X POST "https://api.dingtalk.io/topapi/v2/department/get" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=d3daxxxx51990' \
-d 'dept_id=100' \
-d 'language=zh_CN'

Java

DingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/v2/department/get");
OapiV2DepartmentGetRequest req = new OapiV2DepartmentGetRequest();
req.setDeptId(100L);
req.setLanguage("zh_CN");
OapiV2DepartmentGetResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

Python

import dingtalk.api

req=dingtalk.api.OapiV2DepartmentGetRequest("https://api.dingtalk.io/topapi/v2/department/get")

req.dept_id=100
req.language="zh_CN"
try:
  resp= req.getResponse(access_token)
  print(resp)
except Exception,e:
  print(e)

PHP

include "TopSdk.php";
date_default_timezone_set('Asia/Shanghai');

$c = new DingTalkClient(DingTalkConstant::$CALL_TYPE_OAPI, DingTalkConstant::$METHOD_POST , DingTalkConstant::$FORMAT_JSON);
$req = new OapiV2DepartmentGetRequest;
$req->setDeptId("100");
$req->setLanguage("zh_CN");
$resp = $c->execute($req, $access_token, "https://api.dingtalk.io/topapi/v2/department/get");

IDingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/v2/department/get");
OapiV2DepartmentGetRequest req = new OapiV2DepartmentGetRequest();
req.DeptId = 100L;
req.Language = "zh_CN";
OapiV2DepartmentGetResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);

レスポンス

レスポンスボディ

名前	タイプ	例	説明
request_id	String	4e7ljtq91rgo	リクエスト ID。
errcode	Number	0	リターンコード。
errmsg	String	ok	エラーメッセージ。
result	DeptGetResponse		部門詳細。
dept_id	Number	100	部門 ID。
name	String	HR	部門名。
parent_id	Number	50	親部門 ID。ルート部門は 1 です。
source_identifier	String	HR	部門識別フィールド。説明サードパーティ社内アプリではこのパラメータは返されません。
create_dept_group	Boolean	true	この部門に関連する企業グループを同時に作成するかどうか： - true：作成する - false：作成しない
auto_add_user	Boolean	false	部門グループ作成後、新しいメンバーが部門に加わった際に自動的にグループに参加するかどうか： - true：自動的にグループに参加 - false：自動的にグループに参加しない
tags	String	campus	教育部門タグ： - campus：キャンパス - period：学期 - grade：学年 - class：クラス説明サードパーティ社内アプリではこのパラメータは返されません。
from_union_org	Boolean	false	部門が関連組織からのものかどうか： - true：はい - false：いいえ説明サードパーティ社内アプリではこのパラメータは返されません。
order	Number	10	親部門内での表示順序の値。
dept_group_chat_id	String	123	部門グループ ID。
group_contain_sub_dept	Boolean	true	部門グループに子部門を含めるかどうか： - true：含める - false：含めない
org_dept_owner	String	80	企業グループのグループ作成者 userId。
dept_manager_userid_list	String[]	[“5”,“6”,“7”,“8”]	部門責任者の userid リスト。
outer_dept	Boolean	true	この部門のユーザーが連絡先を閲覧できる範囲を制限するかどうか： - true：制限を有効にします。有効にすると、この部門のユーザーは指定された部門 / 個人のみの連絡先を閲覧できます。 - false：制限しません。
outer_permit_depts	Number[]	[500,600]	設定された、部門の社員が閲覧可能な部門 ID リスト。説明この部門のユーザーの連絡先閲覧を制限する設定が有効な場合に、outer_dept の値が返されます。 - この部門のユーザーの連絡先閲覧を制限している場合（つまり outer_dept が true）：outer_permit_depts は、設定された指定された部門 / 個人のみ閲覧可能な部門 ID リストを表します。説明例えば、企業がこの部門のユーザーの連絡先閲覧を制限し、この部門のユーザーが指定された 2 つの部門と 2 名の社員の連絡先のみ閲覧可能と設定した場合、テスト部門 1 の部門 ID が 1、テスト部門 2 の部門 ID が 2 とします。本 API を呼び出すと、設定された部門 outer_permit_depts の値として [1,2] が取得されます。社員リストは返されません。つまり、社員小钉 1、社員小钉 2 の情報は返されません。 - この部門のユーザーの連絡先閲覧を制限していない場合（つまり outer_dept が false）：API 呼び出し時に outer_permit_depts フィールドは返されません。
outer_permit_users	String[]	[“78”,“79”]	設定された、部門の社員が閲覧可能な社員 userId リスト。説明この部門のユーザーの連絡先閲覧を制限する設定が有効な場合に、outer_dept の値が返されます。 - この部門のユーザーの連絡先閲覧を制限している場合（つまり outer_dept が true）：outer_permit_users は、設定された指定された部門 / 個人のみ閲覧可能な社員 userId リストを表します。説明例えば、企業がこの部門のユーザーの連絡先閲覧を制限し、この部門のユーザーが指定された 2 つの部門と 2 名の社員の連絡先のみ閲覧可能と設定した場合、社員小钉 1 の userId が 001、社員小钉 2 の userId が 002 とします。本 API を呼び出すと、設定された社員 outer_permit_users の値として [“001”,“002”] が取得されます。部門リストは返されません。つまり、テスト部門 1、テスト部門 2 の情報は返されません。 - この部門のユーザーの連絡先閲覧を制限していない場合（つまり outer_dept が false）：API 呼び出し時に outer_permit_users フィールドは返されません。
user_permits	String[]	[“5”,“9”]	部門を非表示にする際の社員 userId リスト。説明企業がこの部門の非表示を有効にした場合に、hide_dept の値が返されます。 - 本部門の非表示を有効にしている場合（つまり hide_dept が true）：user_permits は、設定された指定された部門 / 個人に閲覧を許可する社員 userId リストを表します。説明例えば、企業がこの部門の非表示を有効にし、2 つの部門と 2 名の社員にそれぞれ指定された部門 / 個人での閲覧を許可した場合、社員小钉 1 の userId が 001、社員小钉 2 の userId が 002 とします。本 API を呼び出すと、設定された社員 user_permits の値として [“001”,“002”] が取得されます。部門リストは返されません。つまり、テスト部門 1、テスト部門 2 の情報は返されません。 - 本部門の非表示を有効にしていない場合（つまり hide_dept が false）：API 呼び出し時に user_permits フィールドは返されません。
hide_dept	Boolean	false	本部門の非表示を有効にするかどうか： - true：本部門の非表示を有効にします。非表示の範囲を設定でき、全員と全部門に対して非表示にすることも、指定された部門 / 個人にのみ閲覧を許可することもできます。 - false：本部門の非表示を無効にします。つまり、部門は企業の連絡先に表示されます。
dept_permits	Number[]	[3,4,5]	部門を非表示にする際の部門 ID リスト。説明企業がこの部門の非表示を有効にした場合に、hide_dept の値が返されます。 - 本部門の非表示を有効にしている場合（つまり hide_dept が true）：dept_permits は、設定された指定された部門 / 個人に閲覧を許可する部門 ID リストを表します。説明例えば、企業がこの部門の非表示を有効にし、2 つの部門と 2 名の社員にそれぞれ指定された部門 / 個人での閲覧を許可した場合、テスト部門 1 の部門 ID が 1、テスト部門 2 の部門 ID が 2 とします。本 API を呼び出すと、設定された部門 dept_permits の値として [1,2] が取得されます。社員リストは返されません。つまり、社員小钉 1、社員小钉 2 の情報は返されません。 - 本部門の非表示を有効にしていない場合（つまり hide_dept が false）：API 呼び出し時に dept_permits フィールドは返されません。
auto_approve_apply	Boolean	true	この部門への参加申請をデフォルトで承認するかどうか： - true：この部門への参加申請がデフォルトで承認されます - false：この部門への参加申請には権限を持つ管理者の承認が必要です
code	String	10000	部門コード。説明このフィールドは部門を更新する API を通じて部門コードを設定した後にのみ返されます。
member_count	Number	10	部門の社員数（子部門を含む）。
owning_member_count	Number	8	部門直属の社員数（子部門を含まない）。
union_dept_ext	Object		関連部門情報。
deptId	Number	1234567	関連部門 ID。
corpId	String	test	関連部門の企業の組織 ID。

レスポンスボディ例

{
  "errcode": 0,
  "errmsg": "ok",
  "result": {
    "dept_permits": [
      3,
      4,
      5
    ],
    "outer_permit_users": [
      "user123",
      "1234"
    ],
    "dept_manager_userid_list": [
      "1020302901-431772414"
    ],
    "org_dept_owner": "manager9153",
    "outer_dept": false,
    "dept_group_chat_id": "chat1fccdb4b921f2bde18c26xxxx",
    "group_contain_sub_dept": true,
    "auto_add_user": true,
    "hide_dept": false,
    "name": "テスト",
    "outer_permit_depts": [
      500,
      600
    ],
    "user_permits": [],
    "dept_id": 1,
    "create_dept_group": true,
    "order": 0,
    "code":"100",
    "union_dept_ext":{
      "corp_id": "test",
      "dept_id": 1234567
    }
  },
  "request_id": "4e7ljtq91rgo"
}

エラーコード

API の呼び出し時にエラーが発生した場合は、エラーメッセージに基づいてグローバルエラーコードドキュメントで解決策を検索してください。

エラーコード（errcode）	エラーコードの説明（errmsg）	解決策
43007	権限付与が必要	access_token に操作権限があることを確認してください
60003	該当する部門が見つかりません	dept_id が正しいか確認してください
400002	無効なパラメータ	パラメータが要件どおりに入力されているか確認してください
-1	システムビジー	後で再試行してください

API 呼び出しガイド

認証と認可

連絡先

カレンダー

会議

AI Table

Docs とファイル

IM

リクエスト

クエリパラメータ

リクエストボディ

リクエスト例

レスポンス

レスポンスボディ

レスポンスボディ例

エラーコード

​リクエスト

​クエリパラメータ

​リクエストボディ

​リクエスト例

​レスポンス

​レスポンスボディ

​レスポンスボディ例

​エラーコード

リクエスト

クエリパラメータ

リクエストボディ

リクエスト例

レスポンス

レスポンスボディ

レスポンスボディ例

エラーコード