保利威文档中心

幫助中心

頻道回呼功能(已棄用)

更新時間:2023-06-16 11:33:33

此功能非 SaaS 後台功能,為直播間資訊修改回呼對應文件。此回呼沒有後台設定頁面,建議不要使用此功能完成業務。

SaaS 後台功能【直播間資訊修改回呼】對應文件:頻道改變回呼通知

作用

帳號下直播頻道新增、刪除、修改(包括基本資訊設定、講師設定、嘉賓設定、直播狀態的修改),會對所設定的介面地址進行回呼通知。

詳情

設定回呼介面地址後,當存在頻道新增、修改、刪除操作時,會以 POST 方式請求回呼介面。

超時重試

回呼伺服器在發送訊息通知後,5 秒內未收到您的伺服器回應,即視為通知失敗。後續失敗會以 5 秒、10 秒、20 秒的間隔繼續重試 3 次。

回呼訊息格式

事件回呼訊息以 HTTP/HTTPS POST 請求發送給您的伺服器,其中:

  • 字元編碼格式:UTF-8。
  • 請求:body 格式為 JSON。URL 會帶上 timestamp 和 sign,驗簽名方式為 md5(body + timestamp + appSecret)
  • 應答要求:回應頭需指定 Content-Type: application/json;
  • 正確應答:http status code: 200 為正確業務接收處理,其他狀態一律視為失敗重試處理。

回呼資料範例

一、以下為「頻道建立」的範例 URL 參數:timestamp=1620878344475&sign=eb7d6b79d3816214131015973294b179 回應體:

{
    "channelId": 2290918,
    "channelName": "演示频道",
    "eventType": "ADD",
    "eventTime": "2021-05-13 11:58:29"
}

二、以下為「頻道修改」的範例 URL 參數:timestamp=1620878679926&sign=176230a93b89023a974976eafda7c12a 回應體:

{
    "channelId": 2290918,
    "channelName": "演示频道",
    "liveStatus": "waiting",
    "eventType": "MODIFY",
    "eventTime": "2021-05-13 12:04:04",
    "startTime": "2021-05-13 22:04:04",
    "splashImg":"https://liveimages.videocc.net/uploaded/images/2021/05/fyjxijew0x1.jpg"
    "publisher": "主持人",
    "teacher": {
        "nickname": "讲师",
        "actor": "讲师"
    },
    "guests": [
        {
            "nickname": "陈老师",
            "actor": "嘉宾"
        }
    ]
}

三、以下為「頻道刪除」的範例 URL 參數:timestamp=1620878775840&sign=2e4867bc2a6df0f648ed7ba43a63421c 回應體:

{
    "channelId": 2290918,
    "channelName": "演示频道",
    "eventType": "DELETE",
    "eventTime": "2021-05-13 12:05:40"
}

回呼參數說明

參數名 類型及範圍 說明
channelId int 頻道 ID
channelName string 頻道名稱
liveStatus string 直播狀態(live-直播,end-結束,waiting-等待直播,playback-回放)
eventType string 事件類型(ADD-新增,MODIFY-修改,DELETE-刪除)
eventTime string 事件觸發時間
publisher string 主持人
splashImg string 引導頁圖片
startTime string 開播時間
teacher object 主持人
teacher.nickname string 主持人暱稱
teacher.actor string 主持人頭銜
guests array 嘉賓
guests[].nickname string 嘉賓暱稱
guests[].actor string 嘉賓頭銜
联系客服,在线咨询