Daftar Kontak

Pengembang dapat mengambil daftar kontak di bawah akun melalui API.

Metode Permintaan

GET

URL Permintaan

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

Autentikasi

Untuk detail lebih lanjut, lihat deskripsi metode 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	Gunakan `Authorization: Basic base64(API Key:API Secret)` untuk autentikasi. Silakan buka halaman API Key untuk mendapatkan API Key dan API Secret, gabungkan keduanya dengan tanda titik dua, lalu lakukan encoding Base64.
Content-Type	application/json	Ini adalah format data permintaan. Gunakan `application/json`.

Parameter Kueri

Field	Type	Required	Description
page	integer	No	Nomor halaman. Nilai default adalah 1, dengan 15 item per halaman.
labels	string / string[]	No	Filter berdasarkan label. Mendukung beberapa label dan akan mengembalikan hasil jika salah satu label cocok.
include_contact_inboxes	boolean	No	Menentukan apakah `contact_inboxes` dikembalikan. Nilai default adalah `true`.
sort	string	No	Field pengurutan. Nilai opsional: `email`, `name`, `phone_number`, `last_activity_at`, `created_at`, `company`, `city`, `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": [ // Dikembalikan ketika include_contact_inboxes=true { "source_id": "src_001", "inbox": { "id": 10, "name": "Kanal Layanan Pelanggan", "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": [           // Dikembalikan ketika include_contact_inboxes=true
             {
              "source_id": "src_001",
              "inbox": 
              {
               "id": 10,
              "name": "Kanal Layanan Pelanggan",
              "channel_type": "Channel::Api"
              }
             }
          ]
        }
    ]
}

Tampilkan blok kode ini di jendela mengambang

Parameter Respons

Field	Type	Required	Description
meta	Object	No	Objek metadata.
count	Int	No	Jumlah hasil kueri.
current_page	Int	No	Nomor halaman hasil saat ini.
payload	Object	No	Informasi atribut.
additional_attributes	Object	No	Atribut tambahan.
availability_status	String	No	Status online. Nilai default adalah `offline`.
email	String	No	Alamat email.
id	String	No	ID kontak.
name	String	No	Nama.
phone_number	String	No	Nomor telepon.
blocked	String	No	Menunjukkan apakah diblokir. Nilai default adalah `false`.
identifier	String	No	Pengidentifikasi pengguna.
thumbnail	String	No	Thumbnail.
custom_attributes	Object	No	Atribut kustom.
created_at	String	No	Stempel waktu pembuatan.
last_activity_at	String	No	Stempel waktu aktivitas terakhir.
created_at	String	No	Stempel waktu ketika kontak ini dibuat.
contact_inboxes	array	Informasi kanal terkait, hanya dikembalikan ketika `include_contact_inboxes=true`.
source_id	String	No	ID sumber.
inbox	Object	No	Informasi kotak masuk.
id	Integer	No	ID kotak masuk.
name	String	No	Nama kotak masuk.
channel_type	String	No	Jenis kanal.

Respons Kesalahan

Parameter Respons

HTTP Status Code	Description
401	Tidak terotorisasi. Token tidak valid atau tidak ada.
403	Izin tidak mencukupi.