API Daftar Link Group (v1)

Mengambil daftar link group melalui API.

Filter berdasarkan IDX atau nama grup, dan dapatkan grpIdx yang diperlukan untuk proses create, update, dan delete link.

Dokumentasi v1 (Legacy).

Untuk integrasi baru, kami menyarankan penggunaan versi terbaru, v2.
v1 ditujukan untuk mempertahankan integrasi yang sudah ada dan tidak mendapatkan fitur baru atau peningkatan.

GET

/api/link-group/v1/list?nm={nm} 

{
    "nm": "My+group"
}

Request Parameters

grpIdxinteger
Grup tautan (IDX).
nmstring
Grup tautan (Nama). Mendukung pencarian parsial.
Jika terdapat spasi atau karakter Unicode, disarankan menggunakan URL Encoding. 
{
    "code": 0,
    "message": "",
    "result": [
        {
            "idx":1,
            "nm":"Amazon Electronics",
            "memo":"Products between $100 and $500",
            "linkCnt":112,
            "blockOverseasSticsYn":"N",
            "notfSubscYn":"N",
            "pushNotifyYn":"N",
            "mailNotifyYn":"N",
            "webhookEnableYn": "Y",
            "webhookCallbackUrl": "https://yourdomain.com/webhook/callback/vivoldi",
            "webhookMetric": "P",
            "webhookFrequency": 1,
            "regYmdt":"2024-07-20 02:30:00",
            "modYmdt":"2024-08-15 17:45:10"
        },
        {
            "idx":2,
            "nm":"XXX Advertiser Group",
            "memo":"2-year contract",
            "linkCnt":68,
            "blockOverseasSticsYn":"N",
            "notfSubscYn":"Y",
            "qrBypassYn":"N",
            "pushNotifyYn":"Y",
            "mailNotifyYn":"N",
            "webhookEnableYn": "N",
            "webhookCallbackUrl": null,
            "webhookMetric": "C",
            "webhookFrequency": 1,
            "regYmdt":"2024-07-20 02:42:00",
            "modYmdt":"2025-02-12 11:20:50"
        }
    ]
}

Response Parameters

codeinteger
Kode respons: 0 = Berhasil, nilai lain = Error
messagestring
Pesan respons. Jika kode tidak sama dengan 0, pesan kesalahan akan dikembalikan.
resultarray
idxinteger
Group IDX.
nmstring
Nama grup.
memostring
Catatan untuk pengelolaan grup.
linkCntinteger
Jumlah tautan dalam grup.
notfSubscYnstring
Apakah ini tautan berlangganan push.
qrBypassYn string
Mengatur apakah akan melewati tautan pendek saat memindai kode QR dan langsung menuju ke URL asli yang ditentukan oleh pengguna.
Y: Langsung dialihkan ke URL asli tanpa melalui tautan pendek. (Statistik pemindaian QR tidak dicatat)
N: Melewati tautan pendek sebelum dialihkan ke URL asli. (Statistik pemindaian QR dicatat)
pushNotifyYnstring
Apakah notifikasi push untuk klik diaktifkan.
webhookEnableYn string
Enum:
YN
Status penggunaan Webhook.
webhookCallbackUrl string
URL Callback Webhook.
webhookMetric string
Enum:
CP
Kriteria penerimaan Webhook.
C: Berdasarkan jumlah klik, P: Berdasarkan jumlah pengguna unik (klik unik).
webhookFrequency integer
Enum:
1501002003005001000
Frekuensi penerimaan Webhook.
1: Setiap klik, 50: Setiap 50 klik, 100: Setiap 100 klik, 300: Setiap 300 klik, 500: Setiap 500 klik, 1000: Setiap 1.000 klik.
mailNotifyYnstring
Apakah notifikasi email untuk klik diaktifkan.
regYmdtdatetime
Tanggal pembuatan.
modYmdtdatetime
Tanggal modifikasi.