API de lista de grupos de enlaces (v1)

Obtén la lista de grupos de enlaces mediante API.

Filtra por IDX o nombre del grupo y obtén el grpIdx necesario para crear, actualizar o eliminar enlaces.

Documentación v1 (Legacy).

Para nuevas integraciones, recomendamos utilizar la versión más reciente, v2.
v1 está destinada al mantenimiento de integraciones existentes y no recibe nuevas funciones ni mejoras.

GET

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

{
    "nm": "My+group"
}

Request Parameters

grpIdxinteger
Grupo de enlaces (IDX).
nmstring
Grupo de enlaces (Nombre). Se admite búsqueda parcial.
Si incluye espacios o caracteres Unicode, se recomienda la codificación URL. 
{
    "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
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.
resultarray
idxinteger
Grupo IDX.
nmstring
Nombre del grupo.
memostring
Nota para la gestión del grupo.
linkCntinteger
Número de enlaces en el grupo.
notfSubscYnstring
Indica si es un enlace de suscripción push.
qrBypassYn string
Controla si se debe omitir el enlace corto al escanear un código QR y acceder directamente a la URL original configurada por el usuario.
Y: Redirige directamente a la URL original sin pasar por el enlace corto. (No se registran estadísticas de escaneo QR)
N: Pasa por el enlace corto antes de redirigir a la URL original. (Se registran estadísticas de escaneo QR)
pushNotifyYnstring
Indica si las notificaciones push de clics están activadas.
mailNotifyYnstring
Indica si las notificaciones por correo de clics están activadas.
webhookEnableYn string
Enum:
YN
Activación del Webhook.
webhookCallbackUrl string
URL de Callback del Webhook.
webhookMetric string
Enum:
CP
Criterio de recepción del Webhook.
C: Basado en número de clics, P: Basado en usuarios únicos (clics únicos).
webhookFrequency integer
Enum:
1501002003005001000
Frecuencia de recepción 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.
regYmdtdatetime
Fecha de creación.
modYmdtdatetime
Fecha de modificación.