Permintaan
| Informasi dasar | |
|---|---|
| URL HTTP | https://api.dingtalk.io/topapi/v2/user/getbymobile |
| Metode HTTP | POST |
| Tipe aplikasi yang didukung | appType-Aplikasi internal |
| Izin yang diperlukan | permission-qyapi_get_member_by_mobile-Izin untuk mendapatkan informasi dasar pengguna berdasarkan nomor ponsel |
Parameter kueri
| Nama | Tipe | Wajib | Contoh | Deskripsi |
|---|---|---|---|---|
| access_token | String | Ya | be3Fxxxx | Kredensial aplikasi yang digunakan untuk memanggil API ini. Dapatkan dengan memanggil API untuk mendapatkan access_token dari aplikasi internal. |
Isi permintaan
| Nama | Tipe | Wajib | Contoh | Deskripsi |
|---|---|---|---|---|
| mobile | String | Ya | 185xxxxx676 | Nomor ponsel pengguna. |
| support_exclusive_account_search | Boolean | Ya | true | Apakah mendukung pencarian Akun Perusahaan berdasarkan nomor ponsel. - true: Didukung. - false: Tidak didukung. Catatan - Hanya berlaku untuk Akun Perusahaan. - Hanya Akun Perusahaan yang dibuat oleh organisasi saat ini yang dapat dicari. |
Contoh permintaan
curl -X POST "https://api.dingtalk.io/topapi/v2/user/getbymobile" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=a16xxxxa2efbee' \
-d 'mobile=1851xxxx676' \
-d 'support_exclusive_account_search=true'
DingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/v2/user/getbymobile");
OapiV2UserGetbymobileRequest req = new OapiV2UserGetbymobileRequest();
req.setMobile("185xxxx");
OapiV2UserGetbymobileResponse rsp = client.execute(req, acces_token);
System.out.println(rsp.getBody());
import dingtalk.api
req=dingtalk.api.OapiV2UserGetbymobileRequest("https://api.dingtalk.io/topapi/v2/user/getbymobile")
req.mobile="13800138000"
req.support_exclusive_account_search=true
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 OapiV2UserGetbymobileRequest;
$req->setMobile("13800138000");
$req->setSupportExclusiveAccountSearch("true");
$resp = $c->execute($req, $access_token, "https://api.dingtalk.io/topapi/v2/user/getbymobile");
IDingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/v2/user/getbymobile");
OapiV2UserGetbymobileRequest req = new OapiV2UserGetbymobileRequest();
req.Mobile = "1851xxxx76";
req.SupportExclusiveAccountSearch = true;
OapiV2UserGetbymobileResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);
Respons
Isi respons
| Nama | Tipe | Contoh | Deskripsi |
|---|---|---|---|
| request_id | String | 5w82ciuur781 | ID permintaan. |
| errcode | Number | 0 | Kode pengembalian. |
| errmsg | String | ok | Deskripsi dari kode pengembalian. |
| result | Object | Hasil yang dikembalikan. | |
| userid | String | zhangsan | ID pengguna dari karyawan. |
| exclusive_account_userid_list | String[] | [“zxxxx”,“lixxxi”] | Daftar ID pengguna dari karyawan Akun Perusahaan. Catatan Hanya Akun Perusahaan yang dibuat oleh organisasi saat ini yang dikembalikan. |
Contoh isi respons
{
"errcode":"0",
"result":{
"exclusive_account_userid_list":"[\"zxxxx\",\"lixxxi\"]",
"userid":"zhangsan"
},
"errmsg":"ok"
}
Kode error
Jika terjadi error saat memanggil API ini, temukan solusinya di dokumen Kode error global berdasarkan pesan error.| Kode error (errcode) | Pesan error (errmsg) | Solusi |
|---|---|---|
| 400002 | Invalid parameter | Pastikan parameter diisi sesuai ketentuan dalam dokumentasi di atas. |
| 40104 | Invalid mobile number in the organization | Pastikan nomor ponsel sudah benar. |
| 60121 | User not found | Pastikan informasi diisi dengan benar. |
| -1 | System busy | Coba lagi nanti. |