調用ListLiveMessageGroupMessages查詢群組訊息列表。
介面說明
調用本介面前,您必須已經調用 CreateLiveMessageGroup 建立互動訊息群組。
QPS 限制
本介面的單使用者 QPS 限制為 50 次/秒。超過限制,API 呼叫會被限流,這可能會影響您的業務,請合理調用。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
live:ListLiveMessageGroupMessages |
list |
*Rtc
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| AppId |
string |
是 |
需要查詢的互動訊息應用 ID。 |
demo |
| GroupId |
string |
是 |
需要查詢的群組的 GroupID。 |
grouptest |
| PageSize |
integer |
是 |
一次顯示的訊息數量,取值範圍**[10,50]**。 |
10 |
| SortType |
integer |
是 |
排序方式,按訊息發送時間先後進行排序。取值:
|
1 |
| NextPageToken |
integer |
否 |
查詢頁的起始位置,若為空白則預設為首頁。 |
1 |
| MsgType |
integer |
否 |
需要查詢的訊息類型,若為空白則預設為全部類型。 |
1 |
| BeginTime |
integer |
否 |
查詢起始時間,用 UNIX 時間戳記表示,單位:秒。若為空白則預設為最早時間。 |
1697783235 |
| EndTime |
integer |
否 |
查詢結束時間,用 UNIX 時間戳記表示,單位:秒。若為空白則預設為最晚時間。 |
1698301635 |
| DataCenter |
string |
否 |
資料中心,需要與 CreateLiveMessageApp 中的資料中心一致,當前支援上海(取值為 cn-shanghai)、新加坡(取值為 ap-southeast-1)。 |
cn-shanghai |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
返回參數。 |
||
| RequestId |
string |
請求 ID。 |
1668FDC3-63D7-102F-B5D4-3D2F91D1**** |
| GroupId |
string |
需要查詢的群組的 GroupID。 |
grouptest |
| NextPageToken |
integer |
下一頁的起始位置,若沒有下一頁則為 0。 |
0 |
| Hasmore |
boolean |
是否有下一頁。 |
false |
| MessageList |
array<object> |
訊息列表。 |
|
|
array<object> |
列表詳情。 |
||
| Sender |
object |
訊息參數詳情。 |
|
| UserId |
string |
訊息發送使用者的 ID。 |
uid2 |
| UserInfo |
string |
訊息發送使用者的擴充資訊。 |
testusermeta2 |
| Body |
string |
訊息體。 |
step2 helo, cc group |
| Timestamp |
integer |
訊息建立時間。用 UNIX 時間戳記表示,單位:秒。 |
1697081134 |
| MsgTid |
string |
訊息標識。 |
c-1-1-0 |
| MsgType |
integer |
訊息類型。 |
2 |
| SeqNumber |
integer |
訊息序號。 |
1 |
| TotalMessages |
integer |
總訊息數量。 |
1 |
樣本
正常返回樣本
JSON格式
{
"RequestId": "1668FDC3-63D7-102F-B5D4-3D2F91D1****",
"GroupId": "grouptest",
"NextPageToken": 0,
"Hasmore": false,
"MessageList": [
{
"Sender": {
"UserId": "uid2",
"UserInfo": "testusermeta2"
},
"Body": "step2 helo, cc group",
"Timestamp": 1697081134,
"MsgTid": "c-1-1-0",
"MsgType": 2,
"SeqNumber": 1,
"TotalMessages": 1
}
]
}
錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | InputInvalid | %s. | 輸入參數不合法 |
| 500 | ServerError | %s. | 未知錯誤,請稍後重試或提交工單諮詢。 |
| 403 | NoAuth | %s. | 沒有許可權 |
| 404 | ResourceNotExist | %s. | 請求資源不存在,請檢查後重新嘗試 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。