リンク作成

短縮リンクを作成する基本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バイトまで入力可能です。
domainstringrequired
Default:https://vvd.bz
リンクドメインです。
「brandLinkId」オプションがYの場合、ドメインはhttps://vvd.imになります。
カスタムドメインを入力することもできます。
redirectTypeinteger
Default:302
Enum:
200301302
リダイレクト方式です。
詳細は用語集ページをご確認ください。
この機能はパーソナルプラン以上でご利用いただけます。
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に移動します。
pushNotifyYnstring
Default:N
Enum:
YN
クリック数のプッシュ通知を有効にするかを指定します。
値がYの場合、ダッシュボードの [設定 → 環境設定] で指定したクリック数に達するたびに、Vivoldiアプリがインストールされた端末に通知が送信されます。
この機能はパーソナルプラン以上でご利用いただけます。
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