修改使用者資訊。
介面說明
本介面的單使用者 QPS 限制為 50 次/秒。超過限制,API 呼叫會被限流,這可能會影響您的業務,請合理調用。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
live:ModifyLiveMessageUserInfo |
update |
*全部資源
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| AppId |
string |
是 |
需要修改使用者資訊的互動訊息應用 ID。 |
demo |
| UserId |
string |
是 |
需要修改的使用者識別碼。 |
uid2 |
| UserMetaInfo |
string |
否 |
修改後的使用者擴充資訊,長度不超過 512 位元組。 |
uid2meta2 |
| DataCenter |
string |
否 |
資料中心,需要與 CreateLiveMessageApp 中的資料中心一致,當前支援上海(取值為 cn-shanghai)、新加坡(取值為 ap-southeast-1)。 |
cn-shanghai |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
返回參數。如果修改使用者資訊成功,或使用者不存在,則介面返回成功。 |
||
| FailList |
array<object> |
對象數組。 |
|
|
object |
對象數組。 |
||
| Code |
integer |
錯誤碼。 |
440 |
| GroupId |
string |
使用者所在的群組 ID。若修改失敗,則在查詢群組使用者列表時使用者資訊不會同步更新。可根據失敗原因檢查後重新嘗試。 |
grouptest2 |
| Reason |
string |
群組修改失敗的原因。 |
group not exists or already deleted |
| Success |
boolean |
群組修改失敗。 |
false |
| RequestId |
string |
請求 ID。 |
3271ACD2-F143-1204-AFDB-9A87C131**** |
| SuccessList |
array<object> |
對象數組。 |
|
|
object |
對象數組。 |
||
| GroupId |
string |
使用者所在的群組 ID。若修改成功,則在查詢群組使用者列表時使用者資訊會同步更新。 |
grouptest1 |
| Success |
boolean |
群組修改成功。 |
true |
樣本
正常返回樣本
JSON格式
{
"FailList": [
{
"Code": 440,
"GroupId": "grouptest2",
"Reason": "group not exists or already deleted",
"Success": false
}
],
"RequestId": "3271ACD2-F143-1204-AFDB-9A87C131****",
"SuccessList": [
{
"GroupId": "grouptest1",
"Success": true
}
]
}
錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | InputInvalid | %s. | 輸入參數不合法 |
| 500 | ServerError | %s. | 未知錯誤,請稍後重試或提交工單諮詢。 |
| 403 | NoAuth | %s. | 沒有許可權 |
| 404 | ResourceNotExist | %s. | 請求資源不存在,請檢查後重新嘗試 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。