文档导航
server
API 版本:  v1
公告:融云新文档中心已上线,欢迎到新文档中心阅读 IM 服务端文档

查询用户级推送备注名

更新时间:2024-01-26 PDF

获取用户设置的推送备注名,支持分页获取。

请求方法

POST: https://数据中心域名/user/remarks/get.json

频率限制: 每秒钟限 100 次

签名规则: 所有服务端 API 请求均需要进行规则校验,详见 API 请求签名

正文参数

HTTP 请求正文数据格式为 application/x-www-form-urlencoded,支持以下 HTTP 表单参数:

参数 类型 必传 说明
userId String 用户 ID。
page Integer 页数,默认为第一页。
size Integer 每页条数,默认每页 50 条。

请求示例

POST /user/remarks/get.json HTTP/1.1
Host: api.rong-api.com
App-Key: uwd1c0sxdlx2
Nonce: 14314
Timestamp: 1408710653491
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: application/x-www-form-urlencoded

userId=7
              
已复制
1
2
3
4
5
6
7
8
9

返回结果

HTTP 响应正文包含具有以下结构的 JSON 对象:

返回值 返回类型 说明
code Number 返回码,200 为正常。
total Int 用户的备注名总数。
users Array JSON 对象数组,包含用户 ID(id)和对应的备注名(remark)。单次最多返回 50 个用户备注名。

返回结果示例

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "code":200,
  "total":2,
  "users":[
  {
    "id":"10001",
    "remark":"name1"
  },
  {
    "id":"10002",
    "remark":"name2"
  }]
}
              
已复制
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

文档反馈
意见反馈

您的改进建议

意见反馈

问题类型

联系我们

提交工单

技术支持|集成使用|产品方案


商务咨询

7 x 24 小时

为您解答方案与报价问题

131 6185 6839

文档反馈