APIエラーコード一覧
AskMateChat API はエラーを RFC7807 の形式(application/problem+json)で返します。応答本文の type はこのページの各項目を指しています。
応答の形
{
"type": "https://askmatechat.jp/docs/errors/invalid-query",
"title": "Invalid Query",
"status": 400,
"detail": "botId parameter is required",
"instance": "req-9f3c1a2b-..."
}instance はそのリクエスト固有の ID です(応答の X-Request-Id ヘッダーと同じ値)。お問い合わせの際はこの値をお知らせください。
コード一覧
| コード | HTTP | どういう状態か |
|---|---|---|
| bad-request | 400 | リクエストの形式が正しくありません。 |
| validation-error | 400 | 送られた値が、この API が受け付ける条件を満たしていません。 |
| invalid-json | 400 | リクエスト本文を JSON として読み取れませんでした。 |
| invalid-payload | 400 | 本文は JSON として読めましたが、中身がこの口の要件を満たしていません。 |
| invalid-query | 400 | URL のクエリパラメータが足りない、または正しくありません。 |
| idempotency-key-required | 400 | この口は Idempotency-Key ヘッダーを必須にしています。 |
| forbidden | 403 | 認証はできていますが、この操作を行う権限がありません。 |
| not-found | 404 | 指定された対象が見つかりません。 |
| idempotency-conflict | 409 | 同じ Idempotency-Key で、前回とは中身の違うリクエストが送られました。 |
| version-mismatch | 409 | 指定されたバージョンが、サーバー側の最新と一致しません。 |
| inactive-template | 409 | 指定された同意テンプレートは、すでに無効化されています。 |
| rate-limit-exceeded | 429 | 短い時間に多くのリクエストを送ったため、一時的に制限されています。 |
| too-many-requests | 429 | 短い時間に多くのリクエストを送ったため、一時的に制限されています(rate-limit-exceeded と同じ意味です)。 |
| internal-error | 500 | サーバー側で予期しないエラーが起きました。送った内容に問題があるとは限りません。 |
エンドポイントごとの仕様は APIリファレンス をご覧ください。