查詢學員提問客戶回調地址
更新時間:2026-05-12 09:49:17
介面描述
查詢當前帳號已配置的「學員提問」客戶回調 URL;若從未配置或已刪除,則
data.callbackUrl為空字串。 讀取路徑帶 Redis 快取(未命中時回源 MySQL 並寫入快取,過期時間 1 天)。 介面支援 HTTPS 協定。
介面URL
https://api.polyv.net/live/v5/chat/redirect/channel/student-question-webhook/get
請求方式
GET
介面約束
1、介面同時支援 HTTP、HTTPS,建議使用 HTTPS。
3、**roomId(query)可選**:不傳時,中介軟體對 roomId 不做歸屬校驗;若傳入,則須為該帳號下合法頻道號,與 post/delete 一致,便於與其它 v5 介面統一傳參習慣。
請求參數描述
| 參數名 | 必選 | 類型 | 說明 |
|---|---|---|---|
| appId | true | String | 帳號appId【詳見取得金鑰】 |
| timestamp | true | Long | 當前13位毫秒級時間戳,3分鐘內有效 |
| sign | true | String | 簽名,為32位大寫的MD5值,產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊,嚴禁儲存在用戶端直接使用,所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料【詳見簽名產生規則】 |
| roomId | false | String | 可選;傳入時須為該帳號下合法頻道號 |
範例
請求範例(帶可選 roomId):
GET https://api.polyv.net/live/v5/chat/redirect/channel/student-question-webhook/get?roomId=412738
回應體 JSON(已配置):
{
"code": 200,
"status": "success",
"message": "",
"data": {
"callbackUrl": "https://your-server.example.com/api/polyv/student-question"
}
}
回應體 JSON(未配置):
{
"code": 200,
"status": "success",
"message": "",
"data": {
"callbackUrl": ""
}
}
回應參數描述
| 參數名 | 類型 | 說明 |
|---|---|---|
| code | Integer | 200 成功;500 多為查詢異常 |
| status | String | success / error |
| message | String | 成功時多為空字串 |
| data | Object | 含 callbackUrl(string,未配置時為 "") |
異常範例
未傳 x-auth-user-id:
{
"code": 400,
"status": "fail",
"message": "accountId is required"
}
傳入的 roomId 與帳號不匹配:
{
"code": 400,
"status": "fail",
"message": "roomId非法"
}
伺服器端異常:
{
"code": 500,
"status": "error",
"message": "unknown error"
}
(具體 message 以實際為準。)
