API 呼び出し説明
以下の場合は部門を削除できません。- ルート部門(部門 ID が 1)は削除できません。
- 部門またはその子部門内に未削除の社員が存在する場合は削除できません。
リクエスト
| 基本情報 | |
|---|---|
| HTTP URL | https://api.dingtalk.io/topapi/v2/department/delete |
| HTTP Method | POST |
| 対応アプリタイプ | appType-社内アプリ |
| 必要な権限 | permission-qyapi_manage_addresslist-連絡先データ管理権限 |
クエリパラメータ
| 名前 | タイプ | 必須 | 例 | 説明 |
|---|---|---|---|---|
| access_token | String | はい | bE74xxxx | 当該 API を呼び出すためのアプリ認証情報。社内アプリの access_token を取得する API で取得します。 |
リクエストボディ
| 名前 | タイプ | 必須 | 例 | 説明 |
|---|---|---|---|---|
| dept_id | Number | はい | 100 | 削除する部門 ID。部門リストの取得 API で dept_id の値を取得できます。 |
リクエスト例
curl -X POST "https://api.dingtalk.io/topapi/v2/department/delete" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=f11exxxx6c373a925b' \
-d 'dept_id=100'
DingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/v2/department/delete");
OapiV2DepartmentDeleteRequest req = new OapiV2DepartmentDeleteRequest();
req.setDeptId(100L);
OapiV2DepartmentDeleteResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());
import dingtalk.api
req=dingtalk.api.OapiV2DepartmentDeleteRequest("https://api.dingtalk.io/topapi/v2/department/delete")
req.dept_id=100
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 OapiV2DepartmentDeleteRequest;
$req->setDeptId("100");
$resp = $c->execute($req, $access_token, "https://api.dingtalk.io/topapi/v2/department/delete");
IDingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/v2/department/delete");
OapiV2DepartmentDeleteRequest req = new OapiV2DepartmentDeleteRequest();
req.DeptId = 100L;
OapiV2DepartmentDeleteResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);
レスポンス
レスポンスボディ
| 名前 | タイプ | 例 | 説明 |
|---|---|---|---|
| errcode | Number | 0 | 戻りコード。 |
| errmsg | String | ok | 戻りコードの説明。 |
| request_id | String | 6iq4zcul5zjp | リクエスト ID。 |
レスポンスボディ例
{
"errcode":0,
"errmsg": "ok",
"request_id": "6iq4zcul5zjp"
}
エラーコード
当該 API の呼び出しでエラーが発生した場合は、エラーメッセージをもとにグローバルエラーコードドキュメントから解決方法をご確認ください。| エラーコード(errcode) | エラーコードの説明(errmsg) | 解決方法 |
|---|---|---|
| 43007 | 権限付与が必要です | access_token に操作権限があるかご確認ください |
| 60003 | 対応する部門が見つかりません | dept_id が正しいかご確認ください |
| 400002 | 無効なパラメータです | パラメータが要件どおりに入力されているかご確認ください |
| -1 | システムビジー | 後で再度お試しください |