QRコード生成API

Request Parameters

domain string required

Default:https://vvd.bz

リンクドメイン。 デフォルトは https://vvd.bz です。brandLinkId を設定すると、ドメインは https://vvd.im に切り替わります。
カスタムドメインを使用する場合は、該当ドメインを指定できます。

type string required

Default:url

Enum:

urltextphoneemailsmswifi

QRコードの種類。

• url: WebページURL
• text: テキスト
• phone: 電話番号
• email: メール作成（宛先・件名・本文）
• sms: SMS（宛先番号・本文）
• wifi: Wi-Fi接続（ネットワーク名・セキュリティ・パスワード）

タイプに応じて必要なフィールドが異なるため、対応する値を設定してください。

以前の項目名 qrEml, qrEmlTtl, qrEmlBody, qrSmsPhnNo, qrSmsBody, qrWifiSsid, qrWifiEncrypt, qrWifiPwd も受け付けますが、廃止予定です。上記の名前に変更してください。同じ項目を両方の名前で送ると 400 エラーになります。

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文字。国番号付きの形式を推奨します。
type が sms の場合は SMS の宛先番号で、必須です。ハイフン（-）は保存時に削除されます。

email string

スキャン時に作成されるメールの宛先アドレス。
type が email の場合は必須です。最大 128文字 まで入力できます。

emailSubject string

メールの件名。type が email の場合に使用されます。最大 256文字 まで入力できます。

emailBody string

メールの本文。type が email の場合に使用されます。最大 65,535 bytes まで入力できます。

message string

SMS の本文。type が sms の場合に使用され、宛先番号は phone で送ります。
最大 128文字 まで入力できます。

wifiSsid string

Wi-Fi ネットワーク名（SSID）。type が wifi の場合は必須です。最大 64文字 まで入力できます。

wifiEncryption string

Enum:

WPAWEPnopass

Wi-Fi のセキュリティ方式。type が wifi の場合に使用されます。

• WPA: WPA/WPA2/WPA3
• WEP: WEP
• nopass: パスワードなし

作成時に省略すると WPA になります。

wifiPassword string

Wi-Fi のパスワード。type が wifi の場合に使用され、前後の空白は保存時に削除されます。
最大 32文字 まで入力できます。セキュリティ方式が nopass の場合は空にします。

logoType string

Default:N

Enum:

NCU

QRコード中央に配置するロゴの種類。

• N: ロゴなし
• C: 組織設定のデフォルトロゴ
• U: カスタムロゴ

ロゴを追加するとブランド認知が向上します。本機能はパーソナルプラン以上で利用可能です。

logo string

QRコード中央に表示するロゴ画像URL。 logoType が U の場合に使用します。外部公開されたURLを指定してください。
正方形・透過PNGを推奨。最大サイズは500x500pxです。

foreground string

QRコードの前景色（HEX形式）。デフォルトは黒。
背景とのコントラストを十分に確保してください。
デフォルト: #000000FF

background string

QRコードの背景色（HEX形式）。デフォルトは白。
暗すぎる背景は認識率が低下する可能性があります。
デフォルト: #FFFFFFFF

markerColor string

位置検出マーカーの色。視覚的に強調可能。
デフォルト: #000000FF

markerBorderColor string

マーカーの枠線色。低コントラストは認識に影響します。
デフォルト: #000000FF

style string

QRコードの全体スタイル。ダッシュボードで確認可能。

markerStyle string

マーカーの形状スタイル。複数のデザインをサポート。

grpIdx integer

グループ識別子。リンク管理に使用します。

brandLinkId string

未設定時は自動生成。デフォルトドメインは https://vvd.im。

ttl string

内部管理用タイトル。

memo string

内部メモ（ユーザー非表示）。

qrBypassYn string

Y: 直接遷移（トラッキングなし）
N: 短縮リンク経由（トラッキングあり）

pushNotifyYn string

スキャン時のプッシュ通知設定。

mailNotifyYn string

スキャン時のメール通知設定。

delYmdt datetime

削除予約日時。指定時刻後に自動削除。