Dapatkan Daftar Kontak | LiveDesk API Contact Bahasa Indonesia

Pengembang dapat menggunakan API ini untuk mengkueri daftar kontak di bawah suatu akun.

Metode Permintaan

GET

Endpoint

https://livedesk-api.engagelab.com/api/v2/accounts/contacts

Autentikasi

Untuk detailnya, lihat panduan autentikasi di Ikhtisar API.

Permintaan

Contoh Permintaan

curl -X GET 'https://livedesk-api.engagelab.com/api/v2/accounts/contacts?include_contact_inboxes=false&page=1&sort=last_activity_at&page_size=10' \ -H 'Content-Type: application/json' \ -H 'Authorization: Basic base64(api_key:api_secret)'

              
              curl -X GET 'https://livedesk-api.engagelab.com/api/v2/accounts/contacts?include_contact_inboxes=false&page=1&sort=last_activity_at&page_size=10' \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic base64(api_key:api_secret)'

Tampilkan blok kode ini di jendela mengambang

Header Permintaan

Field	Type	Description
Authorization	string	Lakukan autentikasi dengan `Authorization: Basic base64(API Key:API Secret)`. Buka halaman API Keys untuk mendapatkan API Key dan API Secret, gabungkan keduanya dengan titik dua, lalu enkode ke dalam Base64.
Content-Type	application/json	Tipe data. Gunakan `application/json` untuk pesan teks biasa.

Parameter Query

Field	Type	Required	Description
page	integer	No	Nomor halaman. Default-nya adalah 1, dengan 15 item per halaman.
labels	string / string[]	No	Memfilter berdasarkan label. Mendukung beberapa label; kontak yang cocok dengan salah satu label akan dikembalikan.
include_contact_inboxes	boolean	No	Apakah `contact_inboxes` akan dikembalikan. Default-nya adalah `true`.
sort	string	No	Kolom pengurutan. Nilai yang tersedia: `email`, `name`, `phone_number`, `last_activity_at`, `created_at`, `company`, `city`, dan `country`.
direction	string	No	Arah pengurutan: `asc` atau `desc`.

Respons Berhasil

Contoh Respons

{ "meta": { "count": 1, "current_page": "1" }, "payload": [ { "additional_attributes": { "city": "", "country": "", "telegram": "", "description": "", "company_name": "", "country_code": "", "social_profiles": { "github": "", "twitter": "", "facebook": "", "linkedin": "", "instagram": "" } }, "availability_status": "offline", "email": "support@jiguang.cn", "id": 318763, "name": "support", "phone_number": null, "blocked": false, "identifier": "4444", "thumbnail": "", "custom_attributes": {}, "last_activity_at": 1765441908, "created_at": 1765441895, "contact_inboxes": [ { "source_id": "src_001", "inbox": { "id": 10, "name": "Customer Service Channel", "channel_type": "Channel::Api" } } ] } ] }

              
              {
  "meta": {
    "count": 1,
    "current_page": "1"
  },
  "payload": [
    {
      "additional_attributes": {
        "city": "",
        "country": "",
        "telegram": "",
        "description": "",
        "company_name": "",
        "country_code": "",
        "social_profiles": {
          "github": "",
          "twitter": "",
          "facebook": "",
          "linkedin": "",
          "instagram": ""
        }
      },
      "availability_status": "offline",
      "email": "support@jiguang.cn",
      "id": 318763,
      "name": "support",
      "phone_number": null,
      "blocked": false,
      "identifier": "4444",
      "thumbnail": "",
      "custom_attributes": {},
      "last_activity_at": 1765441908,
      "created_at": 1765441895,
      "contact_inboxes": [
        {
          "source_id": "src_001",
          "inbox": {
            "id": 10,
            "name": "Customer Service Channel",
            "channel_type": "Channel::Api"
          }
        }
      ]
    }
  ]
}

Tampilkan blok kode ini di jendela mengambang

contact_inboxes akan dikembalikan saat include_contact_inboxes=true.

Parameter Respons

Field	Type	Required	Description
meta	Object	No	Objek metadata.
count	Integer	No	Jumlah hasil kueri.
current_page	Integer	No	Nomor halaman dari hasil kueri saat ini.
payload	Object	No	Atribut kontak.
additional_attributes	Object	No	Atribut tambahan.
availability_status	String	No	Status online. Default-nya adalah `offline`.
email	String	No	Alamat email.
id	Integer	No	ID kontak.
name	String	No	Nama.
phone_number	String	No	Nomor telepon.
blocked	Boolean	No	Apakah kontak diblokir. Default-nya adalah `false`.
identifier	String	No	Pengenal pengguna.
thumbnail	String	No	Thumbnail pengguna.
custom_attributes	Object	No	Atribut kustom.
created_at	String	No	Timestamp saat kontak dibuat.
last_activity_at	String	No	Timestamp aktivitas terakhir.
contact_inboxes	Array	No	Informasi kanal kontak, hanya dikembalikan saat `include_contact_inboxes=true`.
source_id	String	No	ID sumber.
inbox	Object	No	Informasi inbox.
id	Integer	No	ID inbox.
name	String	No	Nama inbox.
channel_type	String	No	Tipe kanal.

Respons Kesalahan

Parameter Respons

HTTP Status Code	Description
401	Tidak diotorisasi. Token tidak valid atau tidak tersedia.
403	Izin tidak mencukupi.