QR Code API

Request Parameters

domain string required

Default:https://vvd.bz

Link domain. The default is https://vvd.bz. If brandLinkId is set, the domain switches to https://vvd.im.
If you use a custom domain, specify it here.

type string required

Default:url

Enum:

urltextphoneemailsmswifi

QR code content type.

• url: Website URL
• text: Plain text
• phone: Phone number
• email: Email (recipient, subject, body)
• sms: SMS (recipient number, message)
• wifi: Wi-Fi access (network name, security, password)

Required fields vary by type. Provide the corresponding field based on your selection.

The former field names qrEml, qrEmlTtl, qrEmlBody, qrSmsPhnNo, qrSmsBody, qrWifiSsid, qrWifiEncrypt, qrWifiPwd are still accepted but deprecated. Please switch to the names above. Sending the same field under both names returns a 400 error.

url string

Destination URL for the QR code. Required when type is url. Must be a full http or https URL.
Maximum length: 2,000 bytes.

text string

Text content embedded in the QR code. Used when type is text. The content is displayed as-is when scanned.
Suitable for messages, codes, or instructions. Display may vary by device.
Maximum length: 65,535 bytes.

phone string

Phone number triggered by the QR code. Used when type is phone. Opens the dialer on scan.
Maximum length: 32 characters. Include country code for best compatibility.
When type is sms, this is the recipient number for the text message and is required. Hyphens (-) are removed when saved.

email string

Recipient address of the email composed on scan.
Required when type is email. Maximum length: 128 characters.

emailSubject string

Email subject. Used when type is email. Maximum length: 256 characters.

emailBody string

Email body. Used when type is email. Maximum length: 65,535 bytes.

message string

Text message content. Used when type is sms; send the recipient number in phone.
Maximum length: 128 characters.

wifiSsid string

Wi-Fi network name (SSID). Required when type is wifi. Maximum length: 64 characters.

wifiEncryption string

Enum:

WPAWEPnopass

Wi-Fi security type. Used when type is wifi.

• WPA: WPA/WPA2/WPA3
• WEP: WEP
• nopass: No password

Defaults to WPA when omitted on creation.

wifiPassword string

Wi-Fi password. Used when type is wifi; leading and trailing spaces are removed when saved.
Maximum length: 32 characters. Leave empty when the security type is nopass.

logoType string

Default:N

Enum:

NCU

Logo type placed at the center of the QR code.

• N: No logo
• C: Use default logo from [Settings → Organization]
• U: Use custom uploaded logo

Adding a logo enhances brand recognition. This feature is available on Personal plans and above.

logo string

Logo image URL placed at the center of the QR code. Used when logoType is U. Must be publicly accessible.
Square images are recommended. Transparent PNG works best.

Max size: 500x500 pixels.
Example: https://example.com/images/picture/logo/500x500.png

foreground string

Foreground color of the QR code. Use HEX format (#000000). Default is black.
Maintain strong contrast with the background for reliable scanning. Default: #000000FF

background string

Background color of the QR code. Use HEX format. Default is white.
Dark backgrounds may reduce scan reliability. Default: #FFFFFFFF

markerColor string

Color of position markers (corners). Can be customized separately for visual emphasis.
Default: #000000FF

markerBorderColor string

Border color of the QR markers. Customize alongside marker color. Low contrast may affect scanning.
Default: #000000FF

style string

Default:snakes

Enum:

rectanglessmall-rectanglesdotsround rowscolumnssnakeswater

Overall QR pattern style. Each style changes the visual structure. See the dashboard preview for details.

markerStyle string

Default:round

Enum:

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

Style of position markers. Supports various shapes beyond the default square. Combine with style for custom designs.
See dashboard preview for details.

grpIdx integer

Group identifier for organizing QR codes. Helps manage links by category.
Get group IDX via Group List API or dashboard.

brandLinkId string

If not set, the system generates a link ID automatically.
Without a custom domain, the default becomes https://vvd.im.
Example: https://vvd.im/[brandLinkId]

ttl string

Link title for internal use.

memo string

Internal memo for managing links. Not visible to end users.

qrBypassYn string

Default:N

Enum:

YN

Controls whether scans bypass the short link. Y: Direct access (no tracking)
N: Via short link (tracking enabled)
Use N for analytics and access control.

pushNotifyYn string

Default:N

Enum:

YN

Send push notifications on scan.
If Y, alerts are sent when the configured threshold is reached.
Useful for real-time tracking.
Available on Personal plans and above.

mailNotifyYn string

Default:N

Enum:

YN

Send email notifications on scan.
If Y, emails are sent when thresholds are reached.
Enables instant admin alerts.
Available on Personal plans and above.

delYmdt datetime

Scheduled deletion timestamp. The link is automatically removed after this time.
Example: 2025-08-30 23:59:59