呼叫ListMessageGroupUserById透過使用者ID列表查詢使用者資訊。
介面說明
QPS 限制
本介面的單一使用者 QPS 限制為 100 次/秒。超過限制,API 呼叫會被限流,這可能會影響您的業務,請合理呼叫。更多資訊,請參見 QPS 限制。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
live:ListMessageGroupUserById |
get |
*All Resource
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| AppId |
string |
是 |
互動訊息應用 ID。 |
VKL3*** |
| GroupId |
string |
是 |
訊息群組 ID。 |
AE35-****-T95F |
| UserIdList |
array |
是 |
使用者列表。 |
|
|
string |
否 |
使用者 ID。 |
de1**a0 |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
Schema of Response |
||
| RequestId |
string |
請求 ID。 |
16A96B9A-****-CB92E68F4CD8 |
| Result |
object |
傳回結果。 |
|
| HasMore |
boolean |
是否還有下一頁,取值:
|
false |
| Total |
integer |
查詢到的使用者總數。 |
3 |
| UserList |
array<object> |
使用者列表資訊。 |
|
|
object |
|||
| IsMute |
boolean |
Indicates whether the user is muted. Valid values:
|
true |
| MuteBy |
array |
The type of the mute. Valid values:
|
|
|
string |
The type of the mute. Valid values:
|
user |
|
| UserAvatar |
string |
The URL of the profile picture of the user. |
"http://www.aliyundoc.com/xxyy.png" |
| UserExtension |
string |
The custom information about the user. |
12e |
| UserId |
string |
The ID of the user. |
ad*** |
| UserNick |
string |
The nickname of the user. |
xxyy |
樣本
正常返回樣本
JSON格式
{
"RequestId": "16A96B9A-****-CB92E68F4CD8",
"Result": {
"HasMore": false,
"Total": 3,
"UserList": [
{
"IsMute": true,
"MuteBy": [
"user"
],
"UserAvatar": "\"http://www.aliyundoc.com/xxyy.png\"",
"UserExtension": "12e",
"UserId": "ad***",
"UserNick": "xxyy"
}
]
}
}
錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | MissingParam | Parameter invalid. | |
| 403 | NoAuth | %s. |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。