API de lista de grupos de enlaces (v2)

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.

GET

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


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

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": {
        "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
Código de respuesta: 0 = Éxito, otros valores = Error
message string
Mensaje de respuesta. Si el código no es 0, se devuelve un mensaje de error.
result object
extra object
Información de página y número de datos.
pages integer
Número de la página actual
nextPages integer
Número de la siguiente página
nextYn string
Indica si existe una página siguiente
count integer
Número de registros en la página actual
totalCount integer
Número total de registros
list array
Información del Grupo
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.

Cuándo usar esta API

Utiliza esta API cuando necesites el ID del grupo (grpIdx) al crear o actualizar enlaces.

Es útil cuando no tienes acceso al panel o cuando scripts automatizados deben obtener IDs de forma dinámica.

Puedes cargar todos los grupos para crear menús desplegables o buscar grupos específicos para comprobar su estado.
Más que una simple consulta, actúa como punto de inicio en el flujo de gestión de enlaces.

Uso de filtros

Pasa grpIdx para obtener un grupo específico.
El parámetro nm admite búsqueda parcial, por lo que introducir parte del nombre devuelve resultados coincidentes.

Si el nombre contiene espacios o caracteres Unicode, aplica codificación URL para obtener resultados precisos.

Estructura de respuesta y uso

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

페이지 정보 (extra)

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

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

설정 정보 포함 구조

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

예:

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

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

Casos de uso

  • Automatización: Consultar la lista de grupos antes de crear enlaces para obtener grpIdx
  • Interfaz de gestión: Cargar todos los grupos y mostrarlos como opciones en un menú desplegable
  • Búsqueda específica: Introducir parte del nombre en nm para filtrar rápidamente los grupos
  • Paginación: Incrementar pages de forma secuencial para recorrer todos los grupos

Aspectos a tener en cuenta

  • Si el parámetro nm contiene espacios o caracteres Unicode, aplica codificación URL.
    De lo contrario, los resultados de búsqueda pueden ser inexactos.
  • pages indica el número de página y comienza desde 1.
    Si nextYn es N, es la última página y puedes detener la iteración.
  • El valor idx en la respuesta es el mismo que grpIdx usado en las APIs de creación, actualización y eliminación.
    Evita confundir estos valores.