跳转至

群组服务

群组服务

创建群组

创建群组,并将用户加入该群组,用户将可以收到该群的消息,每个群最大至 3000 人,App 内的群组数量没有限制。注:其实本方法是加入群组方法 /group/join 的别名。

方法名:/group/create

签名方法:请参考 通用 API 接口签名规则

URL:http://api-cn.ronghub.com/group/create.[format]

[format] 表示返回格式,可以为 jsonxml,注意不要带 [ ]。

HTTP 方法:POST

表单参数

名称 类型 说明
userId String 要加入群的用户 Id。(必传)
groupId String 创建群组 Id。(必传)
groupName String 群组 Id 对应的名称,用于在发送群组消息显示远程 Push 通知时使用,如群组名称改变需要调用刷新群组信息接口同步。(必传)

返回值

名称 类型 说明
code Int 返回码,200 为正常。

JSON 格式:

{"code":200}

XML 格式:

<xml><code>200</code></xml>

返回值请参考 API 方法返回值说明

当提交多个 userId 参数时,表示创建群组,并将多个用户加入该群组,用户将可以收到该群的消息;参见下面示例:

示例

Request:

POST /group/create.json HTTP/1.1
Host: api-cn.ronghub.com
App-Key: uwd1c0sxdlx2
Timestamp: 1408710653491
Nonce: 14314
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: Application/x-www-form-urlencoded

userId=1&userId=2&groupId=123&groupName=TestGroup

Response:

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

{"code":200}

加入群组

将用户加入指定群组,用户将可以收到该群的消息,每个群最大至 3000 人。

用户默认只能查看到加入群组后,群组中发送的消息,如果需要查看加入群组之前的消息,则需要提交工单申请开通。注:“查看加入群组之前的消息”需要先开通单群聊消息云存储功能。

方法名:/group/join

签名方法:请参考 通用 API 接口签名规则

URL:http://api-cn.ronghub.com/group/join.[format]

[format] 表示返回格式,可以为 jsonxml,注意不要带 [ ]。

HTTP 方法:POST

表单参数

名称 类型 说明
userId String 要加入群的用户 Id,可提交多个,最多不超过 1000 个。(必传)
groupId String 要加入的群 Id。(必传)
groupName String 要加入的群 Id 对应的名称。(必传)

返回值

名称 类型 说明
code Int 返回码,200 为正常。

JSON 格式:

{"code":200}

XML 格式:

<xml><code>200</code></xml>

返回值请参考 API 方法返回值说明

当提交多个 userId 参数时,表示将多个用户加入指定群组,用户将可以收到该群的消息;参见下面示例:

示例

Request:

POST /group/join.json HTTP/1.1
Host: api-cn.ronghub.com
App-Key: uwd1c0sxdlx2
Timestamp: 1408710653491
Nonce: 14314
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: Application/x-www-form-urlencoded

userId=1&userId=2&groupId=123&groupName=TestGroup

Response:

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

{"code":200}

退出群组

将用户从群中移除,不再接收该群组的消息。

方法名:/group/quit

签名方法:请参考 通用 API 接口签名规则

URL:http://api-cn.ronghub.com/group/quit.[format]

[format] 表示返回格式,可以为 jsonxml,注意不要带 [ ]。

HTTP 方法:POST

表单参数

名称 类型 说明
userId String 要退出群的用户 Id。(必传)
groupId String 要退出的群 Id。(必传)

返回值

名称 类型 说明
code Int 返回码,200 为正常。

JSON 格式:

{"code":200}

XML 格式:

<xml><code>200</code></xml>

返回值请参考 API 方法返回值说明

当提交多个 userId 参数时,表示将多个用户从群中移除,不再接收该群组的消息;参见下面示例:

示例

Request:

POST /group/quit.json HTTP/1.1
Host: api-cn.ronghub.com
App-Key: uwd1c0sxdlx2
Timestamp: 1408710653491
Nonce: 14314
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: Application/x-www-form-urlencoded

userId=1&userId=2&groupId=123

Response:

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

{"code":200}

解散群组

将该群解散,所有用户都无法再接收该群的消息。

方法名:/group/dismiss

签名方法:请参考 通用 API 接口签名规则

URL:http://api-cn.ronghub.com/group/dismiss.[format]

[format] 表示返回格式,可以为 jsonxml,注意不要带 [ ]。

HTTP 方法:POST

表单参数

名称 类型 说明
userId String 操作解散群的用户 Id,可以为任何用户 Id ,非群组创建者也可以解散群组。(必传)
groupId String 要解散的群 Id。(必传)

返回值

名称 类型 说明
code Int 返回码,200 为正常。

JSON 格式:

{"code":200}

XML 格式:

<xml><code>200</code></xml>

返回值请参考 API 方法返回值说明

示例

Request:

POST /group/dismiss.json HTTP/1.1
Host: api-cn.ronghub.com
App-Key: uwd1c0sxdlx2
Timestamp: 1408710653491
Nonce: 14314
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: Application/x-www-form-urlencoded

userId=1&groupId=123

Response:

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

{"code":200}

成员查询

方法名:/group/user/query

签名方法:请参考 通用 API 接口签名规则

URL:http://api-cn.ronghub.com/group/user/query.[format]

[format] 表示返回格式,可以为 jsonxml,注意不要带 [ ]。

HTTP 方法:POST

表单参数

名称 类型 说明
groupId String 群 Id。(必传)

返回值

名称 类型 说明
code Int 返回码,200 为正常。
users String 群成员数组。
id String 群成员 ID。

JSON 格式:

{
  "code":200,
  "users":
  [
    {
      "id":"10001"
    },
    {
      "id":"10002"
    },
    {
      "id":"10000"
    },
    {
      "id":"10003"
    }
  ]
}

XML 格式:

<xml>
   <code>200</code>
   <users>
       <concurrent-hash-map>
           <entry>
               <string>id</string>
               <string>10001</string>
           </entry>
           <entry>
               <string>id</string>
               <string>10002</string>
           </entry>
           <entry>
               <string>id</string>
               <string>10003</string>
           </entry>
       </concurrent-hash-map>
   </users >
</xml>

返回值请参考 API 方法返回值说明

示例

HTTP 请求:

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

groupId=123

HTTP 响应:

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

{"code":200,"users":[{"id":"10001"},{"id":"10002"},{"id":"10000"},{"id":"10003"}]}

刷新群组信息

方法名:/group/refresh

签名方法:请参考 通用 API 接口签名规则

URL:http://api-cn.ronghub.com/group/refresh.[format]

[format] 表示返回格式,可以为 jsonxml,注意不要带 [ ]。

HTTP 方法:POST

表单参数

名称 类型 说明
groupId String 群组 Id。(必传)
groupName String 群组名称。(必传)

返回值

名称 类型 说明
code Int 返回码,200 为正常。

JSON 格式:

{"code":200}

XML 格式:

<xml><code>200</code></xml>

返回值请参考 API 方法返回值说明

示例

HTTP 请求:

POST /group/refresh.json HTTP/1.1
Host: api-cn.ronghub.com
App-Key: uwd1c0sxdlx2
Nonce: 14314
Timestamp: 1408710653491
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: application/x-www-form-urlencoded

groupId=123&groupName=new

HTTP 响应:

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

{"code":200}

同步用户群组

如果在集成融云前 App Server 已有群组数据,可使用此服务进行同步,当第一次连接融云服务器时,需要向融云服务器提交 userId 对应的用户当前所加入的所有群组,此接口主要为防止应用中用户群信息同融云已知的用户所属群信息不同步。

方法名:/group/sync

调用频率:每秒钟限 100 次

签名方法:请参考 通用 API 接口签名规则

URL:http://api-cn.ronghub.com/group/sync.[format]

[format] 表示返回格式,可以为 jsonxml,注意不要带 [ ]。

HTTP 方法:POST

表单参数

名称 类型 说明
userId String 被同步群信息的用户 Id。(必传)
group[id]=name String 该用户所属的群信息,如群 Id 已经存在,则不会刷新对应群组名称,如果想刷新群组名称请调用刷新群组信息方法。此参数可传多个,参见下面示例。

当不提交 group[id]=name 参数时,表示解除 userId 对应群的绑定关系;

返回值

名称 类型 说明
code Int 返回码,200 为正常。

JSON 格式:

{"code":200}

XML 格式:

<xml><code>200</code></xml>

返回值请参考 API 方法返回值说明

示例

Request:

POST /group/sync.json HTTP/1.1
Host: api-cn.ronghub.com
App-Key: uwd1c0sxdlx2
Timestamp: 1408710653491
Nonce: 14314
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: application/x-www-form-urlencoded

userId=2014&group[10001]=TestGroup1&group[10002]=TestGroup2&group[10003]=TestGroup3

Response:

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

{"code":200}

群组成员禁言

如果不想让某一用户在群中发言时,可将此用户在群组中禁言,被禁言用户可以接收查看群组中用户聊天信息,但不能通过客户端 SDK 发送消息。

提示:被禁言用户通过 Server API 发送的消息权限级别较高,不受禁言限制。

添加

方法名:/group/user/gag/add

签名方法:请参考 通用 API 接口签名规则

URL:http://api-cn.ronghub.com/group/user/gag/add.[format]

[format] 表示返回格式,可以为 jsonxml,注意不要带 [ ]。

HTTP 方法:POST

表单参数

名称 类型 说明
userId String 用户 Id。(必传)
groupId String 群组 Id,非必传,为空时则设置用户在加入的所有群组中都不能发送消息。
minute String 禁言时长,以分钟为单位,最大值为43200分钟,为 0 表示永久禁言。(必传)

返回值

名称 类型 说明
code Int 返回码,200 为正常。

JSON 格式:

{"code":200}

XML 格式:

<xml><code>200</code></xml>

返回值请参考 API 方法返回值说明

当提交多个 userId 参数时,表示将群组中多个用户禁言,每次最多设置 20 个用户;参见下面示例。

示例

HTTP 请求:

POST /group/user/gag/add.json HTTP/1.1
Host: api-cn.ronghub.com
App-Key: uwd1c0sxdlx2
Nonce: 14314
Timestamp: 1408710653491
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: application/x-www-form-urlencoded

userId=2582&userId=2583&groupId=16&minute=1

HTTP 响应:

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

{"code":200}

移除

方法名:/group/user/gag/rollback

签名方法:请参考 通用 API 接口签名规则

URL:http://api-cn.ronghub.com/group/user/gag/rollback.[format]

[format] 表示返回格式,可以为 jsonxml,注意不要带 [ ]。

HTTP 方法:POST

表单参数

名称 类型 说明
userId String 用户 Id,支持同时移除多个群成员。(必传)
groupId String 群组 Id,非必传,为空时则移除用户在所有群组中的禁言设置。

返回值

名称 类型 说明
code Int 返回码,200 为正常。

JSON 格式:

{"code":200}

XML 格式:

<xml><code>200</code></xml>

返回值请参考 API 方法返回值说明

当提交多个 userId 参数时,表示将群组中多个用户解禁,每次最多解禁 20 个用户;参见下面示例。

示例

HTTP 请求:

POST /group/user/gag/rollback.json HTTP/1.1
Host: api-cn.ronghub.com
App-Key: uwd1c0sxdlx2
Nonce: 14314
Timestamp: 1408710653491
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: application/x-www-form-urlencoded

userId=2582&userId=2583&groupId=16

HTTP 响应:

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

{"code":200}

获取

方法名:/group/user/gag/list

签名方法:请参考 通用 API 接口签名规则

URL:http://api-cn.ronghub.com/group/user/gag/list.[format]

[format] 表示返回格式,可以为 jsonxml,注意不要带 [ ]。

HTTP 方法:POST

表单参数

名称 类型 说明
groupId String 群组 Id,非必传,为空时则获取所有群组禁言用户列表。

返回值

名称 类型 说明
code Int 返回码,200 为正常。
time String 解禁时间。
userId String 群成员 Id。

JSON 格式:

{
  "code":200,
  "users":
  [
    {
      "time":"2015-09-25 16:12:38",
      "userId":"2582"
    }
  ]
}

XML 格式:

<code>200</code>
<users>
 <map>
   <entry>
     <string>time</string>
     <string>2015-09-25 16:12:38</string>
   </entry>
   <entry>
     <string>userId</string>
     <string>2582</string>
   </entry>
 </map>
</users>

返回值请参考 API 方法返回值说明

示例

HTTP 请求:

POST /group/user/gag/list.json HTTP/1.1
Host: api-cn.ronghub.com
App-Key: uwd1c0sxdlx2
Nonce: 14314
Timestamp: 1408710653491
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: application/x-www-form-urlencoded

groupId=16

HTTP 响应:

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

{"code":200,"users":[{"time":"2015-09-25 16:12:38","userId":"2582"}]}

群组整体禁言

设置某一群组全部成员禁言,如果在群组全部成员禁言状态下,需要某些用户可以发言时,可将此用户加入到群禁言用户白名单中。

添加

方法名:/group/ban/add

签名方法:请参考 通用 API 接口签名规则

URL:http://api-cn.ronghub.com/group/ban/add.[format]

[format] 表示返回格式,可以为 jsonxml,注意不要带 [ ]。

HTTP 方法:POST

表单参数

名称 类型 说明
groupId String 群组 Id,支持一次设置多个,最多不超过 20 个。(必传)

返回值

名称 类型 说明
code Int 返回码,200 为正常。

JSON 格式:

{"code":200}

XML 格式:

<xml><code>200</code></xml>

返回值请参考 API 方法返回值说明

示例

HTTP 请求:

POST /group/ban/add.json HTTP/1.1
Host: api-cn.ronghub.com
App-Key: c9kqb3rdkbb8j
NONCE: 97
TIMESTAMP:  1480479442
SIGNATURE:  9774e3d91656dc92df8aff294d46d6a506412538
Content-Type: application/x-www-form-urlencoded

groupId=XklWnVzXm&groupId=LklWnVzXq

HTTP 响应:

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

{"code":200}

移除

方法名:/group/ban/rollback

签名方法:请参考 通用 API 接口签名规则

URL:http://api-cn.ronghub.com/group/ban/rollback.[format]

[format] 表示返回格式,可以为 jsonxml,注意不要带 [ ]。

HTTP 方法:POST

表单参数

名称 类型 说明
groupId String 群组 Id,支持一次设置多个,最多不超过 20 个。(必传)

返回值

名称 类型 说明
code Int 返回码,200 为正常。

JSON 格式:

{"code":200}

XML 格式:

<xml><code>200</code></xml>

返回值请参考 API 方法返回值说明

示例

HTTP 请求:

POST /group/ban/rollback.json HTTP/1.1
Host: api-cn.ronghub.com
App-Key: c9kqb3rdkbb8j
NONCE: 97
TIMESTAMP:  1480479442
SIGNATURE:  9774e3d91656dc92df8aff294d46d6a506412538
Content-Type: application/x-www-form-urlencoded

groupId=L6c85orxt&groupId=X6c95orxt

HTTP 响应:

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

{"code":200}

获取

方法名:/group/ban/query

签名方法:请参考 通用 API 接口签名规则

URL:http://api-cn.ronghub.com/group/ban/query.[format]

[format] 表示返回格式,可以为 json,注意不要带 [ ]。

HTTP 方法:POST

表单参数

名称 类型 说明
groupId String 群组 Id,不传此参数,表示查询所有设置禁言的群组列表;传此参数时,表示查询传入的群组 Id 是否被设置为群组禁言,支持一次查询多个,最多不超过 20 个。(非必传)

返回值

名称 类型 说明
code Int 返回码,200 为正常。
groupinfo String 禁言群组信息。
groupId String 群组 Id。
stat String 禁言状态,0 表示为未禁言、1 表示为禁言。

JSON 格式:

{
  "code":200,
  "groupinfo":[{
    "groupId":"groupId1",
    "stat":1
  },
  {
      "groupId":"groupId2",
      "stat":1
  }
  ]
}

返回值请参考 API 方法返回值说明

示例

HTTP 请求:

POST /group/ban/query.json HTTP/1.1
Host: api-cn.ronghub.com
App-Key: c9kqb3rdkbb8j
NONCE: 97
TIMESTAMP:  1480479442
SIGNATURE:  9774e3d91656dc92df8aff294d46d6a506412538
Content-Type: application/x-www-form-urlencoded

HTTP 响应:

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

{
  "code":200,
  "groupinfo":[
  {
    "groupId":"groupId1",
    "stat":1
  },
  {
    "groupId":"groupId2",
    "stat":1
  }
  ]
}

禁言用户白名单

在群组被禁言状态下,如果需要某些用户可以发言时,可将此用户加入到群组禁言用户白名单中。群禁言用户白名单,只有群组被设置为全部禁言时才会生效。

添加

方法名:/group/user/ban/whitelist/add

签名方法:请参考 通用 API 接口签名规则

URL:http://api-cn.ronghub.com/group/user/ban/whitelist/add.[format]

[format] 表示返回格式,可以为 jsonxml,注意不要带 [ ]。

HTTP 方法:POST

表单参数

名称 类型 说明
userId String 用户 Id,支持一次添加多个用户,最多不超过 20 个。(必传)
groupId String 群组 Id。(必传)

返回值

名称 类型 说明
code Int 返回码,200 为正常。

JSON 格式:

{"code":200}

XML 格式:

<xml><code>200</code></xml>

返回值请参考 API 方法返回值说明

示例

HTTP 请求:

POST /group/user/ban/whitelist/add.json HTTP/1.1
Host: api-cn.ronghub.com
App-Key: c9kqb3rdkbb8j
NONCE: 97
TIMESTAMP:  1480479442
SIGNATURE:  9774e3d91656dc92df8aff294d46d6a506412538
Content-Type: application/x-www-form-urlencoded

groupId=2MqOJa1Un&userId=3212&userId=2583

HTTP 响应:

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

{"code":200}

移除

方法名:/group/user/ban/whitelist/rollback

签名方法:请参考 通用 API 接口签名规则

URL:http://api-cn.ronghub.com/group/user/ban/whitelist/rollback.[format]

[format] 表示返回格式,可以为 jsonxml,注意不要带 [ ]。

HTTP 方法:POST

表单参数

名称 类型 说明
userId String 用户 Id,支持同时移除多个用户,每次最多不超过 20 个。(必传)
groupId String 群组 Id。(必传)

返回值

名称 类型 说明
code Int 返回码,200 为正常。

JSON 格式:

{"code":200}

XML 格式:

<xml><code>200</code></xml>

返回值请参考 API 方法返回值说明

示例

HTTP 请求:

POST /group/user/ban/whitelist/rollback.json HTTP/1.1
Host: api-cn.ronghub.com
App-Key: uwd1c0sxdlx2
Nonce: 14314
Timestamp: 1408710653491
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: application/x-www-form-urlencoded

userId=2582&userId=2583&groupId=16

HTTP 响应:

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

{"code":200}

获取

方法名:/group/user/ban/whitelist/query

签名方法:请参考 通用 API 接口签名规则

URL:http://api-cn.ronghub.com/group/user/ban/whitelist/query.[format]

[format] 表示返回格式,可以为 json,注意不要带 [ ]。

HTTP 方法:POST

表单参数

名称 类型 说明
groupId String 群组 Id。(必传)

返回值

名称 类型 说明
code Int 返回码,200 为正常。
userIds String[] 用户 Id。

JSON 格式:

{
  "code":200,
  "userIds":["2583","2582"]
}

返回值请参考 API 方法返回值说明

示例

HTTP 请求:

POST /group/user/ban/whitelist/query.json HTTP/1.1
Host: api-cn.ronghub.com
App-Key: uwd1c0sxdlx2
Nonce: 14314
Timestamp: 1408710653491
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: application/x-www-form-urlencoded

groupId=16

HTTP 响应:

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

{"code":200,"userIds":["2111","2582"]}