Docs Overview/
Chat/
服务端 API/
RESTful 接口/
用户管理/
用户信息/
设置资料/

设置资料

功能说明

接口调用说明

请求 URL 示例

https://xxxxxx/v4/profile/portrait_set?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

请求参数说明

下表仅列出调用本接口时涉及修改的参数及其说明，更多参数详情请参考 REST API 简介。
参数
说明
xxxxxx
SDKAppID 所在国家/地区对应的专属域名：
中国：console.tim.qq.com
新加坡：adminapisgp.im.qcloud.com
首尔： adminapikr.im.qcloud.com
法兰克福：adminapiger.im.qcloud.com
硅谷：adminapiusa.im.qcloud.com
雅加达：adminapiidn.im.qcloud.com
v4/profile/portrait_set
请求接口
sdkappid
创建应用时即时通信 IM 控制台分配的 SDKAppID
identifier
必须为 App 管理员账号，更多详情请参见 App 管理员
usersig
App 管理员账号生成的签名，具体操作请参见 生成 UserSig
random
请输入随机的32位无符号整数，取值范围0 - 4294967295
contenttype
请求格式固定值为json

最高调用频率

200次/秒。

请求包示例

{
    "From_Account":"id",
    "ProfileItem":
    [
        {
            "Tag":"Tag_Profile_IM_Nick",
            "Value":"MyNickName"
        }
    ]
}

请求包字段说明

字段
类型
属性
说明
From_Account
String
必填
需要设置该 UserID 的资料
ProfileItem
Array
必填
待设置的用户的资料对象数组，数组中每一个对象都包含了 Tag 和 Value
Tag
String
必填
指定要设置的资料字段的名称，支持设置的资料字段有：
标配资料字段，详情可参见 标配资料字段
自定义资料字段，详情可参见 自定义资料字段
Value
uint64_t/string/bytes
必填
待设置的资料字段的值，详情可参见 资料字段

应答包体示例

{
    "ActionStatus":"FAIL",
    "ErrorCode":40001,
    "ErrorInfo":"Err_Profile_Comm_Decode_Fail",
    "ErrorDisplay":""
}

应答包字段说明

字段
类型
说明
ActionStatus
String
请求处理的结果，“OK” 表示处理成功，“FAIL” 表示失败
ErrorCode
Integer
错误码，0表示成功，非0表示失败
ErrorInfo
String
详细错误信息
ErrorDisplay
String
详细的客户端展示信息

错误码说明

除非发生网络错误（例如502错误），否则该接口的 HTTP 返回码均为200。真正的错误码，错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。 公共错误码（60000到79999）参见 错误码 文档。
本 API 私有错误码如下：
错误码
描述
40001
请求参数错误，请根据错误描述检查请求参数
40003
请求的用户账号不存在
40004
请求需要 App 管理员权限
40006
服务器内部错误，请稍后重试
40008
没有资料字段的写权限
40009
资料字段的 Tag 不存在
40601
资料字段的 Value 长度超过500字节
40605
标配资料字段的 Value错误，详情请参见 标配资料字段
40610
资料字段的 Value 类型不匹配，详情请参见 标配资料字段

接口调试工具

通过 REST API 在线调试 工具调试本接口。

参考

拉取资料（v4/profile/portrait_get）