メインコンテンツまでスキップ

Short URL API

本仕様書では、SMSメッセージ(例:マーケティングプロモーション)で使用するリンクをプログラムで短縮するためのShort URL APIの使用方法について説明します。

APIはREST APIの規則に従います。送信するメッセージの詳細はJSON形式を利用し、メッセージはPOSTメソッドで送信されます。アカウントの認証情報は、Authorization HTTPヘッダでJWTトークンの形式でお伝えいたします。(詳細は認証のセクションをご覧ください。)

レスポンスが200 OKであった場合は、メッセージがAPIへと正しく送信されています。一方で、レスポンスが40xであった場合は、送信されたリクエストに何かしらの問題があったことを示しています。50xとなっている場合は、サービスに一時的な障害があったことを意味しています。

全てのリクエストにおいて、エンコードUTF-8を使用してください。

注: 本ドキュメントに記載されている時刻はすべてUTCとなります。