Channel の QR 認可セッションをポーリングします。
GET /api/v1/forward/qr_sessions/{session_key}
QR 認可セッションの現在のステータスを返します。
Headers
| Header | Required | Description |
|---|---|---|
Authorization | Yes | Bearer <PAT または SAT> |
Path parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
session_key | string | Yes | Create Channel QR Session が返す不透明な QR セッションキー。 |
Example request
Example response
HTTP 200 OK
Response fields
| Field | Type | Description |
|---|---|---|
session_key | string | 不透明な QR セッションキー。 |
channel_id | string | 関連付けられた Channel ID。 |
channel_type | string | wechat、feishu、dingtalk、または wecom。 |
status | string | 現在のセッションステータス。 |
expires_at | string | 有効期限のタイムスタンプ。 |
err_code | string|null | エラーコード（エラー時のみ）。 |
err_msg | string|null | エラーメッセージ（エラー時のみ）。 |
Status values
| Status | Description |
|---|---|
waiting | スキャン、認可、インストール、または設定を待機しています。 |
scanned | QR コードがスキャンされ、モバイルでの確認を待機しています。 |
confirmed | アクティベーションに成功しました。Channel の binding_status が bound になります。 |
expired | QR セッションの有効期限が切れました。新しい QR セッションを作成してください。 |
denied | ユーザーが認可を拒否したか、インストールをキャンセルしました。 |
error | サードパーティチャネルが回復不能なエラーを返しました。 |
Error codes
| HTTP | Type | Trigger |
|---|---|---|
| 401 | authentication_error | PAT または SAT が無効または期限切れです。 |
| 404 | not_found_error | QR セッションが存在しない、期限切れ、または呼び出し元から参照できません。 |
Notes
session_keyは短時間有効な不透明なポーリング用の認証情報です。confirmedになった後は、Channel の詳細を再取得してください。