頻道用量與更正
本頁的介面查詢頻道每天的參會時長,以及事後對歷史用量的更正,用於核對用量。
怎麼統計:
- 按每個成員實際連著媒體的時間累計毫秒,按統計時區分到各天,再按應用、日期、媒體類別(音訊、影片)合計,向上取整為分鐘。
- 釋出者和訂閱者都計入;只佔了席位、還沒連上媒體的時間不計入。
- 按頻道的
media分類:影片頻道里關掉攝像頭,仍計入影片。
這裡的分鐘不是實際扣費
新計費啟用後,實際扣費用的是音影片標準時長:按收到的影片清晰度檔位折算,通話和頻道共用應用的餘額,按應用每月的累計取整。本頁的 audio_minutes、video_minutes 和 billable_minutes 都不能直接當作扣費的標準分鐘。從切換到新計費的那天起,這些日統計和更正不會再按套餐重複收取媒體費用。
查詢每日用量
/{org_name}/{app_name}/rtc/channel-stats路徑引數
org_name、app_name 見接入概述。使用 App Token。
查詢引數
| 引數 | 型別 | 必填 | 說明 |
|---|---|---|---|
from | String | 是 | 開始日期,格式為 YYYY-MM-DD |
to | String | 是 | 結束日期,包含這一天。不能早於 from,合計最多 92 天 |
不能查詢未來的日期,也不能查詢最近 180 個統計日以前的日期。
請求示例
把日期換成有效的範圍:
curl "$IM_API/$ORG/$APP/rtc/channel-stats?from=2026-10-01&to=2026-10-09" -H "Authorization: Bearer $APP_TOKEN"響應
成功返回 200 OK:
| 欄位 | 說明 |
|---|---|
timezone | 統計時區 |
finalized_through | 已定稿到哪一天,這一天及以前的數字不會再變;還沒有時為 null |
items | 每天一項,見下表 |
| 每天的欄位 | 型別 | 說明 |
|---|---|---|
date | String | 日期 |
status | String | finalized 已定稿、provisional 暫定(之後可能變化)、pending 還沒有彙總 |
finalized | Boolean | 是否已定稿 |
audio_participant_ms、video_participant_ms | String / null | 總參會毫秒,十進位制字串。在 JavaScript 中不要直接轉成 number,可能超出安全整數範圍 |
audio_estimated_ms、video_estimated_ms | String / null | 總參會毫秒中屬於估算的部分,已經包含在總數里,不要再加一次 |
audio_minutes、video_minutes | Integer / null | 當天合計後取整的分鐘 |
version | Integer / null | 當天統計的版本號 |
還沒定稿、沒有資料的日期,返回 pending 和 null,不代表用量為 0;只有已定稿的日期沒有資料時才返回 0。晚到的媒體事件會推遲定稿,所以不保證每天在某個固定時間定稿。
錯誤
日期或範圍不合法時返回 400 invalid_argument;認證等通用錯誤見錯誤碼。
查詢用量更正
一天定稿之後,如果又收到了證明成員線上的媒體記錄,服務端會自動為那天生成一條更正。這個介面列出這些更正,只能查詢,沒有寫入或人工確認的介面。
/{org_name}/{app_name}/rtc/channel-usage-adjustments路徑引數
同查詢每日用量。
查詢引數
limit、cursor,見分頁。
請求示例
curl "$IM_API/$ORG/$APP/rtc/channel-usage-adjustments?limit=20" -H "Authorization: Bearer $APP_TOKEN"響應
成功返回 200 OK,包括 items 和 next_cursor。每一項:
| 欄位 | 型別 | 說明 |
|---|---|---|
date、media | String | 更正的是哪一天、audio 還是 video |
status | String | pending 待計費系統接收;confirmed 計費系統已接收,不代表已經出賬或結清 |
proposal_version | Integer | 當前更正的版本號 |
target_version | Integer | 計費系統已接收的版本號 |
participant_ms、minutes | String、Integer | 已被接收的用量 |
proposed_participant_ms、proposed_minutes | String、Integer | 更正後這一天應有的總用量。是更正後的總數,不是要再全額收費的增量 |
billing_adjustment_id | String / null | 計費系統登記這條更正的 ID,還沒登記時為 null |
錯誤
遊標不合法時返回 400 invalid_argument;其他見錯誤碼。
計費規則
頻道用量對應的計量項為 rtc_channel_audio_minutes 和 rtc_channel_video_minutes。是否收費、包含多少、單價多少,都以套餐為準;原有套餐沒有配置這兩個計量項的,不會自動按通話的價格收費。
更正怎麼計費:按原來那個賬期的套餐、包含量和取整方式計算差額。
| 原賬期的賬單 | 差額計入 |
|---|---|
| 還是草稿 | 生成或重新計算草稿時計入。已有的草稿要重新計算才會包含新登記的差額 |
| 已出賬或已結清 | 原賬單不變,差額結轉到下一期或之後可用的草稿 |
- 減免最多減到應付為 0,剩下的繼續結轉;超出每張賬單調整項上限的部分也保留,之後再計入。
- 自動生成的調整不能透過人工刪除介面刪除。
- 某個歷史賬期如果已經手工補償過,請與平臺核對,避免重複補償。
賬單的規則見套餐與賬單。
