API Daftar Link Group (v2)

Mengambil daftar link group melalui API.

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

GET

/api/link-group/v2/list?nm={nm}&pages={pages} 


GET /api/link-group/v2/list
     ?nm=My+group
     &pages=1

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": {
        "extra": {
            "pages": 1,
            "nextPages": 1,
            "nextYn": "N",
            "count": 2,
            "totalCount": 2
        },
        "list": [
            {
                "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

code integer
Kode respons: 0 = Berhasil, nilai lain = Error
message string
Pesan respons. Jika kode bukan 0, pesan error akan dikembalikan.
result object
extra object
Informasi halaman dan jumlah data.
pages integer
Nomor halaman saat ini
nextPages integer
Nomor halaman berikutnya
nextYn string
Apakah ada halaman berikutnya
count integer
Jumlah data pada halaman saat ini
totalCount integer
Jumlah total data
list array
Informasi Grup
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.

Kapan menggunakan API ini

Gunakan API ini saat membutuhkan group ID (grpIdx) untuk membuat atau memperbarui link.

Cocok digunakan ketika dashboard tidak tersedia atau saat script otomatis perlu mengambil ID grup secara dinamis.

Ambil seluruh daftar grup untuk membuat UI dropdown atau cari grup tertentu untuk mengecek statusnya.
Tidak hanya untuk pengambilan data, API ini juga menjadi titik awal dalam alur pengelolaan link.

Cara menggunakan filter

Gunakan grpIdx untuk mengambil grup tertentu.
Parameter nm mendukung pencarian sebagian, sehingga cukup memasukkan sebagian nama grup untuk mendapatkan hasil yang sesuai.

Jika nama mengandung spasi atau karakter Unicode, gunakan URL encoding agar hasil lebih akurat.

Struktur respons dan cara penggunaan

이 API는 페이지 기반 구조화된 데이터를 반환합니다.
조회 결과는 단순 출력이 아니라 후속 API와 연결되는 기준 데이터로 사용됩니다.

페이지 정보 (extra)

  • pages → 현재 페이지
  • nextPages → 다음 페이지 존재 여부
  • count → 현재 페이지 데이터 수
  • totalCount → 전체 그룹 수

대량 데이터 처리 시 반복 조회 로직 구성 기준이 됩니다.

설정 정보 포함 구조

응답에는 그룹의 운영 설정도 함께 포함됩니다.

예:

  • 접근 제어 (notSubscYn, qrBypassYn)
  • 알림 (pushNotifyYn, mailNotifyYn)
  • Webhook (webhookEnableYn, webhookCallbackUrl)
  • totalCount → 전체 그룹 수

별도 조회 없이 현재 상태를 즉시 파악 가능합니다.

Contoh penggunaan

  • Pipeline otomatis: Ambil daftar grup sebelum membuat link untuk mendapatkan grpIdx
  • UI manajemen grup: Muat semua grup dan tampilkan sebagai opsi dropdown
  • Pencarian grup: Masukkan sebagian nama di nm untuk memfilter grup dengan cepat
  • Paginasi: Tingkatkan pages secara bertahap untuk menelusuri seluruh grup

Hal yang perlu diperhatikan

  • Jika parameter nm mengandung spasi atau karakter Unicode, gunakan URL encoding.
    Jika tidak, hasil pencarian bisa menjadi tidak akurat.
  • pages menunjukkan nomor halaman dan dimulai dari 1.
    Jika nextYn bernilai N, berarti halaman terakhir dan iterasi dapat dihentikan.
  • Nilai idx pada respons sama dengan grpIdx yang digunakan pada API create, update, dan delete link.
    Pastikan tidak tertukar.