リクエスト
| 基本情報 | |
|---|---|
| HTTP URL | https://api.dingtalk.io/topapi/role/addrolesforemps |
| HTTP Method | POST |
| サポートされるアプリタイプ | appType-社内アプリ |
| 権限要件 | permission-qyapi_manage_addresslist-連絡先データ管理権限 |
クエリパラメータ
| 名前 | タイプ | 必須 | 例 | 説明 |
|---|---|---|---|---|
| access_token | String | はい | 6d1bxxxx | 当該インターフェイスを呼び出すためのアプリ認証情報。社内アプリの access_token を取得するインターフェイスから取得します。 |
リクエストボディ
| 名前 | タイプ | 必須 | 例 | 説明 |
|---|---|---|---|---|
| roleIds | String | はい | 1507113584 | ロールの roleId リスト。ロールリストの取得インターフェイスを呼び出して取得できます。 複数の roleId は半角カンマ(,)で区切り、最大 20 個まで指定できます。 |
| userIds | String | はい | user1 | 社員の userId。電話番号によるユーザー検索を呼び出して取得できます。 複数の userId は半角カンマ(,)で区切り、最大 20 個まで指定できます。 |
リクエスト例
curl -X POST "https://api.dingtalk.io/topapi/role/addrolesforemps" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=8f577dxxxx76f2a3a2' \
-d 'roleIds=1507113584' \
-d 'userIds=user1'
DingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/role/addrolesforemps");
OapiRoleAddrolesforempsRequest req = new OapiRoleAddrolesforempsRequest();
req.setRoleIds("1507113584,1507113589");
req.setUserIds("user1,user2");
OapiRoleAddrolesforempsResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());
import dingtalk.api
req=dingtalk.api.OapiRoleAddrolesforempsRequest("https://api.dingtalk.io/topapi/role/addrolesforemps")
req.roleIds="1507113584"
req.userIds="user1"
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 OapiRoleAddrolesforempsRequest;
$req->setRoleIds("1507113584");
$req->setUserIds("user1");
$resp = $c->execute($req, $access_token, "https://api.dingtalk.io/topapi/role/addrolesforemps");
IDingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/role/addrolesforemps");
OapiRoleAddrolesforempsRequest req = new OapiRoleAddrolesforempsRequest();
req.RoleIds = "1507113584";
req.UserIds = "user1";
OapiRoleAddrolesforempsResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);
レスポンス
レスポンスボディ
| 名前 | タイプ | 例 | 説明 |
|---|---|---|---|
| errcode | Number | 0 | リターンコード。 |
| errmsg | String | ok | リターンコードの説明。 |
| request_id | String | emhw6ma4xmeg | リクエスト ID。 |
レスポンスボディ例
{
"errcode": 0,
"request_id": "emhw6ma4xmeg"
}
エラーコード
当該インターフェイスの呼び出しでエラーが発生した場合は、エラーメッセージをもとにグローバルエラーコードドキュメントで解決策を検索してください。| エラーコード(errcode) | エラーコードの説明(errmsg) | 解決策 |
|---|---|---|
| 33011 | 無効な roleIds | roleIds が正しいか確認してください |
| 33012 | 無効な userIds | userId が正しいか確認してください |
| 12012 | 当該企業が存在しません | access_token が正しいか確認してください |
| 1002 | システムビジー | 後で再試行してください |