QR 코드 생성 API

Request Parameters

domain string required

Default:https://vvd.bz

링크 도메인. 기본값은 https://vvd.bz이며, brandLinkId가 설정되면 도메인은 https://vvd.im이 사용됩니다.
커스텀 도메인을 사용하는 경우 해당 도메인으로 지정할 수 있습니다.

type string required

Default:url

Enum:

urltextphone

QR 코드 유형.

• url: 웹 페이지 URL
• text: 일반 텍스트
• phone: 전화번호

각 유형에 따라 필요한 입력 값이 달라지므로 type에 맞는 필드를 함께 전달해야 합니다.

url string

QR 코드 스캔 시 이동할 대상 URL. type이 url일 때 필수이며, http 또는 https 형식의 전체 URL을 입력해야 합니다.
최대 2,000 bytes까지 입력 가능합니다.

text string

QR 코드에 포함될 텍스트 내용. type이 text일 때 사용되며, 스캔 시 해당 문자열이 그대로 표시됩니다.
간단한 메시지, 코드, 안내 문구 등에 활용할 수 있고, 사용자마다 사용하는 기기에 따라 표시 방식이 다를 수 있습니다.
최대 65,535 bytes까지 입력 가능합니다.

phone string

QR 코드 스캔 시 연결될 전화번호. type이 phone일 때 사용되며, 사용자의 기기에서 전화 연결 화면이 열립니다.
최대 32자까지 입력 가능합니다. 국가번호를 포함한 형식으로 입력하는 것을 권장합니다.

logoType string

Default:N

Enum:

NCU

QR 코드 중앙에 삽입할 로고 유형.

• N: 로고 미사용
• C: [설정 → 조직] 페이지에 업로드된 기본 로고 사용
• U: 사용자 업로드 로고 사용

로고를 삽입하면 브랜드 인지도를 높일 수 있습니다. 이 기능은 퍼스널 요금제 이상에서만 제공됩니다.

logo string

QR 코드 중앙에 삽입할 로고 이미지 URL. logoType이 U인 경우 사용되며, 외부에서 접근 가능한 이미지 URL을 입력해야 합니다.
권장 크기는 정사각형이며, 배경이 투명한 이미지(PNG)를 사용하는 것이 좋습니다.

이미지 크기는 최대 500x500 픽셀입니다.
예: https://example.com/images/picture/logo/500x500.png

foreground string

QR 코드 전경 색상. HEX 컬러 코드 형식(#000000 등)으로 입력하며, 기본값은 검정색입니다.
배경색과 충분한 대비를 유지해야 스캔 인식률이 안정적으로 유지됩니다. 기본값: #000000FF

background string

QR 코드 배경 색상. HEX 컬러 코드 형식으로 입력하며, 기본값은 흰색입니다.
너무 어두운 배경을 사용할 경우 인식률이 낮아질 수 있습니다. 기본값: #FFFFFFFF

markerColor string

QR 코드의 위치 인식 마커(모서리)의 색상. 기본 패턴 색상과 별도로 설정할 수 있으며, 시각적인 강조 효과를 줄 수 있습니다.
기본값: #000000FF

markerBorderColor string

QR 코드 마커의 테두리 색상. 마커 색상과 조합하여 디자인을 커스터마이징할 수 있으며, 너무 낮은 대비는 인식에 영향을 줄 수 있습니다.
기본값: #000000FF

style string

Default:snakes

Enum:

rectanglessmall-rectanglesdotsround rowscolumnssnakeswater

QR 코드 전체 패턴 스타일. 스타일에 따라 QR 코드의 시각적 형태가 달라지며, 각 스타일을 확인하려면 대시보드에서 QR 코드 생성 화면을 참조하세요.

markerStyle string

Default:round

Enum:

rectanglesroundcirclesdrop-in drop-outround-inround-outedge-in edge-out

QR 코드의 위치 인식 마커 스타일. 기본 사각형 외에도 다양한 형태를 지원하며, 스타일과 조합하여 디자인을 구성할 수 있습니다.
각 스타일을 확인하려면 대시보드에서 QR 코드 생성 화면을 참조하세요.

grpIdx integer

QR 코드를 특정 그룹에 포함시키기 위한 식별자. 그룹을 활용하면 QR 코드 및 링크를 카테고리별로 관리할 수 있습니다.
그룹IDX는 그룹 목록 API를 호출하거나 대시보드에서 확인할 수 있습니다.

brandLinkId string

이 값이 설정되지 않으면 링크ID는 시스템에서 자동으로 생성됩니다.
커스텀 도메인을 사용하지 않는 경우, 기본 도메인은 https://vvd.im 입니다.
예: https://vvd.im/[brandLinkId]

ttl string

링크 제목. 내부 관리 용도로 사용될 수 있습니다.

memo string

링크 관리용 메모. 사용자에게 노출되지 않으며, 내부 관리 및 구분을 위해 사용됩니다.

qrBypassYn string

Default:N

Enum:

YN

QR 코드 스캔 시 단축 URL을 거치지 않고, 사용자가 설정한 원본 URL로 직접 이동할지 여부를 설정합니다.
Y: 원본 URL로 직접 이동합니다. (QR 스캔 통계 미기록)
N: 단축 URL을 거친 후 원본 URL로 이동합니다. (QR 스캔 통계 기록됨)
보안 또는 접근 제어가 필요한 경우 N 설정을 권장합니다.

blockOverseasSticsYn string

Default:N

Enum:

YN

해외통계 차단 여부. 한국 외 국가에서 접속하면 클릭 수는 집계되지 않습니다.

pushNotifyYn string

Default:N

Enum:

YN

QR 코드 스캔 시 푸시 알림 전송 여부.
값이 Y이면 대시보드의 [설정 -> 환경 설정]에서 지정한 클릭 수에 도달할 때마다 비볼디 앱이 설치된 기기로 알림이 전송됩니다.
실시간 사용자 반응을 확인하거나 이벤트 트래킹에 활용할 수 있습니다.
이 기능은 퍼스널 요금제 이상에서만 제공됩니다.

mailNotifyYn string

Default:N

Enum:

YN

QR 코드 스캔 시 메일 알림 전송 여부.
값이 Y이면 [설정 -> 환경 설정]에서 지정한 클릭 수에 도달할 때마다 이메일로 알림이 전송됩니다.
특정 이벤트 발생 시 관리자가 즉시 확인할 수 있도록 도와줍니다.
이 기능은 퍼스널 요금제 이상에서만 제공됩니다.

delYmdt datetime

링크 삭제 예약 일시입니다. 지정한 날짜가 지나면 링크는 시스템에 의해 자동으로 삭제됩니다.
예: 2025-08-30 23:59:59