> ## Documentation Index
> Fetch the complete documentation index at: https://help.dingtalk.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Mendapatkan daftar kontak eksternal

> Panggil API ini untuk mendapatkan daftar kontak eksternal organisasi di DingTalk — memudahkan admin meninjau dan mengelola kontak eksternal yang dipelihara secara terpusat.

Panggil API ini untuk mendapatkan daftar kontak eksternal sebuah organisasi.

## Permintaan

| **Informasi dasar**         |                                                                                                  |
| --------------------------- | ------------------------------------------------------------------------------------------------ |
| URL HTTP                    | [https://api.dingtalk.io/topapi/extcontact/list](https://api.dingtalk.io/topapi/extcontact/list) |
| Metode HTTP                 | POST                                                                                             |
| Tipe aplikasi yang didukung | appType-Aplikasi internalappType-Aplikasi perusahaan pihak ketiga                                |
| Izin yang diperlukan        | permission-qyapi\_ext\_read-Izin baca untuk kontak eksternal                                     |

### Parameter kueri

| Nama          | Tipe   | Wajib | Contoh   | Deskripsi                                                                                                                                                                                                                                                                                                                                              |
| ------------- | ------ | ----- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| access\_token | String | Ya    | 6d1bxxxx | Kredensial aplikasi yang digunakan untuk memanggil API ini.   - Untuk aplikasi internal, dapatkan dengan memanggil API untuk mendapatkan [access\_token aplikasi internal](/id/open/development/obtain-orgapp-token). - Untuk aplikasi perusahaan pihak ketiga, dapatkan dengan memanggil API untuk mendapatkan access\_token perusahaan pihak ketiga. |

### Isi permintaan

| Nama   | Tipe   | Wajib | Contoh | Deskripsi                                                                                                                                       |
| ------ | ------ | ----- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------- |
| size   | Number | Tidak | 20     | Mendukung kueri berpaginasi. Parameter ini hanya berlaku bila diatur bersama parameter offset. Menunjukkan ukuran halaman, dengan maksimum 100. |
| offset | Number | Tidak | 0      | Mendukung kueri berpaginasi. Parameter ini hanya berlaku bila diatur bersama parameter size. Menunjukkan offset, dimulai dari 0.                |

### Contoh permintaan

```curl theme={"theme":{"light":"github-light","dark":"github-dark"}}
curl -X POST "https://api.dingtalk.io/topapi/extcontact/list" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=b5039xxxx8bcc' \
-d 'offset=0' \
-d 'size=20'
```

Java

```text theme={"theme":{"light":"github-light","dark":"github-dark"}}
DingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/extcontact/list");
OapiExtcontactListRequest req = new OapiExtcontactListRequest();
req.setSize(20L);
req.setOffset(0L);
OapiExtcontactListResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());
```

Python

```python theme={"theme":{"light":"github-light","dark":"github-dark"}}
import dingtalk.api

req=dingtalk.api.OapiExtcontactListRequest("https://api.dingtalk.io/topapi/extcontact/list")

req.offset=0
req.size=20
try:
  resp= req.getResponse(access_token)
  print(resp)
except Exception,e:
  print(e)
```

PHP

```php theme={"theme":{"light":"github-light","dark":"github-dark"}}
include "TopSdk.php";
date_default_timezone_set('Asia/Shanghai');

$c = new DingTalkClient(DingTalkConstant::$CALL_TYPE_OAPI, DingTalkConstant::$METHOD_POST , DingTalkConstant::$FORMAT_JSON);
$req = new OapiExtcontactListRequest;
$req->setOffset("0");
$req->setSize("20");
$resp = $c->execute($req, $access_token, "https://api.dingtalk.io/topapi/extcontact/list");
```

C#

```text theme={"theme":{"light":"github-light","dark":"github-dark"}}
IDingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/extcontact/list");
OapiExtcontactListRequest req = new OapiExtcontactListRequest();
req.Offset = 0L;
req.Size = 20L;
OapiExtcontactListResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);
```

## Respons

### Isi respons

| Nama               | Tipe              | Contoh                    | Deskripsi                                                                                            |
| ------------------ | ----------------- | ------------------------- | ---------------------------------------------------------------------------------------------------- |
| results            | 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                     | Daftar tag kontak eksternal.                                                                         |
| remark             | String            | Alias content             | Alias.                                                                                               |
| address            | String            | Address content           | Alamat.                                                                                              |
| name               | String            | Zhang San                 | Nama.                                                                                                |
| follower\_user\_id | String            | 6767531692                | userid pemilik.                                                                                      |
| state\_code        | String            | 86                        | Kode negara.                                                                                         |
| company\_name      | String            | DingTalk                  | Nama perusahaan.                                                                                     |
| share\_user\_ids   | String\[]         | 042059613752              | Daftar userid karyawan yang menjadi tujuan berbagi kontak.                                           |
| mobile             | String            | 13088888888               | Nomor ponsel.  **Catatan**  Parameter ini tidak dikembalikan untuk aplikasi perusahaan pihak ketiga. |
| userid             | String            | 0123456789                | userid kontak eksternal.                                                                             |
| email              | String            | [1@1.com](mailto:1@1.com) | Alamat email.                                                                                        |
| errcode            | Number            | 0                         | Kode kembalian.                                                                                      |
| errmsg             | String            | ok                        | Deskripsi kode kembalian.                                                                            |
| request\_id        | String            | 439eqp31da45              | ID permintaan.                                                                                       |

### Contoh isi respons

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
  "errcode": 0,
  "results": [
    {
      "address": "Beijing",
      "company_name": "DingTalk",
      "email": "zhang@example.com",
      "follower_user_id": "manager4220",
      "label_ids": [
        1517
      ],
      "mobile": "1360054xxxx",
      "name": "Manajer Wang",
      "remark": "Pemimpin Teknis",
      "share_dept_ids": [
        42536
      ],
      "share_user_ids": [
        "0423752"
      ],
      "state_code": "86",
      "title": "CFO",
      "userid": "01129774889"
    }
  ],
  "request_id": "439eqp31da45"
}
```

### Kode error

Jika terjadi error saat Anda memanggil API ini, temukan solusinya di dokumen [Kode error global](/id/open/development/server-api-error-codes-1) berdasarkan pesan error.

| Kode error (errcode) | Pesan error (errmsg)   | Solusi                                    |
| -------------------- | ---------------------- | ----------------------------------------- |
| 33009                | Invalid tokenGrantType | Periksa apakah access\_token sudah benar. |
| 40069                | Invalid size           | Sesuaikan ukuran halaman.                 |
| 40068                | Invalid offset         | Sesuaikan offset.                         |
| 400001               | System error           | Coba lagi nanti.                          |