All Products
Search
Document Center

Quick Audience:Spesifikasi API Pelaporan Event 3.0

Last Updated:Jun 29, 2025

Pada April 2024, Quick Audience memperbarui API 3.0 untuk pelaporan event. Dalam versi 3.0 dibandingkan dengan API 2.0, Quick Audience mendukung event multi-entitas dan dapat memberikan izin fleksibel untuk memanggil aplikasi.

Operasi ini didasarkan pada API Platform Terbuka Quick Audience. Sebelum digunakan, ikuti petunjuk dalam dokumen ini untuk menyelesaikan debugging API platform terbuka Quick Audience. Untuk informasi lebih lanjut tentang prosedur dan persyaratan, lihat API Platform Terbuka Quick Audience.

Catatan

Hanya SDK untuk Java yang disediakan.

Antarmuka pelaporan data event

Catatan penggunaan

Sinkronisasi event real-time

URL

/openapi/cloud/event/detail/receive

Metode permintaan

post

Parameter

Tipe Data Edisi

Tipe data

Diperlukan

Deskripsi

1.accessId

string

body form-data

Ya

ID Organisasi / ID Tenant. Contoh nilai: 8f3554 ba-a242-4436-8354-90672bfc76ea.

2.eventMessageModelListJson

string

Ya

Lihat Model Event ClientEventMessageModel di bawah ini untuk detailnya.

Kode status

Deskripsi

200

Permintaan API berhasil.

Lainnya

Permintaan gagal

Nama Properti Kembali

Item

Deskripsi migrasi

1.traceId

string

ID unik dari permintaan, yang digunakan untuk melokalisasi masalah pada tautan.

2.success

boolean

Apakah pemrosesan server berhasil.

3.errorCode

string

Kode kesalahan.

4.errorDesc

string

Pesan kesalahan.

5.data

string

true/false

Contoh

Parameter permintaan

curl --location --request POST 'http://endpoint/openapi/cloud/event/detail/receive?appId=673198870988276864&timestamp=1708235644862&accessKey=ec22d92d8dd142b8b39b23b39bc8b39c' \
--header 'Authorization: 27316d96901ab5a901ef7dbc0a8a38a5' \
--form 'eventMessageModelListJson="[]"' \
--form 'accessId="480002d3-bdc8-4244-9e20-c2d04c711583"'

Nilai kembali

{

"data": true,

"errorCode": null,

"errorDesc": null,

"success": true,

"traceId": "ff0f996e-6c63-412d-a4cd-acf5d00775cd"

}

Model Event ClientEventMessageModel

@Data
public class ClientEventMessageModel {

    /**
     * ID Organisasi, wajib.
     */
    String organizationId;

    /**
     * ID ruang kerja. Parameter ini opsional.
     */
    String workspaceId;

    /**
     * ID pengguna dari sistem Anda sendiri. Parameter ini wajib.
     */
    String customerId;

    /**
     * Jika ID entitas adalah entitas manusia, parameter ini opsional.
     Wajib jika merupakan entitas lain (seperti entitas mobil)
   */
    String entityId;

    /**
     * Kode event. Bidang ini wajib.
     */
    String eventCode;

    /**
     * Waktu terjadinya event. Bidang ini wajib.
     */
    Long eventTime;

    /**
     * Properti event. Apakah parameter ini diperlukan bergantung pada pengaturan properti dalam definisi event.
     */
    Map<String, String> extendAttributes = new HashMap<>();

    /**
     * ID pengguna yang didukung oleh Quick Audience. Jika customerId yang sama telah dilaporkan sebelumnya, parameter ini opsional.
     */
    List<CustomerIdModel> customerIdList = new ArrayList<>();

    /**
     * Apakah ini data transaksi, 0 (tidak) / 1 (ya)
     */
    String isOrder;
}

@Data
public class CustomerIdModel {
    String customerId;
    String idMapping;
    public CustomerIdModel() {
    }
    public CustomerIdModel(String customerId, String idMapping) {
        this.customerId = customerId;
        this.idMapping = idMapping;
    }
}

Cara mendapatkan entityId: Buka Manajemen Konfigurasi - Manajemen Entitas di konsol untuk melihat query?_=xxxx API guna melihat entityCode.

image

CustomerIdModel:

public class CustomerIdModel {
    @ ApiModelProperty(required = true, value = "ID pengguna aktual, seperti 139****0000")
    String customerId;
    @ ApiModelProperty(required = true, value = "Tipe ID pengguna, seperti nomor telepon, lihat deskripsi tipe ID pengguna di bawah ini")
    String idMapping;
}

Deskripsi Tipe ID Pengguna:

Quick Audience mendukung semua tipe ID pengguna yang diaktifkan di halaman Manajemen Tipe ID dari ruang kerja. Anda harus menggunakan kode tipe ID sebagai nama tipe ID dalam kode.

  • Kode tipe ID dari ID sistem preset. Untuk informasi lebih lanjut, lihat Daftar ID Sistem Preset.

  • Kode tipe ID dari ID kustom. Untuk melihat kode tipe ID, klik Edit di kolom Tindakan yang sesuai dengan ID kustom.