開発ガイドリクエスト
| 基本情報 | |
|---|---|
| HTTP URL | https://api.dingtalk.io/topapi/attendance/group/wifis/add |
| HTTP メソッド | POST |
| 対応アプリタイプ | appType-社内アプリ |
| 権限 | permission-qyapi_attendance_group_manage-勤怠グループ管理権限 |
クエリパラメータ
| 名前 | タイプ | 必須 | 例 | 説明 |
|---|---|---|---|---|
| access_token | String | はい | 1eb68xxx | この API を呼び出すためのアプリ認証情報です。社内アプリの access_token を取得を呼び出して取得します。 |
リクエストボディ
| 名前 | タイプ | 必須 | 例 | 説明 |
|---|---|---|---|---|
| op_userid | String | いいえ | user01 | 操作者のユーザー ID です。 |
| group_key | String | はい | 0151E0xxx | 勤怠グループ ID です。 注意 勤怠グループの識別子が group_id の場合は、groupId を groupKey に変換を呼び出して group_id を group_key に変換してください。 |
| wifi_list | Wifi[] | はい | Wi-Fi のリストです。1回の呼び出しで最大100件の Wi-Fi を追加できます。 | |
| foreign_id | String | はい | office-wifi | 業務側の Wi-Fi ID です。 |
| mac_addr | String | はい | 11:11:11:11:11:11 | MAC アドレスです。 |
| ssid | String | はい | office-wifi-1 | 名前です。 |
リクエスト例
curl -X POST "https://api.dingtalk.io/topapi/attendance/group/wifis/add" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=b040xxxx34a60' \
-d 'group_key=0151E02xxxx17E876' \
-d 'op_userid=123456' \
-d 'wifi_list=null'
DingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/attendance/group/wifis/add");
OapiAttendanceGroupWifisAddRequest req = new OapiAttendanceGroupWifisAddRequest();
req.setOpUserid("123456");
req.setGroupKey("0151Exxxx17E876");
List<Wifi> list2 = new ArrayList<Wifi>();
Wifi obj3 = new Wifi();
list2.add(obj3);
obj3.setForeignId("123456");
obj3.setMacAddr("11:11:11:11:11:11");
obj3.setSsid("alibaba-guest");
req.setWifiList(list2);
OapiAttendanceGroupWifisAddResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());
import dingtalk.api
req=dingtalk.api.OapiAttendanceGroupWifisAddRequest("https://api.dingtalk.io/topapi/attendance/group/wifis/add")
req.op_userid="123456"
req.group_key="0151E022xxxx17E876"
req.wifi_list=""
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 OapiAttendanceGroupWifisAddRequest;
$req->setOpUserid("123456");
$req->setGroupKey("0151E0xxxx7E876");
$wifi_list = new Wifi;
$wifi_list->foreign_id="123456";
$wifi_list->mac_addr="11:11:11:11:11:11";
$wifi_list->ssid="alibaba-guest";
$req->setWifiList(array($wifi_list));
$resp = $c->execute($req, $access_token, "https://api.dingtalk.io/topapi/attendance/group/wifis/add");
IDingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/attendance/group/wifis/add");
OapiAttendanceGroupWifisAddRequest req = new OapiAttendanceGroupWifisAddRequest();
req.OpUserid = "123456";
req.GroupKey = "0151E0xxxx17E876";
List<OapiAttendanceGroupWifisAddRequest.WifiDomain> list2 = new List<OapiAttendanceGroupWifisAddRequest.WifiDomain>();
OapiAttendanceGroupWifisAddRequest.WifiDomain obj3 = new OapiAttendanceGroupWifisAddRequest.WifiDomain();
list2.Add(obj3);
obj3.ForeignId = "123456";
obj3.MacAddr = "11:11:11:11:11:11";
obj3.Ssid = "alibaba-guest";
req.WifiList_ = list2;
OapiAttendanceGroupWifisAddResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);
レスポンス
レスポンスボディ
| 名前 | タイプ | 例 | 説明 |
|---|---|---|---|
| result | DingOpenResult | 返却情報です。 | |
| result | Result | Wi-Fi の追加結果です。 | |
| error_info_list | ErrorInfo[] | 追加に失敗した Wi-Fi のリストです。 | |
| failure_list | Wifi[] | 失敗リストです。 | |
| foreign_id | String | alibaba-guest | 業務側の Wi-Fi ID です。 |
| mac_addr | String | 02:10:18:11:11:11 | MAC アドレスです。 |
| ssid | String | alibaba-guest1 | MAC 名です。 |
| wifi_key | String | 01xxxxE876 | 追加に失敗した Wi-Fi のキーです。 |
| msg | String | 業務エラー | エラーの説明です。 |
| code | String | 1000 | エラーコードです。 |
| success_list | Wifi[] | 追加に成功した Wi-Fi のリストです。 | |
| foreign_id | String | office-wifi | 業務側の Wi-Fi ID です。 |
| mac_addr | String | 11:11:11:11:11:11 | MAC アドレスです。 |
| ssid | String | office-wifi-1 | MAC 名です。 |
| wifi_key | String | 01xxxxE876 | 追加に成功した Wi-Fi のキーです。 |
| errcode | Number | 0 | 戻りコードです。 |
| errmsg | String | ok | 戻りコードの説明です。 |
| success | Boolean | true | 呼び出しに成功したかどうかを示します。 - true：成功 - false：失敗 |
| request_id | String | wicoxqraqt0g | リクエスト ID です。 |
レスポンスボディの例
{
"result": {
"errcode": 0,
"errmsg":"ok",
"result": {
"error_info_list": [
{
"code": "1000",
"failure_list": [
{
"foreign_id": "alibaba-guest",
"mac_addr": "02:10:18:11:11:11",
"ssid": "alibaba-guest1"
}
],
"msg": "業務エラー"
}
],
"success_list": [
{
"foreign_id": "office-wifi",
"mac_addr": "11:11:11:11:11:11",
"ssid": "office-wifi-1"
}
]
},
"success": true
},
"request_id": "10enywafok7h8"
}