ログイン
このメソッドは、パスワードを平文で渡す必要があるアプリケーションで使用されます(HTTPS 経由のログインページで一般的です)。
Login メソッドは、以下のアプリケーションで使用できます:
- エージェントデスクトップ(例:「agentdesktop」)
- ウォールボード(例:「wallboard」)
- コンタクトセンター管理者(例:「admin」)
同一のユーザーが、同じユーザー名とパスワードで複数のセッションを同時に作成することができます。
HTTPメソッド
POST
リクエスト
session_login(domain, ユーザー名, パスワード, application)
例
POST /session_login HTTP/1.1 {"domain":"example.com", "ユーザー名":"tony.cobb", "パスワード":"パスワード", “ip_address”:”1.2.3.4”, "application":"agentdesktop"}
成功時のレスポンス
成功時のレスポンスには、200 OK ステータスコードと、session_id を含む application/JSON 形式の本文が含まれます。
例
HTTP/1.1 200 OK { “session_id”: “8439309F-4C70-44CF-9D92-FA0E56C97BD0”, "tenant_id":"4E3707BE-CD47-4627-A5D9-34EF70A0DE42", "user_id":"9E33BE47-47DF-40F7-B160-8B90E12FE6C5" }
エラー応答
エラー応答は、4xx HTTP レスポンスコードと、詳細なエラー情報を含む JSON 本文とともに返されます。
| コード | 説明 | 例 |
| 400 | 不正なリクエスト(パラメータの欠落、リクエスト形式の不備) | |
| 403 | アクセス拒否 |
{ “エラー”: “account_disabled” } { “エラー”: “tenant_disabled” } { “エラー”: “ip_address_not_allowed” } { “エラー”: “アカウントロック” } - 無効なログイン試行が回数制限を超えたため、アカウントがロックされました { “エラー”: “wait_before_login” } - 5秒未満の間隔でのログイン試行は許可されません |
| 404 | 見つかりません |
{ “エラー: ユーザー名が不正です” } - ユーザー名が不正です { “エラー”: “invalid_domain” } - テナント URL が不正です |