API を介した URL 短縮
URLの短縮とトラッキングは、現在、SMS（Short Message ServiceおよびViberのAPI経由で利用できます。
SMSでは、HTTP APIとSMPPでURLの短縮とトラッキングがサポートされています。SMPP の詳細については、「SMPP 仕様](/essentials/api-essentials/smpp-specification)を参照してください。
NTT CPaaS への API 要求で短縮と追跡を有効にするには、以下を使用します。
json
{
...
"urlOptions": {
"shortenUrl": true,
"trackClicks": true,
"trackingUrl": "https://mybrand.com/track-url-clicks-webhook",
"removeProtocol": true,
"customDomain": "mybrand.com"
}
}
どこ：
オプション | 形容 |
|---|---|
| 短縮URL(shortenUrl) | デフォルト:true。 urlOptions を使用する場合にのみ "true" にすることができます。 |
| trackClicks (トラッククリック数) | 「true」または「false」に設定すると、エンドユーザーがURLをクリックしたタイミングをトラッキングできます。デフォルト: true。注: 短縮 URL にのみ使用できます。 |
| trackingURL (トラッキング URL) | URL クリック イベントを返す Webhook。 |
| removeプロトコル | 「true」または「false」に設定して、URLから「https://」を削除します。デフォルト: false |
| customDomain (カスタムドメイン) | 保持するカスタムまたはブランドドメイン。 |
さらに、次のガイダンスに注意してください。
- SMS要求で無効なカスタムドメインを送信すると、メッセージは失敗し、配信レポートに拒否が示されます。
- customDomain が設定されていない場合、URL は NTT CPaaS の既定のドメインを使用して短縮されます。