Cari Kontak

Developer dapat menggunakan API ini untuk mencari daftar kontak dalam akun. API ini mendukung pencarian berdasarkan email kontak, phone_number, nama, dan identifier.

Metode Permintaan

GET

Endpoint

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

Autentikasi

Untuk detailnya, lihat deskripsi metode autentikasi di Ikhtisar API.

Permintaan

Contoh Permintaan

curl -X GET https://livedesk-api.engagelab.com/api/v2/accounts/contacts?q=support@engagelab.com \ -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?q=support@engagelab.com \
-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. Buka halaman API Key untuk mendapatkan API Key dan API Secret, lalu gabungkan keduanya dengan tanda titik dua dan encode ke dalam Base64.
Content-Type	application/json	Tipe data. Gunakan `application/json` untuk pesan teks biasa.

Parameter Query

Field	Type	Required	Description
q	string	No	Parameter query. Field kontak yang didukung meliputi `email`, `phone_number`, `name`, dan `identifier`.
page	integer	No	Nomor halaman. Default-nya adalah `1`, dengan `15` item per halaman.
labels	string / string[]	No	Filter berdasarkan label. Mendukung beberapa label dan dicocokkan menggunakan kondisi any-match.
include_contact_inboxes	boolean	No	Apakah akan mengembalikan `contact_inboxes`. Default-nya 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`.

Contoh Respons

{ "meta": { "count": 1, "current_page": 1 }, "payload": [ { "additional_attributes": { "source_id": "email:ed5c8362-425c-4589-8adb-61a033d8c5fb.support@engagelab.com" }, "availability_status": "offline", "email": "support@engagelab.com", "id": 64464046, "name": "support", "phone_number": null, "blocked": false, "identifier": null, "thumbnail": "", "custom_attributes": {}, "last_activity_at": 1778572024, "created_at": 1778570103, "contact_inboxes": [ { "source_id": "support@engagelab.com", "inbox": { "id": 985, "channel_id": 107, "name": "Email", "channel_type": "Channel::Email", "provider": null } } ] } ] }

              
              {
    "meta": {
        "count": 1,
        "current_page": 1
    },
    "payload": [
        {
            "additional_attributes": {
                "source_id": "email:ed5c8362-425c-4589-8adb-61a033d8c5fb.support@engagelab.com"
            },
            "availability_status": "offline",
            "email": "support@engagelab.com",
            "id": 64464046,
            "name": "support",
            "phone_number": null,
            "blocked": false,
            "identifier": null,
            "thumbnail": "",
            "custom_attributes": {},
            "last_activity_at": 1778572024,
            "created_at": 1778570103,
            "contact_inboxes": [
                {
                    "source_id": "support@engagelab.com",
                    "inbox": {
                        "id": 985,
                        "channel_id": 107,
                        "name": "Email",
                        "channel_type": "Channel::Email",
                        "provider": null
                    }
                }
            ]
        }
    ]
}

Tampilkan blok kode ini di jendela mengambang

Parameter Respons

Field	Type	Required	Description
count	Int	No	Jumlah hasil pencarian.
current_page	Int	No	Nomor halaman hasil pencarian.
payload	Object	No	Struktur payload.
additional_attributes	Object	No	Atribut tambahan.
availability_status	String	No	Status online. Default-nya adalah `offline`.
email	String	No	Alamat email.
id	String	No	ID kontak.
name	String	No	Nama.
phone_number	String	No	Nomor ponsel.
blocked	String	No	Menunjukkan apakah kontak diblokir. Default-nya adalah `false`.
identifier	String	No	Identifier unik eksternal kontak, sesuai dengan UserID yang ditampilkan di antarmuka.
thumbnail	String	No	URL avatar.
custom_attributes	String	No	Atribut kontak.
created_at	String	No	Timestamp pembuatan.
last_activity_at	String	No	Timestamp aktivitas terakhir.
contact_inboxes	Array	No	Informasi channel terkait. Hanya dikembalikan saat `include_contact_inboxes=true`.
source_id	String	No	ID channel.
inbox	Object	No	Informasi channel.
id	String	No	ID channel.
name	String	No	Nama channel.
channel_type	String	No	Tipe channel.
provider	String	No	Penyedia. Misalnya, jika channel adalah WhatsApp, nilai yang sesuai adalah `whatsapp_cloud`, `engagelab_whatsapp`, atau `twilio`. Untuk channel yang tidak membedakan penyedia, nilainya adalah `null`.