Buat Kontak
Pengembang dapat membuat kontak melalui API.
Metode Permintaan
POST
URL Permintaan
https://livedesk-api.engagelab.com/api/v2/accounts/contacts
Autentikasi
Untuk mengetahui detailnya, lihat petunjuk autentikasi di API Overview.
Permintaan
Contoh Permintaan
curl -X POST 'https://livedesk-api.engagelab.com/api/v2/accounts/contacts' \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic base64(api_key:api_secret)' \
-d '{
"inbox_id": 407,
"name": "Test",
"email": "alice@acme.inc",
"phone_number": "+123456789",
"avatar_url": "https://example.com/avatar.png",
"identifier": "1234567890"
}'
curl -X POST 'https://livedesk-api.engagelab.com/api/v2/accounts/contacts' \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic base64(api_key:api_secret)' \
-d '{
"inbox_id": 407,
"name": "Test",
"email": "alice@acme.inc",
"phone_number": "+123456789",
"avatar_url": "https://example.com/avatar.png",
"identifier": "1234567890"
}'
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 enkode hasilnya menggunakan Base64. |
| Content-Type | application/json | Tipe data. Gunakan application/json untuk pesan teks biasa. |
Parameter Body Permintaan
| Field | Type | Required | Description |
|---|---|---|---|
| inbox_id | String | Yes | ID saluran. Nilainya sesuai dengan Channel ID di Project Settings > Channels > Specific Channel > Settings. |
| name | String | No | Nama kontak. |
| String | No | Alamat email. | |
| phone_number | String | No | Informasi kontak. |
| avatar_url | String | No | URL avatar. |
| identifier | String | No | Pengenal pengguna. |
Respons
Contoh Respons
{
"payload": {
"contact": {
"additional_attributes": {},
"availability_status": "offline",
"email": null,
"id": 2219259,
"name": "Test",
"phone_number": null,
"blocked": false,
"identifier": null,
"thumbnail": "",
"custom_attributes": {},
"created_at": 1766571703,
"contact_inboxes": []
},
"contact_inbox": {
"inbox": null,
"source_id": null
}
}
}
{
"payload": {
"contact": {
"additional_attributes": {},
"availability_status": "offline",
"email": null,
"id": 2219259,
"name": "Test",
"phone_number": null,
"blocked": false,
"identifier": null,
"thumbnail": "",
"custom_attributes": {},
"created_at": 1766571703,
"contact_inboxes": []
},
"contact_inbox": {
"inbox": null,
"source_id": null
}
}
}
Tampilkan blok kode ini di jendela mengambang
Parameter Respons
| Field | Type | Required | Description |
|---|---|---|---|
| additional_attributes | Object | No | Atribut tambahan. |
| availability_status | String | No | Status online. Nilai default-nya adalah offline. |
| String | No | Alamat email. | |
| id | String | No | ID kontak. |
| name | String | No | Nama. |
| phone_number | String | No | Nomor telepon. |
| blocked | String | No | Menunjukkan apakah kontak diblokir. Nilai default-nya adalah false. |
| identifier | String | No | Pengenal pengguna. |
| thumbnail | String | No | Pengenal pengguna. |
| custom_attributes | String | No | Atribut pelanggan. |
| created_at | String | No | Stempel waktu pembuatan. |
| contact_inboxes | Array | No | Pengenal pengguna. |
| inbox | String | No | Saluran. |
| source_id | String | No | ID sumber. |
