保利威文档中心

幫助中心

直播間人員狀態回調通知

更新時間:2025-07-17 12:24:21

作用

對於機構,需要較為即時地知道學生和老師是否已經在規定的時間進入教室,如果沒有,則需要電話通知學員來上課。使用本功能,帳號下頻道直播間人員狀態改變後,伺服端會對客戶所設定的介面地址,以POST方式提交到給使用者自訂的回調介面進行通知。

回調包含的參數(透過 form-data 參數請求):

參數名 類型 說明
logList string 為物件陣列 json 格式
timestamp number 目前時間戳
sign string 簽名驗證,前後加 polyvlog,中間由資料的 key 和 value 組成,key 值按首字母從小到大排序。md5 轉碼後,轉為大寫。例如,參數為 {roomId:'200060', channelId:'005200060', user:{nick:'yang'}},則簽名為 md5/('polyvlog'+'channelId'+'005200060'+'roomId'+'200060'+'user'+JSON.stringify({nick:'yang'})+'polyvlog').toLocaleUpperCase();'}

說明

  • 回調會累計 1 分鐘內的資料統一進行回調
  • 新舊版後台皆支援
  • 因回調較為頻繁,可能對客戶伺服端造成壓力,需提前與客戶溝通
  • 介面回傳 json 物件,json 物件中有欄位 code,200 表示成功。若未回傳 200,會重試 3 次,超過 3 次則丟棄日誌

logList 參數 json 物件陣列格式

參數名 類型 說明
channelId string 頻道號
groupId string 分組 id,非必傳
viewerId string 與會人 ID
nickName string 使用者暱稱
logType number 日誌類型。21:同意連線,22:結束連線,31:同意演示,32:結束演示,11:進入直播間,12:退出直播間,41:上課,42:下課,101:上課時在直播間的學員名單,102:下課時在直播間的學員名單
interactType string 日誌類型對應列舉(建議直接取 logType)。login:進入直播間,diconnect:退出直播間,startClass:上課或上課時在直播間的學員名單,finishClass:下課或下課時在直播間的學員名單
logTime number 日誌時間戳
ipAddress string IP 地址,非必傳
userAgent string UA 資訊,非必傳
referer string referer 資訊 - 請求來源,非必傳
viewerCount number 目前與會人數
timestamp number 13 位毫秒級時間戳
sessionId string|null 目前場次
userOrigin string 使用者來源,非必傳
content string logType 為 101 和 102 時,表示學員名單的 oss 地址,可根據該地址取得學員名單資訊,名單回傳資料格式與 logList 格式相同
role string 使用者身分資訊,teacher:講師,guest:嘉賓,slice:雲課堂觀眾,viewer:一般觀眾,student:一般觀眾,assistant:助教,attendee:研討會場景下的主持人或與會人,listener:研討會場景下的觀眾
inClass number 頻道是否在直播中,1 表示正在直播,2 表示不在直播,該欄位部分回調中不存在

如何設定

透過後台設定:

登入帳戶 - 進入【雲直播】 - 點選【開發設定】- 點選【回調設定】- 直播間人員狀態回調 URL

注意:提交的介面地址必須以 http:// 或 https:// 開頭

後台設定參考圖片

新版後台設定:

image-20211105095516577

舊版後台設定:

image-20211105095551386

若無法找到對應設定,可能為帳號權限不足,如需取得協助,請聯絡右下角線上客服解決。

联系客服,在线咨询