API 参考
圈组

查询快捷评论

更新时间: 2024/07/17 17:57:35

云信服务端提供 API 支持查询快捷评论。快捷评论是一个操作功能,并非一种消息类型。评论内容并非一条消息,而是一个 int 类型,由开发者指定评论内容与界面展示之间的联系。快捷评论的 UI 示例可参见Android 端快捷评论文档的 UI 示例

URL

POST  http://api.netease.im/nimserver/qchat/queryQuickComment.action  HTTP/1.1
Content-Type: application/x-www-form-urlencoded;charset=utf-8

请求参数

  • POST 请求中 Headers 的设置请参考API调用方式

  • POST 请求中 Body 的设置如下:

参数类型是否必填说明
serverIdString服务器 ID,服务器唯一标识
channelIdString频道 ID,频道唯一标识
accidString操作者的 IM 账号(accid),代表以谁的名义查询
msgIdServerListString消息 ID 列表,可以转成 JSON Array,每一项都是一个服务端消息 ID,最多 20 个

返回参数

参数 说明
code 状态码
data 查询到的数据,具体字段见下表
data 的字段
说明
msgIdServer 被评论的的消息的服务端消息 ID,即云信服务端给出的消息 ID
time 最后一次评论的时间
count 评论总数
details 评论详情列表,具体字段信息如下:
  • type:评论类型
  • count:该类型的评论数量
  • self:true 或 false,当前用户是否添加了该类型的评论
  • topN:随机抽取的添加此类评论的账号(accid)列表

示例

cURL 请求示例

curl -X POST -H "AppKey: go9dnk4****03mgq3" -H "Nonce: 4tggge**323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'serverId=1513535&channelId=123&accid=asasa&msgIdServerList=[12121,212121,21212]' 'http://api.netease.im/nimserver/qchat/queryQuickComment.action'

返回示例

HTTP 响应:JSON

"Content-Type": "application/json; charset=utf-8"
{
    "code":200,
    "data":[
       "msgIdServer": 1212,
       "time": 1212,
       "count": 12,
       "detail":[{"type":123,"count":10,"self":true,"createTime":1111,"topN":["zhangsan","lisi","wangwu"]}]
    ]
     
}

状态码

该接口在 HTTPS Body 中返回请求的状态码,以下仅列出与接口业务相关的状态码。完整状态码及说明请参见状态码

状态码 说明 处理建议
200 请求成功 -
403 非法操作或没有权限
  • 检查是否已开通圈组功能
  • 检查是否已经开通圈组的快捷评论功能
404 对象不存在
  • 检查传入的账号、消息 ID、服务器 ID、频道 ID 等信息是否存在
  • 检查是否存在必传参数为空的问题
414 参数错误 根据提示信息,检查传入参数的格式和限制条件
416 调用频率超限 降低调用频率
431 HTTP 重复请求 -
此文档是否对你有帮助?
有帮助
去反馈
  • URL
  • 请求参数
  • 返回参数
  • 示例
  • cURL 请求示例
  • 返回示例
  • 状态码