Panduan pengembangPermintaan
| Informasi dasar | |
|---|---|
| URL HTTP | https://api.dingtalk.io/topapi/extcontact/listlabelgroups |
| Metode HTTP | POST |
| Tipe aplikasi yang didukung | appType-Aplikasi internal appType-Aplikasi perusahaan pihak ketiga |
| Izin yang diperlukan | permission-qyapi_ext_read-Izin baca untuk kontak eksternal organisasi |
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 |
|---|---|---|---|---|
| size | Number | Tidak | 20 | Mendukung penomoran halaman. Hanya berlaku jika ditetapkan bersama parameter offset. Parameter ini menunjukkan ukuran halaman, dengan maksimum 100. |
| offset | Number | Tidak | 0 | Mendukung penomoran halaman. Hanya berlaku jika ditetapkan bersama parameter size. Parameter ini menunjukkan offset, yang dimulai dari 0. |
Contoh permintaan
curl -X POST "https://api.dingtalk.io/topapi/extcontact/listlabelgroups" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=e6eaxxxxa401' \
-d 'offset=0' \
-d 'size=20'
DingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/extcontact/listlabelgroups");
OapiExtcontactListlabelgroupsRequest req = new OapiExtcontactListlabelgroupsRequest();
req.setSize(20L);
req.setOffset(0L);
OapiExtcontactListlabelgroupsResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());
import dingtalk.api
req=dingtalk.api.OapiExtcontactListlabelgroupsRequest("https://api.dingtalk.io/topapi/extcontact/listlabelgroups")
req.size=20
req.offset=0
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 OapiExtcontactListlabelgroupsRequest;
$req->setSize("20");
$req->setOffset("0");
$resp = $c->execute($req, $access_token, "https://api.dingtalk.io/topapi/extcontact/listlabelgroups");
IDingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/extcontact/listlabelgroups");
OapiExtcontactListlabelgroupsRequest req = new OapiExtcontactListlabelgroupsRequest();
req.Size = 20L;
req.Offset = 0L;
OapiExtcontactListlabelgroupsResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);
Respons
Isi respons
| Nama | Tipe | Contoh | Deskripsi |
|---|---|---|---|
| results | OpenLabelGroup[] | Hasil kueri. | |
| name | String | Tipe | Nama grup tag. |
| color | Number | -15220075 | Warna grup tag. |
| labels | OpenLabel[] | Daftar tag. | |
| name | String | Pelanggan | Nama tag. |
| id | Number | 1026002 | ID tag. |
| errcode | Number | 0 | Kode pengembalian. |
| request_id | String | 8n3mksu5hqzy | ID permintaan. |
Contoh isi respons
{
"errcode":0,
"results":[
{
"color":-15220075,
"name":"Tipe",
"labels":[
{
"name":"Pelanggan",
"id":1561077310
},
{
"name":"Mitra saluran",
"id":1561077311
},
{
"name":"Pemasok",
"id":1561077312
},
{
"name":"Mitra",
"id":1561077313
},
{
"name":"Kandidat wawancara",
"id":1561077314
},
{
"name":"Tipe lainnya",
"id":1561077315
}
]
},
{
"color":-11687445,
"name":"Tingkat",
"labels":[
{
"name":"Umum",
"id":1561077317
},
{
"name":"Penting",
"id":1561077318
},
{
"name":"Inti",
"id":1561077319
}
]
},
{
"color":-543394,
"name":"Status",
"labels":[
{
"name":"Potensial",
"id":1561077321
},
{
"name":"Tertarik",
"id":1561077322
},
{
"name":"Dalam negosiasi",
"id":1561077323
},
{
"name":"Kesepakatan tercapai",
"id":1561077324
},
{
"name":"Hilang",
"id":1561077325
}
]
},
{
"color":-543394,
"name":"Status rekrutmen",
"labels":[
{
"name":"Akan diundang",
"id":1561077327
},
{
"name":"Akan diwawancarai",
"id":1561077328
},
{
"name":"Wawancara putaran pertama",
"id":1561077329
},
{
"name":"Wawancara putaran kedua",
"id":1561077330
},
{
"name":"Sudah bergabung",
"id":1561077331
}
]
}
],
"request_id":"51jof1jt5f4t"
}
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. |
| 400043 | Invalid orgId | Periksa apakah access_token sudah benar. |
| 41101 | Invalid size | Periksa apakah ukuran halaman valid. |
| 40068 | Invalid offset | Sesuaikan offset. |
| -1 | System busy | Coba lagi nanti. |