Poll a Channel QR authorization session.
GET /api/v1/forward/qr_sessions/{session_key}
Returns the current status of a QR authorization session.
Headers
| Header | Required | Description |
|---|---|---|
Authorization | Yes | Bearer <PAT or SAT> |
Path parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
session_key | string | Yes | Opaque QR session key returned by Create Channel QR Session. |
Example request
Example response
HTTP 200 OK
Status values
| Status | Description |
|---|---|
waiting | Waiting for scan, authorization, installation, or configuration. |
scanned | QR code was scanned and is waiting for mobile confirmation. |
confirmed | Activation succeeded. Channel binding_status becomes bound. |
expired | QR session expired. Create a new QR session. |
denied | User denied authorization or cancelled installation. |
error | The third-party channel returned an unrecoverable error. |
Error codes
| HTTP | Type | Trigger |
|---|---|---|
| 401 | authentication_error | PAT or SAT is invalid or expired. |
| 404 | not_found_error | QR session does not exist, is expired, or is not visible to the caller. |
Response fields
| Field | Type | Description |
|---|---|---|
session_key | string | Opaque QR session key. |
status | string | waiting, scanned, confirmed, expired, denied, or error. |
channel_id | string | Associated Channel ID. |
channel_type | string | Associated channel type. |
expires_at | string | QR session expiration time. |
err_code | string|null | Channel error code on failure. |
err_msg | string|null | Channel error message on failure. |
Notes
session_keyis a short-lived opaque credential.- After
confirmed, refresh Channel details.