智能媒资托管更新用户信息-服务级 API 文档-文档中心-腾讯云

1. 接口描述

接口请求域名： smh.tencentcloudapi.com 。

更新用户信息。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：ModifyUser。
Version	是	String	公共参数，本接口取值：2021-07-12。
Region	否	String	公共参数，本接口不需要传递此参数。
LibraryId	是	String	媒体库 ID。示例值：smh08gcw6500e6jl
Filter	是	UserFilter	用于唯一查找用户的过滤器。示例值：{ "Key": "PhoneNumber", "Value": "+86-13800000000" }
Role	否	String	用户角色，当只支持 user。示例值：user
Enabled	否	Boolean	是否启用。示例值：true
CountryCode	否	String	手机号国家码，不传默认为 null，此时无法使用该登录方式进行登录。示例值：+86
PhoneNumber	否	String	手机号码，不传默认为 null，此时无法使用该登录方式进行登录。如果与同一媒体库内已有手机号重复则报错。CountryCode 和 PhoneNumber 必须同时传入或同时不传入。示例值：13800138000
Email	否	String	邮箱，不传默认为 null，此时无法使用该登录方式进行登录。如果与同一媒体库内已有邮箱重复则报错。示例值：admin@mail.foobar.com
AccountName	否	String	账号，不传默认为 null，此时无法使用该登录方式进行登录。如果与同一媒体库内已有账号重复则报错。只能使用大小写字母、数字、中划线、下划线、小数点，长度不超过 50 个字符。示例值：account_name
AccountPassword	否	String	密码的 base64 形式，不传默认为 null，此时无法使用该登录方式进行登录。AccountName 和 AccountPassword 必须同时传入或同时不传入。示例值：UEBzc3cwcmQ=
AccountUserId	否	String	第三方账号 ID，用于关联第三方账号体系，不传默认为 null，此时无法使用该登录方式进行登录。如果与同一媒体库内已有第三方账号重复则报错。只能使用大小写字母、数字、中划线、下划线、小数点，长度不超过 200 个字符。示例值：x53mYVqykfPqTCqekbNwwa4aXk4
Comment	否	String	备注。不超过 255 个字符。示例值：腾讯云助手账号
Nickname	否	String	昵称。不超过 100 个字符。示例值：腾讯云助手
Avatar	否	String	用户头像地址。不超过 255 个字符。示例值：https://cloudcache.tencent-cloud.com/qcloud/portal/kit/images/slice/logo.23996906.svg
Customize	否	String	自定义信息。不超过 255 个字符。

3. 输出参数

参数名称	类型	描述
LibraryId	String	用户所在的媒体库 ID。示例值：smh08gcw6500e6jl
UserId	String	用户 ID。示例值：user18llqxtbrcvgn
CreationTime	Timestamp ISO8601	用户创建时间。示例值：2024-07-07T03:45:26Z
Role	String	用户角色. 示例值：user
Enabled	Boolean	是否启用。示例值：true
CountryCode	String	手机号国家码，如未指定则为 null。注意：此字段可能返回 null，表示取不到有效值。示例值：+86
PhoneNumber	String	手机号码，如未指定则为 null。注意：此字段可能返回 null，表示取不到有效值。示例值：13800000000
Email	String	邮箱，如未指定则为 null。注意：此字段可能返回 null，表示取不到有效值。示例值：admin@mail.foobar.com
AccountName	String	账号，如未指定则为 null。注意：此字段可能返回 null，表示取不到有效值。示例值：account_name
AccountUserId	String	第三方账号 ID，用于关联第三方账号体系，如未指定则为 null。注意：此字段可能返回 null，表示取不到有效值。示例值：x53mYVqykfPqTCqekbNwwa4aXk4
Comment	String	备注。示例值：腾讯云助手账号
Nickname	String	昵称。示例值：腾讯云助手
Avatar	String	用户头像地址。示例值：https://cloudcache.tencent-cloud.com/qcloud/portal/kit/images/slice/logo.23996906.svg
Customize	String	自定义信息。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 更新用户信息

输入示例

POST / HTTP/1.1
Host: smh.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyUser
<公共请求参数>

{
    "LibraryId": "smh08gcw6500e6jl",
    "Filter": {
        "Key": "PhoneNumber",
        "Value": "+86-13800000000"
    },
    "CountryCode": "+86",
    "PhoneNumber": "13800138000"
}

输出示例

{
    "Response": {
        "LibraryId": "smh08gcw6500e6jl",
        "UserId": "user18llqxtbrcvgn",
        "CreationTime": "2024-07-07T03:45:26Z",
        "Role": "user",
        "Enabled": true,
        "CountryCode": "+86",
        "PhoneNumber": "13800138000",
        "Email": null,
        "AccountName": null,
        "AccountUserId": null,
        "Comment": "",
        "Nickname": "",
        "Avatar": "",
        "Customize": "",
        "RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
InternalError	内部错误。
InvalidParameter.OneOfAccountNameAndAccountPasswordIsEmpty	AccountName 和 AccountPassword 必须同时指定或同时不指定。
InvalidParameter.OneOfCountryCodeAndPhoneNumberIsEmpty	CountryCode 和 PhoneNumber 必须同时指定或同时不指定。
InvalidParameterValue.AccountNameTooLong	AccountName 过长。
InvalidParameterValue.AccountPassword	AccountPassword 无效。
InvalidParameterValue.AccountUserIdTooLong	AccountUserId 过长。
InvalidParameterValue.CountryCodeTooLong	CountryCode 过长。
InvalidParameterValue.DuplicateAccountName	AccountName 重复。
InvalidParameterValue.DuplicateAccountUserId	AccountUserId 重复。
InvalidParameterValue.DuplicateEmail	Email 重复。
InvalidParameterValue.DuplicateUserPhoneNumber	CountryCode 和 PhoneNumber 重复。
InvalidParameterValue.EmailTooLong	Email 过长。
InvalidParameterValue.Filter	指定的 Filter 无效。
InvalidParameterValue.InvalidAccountName	AccountName 无效。
InvalidParameterValue.InvalidAccountUserId	AccountUserId 无效。
InvalidParameterValue.InvalidCountryCode	CountryCode 无效。
InvalidParameterValue.InvalidEmail	Email 无效。
InvalidParameterValue.InvalidPhoneNumber	PhoneNumber 无效。
InvalidParameterValue.PhoneNumberTooLong	PhoneNumber 过长。
InvalidParameterValue.RoleNotSupport	指定的 Role 不支持。
ResourceNotFound.Library	媒体库不存在或不属于当前账号。
ResourceNotFound.User	指定的用户不存在。

更新用户信息

本页目录：