列出特定即時通訊的聊天室訊息。
當您第一次要求擷取即時通訊訊息時,API 會傳回部分或所有即時通訊記錄 (視記錄長度而定)。回應訊息會依照順序由新到舊排序。
當您第一次要求擷取即時通訊訊息時,API 會傳回部分或所有即時通訊記錄 (視記錄長度而定)。回應訊息會依照順序由新到舊排序。
- 回應中的
nextPageToken
提供權杖,可在下一個要求中識別 API 用戶端應擷取的下一組結果。 pollingIntervalMillis
屬性會指出 API 用戶端需要等待多久時間才能收到其他結果。
pageToken
參數設為 nextPageToken
值,且 API 伺服器會傳回額外的即時通訊訊息 (如果有的話)。同樣地,在該結果集中,郵件會依照時間由新到舊排序。常見用途
要求
HTTP 要求
GET https://www.googleapis.com/youtube/v3/liveChat/messages
參數
下表列出這項查詢支援的參數。上方列出的所有參數都是查詢參數。
參數 | ||
---|---|---|
必要參數 | ||
liveChatId |
string liveChatId 參數會指定將傳回訊息的即時通訊 ID。與廣播相關聯的聊天室 ID 會在 liveBroadcast 資源的 snippet.liveChatId 屬性中傳回。 |
|
part |
string part 參數會指定 API 回應將包含的 liveChatMessage 資源部分。支援的值為 id 、snippet 和 authorDetails 。 |
|
選用參數 | ||
hl |
string hl 參數會指示 API 擷取 YouTube 網站支援的應用程式語言的本地化貨幣顯示字串。例如,在英文中,貨幣會顯示為 $1.50 ,但在法文中則會顯示為 1,50$ 。參數值必須是 i18nLanguages.list 方法傳回的清單中包含的語言代碼。 |
|
maxResults |
unsigned integer maxResults 參數會指定要在結果集中傳回的訊息數量上限。可接受的值為 200 到 2000 (含首尾)。預設值為 500 。 |
|
pageToken |
string pageToken 參數可指定要傳回結果集中的網頁。在 API 回應中,nextPageToken 屬性可識別其他可擷取的網頁。 |
|
profileImageSize |
unsigned integer profileImageSize 參數會指定結果集應該傳回的使用者個人資料圖片大小。圖片為正方形。預設值為 88 ,表示圖片大小為 88px x 88px。可接受的值介於 16 到 720 之間 (含首尾)。 |
要求主體
呼叫此方法時請不要提供要求主體。
回應
如果成功的話,這個方法會傳回回應內文,其結構如下:
{ "kind": "youtube#liveChatMessageListResponse", "etag": etag, "nextPageToken": string, "pollingIntervalMillis": unsigned integer, "offlineAt": datetime, "pageInfo": { "totalResults": integer, "resultsPerPage": integer }, "items": [ liveChatMessage Resource ] }
屬性
下表定義此資源中顯示的屬性:
屬性 | |
---|---|
kind |
string 識別 API 資源類型。這個值會是 youtube#liveChatMessageListResponse 。 |
etag |
etag 這項資源的 Etag。 |
nextPageToken |
string 這個符記可用做 pageToken 參數的值,以擷取結果集的下一頁。 |
pollingIntervalMillis |
unsigned integer 客戶應等待多久才開始接受新的聊天室訊息輪詢。 |
offlineAt |
datetime 基礎直播開始離線的日期和時間。只有在串流處於離線狀態時,才會顯示此屬性。這個值以 ISO 8601 ( YYYY-MM-DDThh:mm:ss.sZ ) 格式指定。 |
pageInfo |
object pageInfo 物件會封裝結果集的分頁資訊。 |
pageInfo.totalResults |
integer 結果集中的結果總數。 |
pageInfo.resultsPerPage |
integer API 回應中包含的結果數量。 |
items[] |
list 聊天室訊息清單。清單中的每個項目都是 liveChatMessage 資源。 |
錯誤
下表說明 API 在回應此方法時可能傳回的錯誤訊息。詳情請參閱錯誤訊息說明文件。
錯誤類型 | 錯誤詳細資料 | 說明 |
---|---|---|
forbidden (403) |
forbidden |
您沒有存取指定聊天室訊息的權限。 |
forbidden (403) |
liveChatDisabled |
指定的廣播未啟用聊天室。 |
forbidden (403) |
liveChatEnded |
指定的聊天室已失效。 |
notFound (404) |
liveChatNotFound |
找不到你嘗試擷取的聊天室。請檢查要求的 liveChatId 參數值,確認該參數正確無誤。 |
rateLimitExceeded |
rateLimitExceeded |
要求在前一個要求之後太快傳送。如果 API 要求擷取訊息的頻率超過 YouTube 的重新整理頻率,就會發生這個錯誤,因為這麼做會浪費頻寬。 |
試試看!
使用 APIs Explorer 呼叫這個 API 並查看 API 要求和回應。