CHAINHULK Developers
Website Workspace
Dokumentasi/Kontak dan identitas

Kontak dan identitas

Kelola profil pelanggan dan kaitkan identitas messenger secara eksplisit dalam satu workspace.

Profil kontak dan identitas

Satu kontak dapat memiliki beberapa identitas messenger. Setiap identitas berada pada namespace akun messenger tertentu. Nama, email, atau nomor yang sama tidak menggabungkan kontak secara otomatis.

Izin akses

  • contacts:read — membaca profil, identitas terkait, dan kandidat dari percakapan langsung.
  • contacts:write — membuat, mengubah, mengarsipkan, memulihkan, serta mengaitkan atau melepas identitas.
  • API key hanya berlaku dalam workspace tempat kunci dibuat. Pilih scope yang diperlukan melalui dashboard workspace.

Membuat kontak

POST /api/v1/workspaces/{workspace_id}/contacts memerlukan Idempotency-Key sepanjang 8–128 karakter. Permintaan baru mengembalikan 201; pengulangan dengan body yang sama mengembalikan 200. Body berbeda dengan key yang sama mengembalikan 409.

{
  "name": "Pelanggan",
  "email": "customer@example.com",
  "phone": "+6281234567890",
  "notes": ""
}

Mengaitkan identitas

Cari identitas melalui GET /contacts/identity-candidates?q=nama. POST /contacts/{id}/identities menerima conversation_id dan version kontak. Server mengambil identitas dari percakapan langsung yang sudah ada pada workspace yang sama. Identitas yang sudah terkait pada kontak lain menghasilkan 409.

{
  "conversation_id": "5f0dd5d4-367a-4cda-8458-dd691778589b",
  "version": 1
}

Perubahan dan arsip

PATCH /contacts/{id} menerima profil lengkap dan version saat ini. Perubahan bersamaan menghasilkan 409; baca kembali profil sebelum mengulang. state bernilai active atau archived. Arsip mempertahankan identitas dan riwayat percakapan. Pengaitan baru memerlukan kontak aktif.

DELETE /contacts/{id}/identities/{identity_id} menerima body berisi version. Pelepasan kaitan tidak menghapus pesan, percakapan, atau akun messenger. GET /contacts mendukung q, cursor, dan include_archived=true, dengan paling banyak 50 kontak per halaman.