エラーと制限
拒否された呼び出しの応答と、APIが適用する制限。
エラー
拒否された呼び出しは、JSON本文{ statusCode, error, message }で応答します。メッセージに問題の内容が示されます。
| ステータス | メッセージ | 意味 |
|---|---|---|
| 400 | 場合による | 必須フィールドがない、対象が指定されていない、またはステートの値が許可されていない（layout、countdownStyle、progressStyle、versus.activeSide、countdownTo、segments）。メッセージにフィールド名が示されます。 |
| 401 | API_KEY_REQUIRED / INVALID_API_KEY | x-api-keyヘッダーがないか、正しくありません。 |
| 402 | PLAN_SELECTION_REQUIRED | チームがプランを選んでいません。ダッシュボードで選択します（無料プランで使えます）。 |
| 402 | FREE_TIER_LIMIT_REACHED | 無料プランの毎月のプッシュ数を使い切りました。配信と請求を参照してください。 |
| 403 | ACCOUNT_SUSPENDED | このチームを所有するアカウントが停止されています。利用規約を参照してください。 |
| 404 | No activity matched | 送信したアクティビティIDが、このコンテナに1つも見つかりませんでした。 |
| 413 | The "state" object is too large | ステートが16KBを超えています。 |
| 413 | The notification is too long | プッシュ通知が4KBを超えています。 |
| 429 | 場合による | 短時間にリクエストが多すぎます。少し待ってから再試行してください。 |
| 500 | Internal Server Error | 当社側で問題が発生しました。しばらくしてから再試行してください。 |
制限
| 項目 | 上限 |
|---|---|
state | JSONで16KB。 |
segments | 12ステップ。ラベルは60文字で切られます。 |
countdownTo | Unixエポック秒の数値。 |
| カードのテキスト | 収まるテキストを参照してください。 |
| 画像 | スマートフォンがダウンロードできる完全なhttps URL。WebPが最適で、PNGとJPEGも使えます。SVGは使えません。収まる画像を参照してください。 |
| プッシュ通知 | 4KB. |
| リクエスト | 固定のレート制限はありません。非常に多いトラフィックは429でブロックされることがあります。1つのアクティビティに45秒以内に複数の更新があった場合、送信されるのは最新のものだけです。 |
| グループまたは再利用ボタンあたりのスマートフォン数 | 制限なし。 |
| Webhookの応答 | 8秒。 |
