링크 생성
단축 링크를 생성하는 기본 API입니다.
여러 링크를 한 번에 생성하려면 Bulk Create API를 사용하거나, 대시보드의 [대량 링크 만들기] 메뉴를 이용하세요.
모든 단축 링크에는 QR 코드가 자동 생성됩니다.
- QR 코드는 https://vvd.bz/
[linkId]
/qr 형태로 확인할 수 있으며, size 파라미터로 크기를 조정할 수 있습니다. - 예: https://vvd.bz/hj7V/qr?size=200 → 200px 크기의 QR 코드 반환.
POST
/api/link/v2/create
{
"url": "https://www.facebook.com/vivoldi365",
"domain": "https://vvd.bz"
}
Request Parameters
- urlstringrequired
- 원본 URL. 최대 3,000 bytes까지 입력 가능합니다.
- domainstringrequired
- Default:https://vvd.bz
- 링크 도메인. “brandLinkId” 옵션이
Y
일 경우 도메인은https://vvd.im
입니다.
커스텀 도메인을 입력할 수도 있습니다. - redirectTypeinteger
- Default:302
- Enum:200301302
- Redirect 방식. 자세한 내용는 주요 용어 페이지에서 확인하세요.
이 기능은 퍼스널 요금제 이상에서만 제공됩니다.
- grpIdxinteger
- 링크를 그룹화할 때 사용됩니다. 그룹IDX는 그룹 목록 API를 호출하거나 대시보드에서 확인할 수 있습니다.
- brandLinkIdstring
- 이 값이 설정되지 않으면 링크ID는 시스템에서 자동으로 생성됩니다.
커스텀 도메인을 사용하지 않는 경우, 기본 링크 도메인은https://vvd.im
입니다.
예: https://vvd.im/[brandLinkId] - ttlstring
- 링크 제목입니다. 값이 지정되지 않으면 원본 URL의 웹페이지 제목이 자동으로 사용됩니다.
빠른 링크 생성을 원한다면 값을 직접 지정하여 불필요한 파싱 과정을 줄이세요.
- descriptionstring
redirectType
값이200
일 경우, description 메타 태그를 설정할 수 있습니다.- metaImgstring
redirectType
값이200
일 경우, image 메타 태그를 설정할 수 있습니다.
이미지 URL은 반드시https://
로 시작해야 합니다.- memostring
- 링크 관리용 메모입니다.
- notfSubscYnstring
- Default:N
- Enum:YN
- 푸시구독 링크 여부입니다. 값이
Y
이면 원본 URL로 이동되기 전에 랜딩 페이지가 열리며, 사용자에게 푸시 알림 권한을 요청합니다.
사용자가 권한을 거부하거나 취소하면 즉시 원본 URL로 이동됩니다. - blockOverseasSticsYnstring
- Default:N
- Enum:YN
- 해외통계 차단 여부입니다. 한국 외 국가에서 접속하면 클릭 수는 집계되지 않습니다.
- pushNotifyYnstring
- Default:N
- Enum:YN
- 클릭 수 푸시 알림 여부입니다. 값이
Y
이면 대시보드의 [설정 -> 환경 설정]에서 지정한 클릭 수에 도달할 때마다 비볼디 앱이 설치된 기기로 알림이 전송됩니다.이 기능은 퍼스널 요금제 이상에서만 제공됩니다.
- mailNotifyYnstring
- Default:N
- Enum:YN
- 클릭 수 메일 알림 여부입니다. 값이
Y
이면 [설정 -> 환경 설정]에서 지정한 클릭 수에 도달할 때마다 이메일로 알림이 전송됩니다.이 기능은 퍼스널 요금제 이상에서만 제공됩니다.
- delYmdtdatetime
- 링크 삭제 예약 일시입니다. 지정한 날짜가 지나면 링크는 시스템에 의해 자동으로 삭제됩니다.
예: 2025-08-30 23:59:59
{
"code": 0,
"message": "",
"result": "https://vvd.bz/jH3d"
}
Response Parameters
- codeinteger
- 응답 코드: 0 = 성공, 그 외 값 = 오류
- messagestring
- 응답 메시지입니다. 응답 코드가 0이 아니면, 오류 관련 메시지가 반환됩니다.
- resultstring
- 응답 값입니다. 단축된 링크가 반환됩니다.
예: https://vvd.bz/jH3d