Crear Grupo de Enlaces

API para crear un grupo de enlaces.
Un grupo de enlaces permite organizar y administrar múltiples enlaces cortos dentro de un mismo grupo.

Cuando el número de enlaces aumenta, administrar la configuración de cada enlace individualmente puede volverse complicado.
Al agrupar los enlaces, puedes aplicar configuraciones como fecha de expiración, límite de clics, contraseña, notificaciones y estadísticas a nivel de grupo.

Las opciones configuradas en el grupo se aplican a todos los enlaces incluidos en ese grupo. Si existen configuraciones tanto a nivel de enlace como de grupo, la configuración del grupo tiene prioridad.

También puedes organizar enlaces por campaña, proyecto o canal de marketing, lo que facilita el análisis y la gestión de enlaces a nivel de grupo.

El ID del grupo generado puede utilizarse en la API de creación de enlaces.

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
Nombre del grupo.
Define el nombre del grupo utilizado para organizar y administrar enlaces.
memo string
Nota interna del grupo.
Puedes registrar libremente información de administración o el propósito del grupo.
notfSubscYn string
Default:N
Enum:
YN
Define si el enlace será un enlace de suscripción a notificaciones push.
Y: Se crea un enlace exclusivo para suscripción a notificaciones push.
N: Se crea un enlace normal.
Cuando un usuario accede a un enlace de suscripción, se mostrará una solicitud para suscribirse a notificaciones push del navegador.
qrBypassYn string
Default:N
Enum:
YN
Define el comportamiento de redirección al acceder mediante un código QR.
Y: Redirige directamente a la URL original. (No se registran estadísticas de clics)
N: Redirige a la URL corta. (Los clics sí se registran en las estadísticas)
blockOverseasSticsYn string
Default:N
Enum:
YN
Define si se excluyen accesos internacionales de las estadísticas.
Y: Los accesos desde el extranjero no se incluyen en las estadísticas.
N: Los accesos desde todos los países se incluyen en las estadísticas.
pushNotifyYn string
Default:N
Enum:
YN
Define si se envían notificaciones push basadas en el número de clics.
Y: Se enviará una notificación push cuando se alcance el umbral configurado.
N: No se enviarán notificaciones push.
Esta función está disponible a partir del plan Personal.
mailNotifyYn string
Default:N
Enum:
YN
Define si se envían notificaciones por correo electrónico basadas en el número de clics.
Y: Se enviará un correo cuando se alcance el umbral configurado.
N: No se enviarán correos electrónicos.
Esta función está disponible a partir del plan Personal.
nonmemberSticsPwd string
Contraseña para consultar estadísticas de clics como usuario no registrado.
Si deseas permitir que usuarios no registrados vean las estadísticas, establece la contraseña requerida para acceder a la página de estadísticas.
strtYmdt datetime
Fecha y hora de inicio de validez del enlace.
El enlace podrá utilizarse a partir de la fecha y hora especificadas.
Ejemplo: 2026-03-01 00:00:00
endYmdt datetime
Fecha y hora de expiración del enlace.
Después de la fecha indicada, el acceso al enlace será bloqueado.
Ejemplo: 2026-03-31 23:59:59
expireUrl string
URL a la que se redirige cuando el enlace ha expirado.
Si no se especifica, se mostrará una página de aviso predeterminada.
Ejemplo: https://example.com/event-expired
pwd string
Contraseña para acceder al enlace.
Si se establece, los usuarios deberán introducir la contraseña antes de acceder al destino.
acesMaxCnt integer
Número máximo de clics permitidos.
Si se supera el límite establecido, el acceso al enlace será bloqueado. (0 significa sin límite)
webhookEnableYn string
Default:N
Enum:
YN
Define si se utiliza Webhook.
El Webhook global debe estar habilitado.
Esta función solo está disponible en el plan Enterprise.
webhookCallbackUrl string
URL del servidor que recibirá los eventos Webhook.
Es obligatorio cuando webhookEnableYn es Y. Introduce el endpoint de tu servidor que recibirá los datos del evento.
Ejemplo: https://api.example.com/webhook
webhookMetric string
Default:C
Enum:
CP
Criterio para activar el Webhook.
C: basado en el número de clics, P: basado en el número de usuarios (clics únicos)
webhookFrequency integer
Default:1
Enum:
1501002003005001000
Frecuencia de envío del Webhook.
1: cada clic, 50: cada 50 clics, 100: cada 100 clics, 300: cada 300 clics, 500: cada 500 clics, 1000: cada 1,000 clics
{
    "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
Código de respuesta: 0 = Éxito, cualquier otro valor = Error
messagestring
Mensaje de respuesta. Si el código no es 0, se devuelve un mensaje relacionado con el error.
resultobject
grpIdx integer
IDX del grupo.
webhookSecretKey string
Se devuelve una secret key cuando webhookEnableYn tiene el valor Y.