Permintaan
| Informasi dasar | |
|---|---|
| URL HTTP | https://api.dingtalk.io/topapi/v2/department/listsub |
| Metode HTTP | POST |
| Tipe aplikasi yang didukung | appType-Aplikasi internalappType-Aplikasi perusahaan pihak ketiga |
| Izin | permission-qyapi_get_department_list-Izin baca untuk informasi departemen di Kontak |
Parameter kueri
| Nama | Tipe | Wajib | Contoh | Deskripsi |
|---|---|---|---|---|
| access_token | String | Ya | bE74xxxx | Kredensial aplikasi yang digunakan untuk memanggil API ini. - Untuk aplikasi internal, dapatkan dengan memanggil API untuk mendapatkan access_token aplikasi internal. - Untuk aplikasi perusahaan pihak ketiga, dapatkan dengan memanggil API untuk mendapatkan access_token perusahaan pihak ketiga. |
Isi permintaan
| Nama | Tipe | Wajib | Contoh | Deskripsi |
|---|---|---|---|---|
| dept_id | Number | Tidak | 1 | ID departemen induk. Panggil API Mendapatkan daftar departemen untuk mendapatkan nilai parameter dept_id. |
| language | String | Tidak | zh_CN | Bahasa Kontak: - zh_CN (default): Bahasa Tionghoa - en_US: Bahasa Inggris |
Contoh permintaan
curl -X POST "https://api.dingtalk.io/topapi/v2/department/listsub" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=6846xxxx0cc781' \
-d 'dept_id=100' \
-d 'language=zh_CN'
DingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/v2/department/listsub");
OapiV2DepartmentListsubRequest req = new OapiV2DepartmentListsubRequest();
req.setDeptId(1L);
req.setLanguage("zh_CN");
OapiV2DepartmentListsubResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());
import dingtalk.api
req=dingtalk.api.OapiV2DepartmentListsubRequest("https://api.dingtalk.io/topapi/v2/department/listsub")
req.dept_id=100
req.language="zh_CN"
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 OapiV2DepartmentListsubRequest;
$req->setDeptId("100");
$req->setLanguage("zh_CN");
$resp = $c->execute($req, $access_token, "https://api.dingtalk.io/topapi/v2/department/listsub");
IDingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/v2/department/listsub");
OapiV2DepartmentListsubRequest req = new OapiV2DepartmentListsubRequest();
req.DeptId = 100L;
req.Language = "zh_CN";
OapiV2DepartmentListsubResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);
Respons
Isi respons
| Nama | Tipe | Contoh | Deskripsi |
|---|---|---|---|
| request_id | String | 5um7ykyaalsj | ID permintaan. |
| errcode | Number | 0 | Kode pengembalian. |
| errmsg | String | Invalid access_token | Pesan error yang dikembalikan ketika panggilan gagal. |
| result | DeptBaseResponse[] | Daftar departemen. | |
| dept_id | Number | 100 | ID departemen. |
| name | String | HR | Nama departemen. |
| parent_id | Number | 50 | ID departemen induk. |
| create_dept_group | Boolean | true | Apakah akan membuat obrolan organisasi yang terkait dengan departemen ini secara bersamaan: - true: Buat - false: Jangan buat |
| auto_add_user | Boolean | false | Setelah Obrolan Departemen dibuat, apakah anggota baru yang bergabung dengan departemen otomatis ditambahkan ke obrolan: - true: Ditambahkan otomatis - false: Tidak ditambahkan |
Contoh respons
{
"errcode": 0,
"errmsg":"ok",
"result": [
{
"auto_add_user": true,
"create_dept_group": true,
"dept_id": 37xxxx95,
"name": "Departemen Pemasaran",
"parent_id": 1
},
{
"auto_add_user": true,
"create_dept_group": true,
"dept_id": 399xxxx96,
"name": "Departemen Keuangan",
"parent_id": 1
}
],
"request_id": "5um7ykyaalsj"
}
Kode error
Jika panggilan API mengembalikan error, temukan solusinya di dokumen Kode error global berdasarkan pesan error.| Kode error (errcode) | Pesan error (errmsg) | Solusi |
|---|---|---|
| 60003 | Department not found | Pastikan dept_id sudah benar. |
| 400002 | Invalid parameter | Pastikan parameter dimasukkan sesuai ketentuan. |
| -1 | System busy | Coba lagi nanti. |