API

API ドキュメント

TODAY SMS APIは、HTTPS上のJSON APIです。すべてのリクエストでAPIキーをAuthorizationヘッダーで送ります。料金、返金、20分の待機時間はWebサイトと同じです。一覧からメソッドを選ぶと、リクエストとレスポンスの例が表示されます。

APIキーは、初回チャージが反映されたあとにAPIキーページで作成します。下の例のYOUR_API_KEYをご自身のキーに置き換えてお使いください。

GET

/balance

残高の確認

アカウントの現在の残高を米ドルで返します。認証コードの受信とSMS送信は同じ残高を使います。

リクエストパラメーター

リクエストパラメーターはありません。

リクエスト例

request
$ curl https://today-sms.com/api/v1/balance \
  -H "Authorization: Bearer YOUR_API_KEY"

レスポンス例

response
{
  "balance": "42.5000",
  "currency": "USD"
}

発生しうるエラー

unauthorizedAPIキーがないか、正しくありません
not_allowedAPIは初回チャージが反映されたあとに使えるようになります
rate_limited1分間のリクエストが多すぎます