修改用户信息。
接口说明
本接口的单用户 QPS 限制为 50 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
live:ModifyLiveMessageUserInfo |
update |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| AppId |
string |
是 |
需要修改用户信息的互动消息应用 ID。 |
demo |
| UserId |
string |
是 |
需要修改的用户 ID。 |
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. | 请求资源不存在,请检查后重新尝试 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。