開発ガイドリクエスト
| ベーシック情報 | |
|---|---|
| HTTP URL | https://api.dingtalk.io/topapi/attendance/groups/keytoid |
| HTTP メソッド | POST |
| サポートされるアプリタイプ | appType-社内アプリ appType-サードパーティ社内アプリ |
| 必須権限 | qyapi_attendance_group_read（勤怠グループの読み取り権限） |
クエリパラメータ
| 名前 | タイプ | 必須 | 例 | 説明 |
|---|---|---|---|---|
| access_token | String | はい | bE74xxxx | この API の呼び出しに使用するアプリ認証情報です。 - 社内アプリ：社内アプリの access_token を取得 API を呼び出して取得します。 - サードパーティ社内アプリ：サードパーティ社内アプリの access_token を取得 API を呼び出して取得します。 |
リクエストボディ
| 名前 | タイプ | 必須 | 例 | 説明 |
|---|---|---|---|---|
| op_user_id | String | はい | user01 | 操作者の userId です。 |
| group_key | String | はい | 02B1Exxxx | 勤怠グループ ID（旧形式の勤怠グループ識別子）です。勤怠グループ詳細の一括取得 API を呼び出して、group_id パラメータの値を取得してください。 |
リクエスト例
curl -X POST "https://api.dingtalk.io/topapi/attendance/groups/keytoid" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=40bafxxxx9d3b06' \
-d 'group_key=0151E0xxxxA917E876' \
-d 'op_user_id=123'
DingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/attendance/groups/keytoid");
OapiAttendanceGroupsKeytoidRequest req = new OapiAttendanceGroupsKeytoidRequest();
req.setOpUserId("user01");
req.setGroupKey("02B1Exxxx");
OapiAttendanceGroupsKeytoidResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());
import dingtalk.api
req=dingtalk.api.OapiAttendanceGroupsKeytoidRequest("https://api.dingtalk.io/topapi/attendance/groups/keytoid")
req.op_user_id="123"
req.group_key="0151E022xxxx917E876"
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 OapiAttendanceGroupsKeytoidRequest;
$req->setOpUserId("123");
$req->setGroupKey("0151E02xxxx17E876");
$resp = $c->execute($req, $access_token, "https://api.dingtalk.io/topapi/attendance/groups/keytoid");
IDingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/attendance/groups/keytoid");
OapiAttendanceGroupsKeytoidRequest req = new OapiAttendanceGroupsKeytoidRequest();
req.OpUserId = "123";
req.GroupKey = "0151E0xxxx7E876";
OapiAttendanceGroupsKeytoidResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);
レスポンス
レスポンスボディ
| 名前 | タイプ | 例 | 説明 |
|---|---|---|---|
| result | Number | 685935028 | 勤怠グループ ID です。 |
| success | Boolean | true | リクエストが成功したかどうかを示します。 - true：成功 - false：失敗 |
| errcode | Number | 0 | リターンコードです。 |
| errmsg | String | ok | リターンコードの説明です。 |
| request_id | String | 3yt2gu3zz0qi | リクエスト ID です。 |
レスポンスボディの例
{
"errcode":0,
"result":685935028,
"errmsg":"ok",
"success":true,
"request_id":"3yt2gu3zz0qi"
}