查詢訊息列表。
介面說明
QPS 限制
本介面的單使用者 QPS 限制為 100 次/秒。超過限制,API 呼叫會被限流,這可能會影響您的業務,請合理調用。更多資訊,請參見 QPS 限制。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
live:ListMessage |
get |
*全部資源
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| GroupId |
string |
是 |
訊息組 ID。 |
AE35-****-T95F |
| AppId |
string |
是 |
互動訊息應用 ID。 |
VKL3*** |
| Type |
integer |
否 |
使用者自訂訊息類型,需大於 10000。 |
10002 |
| SortType |
integer |
否 |
相片順序,取值:
|
1 |
| PageNum |
integer |
是 |
頁碼,預設值:1。取值範圍:1~100000。 |
10 |
| PageSize |
integer |
是 |
單頁顯示使用者的數量,預設值:20。取值範圍:1~50。 |
20 |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
Schema of Response |
||
| RequestId |
string |
請求 ID。 |
16A96B9A-****-CB92E68F4CD8 |
| Result |
object |
返回結果。 |
|
| HasMore |
boolean |
是否還有下一頁,取值:
|
false |
| MessageList |
array<object> |
訊息列表。 |
|
|
object |
|||
| Data |
string |
訊息體,JSONString 類型。 |
test |
| GroupId |
string |
訊息組 ID。 |
AE35-****-T95F |
| MessageId |
string |
訊息 ID。 |
qt*** |
| SenderId |
string |
訊息寄件者 ID。 |
yi*** |
| Type |
integer |
訊息類型。 |
10002 |
樣本
正常返回樣本
JSON格式
{
"RequestId": "16A96B9A-****-CB92E68F4CD8",
"Result": {
"HasMore": false,
"MessageList": [
{
"Data": "test",
"GroupId": "AE35-****-T95F",
"MessageId": "qt***",
"SenderId": "yi***",
"Type": 10002
}
]
}
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。