Logo Site EngageLab Mark Colored TransparentDokumen
LiveDesk
Beranda Dokumen
IkhtisarPercakapanSaluranAgenWawasanPengaturanAPICatatan rilis
Cari
Masuk
API/Contact/Perbarui Kontak
APIContactPerbarui Kontak...

Perbarui Kontak

Terakhir diperbarui：sekitar 1 bulan yang lalu

Pengembang dapat memperbarui informasi kontak melalui API.

Metode Permintaan

PATCH

URL Permintaan

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

Autentikasi

Untuk detailnya, lihat metode autentikasi yang dijelaskan di Ikhtisar API.

Permintaan

Contoh Permintaan

curl -X PATCH https://livedesk-api.engagelab.com/api/v2/accounts/contacts/:id \ -H 'Content-Type: application/json' \ -H 'Authorization: Basic base64(api_key:api_secret)' \ -d '{ "additional_attributes": { "description": "", "company_name": "", "city": "", "telegram": "", "country": "", "country_code": "", "social_profiles": { "facebook": "", "github": "", "instagram": "", "linkedin": "", "twitter": "" } }, "availability_status": "offline", "email": "support@jiguang.cn", "name": "support", "phone_number": null, "blocked": false, "identifier": "2222", "thumbnail": "", "last_activity_at": 1765441908, "custom_attributes": { // Opsional: gabungkan dan perbarui field kustom secara inkremental "vip_level": "platinum" }, "created_at": 1765441895, "first_name": "support", "last_name": "" }'
              
              curl -X PATCH https://livedesk-api.engagelab.com/api/v2/accounts/contacts/:id \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic base64(api_key:api_secret)' \
-d '{
    "additional_attributes": {
        "description": "",
        "company_name": "",
        "city": "",
        "telegram": "",
        "country": "",
        "country_code": "",
        "social_profiles": {
            "facebook": "",
            "github": "",
            "instagram": "",
            "linkedin": "",
            "twitter": ""
        }
    },
    "availability_status": "offline",
    "email": "support@jiguang.cn",
    "name": "support",
    "phone_number": null,
    "blocked": false,
    "identifier": "2222",
    "thumbnail": "",
    "last_activity_at": 1765441908,
    "custom_attributes": {
        // Opsional: gabungkan dan perbarui field kustom secara inkremental
        "vip_level": "platinum"
    },
    "created_at": 1765441895,
    "first_name": "support",
    "last_name": ""
}'
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 Keys untuk mendapatkan API Key dan API Secret, gabungkan keduanya dengan tanda titik dua, lalu enkode menggunakan Base64.
Content-Type application/json Tipe data. Gunakan application/json untuk pesan teks biasa.

Parameter Path

Field Type Required Description
account integer Yes ID proyek LiveDesk.
id integer Yes ID kontak.

Parameter Body Permintaan

Field Type Required Description
additional_attributes Object No Atribut tambahan.
description Object No Deskripsi.
company_name String No Nama perusahaan.
city String No Kota.
telegram String No Informasi kontak Telegram.
country String No Negara.
country_code String No Kode negara.
social_profiles String No Informasi kontak media sosial.
availability_status String No Status ketersediaan. Nilai default-nya adalah offline.
email String No Alamat email.
name String No Nama.
phone_number String No Nomor telepon.
blocked Boolean No Menunjukkan apakah kontak diblokir. Nilai default-nya adalah false.
identifier String No Pengidentifikasi eksternal unik kontak, sesuai dengan UserID yang ditampilkan di antarmuka.
thumbnail String No URL avatar kontak.
last_activity_at String No Stempel waktu pembaruan terbaru.
created_at String No Stempel waktu pembuatan.
first_name String No Nama depan kontak.
last_name String No Nama belakang kontak.
custom_attributes Object No Field kustom.

Contoh Respons

{ "payload": { "additional_attributes": { "description": "", "company_name": "", "city": "", "telegram": "", "country": "", "country_code": "", "social_profiles": { "facebook": "", "github": "", "instagram": "", "linkedin": "", "twitter": "" } }, "availability_status": "offline", "email": "support@jiguang.cn", "id": 318763, "name": "support", "phone_number": null, "blocked": false, "identifier": "2222", "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" } } ] } }
              
              {
    "payload": {
        "additional_attributes": {
            "description": "",
            "company_name": "",
            "city": "",
            "telegram": "",
            "country": "",
            "country_code": "",
            "social_profiles": {
                "facebook": "",
                "github": "",
                "instagram": "",
                "linkedin": "",
                "twitter": ""
            }
        },
        "availability_status": "offline",
        "email": "support@jiguang.cn",
        "id": 318763,
        "name": "support",
        "phone_number": null,
        "blocked": false,
        "identifier": "2222",
        "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

Parameter Respons

Field Type Required Description
payload Object No Struktur atribut.
additional_attributes Object No Atribut tambahan.
availability_status String No Status ketersediaan. Nilai default-nya adalah offline.
email String No Alamat email.
id String No ID kontak.
name String No Nama.
phone_number String No Nomor telepon.
blocked Boolean No Menunjukkan apakah kontak diblokir. Nilai default-nya adalah false.
identifier String No Pengidentifikasi eksternal unik kontak, sesuai dengan UserID yang ditampilkan di antarmuka.
thumbnail String No URL avatar.
custom_attributes Object No Atribut kontak.
created_at String No Stempel waktu pembuatan.
last_activity_at String No Stempel waktu pembaruan 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 Tipe saluran.
Icon Solid Transparent White Qiyu
Hubungi Sales