ヘルプセンター統合

のために: 管理者

APIエラーとステータスコードを処理する

エラー本文を読み、400、401、403、404、500、503の意味、そしてキーで確認できない項目が404エラーを返す理由を確認してください。

この記事では5 セクション

このページでは、どちらのAPIも、管理キーやハブキーを使って、通話が拒否された場合の報告方法について説明しています。

エラー本文

拒否された各通話には、ステータスコードとJSONボディが返されます。

{
  "error": {
    "code": 400,
    "message": "CaseReferenceIdExistsException",
    "error_type": "ClientException",
    "reason": {"case_id": "cc-1a2b3c4d5e6f70", "host_id": "ca-7e6d5c4b3a2f10"}
  }
}
分野中身
code再び、ステータスコードです。
messageエラーの名前は、例えばCaseReferenceIdExistsExceptionのような形です。コードをこのエラーに対応させてください。読み手の言語によっては、このエラーの名前が変わることはありません。
error_typeエラーの種類は以下の通りです:ClientException – 拒否された場合、ApiException – 無効なリクエストの場合、SessionException – キーが存在しない場合、ModelException – キーが拒否されたり、データストアからの応答が拒否された場合、TransientException – 再試行すべき問題が発生した場合、InternalError – CaseActiveに問題が発生した場合です。
reasonもっと詳細が必要な場合は、そのレコードのIDや、最初のフィールドに問題があるかどうかを記載してください。ただし、多くの場合、この情報は空欄のままです。
errors無効なリクエストの場合、各フィールドにつき1つのエントリーのみが許可されます。

フィールドエラー

フィールドが欠落しているか、有効でない場合、そのリクエストは400 SchemaFieldsExceptionというエラーコードを返します。各フィールドには、errorsという値が記載されています。locationはフィールドの名前を示し、内部のフィールド同士の間には点が使われています。また、messageは問題点を示すものです。

{
  "error": {
    "code": 400,
    "message": "SchemaFieldsException",
    "error_type": "ApiException",
    "reason": "FieldRequiredException",
    "errors": [
      {"domain": "json", "location": "ref_id", "locationId": "ref_id", "locationType": "schema", "message": "FieldRequiredException", "reason": "FieldRequiredException"}
    ]
  }
}

domain はい json 体のために… query アドレスのパラメータに関する問題です。よくあるフィールドのエラー点です。

messageどうしたの
FieldRequiredExceptionそれが欠けているか、あるいは、そこには何もないのだ。
FieldValidatorFailedExceptionその値は、ロールやケースタイプ、またはホップが持っていないステージなど、許可されているものではありません。
FieldMinLengthException, FieldMaxLengthException短すぎるか、長すぎる。
FieldLimitTooLargeExceptionリスト内のlimitの値は1000を超えています。つまり、1ページに表示できるデータの量には上限があります。
FieldEmailTypeException, FieldPhoneTypeExceptionメールアドレスでも、国コードが含まれている電話番号でもありません。
FieldNameTypeException文字で表せない名前です。
FieldPathSlugTypeExceptionタグIDや参照IDには、文字、数字、ハイフン、スラッシュ以外の文字を使用しても構いません。
FieldDateTypeException日付ではありません。例えば、2026-03-15のようなものです。

APIが認識できないものは無視されるだけで、拒否されるわけではありません。ですから、正確なスペルを確認するために、参照資料と照らし合わせてみてください。

ステータスコード

状態それはどういう意味か何をするか
400この要求は有効ではありません。また、変更が許可されない場合もあります。フィールドエラーが発生しているか、messageで指定された理由により、変更が拒否されている可能性があります。例えば、CaseReferenceIdExistsExceptionのようなケースです。再度送信する前に、その内容を修正してください。
401キー自体が受け入れられなかった。詳しくは、「キーを使ってAPIリクエストを認証する方法」を参照してください。止まって、その鍵を確認してみてください。
403そのキーでは、このようなことが起こらないかもしれません。つまり、管理キーを呼び出しても、何も起こりません。BotNotAllowedException), ロックされたハブManageBillingInactiveException 管理キーのためには、 BillingReadOnlyException ポータルが読み取り専用になった場合のハブキーとしては、閉じたケースです。CaseClosedException), または、同時に行われる別の変更と矛盾するような変更もあります。ItemUpdateFailedException その他の人々も同様です。原因を特定してください。もし衝突が発生した場合は、そのアイテムを再び読み直し、その後もう一度試してみてください。
404そのアイテムは存在しません。別のハブに属していますし、削除されているか、またはキーがそのアイテムを見ることができない状態です。身分証明書を確認してください。
500InternalError:CaseActiveに問題があります。開発者にはそのことについて伝えられています。もう一度試してみてください。もし問題が続く場合は、サポートに連絡してください。
503TransientException:そのハブは、一時的に忙しすぎて対応できなかった。少し時間を待った後、再試行してください。毎回、より長い時間を待ちます。

30秒を超える長い通話の場合、ネットワークからの504エラーにより、JSONボディなしで通話が切断されてしまいます。しかし、インポートはバックグラウンドで実行されることで、この問題を回避できます。

あなたが知っているアイテムが存在する理由 404

Hubキーは、あなたのHubとして機能します。 バーチャルアシスタントバーチャルアシスタント 会社への歓迎メッセージ、チェックイン、ステージングに関する投稿を行う自動化されたチームメンバー。その投稿にはバーチャルアシスタントのバッジが付いています。, そして、バーチャルアシスタントが見ることができる範囲内の情報のみを表示します。その役割では見えない項目は、404エラーとなります。つまり、存在しないものとして扱われるのです。したがって、APIはそのような項目を明らかにしません。今日、公開されている請求書や電子署名を編集したり、削除したりすると、その役割では見えない情報についても、依然として403エラーが発生します。 PublishAlreadyPublishedException. リストには、そのように指定されていない項目が含まれていることがあります。この機能が何を意味するかを知りたければ、その説明を読んでみてください。 role::bots 管理キーを使ってください。詳細はこちらをご覧ください。 キーワードを使って、役割を読み取る。.

再挑戦しても安全です

  • 503番目のもの、そして、TransientExceptionについては、少し時間を待った後に処理されます。
  • 400 TransactionCanceledExceptionという値は、忙しい時期に発生するものです。また、CaseUserLimitOrTransactionExceptionの値は、ケースを確認した後には、もう満たされていない状態になります。
  • 500、少し後です。

他の400番エラーや、401、403、404といったエラーも、同じように再試行してはいけません。そうすると、また拒否されてしまいます。

関連記事

キーを使用してAPIリクエストを認証する管理キーを取得するには、キーをベアラートークンとして管理パネルのAPIに送信するか、ハブキーを取得するにはポータルのAPIに送信し、アクセスを自分のIPアドレスに限定してください。統合APIで何ができるかを理解しましょう管理キーとハブキーがそれぞれどのような範囲にアクセスできるのか、なぜすべてのキーが仮想アシスタントとして機能するのか、そして完全な技術仕様書はどこにあるのかを学びましょう。統合