跳到主要内容

获取会话属性

获取指定会话的所有属性信息,包括标签信息、置顶状态、免打扰设置等。该接口可以全面了解会话的当前状态和配置信息。

请求方法

GET: https://数据中心域名/conversation/attribute/get.json

频率限制: 每秒 100 次

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

正文参数

HTTP 请求支持以下参数:

参数类型必传说明
userIdString用户 ID。
targetIdString目标 ID。根据会话类型的不同,该字段为单聊用户 ID、群组 ID 或系统目标 ID。
conversationTypeString会话类型。支持的会话类型包括:1 (二人会话)、3 (群组会话)、6 (系统会话)。

请求示例

HTTP
GET  conversation/attribute/get.json?userId=testUserId&targetId=group1&conversationType=3
Host: api.rong-api.com
App-Key: xxxxxx
Nonce: 14314
Timestamp: 111111111111
Signature: xxxxxxxxxxxxxxxxxxxxxxx

返回结果

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

返回值返回类型说明
codeNumber返回码。200 表示成功。详见服务端 API 状态码
dataObject
data.targetIdString目标 ID。根据会话类型的不同,该字段为单聊用户 ID、群组 ID 或系统目标 ID。
data.conversationTypeint会话类型。支持的会话类型包括:1 (二人会话)、3 (群组会话)、6 (系统会话)。
data.topObject置顶信息。未设置过置顶时不返回
data.top.topboolean是否置顶
data.top.topTimeNumber设置置顶的时间戳
data.muteObject免打扰信息。未设置过免打扰不返回
data.mute.muteNumber消息免打扰设置状态。
  • -1: 全部消息通知
  • 0: 未设置(用户未设置情况下,默认以群 或者 APP级别的默认设置为准,如未设置则全部消息都通知)
  • 1: 仅针对 @ 消息进行通知
  • 2: 仅针对 @ 指定用户进行通知
  • 4: 仅针对 @ 群全员进行通知。
  • 5: 不接收通知
data.tagsObject[]标签信息列表。未设置过标签时不返回该字段。单个会话可以属于多个标签。
data.tags[].tagIdString标签 ID。标签的唯一标识,长度不超过 10 个字符。
data.tags[].tagNameString标签名称。标签的显示名称,长度不超过 15 个字符。

返回结果示例

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

{
"code": 200,
"data": {
"targetId": "user1",
"conversationType": 1,
"tags": [
{
"tagId": "tag3",
"tagName": ""
},
{
"tagId": "tag1",
"tagName": ""
},
{
"tagId": "tag2",
"tagName": ""
}
],
"top": {
"top": true,
"topTime": 1756380709937
},
"mute": {
"mute": 5
}
}
}