Cari Kontak
Developer dapat menggunakan API LiveDesk untuk mengambil daftar kontak dalam sebuah akun dan mencari kontak berdasarkan alamat email, nomor telepon, nama, atau pengidentifikasi.
Metode Permintaan
GET
URL Permintaan
https://livedesk-api.engagelab.com/api/v2/accounts/contacts
Autentikasi
Untuk mengetahui detailnya, lihat petunjuk 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 | Lakukan autentikasi menggunakan Authorization: Basic base64(API Key:API Secret). Buka halaman API Keys untuk mendapatkan API key dan API secret, gabungkan keduanya dengan tanda titik dua, lalu enkodekan dalam Base64. |
| Content-Type | application/json | Jenis data. Gunakan application/json untuk data berformat JSON. |
Parameter Query
| Field | Type | Required | Description |
|---|---|---|---|
| q | string | No | Parameter kueri. Field atribut kontak mencakup email, phone_number, name, dan identifier. |
| page | integer | No | Nomor halaman. Nilai default adalah 1, dengan 15 item per halaman. |
| labels | string / string[] | No | Filter berdasarkan label. Mendukung beberapa label; kontak yang cocok dengan salah satu label akan dikembalikan. |
| include_contact_inboxes | boolean | No | Menentukan apakah contact_inboxes akan dikembalikan. Nilai default adalah true. |
| sort | string | No | Field 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. |
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 kueri. |
| current_page | Int | No | Nomor halaman hasil kueri. |
| payload | Object | No | Struktur properti. |
| additional_attributes | Object | No | Atribut tambahan. |
| availability_status | String | No | Status ketersediaan. Nilai default adalah offline. |
| String | No | Alamat email. | |
| id | String | No | ID kontak. |
| name | String | No | Nama. |
| phone_number | String | No | Nomor telepon. |
| blocked | String | No | Menentukan apakah kontak diblokir. Nilai default adalah false. |
| identifier | String | No | Pengidentifikasi unik eksternal kontak, sesuai dengan ID Pengguna yang ditampilkan di antarmuka. |
| thumbnail | String | No | URL avatar. |
| custom_attributes | String | No | Atribut kontak. |
| created_at | String | No | Stempel waktu pembuatan. |
| last_activity_at | String | No | Stempel waktu aktivitas terbaru. |
| contact_inboxes | Array | No | Informasi saluran terkait, hanya dikembalikan saat include_contact_inboxes=true. |
| source_id | String | No | ID saluran. |
| inbox | Object | No | Informasi saluran. |
| id | String | No | ID saluran. |
| name | String | No | Nama saluran. |
| channel_type | String | No | Jenis saluran. |
| provider | String | No | Penyedia. Misalnya, saat saluran yang digunakan adalah WhatsApp, nilainya adalah whatsapp_cloud, engagelab_whatsapp, atau twilio. Untuk saluran tanpa penyedia khusus, nilainya adalah null. |
