含 UI 集成方案(荐)

无 UI 集成方案

服务端 API

数据库文档捉虫大赛邀您参加,好礼多多> HOT

功能说明

每个应用可以设置自定义的用户属性,最多可以有10个。通过本接口可以设置每个属性的名称,设置完成后,即可用于按用户属性推送等。

接口调用说明

“全员推送”为 IM 旗舰版功能,需 购买旗舰版套餐包 并在 控制台 > 功能配置 > 登录与消息 > 全员推送设置 打开开关后方可使用。

请求 URL 示例

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

请求参数说明

参数
说明
https
请求协议为 HTTPS,请求方式为 POST
xxxxxx
SDKAppID 所在国家/地区对应的专属域名:
中国:console.tim.qq.com
新加坡:adminapisgp.im.qcloud.com
首尔: adminapikr.im.qcloud.com
法兰克福:adminapiger.im.qcloud.com
孟买:adminapiind.im.qcloud.com
硅谷:adminapiusa.im.qcloud.com
v4/all_member_push/im_set_attr_name
请求接口
usersig
App 管理员帐号生成的签名,参见 UserSig 后台 API
identifier
必须为 App 管理员帐号
sdkappid
创建应用时即时通信控制台分配的 SdkAppid
random
32位无符号整数随机数
contenttype
固定值为:json

最高调用频率

100次/秒。

请求包示例

设置应用第0号属性表示性别,第1号属性表示城市,第2号属性表示国家。
{
"AttrNames": {
"0": "sex",
"1": "city",
"2": "country"
}
}

请求包字段说明

字段
类型
属性
说明
数字键
String
必填
表示第几个属性(“0”到“9”之间)
属性名
String
必填
属性名最长不超过50字节。应用最多可以有10个推送属性(编号从0到9),用户自定义每个属性的含义

应答包体示例

{
"ActionStatus": "OK",
"ErrorInfo": "",
"ErrorCode": 0
}

应答包字段说明

字段
类型
说明
ActionStatus
String
请求处理的结果,OK 表示处理成功,FAIL 表示失败
ErrorCode
Integer
错误码
ErrorInfo
String
错误信息

错误码说明

除非发生网络错误(例如502错误),否则该接口的 HTTP 返回码均为200。真正的错误码,错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。公共错误码(60000到79999)参见 错误码 文档。 本 API 私有错误码如下:
错误码
含义说明
90001
JSON 格式解析失败,请检查请求包是否符合 JSON 规范。
90009
请求需要 App 管理员权限。
91000
服务内部错误,请重试。

接口调试工具

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

参考

目录