リクエスト
| 基本情報 | |
|---|---|
| HTTP URL | https://api.dingtalk.io/topapi/v2/department/listsub |
| HTTP Method | POST |
| 対応アプリタイプ | appType-社内アプリ appType-サードパーティ社内アプリ |
| 必要な権限 | permission-qyapi_get_department_list-連絡先部門情報の読み取り権限 |
クエリパラメータ
| 名前 | タイプ | 必須 | 例 | 説明 |
|---|---|---|---|---|
| access_token | String | はい | bE74xxxx | 当該 API を呼び出すためのアプリ認証情報。 - 社内アプリの場合、社内アプリの access_token を取得するインターフェースから取得します。 - サードパーティ社内アプリの場合、サードパーティ企業の access_token を取得するインターフェースから取得します。 |
リクエストボディ
| 名前 | タイプ | 必須 | 例 | 説明 |
|---|---|---|---|---|
| dept_id | Number | いいえ | 1 | 親部門 ID。部門リストの取得 インターフェースを呼び出して dept_id パラメータの値を取得できます。 |
| language | String | いいえ | zh_CN | 連絡先の言語: - zh_CN(デフォルト):中国語 - en_US:英語 |
リクエスト例
curl -X POST "https://api.dingtalk.io/topapi/v2/department/listsub" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=6846xxxx0cc781' \
-d 'dept_id=100' \
-d 'language=zh_CN'
DingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/v2/department/listsub");
OapiV2DepartmentListsubRequest req = new OapiV2DepartmentListsubRequest();
req.setDeptId(1L);
req.setLanguage("zh_CN");
OapiV2DepartmentListsubResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());
import dingtalk.api
req=dingtalk.api.OapiV2DepartmentListsubRequest("https://api.dingtalk.io/topapi/v2/department/listsub")
req.dept_id=100
req.language="zh_CN"
try:
resp= req.getResponse(access_token)
print(resp)
except Exception,e:
print(e)
include "TopSdk.php";
date_default_timezone_set('Asia/Shanghai');
$c = new DingTalkClient(DingTalkConstant::$CALL_TYPE_OAPI, DingTalkConstant::$METHOD_POST , DingTalkConstant::$FORMAT_JSON);
$req = new OapiV2DepartmentListsubRequest;
$req->setDeptId("100");
$req->setLanguage("zh_CN");
$resp = $c->execute($req, $access_token, "https://api.dingtalk.io/topapi/v2/department/listsub");
IDingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/v2/department/listsub");
OapiV2DepartmentListsubRequest req = new OapiV2DepartmentListsubRequest();
req.DeptId = 100L;
req.Language = "zh_CN";
OapiV2DepartmentListsubResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);
レスポンス
レスポンスボディ
| 名前 | タイプ | 例 | 説明 |
|---|---|---|---|
| request_id | String | 5um7ykyaalsj | リクエスト ID。 |
| errcode | Number | 0 | リターンコード。 |
| errmsg | String | 不正な access_token | 呼び出しに失敗した際に返されるエラーメッセージ。 |
| result | DeptBaseResponse[] | 部門リスト。 | |
| dept_id | Number | 100 | 部門 ID。 |
| name | String | HR | 部門名。 |
| parent_id | Number | 50 | 親部門 ID。 |
| create_dept_group | Boolean | true | 当該部門に関連する企業グループを同時に作成するかどうか: - true:作成する - false:作成しない |
| auto_add_user | Boolean | false | 部門グループが既に作成された後、新しいメンバーが部門に加入した際に自動的に当該グループに加入するかどうか: - true:自動的にグループに加入する - false:加入しない |
レスポンスボディ例
{
"errcode": 0,
"errmsg":"ok",
"result": [
{
"auto_add_user": true,
"create_dept_group": true,
"dept_id": 37xxxx95,
"name": "マーケティング部",
"parent_id": 1
},
{
"auto_add_user": true,
"create_dept_group": true,
"dept_id": 399xxxx96,
"name": "経理部",
"parent_id": 1
}
],
"request_id": "5um7ykyaalsj"
}
エラーコード
当該インターフェースの呼び出し時にエラーが発生した場合は、エラーメッセージを基に グローバルエラーコード ドキュメントから解決方法を検索してください。| エラーコード(errcode) | エラーコード説明(errmsg) | 解決方法 |
|---|---|---|
| 60003 | 該当する部門が見つかりません | dept_id が正しいかご確認ください |
| 400002 | 無効なパラメータ | パラメータが要件通りに入力されているかご確認ください |
| -1 | システムビジー | 後で再度お試しください |