開発ガイドリクエスト
| ベーシック情報 | |
|---|---|
| HTTP URL | https://api.dingtalk.io/topapi/attendance/group/wifis/query |
| HTTP メソッド | POST |
| 対応するアプリタイプ | appType-社内アプリ |
| 必須の権限 | permission-qyapi_attendance_group_read-勤怠グループの照会権限 |
Query パラメータ
| 名前 | タイプ | 必須 | 例 | 説明 |
|---|---|---|---|---|
| access_token | String | はい | 4c9ebd2b1534xxxx | この API の呼び出しに使用するアプリ認証情報です。社内アプリの access_token を取得する API を呼び出して取得してください。 |
リクエストボディ
| 名前 | タイプ | 必須 | 例 | 説明 |
|---|---|---|---|---|
| cursor | String | いいえ | 0151E022xxxx | 前回のバッチの最後の ID です。デフォルトは空です。 |
| size | Number | はい | 50 | 1 ページあたりの件数です。 |
| op_userid | String | いいえ | user01 | 操作者のユーザー ID です。 |
| group_key | String | はい | 015xxxx | 勤怠グループ ID です。 注意 勤怠グループの識別子が group_id の場合は、groupId から groupKey への変換 API を呼び出して、group_id を group_key に変換してください。 |
リクエスト例
curl -X POST "https://api.dingtalk.io/topapi/attendance/group/wifis/query" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=698cxxxx9b13' \
-d 'cursor=0151E0xxxx17E876' \
-d 'group_key=0151Exxxx17E876' \
-d 'op_userid=123456' \
-d 'size=50'
DingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/attendance/group/wifis/query");
OapiAttendanceGroupWifisQueryRequest req = new OapiAttendanceGroupWifisQueryRequest();
req.setCursor("0151E022xxxx");
req.setSize(50L);
req.setOpUserid("user01");
req.setGroupKey("015xxxx");
OapiAttendanceGroupWifisQueryResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());
import dingtalk.api
req=dingtalk.api.OapiAttendanceGroupWifisQueryRequest("https://api.dingtalk.io/topapi/attendance/group/wifis/query")
req.cursor="0151E0xxxx917E876"
req.size=50
req.op_userid="123456"
req.group_key="0151E0xxxx917E876"
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 OapiAttendanceGroupWifisQueryRequest;
$req->setCursor("0151E0xxxxE876");
$req->setSize("50");
$req->setOpUserid("123456");
$req->setGroupKey("0151E02xxxx7E876");
$resp = $c->execute($req, $access_token, "https://api.dingtalk.io/topapi/attendance/group/wifis/query");
IDingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/attendance/group/wifis/query");
OapiAttendanceGroupWifisQueryRequest req = new OapiAttendanceGroupWifisQueryRequest();
req.Cursor = "0151E022xxxx7E876";
req.Size = 50L;
req.OpUserid = "123456";
req.GroupKey = "0151E02xxxxA917E876";
OapiAttendanceGroupWifisQueryResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);
レスポンス
レスポンスボディ
| 名前 | タイプ | 例 | 説明 |
|---|---|---|---|
| result | DingOpenResult | 返却結果です。 | |
| result | Result | Wi-Fi 一覧の取得結果です。 | |
| wifi_list | Wifi[] | Wi-Fi 一覧です。 | |
| mac_addr | String | 54:8D:xx:xx:xx:73 | MAC アドレスです。 |
| ssid | String | office-wifi | Wi-Fi の名前です。 |
| wifi_key | String | E4CB0xxxx | Wi-Fi のキーです。 |
| has_more | Boolean | true | さらにデータが存在するかどうかを示します。 - true：はい - false：いいえ |
| errcode | Number | 0 | 戻りコードです。 |
| errmsg | String | ok | 戻りコードの説明です。 |
| success | Boolean | true | 呼び出しに成功したかどうかを示します。 - true：成功 - false：失敗 |
| request_id | String | 155qyie8nxoqu | リクエスト ID です。 |
レスポンスボディの例
{
"result": {
"errcode": 0,
"errmsg":"ok",
"result": {
"has_more": false,
"wifi_list": [
{
"mac_addr": "54:8D:xx:xx:xx:73",
"ssid": "office-wifi",
"wifi_key": "E4CB0xxxx"
}
]
},
"success": true
},
"request_id": "155qyie8nxoqu"
}