API 呼び出し説明
- 本 API を呼び出す前に、削除対象のロールに関連付けられているすべての社員から、そのロールが解除されていることを確認してください。
- デフォルトのロールグループ配下のロールは削除できません。
リクエスト
| 基本情報 | |
|---|---|
| HTTP URL | https://api.dingtalk.io/topapi/role/deleterole |
| HTTP Method | POST |
| サポートされるアプリタイプ | appType-社内アプリ |
| 必要な権限 | permission-qyapi_manage_addresslist-連絡先データ管理権限 |
クエリパラメータ
| 名前 | タイプ | 必須 | 例 | 説明 |
|---|---|---|---|---|
| access_token | String | はい | 6ed1xxxx | 本 API を呼び出すためのアプリ認証情報です。社内アプリの access_token を取得する API から取得します。 |
リクエストボディ
| 名前 | タイプ | 必須 | 例 | 説明 |
|---|---|---|---|---|
| role_id | Number | はい | 1581321999 | 削除対象のロール ID です。ロールリストの取得 API を呼び出して取得できます。 「デフォルト」グループ内のロール(責任者、上司、スーパー管理者、サブ管理者)は変更できません。 |
リクエスト例
curl -X POST "https://api.dingtalk.io/topapi/role/deleterole" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=f5326exxxxbe8d071' \
-d 'role_id=11'
DingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/role/deleterole");
OapiRoleDeleteroleRequest req = new OapiRoleDeleteroleRequest();
req.setRoleId(1581321999L);
OapiRoleDeleteroleResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());
import dingtalk.api
req=dingtalk.api.OapiRoleDeleteroleRequest("https://api.dingtalk.io/topapi/role/deleterole")
req.role_id=11
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 OapiRoleDeleteroleRequest;
$req->setRoleId("11");
$resp = $c->execute($req, $access_token, "https://api.dingtalk.io/topapi/role/deleterole");
IDingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/role/deleterole");
OapiRoleDeleteroleRequest req = new OapiRoleDeleteroleRequest();
req.RoleId = 11L;
OapiRoleDeleteroleResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);
レスポンス
レスポンスボディ
| 名前 | タイプ | 例 | 説明 |
|---|---|---|---|
| errcode | Number | 0 | リターンコードです。 |
| errmsg | String | ok | リターンコードの説明です。 |
| request_id | String | zw9fhpj3m32u | リクエスト ID です。 |
レスポンスボディ例
{
"errcode":"0",
"request_id":"zw9fhpj3m32u"
}
エラーコード
本 API の呼び出しでエラーが発生した場合は、エラーメッセージをもとに グローバルエラーコード ドキュメントで解決方法を確認してください。| エラーコード(errcode) | エラーコード説明(errmsg) | 解決方法 |
|---|---|---|
| 33011 | 無効な role_id です | role_id が正しいか確認してください |
| 23004 | システムタグは編集できません | role_id が正しいか確認してください |
| 1002 | システムビジー | 後でもう一度お試しください |