Deskripsi panggilan API
API ini tidak dibatasi oleh Cakupan izin Kontak.Permintaan
| Informasi dasar | |
|---|---|
| URL HTTP | https://api.dingtalk.io/topapi/user/count |
| Metode HTTP | POST |
| Tipe aplikasi yang didukung | appType-Aplikasi internal, appType-Aplikasi perusahaan pihak ketiga |
| Izin yang diperlukan | permission-qyapi_get_member-Izin baca untuk informasi pengguna |
Parameter kueri
| Nama | Tipe | Wajib | Contoh | Deskripsi |
|---|---|---|---|---|
| access_token | String | Ya | bE74xxxx | Kredensial aplikasi yang digunakan untuk memanggil API ini. - Untuk aplikasi internal, dapatkan melalui API untuk mendapatkan access_token aplikasi internal. - Untuk aplikasi perusahaan pihak ketiga, dapatkan melalui API untuk mendapatkan access_token perusahaan pihak ketiga. |
Isi permintaan
| Nama | Tipe | Wajib | Contoh | Deskripsi |
|---|---|---|---|---|
| only_active | Boolean | Ya | false | Apakah menyertakan jumlah karyawan yang belum mengaktifkan DingTalk: - false: Menyertakan karyawan yang belum mengaktifkan DingTalk. - true: Hanya menyertakan karyawan yang telah mengaktifkan DingTalk. |
Contoh permintaan
curl -X POST "https://api.dingtalk.io/topapi/user/count" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=7a1bee78-57cb-4a05-9316-0341b1ca303f' \
-d 'only_active=false'
DingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/user/count");
OapiUserCountRequest req = new OapiUserCountRequest();
req.setOnlyActive(false);
OapiUserCountResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());
import dingtalk.api
req=dingtalk.api.OapiUserCountRequest("https://api.dingtalk.io/topapi/user/count")
req.only_active=false
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 OapiUserCountRequest;
$req->setOnlyActive("false");
$resp = $c->execute($req, $access_token, "https://api.dingtalk.io/topapi/user/count");
IDingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/user/count");
OapiUserCountRequest req = new OapiUserCountRequest();
req.OnlyActive = false;
OapiUserCountResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);
Respons
Isi respons
| Nama | Tipe | Contoh | Deskripsi |
|---|---|---|---|
| request_id | String | o38h5bztjouc | ID permintaan. |
| errcode | Number | 0 | Kode status. 0 menunjukkan bahwa panggilan berhasil. |
| errmsg | String | Invalid access_token | Pesan error yang dikembalikan saat panggilan gagal. |
| result | CountUserResponse | Hasil yang dikembalikan. | |
| count | Number | 4 | Jumlah karyawan. |
Contoh isi respons
{
"errcode": 0,
"errmsg":"ok",
"result": {
"count": 4
},
"request_id": "40k5v0mgbzyh"
}
Kode error
Jika terjadi error saat Anda memanggil API ini, lihat dokumen Kode error global untuk menemukan solusi berdasarkan pesan error.| Kode error (errcode) | Pesan error (errmsg) | Solusi |
|---|---|---|
| 400002 | Parameter is empty | Pastikan semua parameter wajib telah disediakan. |
| 40035 | Invalid parameter | Pastikan parameter memenuhi persyaratan dalam dokumentasi di atas. |
| -1 | System busy | Coba lagi nanti. |