onServerError
受信するサーバーエラーをすべて監視します。これらは、通常、システム全体の正常性や現在のエージェント認証セッションに影響を及ぼすグローバルエラーです。発生しうる既知のエラーのリストについては、以下で説明します。
リクエスト
構文
| on('ON_SERVER_ERROR', handler: OnServerErrorHandler): void
type ServerErrorData = { code: ServerErrorCodes[keyof ServerErrorCodes] name: keyof ServerErrorCodes timestamp: number // Date.now() メッセージ?: string } type ServerErrorCodes = { forced_logout_by_other_client: 100 supervisorによる強制ログアウト: 101 無効なリクエスト: 102 電話番号が登録されていません: 103 電話番号がダイヤルプランに含まれていません: 104 テナントが無効化されています: 105 宛先ユーザーがログインしていない: 106 ユーザーが無効化または削除された: 107 ユーザーがすでにログインしている: 108 認証情報が無効: 109 他のユーザーがその電話でログイン済み: 110 トークンが無効です: 111 ログインユーザー数の上限に達しました: 112 同じセッションで既にログイン済み: 113 権限不足: 114 SIPサーバーエラー: 200 不明なエラー: 300 } |
パラメータ
| パラメータ | パラメータ値 | データ型 | オプション/必須 | 説明 |
| errorData | ||||
| code | 文字列 | 必須 | ServerErrorCodes オブジェクトからのエラーコードです。 | |
| 名前 | 文字列 | 必須 | ServerErrorCodes オブジェクトのエラーの名前です。 | |
| timestamp | 数値 | 必須 | サーバーからエラーメッセージを受信した時点のタイムスタンプ。Date.now() メソッドを使用します。 | |
| メッセージ | 文字列 | オプション | エラーの説明文 |
リクエスト例
function serverErrorHandler(errorInfo: ServerErrorData) {
console.log("エラー " + errorInfo.名前 + " が発生しました!");
}
adApi.on("ON_SERVER_ERROR", serverErrorHandler);
戻り値
(なし)