Buat Grup Tautan

API untuk membuat grup tautan.
Grup tautan memungkinkan Anda mengelompokkan dan mengelola beberapa tautan pendek dalam satu grup.

Jika jumlah tautan semakin banyak, mengelola pengaturan setiap tautan secara terpisah dapat menjadi sulit.
Dengan menggunakan grup, Anda dapat menerapkan pengaturan seperti masa berlaku, batas klik, kata sandi, notifikasi, dan statistik pada tingkat grup.

Opsi yang diatur pada grup akan diterapkan ke semua tautan di dalam grup tersebut. Jika terdapat konflik antara pengaturan tautan dan pengaturan grup, maka pengaturan grup akan diprioritaskan.

Anda juga dapat mengelompokkan tautan berdasarkan kampanye, proyek, atau saluran pemasaran, sehingga analisis statistik dan pengelolaan tautan menjadi lebih efisien.

ID grup yang dihasilkan dapat digunakan dalam API pembuatan tautan.

POST

/api/link-group/v1/create

{
    "nm": "Youtube Group",
    "memo": "A group of links included in the description section of a YouTube video.",
    "nonmemberSticsPwd": "123456"
}

Request Parameters

nm string required
Nama grup.
Menentukan nama grup yang digunakan untuk mengelompokkan dan mengelola tautan.
memo string
Catatan untuk pengelolaan grup.
Anda dapat mencatat tujuan grup atau informasi pengelolaan lainnya secara bebas.
notfSubscYn string
Default:N
Enum:
YN
Menentukan apakah tautan dibuat sebagai tautan langganan notifikasi push.
Y: Membuat tautan khusus untuk langganan notifikasi push.
N: Membuat tautan biasa.
Ketika pengguna membuka tautan langganan, permintaan berlangganan notifikasi push dari browser akan ditampilkan.
qrBypassYn string
Default:N
Enum:
YN
Menentukan perilaku pengalihan saat tautan diakses melalui kode QR.
Y: Langsung dialihkan ke URL asli. (Statistik klik tidak dicatat)
N: Dialihkan melalui URL tautan pendek. (Statistik klik dicatat)
blockOverseasSticsYn string
Default:N
Enum:
YN
Menentukan apakah akses dari luar negeri dikecualikan dari statistik.
Y: Akses dari luar negeri tidak dimasukkan dalam statistik.
N: Akses dari semua negara dimasukkan dalam statistik.
pushNotifyYn string
Default:N
Enum:
YN
Menentukan apakah notifikasi push dikirim berdasarkan jumlah klik.
Y: Notifikasi push akan dikirim ketika batas yang ditentukan tercapai.
N: Notifikasi push tidak dikirim.
Fitur ini tersedia mulai dari paket Personal.
mailNotifyYn string
Default:N
Enum:
YN
Menentukan apakah notifikasi email dikirim berdasarkan jumlah klik.
Y: Email akan dikirim ketika batas yang ditentukan tercapai.
N: Email tidak dikirim.
Fitur ini tersedia mulai dari paket Personal.
nonmemberSticsPwd string
Kata sandi untuk melihat statistik klik bagi pengguna non-anggota.
Jika Anda ingin mengizinkan pengguna non-anggota melihat statistik klik, tetapkan kata sandi yang harus dimasukkan saat mengakses halaman statistik.
strtYmdt datetime
Tanggal dan waktu mulai masa berlaku tautan.
Tautan dapat diakses setelah tanggal dan waktu yang ditentukan.
Contoh: 2026-03-01 00:00:00
endYmdt datetime
Tanggal dan waktu berakhirnya masa berlaku tautan.
Setelah waktu yang ditentukan, akses ke tautan akan diblokir.
Contoh: 2026-03-31 23:59:59
expireUrl string
URL tujuan setelah tautan kedaluwarsa.
Jika tidak ditentukan, halaman pemberitahuan default akan ditampilkan.
Contoh: https://example.com/event-expired
pwd string
Kata sandi untuk mengakses tautan.
Jika ditetapkan, pengguna harus memasukkan kata sandi sebelum dapat membuka halaman tujuan.
acesMaxCnt integer
Jumlah maksimum klik yang diizinkan.
Jika batas yang ditentukan terlampaui, akses ke tautan akan diblokir. (0 berarti tanpa batas)
webhookEnableYn string
Default:N
Enum:
YN
Menentukan apakah fitur Webhook digunakan.
Webhook global harus diaktifkan terlebih dahulu.
Fitur ini hanya tersedia pada paket Enterprise.
webhookCallbackUrl string
URL server yang menerima event Webhook.
Wajib diisi ketika webhookEnableYn bernilai Y. Masukkan endpoint pada server Anda yang menerima data event.
Contoh: https://api.example.com/webhook
webhookMetric string
Default:C
Enum:
CP
Kriteria pemicu Webhook.
C: berdasarkan jumlah klik, P: berdasarkan jumlah pengguna (klik unik)
webhookFrequency integer
Default:1
Enum:
1501002003005001000
Frekuensi pengiriman 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
{
    "code": 0,
    "message": "",
    "result": {
        "grpIdx": 5066,  // group idx
        "webhookSecretKey": null  // When the ‘webhookEnableYn’ parameter is set to ‘Y’, a secret key is specified.
    }
}

Response Parameters

codeinteger
Kode respons: 0 = Berhasil, nilai lain = Error
messagestring
Pesan respons. Jika kode tidak sama dengan 0, pesan kesalahan akan dikembalikan.
resultobject
grpIdx integer
IDX grup.
webhookSecretKey string
Nilai secret key akan dikirim jika webhookEnableYn bernilai Y.