Version: 1.0.0
Mico SMS/RCS API
SMS メッセージを送信し、配信結果のレポートを収集するための HTTP ベース API です。
ここでは各エンドポイントの入出力を定義します。主な利用シナリオ・配信の流れ・認証の手順は、図とあわせて開発者向けドキュメントの「はじめに」「クイックリファレンス」で説明しています。
プロダクトをまたいで挙動が共通の仕様は「共通仕様」にまとめています(レート制限 / 短縮 URL)。
レート制限
各エンドポイントには、受け付けられるリクエスト数の上限があります。上限値は各エンドポイントの説明に記載しています。特定の値に依存せず、上限に達した場合の処理を必ず実装してください。
- SMS/RCS のレート制限 … エンドポイントごとの上限値の一覧と、上限の範囲内で要件を満たすための API の選び方
- 共通仕様 / レート制限 … 上限の考え方・上限を数える単位・ポーリング間隔と再試行の実装方針
Authentication
- HTTP: Bearer Auth
POST /oauth/token で取得したアクセストークンを Authorization: Bearer <access_token> で指定します。
Security Scheme Type: | http |
|---|---|
HTTP Authorization Scheme: | bearer |
Bearer format: | JWT |