Permintaan
| Informasi dasar | |
|---|---|
| URL HTTP | https://api.dingtalk.io/topapi/extcontact/get |
| Metode HTTP | POST |
| Tipe aplikasi yang didukung | appType-Aplikasi internal, appType-Aplikasi perusahaan pihak ketiga |
| Izin | permission-qyapi_ext_read-Izin baca untuk kontak eksternal |
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 |
|---|---|---|---|---|
| user_id | String | Ya | 112500xxxx4889 | ID pengguna kontak eksternal. Panggil API Mendapatkan daftar kontak eksternal untuk mendapatkan nilai parameter userid. |
Contoh permintaan
curl -X POST "https://api.dingtalk.io/topapi/extcontact/get" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=53584xxxx2c50b' \
-d 'user_id=112500xxxx4889'
DingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/extcontact/get");
OapiExtcontactGetRequest req = new OapiExtcontactGetRequest();
req.setUserId("112500xxxx4889");
OapiExtcontactGetResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());
import dingtalk.api
req=dingtalk.api.OapiExtcontactGetRequest("https://api.dingtalk.io/topapi/extcontact/get")
req.user_id="112500xxxx4889"
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 OapiExtcontactGetRequest;
$req->setUserId("112500xxxx4889");
$resp = $c->execute($req, $access_token, "https://api.dingtalk.io/topapi/extcontact/get");
IDingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/extcontact/get");
OapiExtcontactGetRequest req = new OapiExtcontactGetRequest();
req.UserId = "112500xxxx4889";
OapiExtcontactGetResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);
Respons
Isi respons
| Nama | Tipe | Contoh | Deskripsi |
|---|---|---|---|
| result | OpenExtContact | Hasil kueri. | |
| title | String | Development Engineer | Jabatan. |
| share_dept_ids | Number[] | [1,2,3] | Daftar ID departemen yang dibagikan. |
| label_ids | Number[] | [1,2,3] | Tag. |
| remark | String | Alias content | Alias. |
| address | String | Address content | Alamat. |
| name | String | Zhang San | Nama. |
| follower_user_id | String | 6767531692 | ID pengguna pemilik. |
| state_code | String | 86 | Kode negara. |
| company_name | String | DingTalk | Nama perusahaan. |
| share_user_ids | String[] | [“042059613752”] | Daftar ID pengguna karyawan yang dibagikan. |
| mobile | String | 13088888888 | Nomor ponsel. Catatan: Parameter ini tidak dikembalikan untuk aplikasi perusahaan pihak ketiga. |
| userid | String | 0123456789 | ID pengguna kontak eksternal. |
| String | xxx@1.com | Alamat email. | |
| errcode | Number | 0 | Kode kembalian. |
| errmsg | String | ok | Deskripsi kode kembalian. |
| request_id | String | xrudojam4g8f | ID permintaan. |
Contoh respons
{
"errcode":0,
"result":{
"share_user_ids":[
"66220007745510"
],
"follower_user_id":"manager4220",
"address":"Beijing",
"share_dept_ids":[],
"label_ids":[
1561077317
],
"share_dept_ids": [
42xxxx36
],
"mobile":"136***47616",
"remark":"Technical Lead",
"title":"CFO",
"userid":"011250026469774889",
"company_name":"DingTalk",
"name":"Manager Wang",
"state_code":"86",
"email":"zhang@example.com"
},
"request_id":"xrudojam4g8f"
}
Kode error
Jika error dikembalikan saat Anda memanggil API ini, temukan solusinya di dokumen Kode error global berdasarkan pesan error.| Kode error (errcode) | Pesan error (errmsg) | Solusi |
|---|---|---|
| 33009 | Invalid tokenGrantType | Periksa apakah access_token sudah benar. |
| 33012 | Invalid userId | Periksa apakah userId sudah benar. |
| 43007 | Operation permission required | Periksa apakah access_token memiliki izin operasi yang diperlukan. |
| 400001 | System error | Coba lagi nanti. |