Link-Gruppe erstellen

API zum Erstellen einer Linkgruppe.
Eine Linkgruppe ermöglicht es, mehrere Kurzlinks in einer gemeinsamen Gruppe zu organisieren und zu verwalten.

Wenn die Anzahl der Links wächst, kann die Verwaltung einzelner Linkeinstellungen schnell unübersichtlich werden.
Durch die Verwendung von Gruppen lassen sich Einstellungen wie Ablaufdatum, Klicklimit, Passwortschutz, Benachrichtigungen und Statistiken zentral auf Gruppenebene verwalten.

Die in einer Gruppe festgelegten Optionen gelten für alle Links innerhalb dieser Gruppe. Wenn sowohl Link- als auch Gruppeneinstellungen vorhanden sind, haben die Gruppeneinstellungen Vorrang.

Darüber hinaus können Links nach Kampagnen, Projekten oder Marketingkanälen organisiert werden, wodurch Analyse und Verwaltung auf Gruppenebene deutlich effizienter werden.

Die generierte Gruppen-ID kann in der Link-Erstellungs-API verwendet werden.

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
Name der Gruppe.
Legt den Namen der Gruppe fest, mit der Links organisiert und verwaltet werden.
memo string
Interne Notiz zur Gruppenverwaltung.
Hier können Sie den Zweck der Gruppe oder administrative Informationen frei dokumentieren.
notfSubscYn string
Default:N
Enum:
YN
Legt fest, ob der Link als Push-Benachrichtigungs-Abonnementlink erstellt wird.
Y: Erstellt einen Link speziell für Push-Benachrichtigungs-Abonnements.
N: Erstellt einen normalen Link.
Beim Aufruf eines solchen Links wird dem Benutzer eine Anfrage zur Browser-Push-Benachrichtigung angezeigt.
qrBypassYn string
Default:N
Enum:
YN
Definiert das Weiterleitungsverhalten bei Zugriff über einen QR-Code.
Y: Leitet direkt zur ursprünglichen URL weiter. (Klickstatistiken werden nicht erfasst)
N: Leitet über die Kurz-URL weiter. (Klickstatistiken werden erfasst)
blockOverseasSticsYn string
Default:N
Enum:
YN
Legt fest, ob Zugriffe aus dem Ausland von der Statistik ausgeschlossen werden.
Y: Zugriffe aus dem Ausland werden nicht in der Statistik berücksichtigt.
N: Zugriffe aus allen Ländern werden in der Statistik erfasst.
pushNotifyYn string
Default:N
Enum:
YN
Legt fest, ob Push-Benachrichtigungen basierend auf der Klickanzahl gesendet werden.
Y: Eine Push-Benachrichtigung wird gesendet, sobald der definierte Schwellenwert erreicht ist.
N: Es werden keine Push-Benachrichtigungen gesendet.
Diese Funktion ist ab dem Personal-Tarif verfügbar.
mailNotifyYn string
Default:N
Enum:
YN
Legt fest, ob E-Mail-Benachrichtigungen basierend auf der Klickanzahl gesendet werden.
Y: Eine E-Mail wird gesendet, sobald der definierte Schwellenwert erreicht ist.
N: Es werden keine E-Mails gesendet.
Diese Funktion ist ab dem Personal-Tarif verfügbar.
nonmemberSticsPwd string
Passwort zum Anzeigen der Klickstatistiken für nicht registrierte Benutzer.
Wenn Sie Statistikdaten auch für nicht registrierte Benutzer freigeben möchten, legen Sie hier das Passwort fest, das für den Zugriff auf die Statistikseite erforderlich ist.
strtYmdt datetime
Startdatum und -zeit der Linkgültigkeit.
Der Link kann erst ab dem angegebenen Zeitpunkt aufgerufen werden.
Beispiel: 2026-03-01 00:00:00
endYmdt datetime
Ablaufdatum und -zeit des Links.
Nach diesem Zeitpunkt wird der Zugriff auf den Link blockiert.
Beispiel: 2026-03-31 23:59:59
expireUrl string
URL, zu der Benutzer nach Ablauf des Links weitergeleitet werden.
Wenn kein Wert gesetzt ist, wird eine Standard-Hinweisseite angezeigt.
Beispiel: https://example.com/event-expired
pwd string
Passwort zum Zugriff auf den Link.
Wenn ein Passwort gesetzt ist, müssen Benutzer dieses eingeben, bevor sie auf die Zielseite weitergeleitet werden.
acesMaxCnt integer
Maximal zulässige Anzahl von Klicks.
Wird das festgelegte Limit überschritten, wird der Zugriff auf den Link blockiert. (0 bedeutet unbegrenzt)
webhookEnableYn string
Default:N
Enum:
YN
Legt fest, ob Webhooks aktiviert sind.
Der globale Webhook muss zuvor aktiviert sein.
Diese Funktion ist nur im Enterprise-Tarif verfügbar.
webhookCallbackUrl string
Server-URL, die Webhook-Events empfängt.
Erforderlich, wenn webhookEnableYn den Wert Y hat. Geben Sie den Endpoint Ihres Servers an, der Eventdaten empfängt.
Beispiel: https://api.example.com/webhook
webhookMetric string
Default:C
Enum:
CP
Kriterium zur Auslösung des Webhooks.
C: basierend auf Klickanzahl, P: basierend auf Benutzeranzahl (eindeutige Klicks)
webhookFrequency integer
Default:1
Enum:
1501002003005001000
Häufigkeit der Webhook-Auslösung.
1: bei jedem Klick, 50: alle 50 Klicks, 100: alle 100 Klicks, 300: alle 300 Klicks, 500: alle 500 Klicks, 1000: alle 1.000 Klicks
{
    "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
Antwortcode: 0 = Erfolgreich, jeder andere Wert = Fehler
messagestring
Antwortnachricht. Wenn der Antwortcode ungleich 0 ist, wird eine Fehlermeldung zurückgegeben.
resultobject
grpIdx integer
Gruppen-IDX.
webhookSecretKey string
Der secret key wird zurückgegeben, wenn webhookEnableYn den Wert Y hat.