服务端 API 汇总

更新时间：2020-10-22

接口列表

获取IM token

获取使用IM SDK需要的 im_token

URL：/api/rest/getToken
支持格式：表单参数
请求方式： POST (application/x-www-form-urlencoded)
请求header

返回字段	字段类型	说明
appId	string	LinkV 分配的 im_app_id
appkey	string	LinkV 分配的 im_app_key
nonce	string	随机字符串
sign	string	参照`签名生成sign`进行签名生成
timestamp	string	秒级时间戳
appUid	string	用户 Id，支持大小写英文字母、数字、部分特殊符号 + = - _ 的组合方式，最大长度 64 字节。是用户在 App 中的唯一标识，必须保证在同一个 App 内不重复，重复的用户 Id 将被当作是同一用户。
signature	string	与 sign 一致

请求参数

参数	必选	类型	说明
userId	true	string	用户 Id，支持大小写英文字母、数字、部分特殊符号 + = - _ 的组合方式，最大长度 64 字节。是用户在 App 中的唯一标识，必须保证在同一个 App 内不重复，重复的用户 Id 将被当作是同一用户。

返回字段

返回字段	字段类型	说明
code	string	标识是否成功，200表示成功，其余失败
userId	string	请求时传递的用户Id
token	string	token

返回示例

// success
{
  "code": 200, // 标识是否成功，200表示成功，其余失败
  "userId": "738131192624578560",
  "token": "hamif02795fce736993c96be32c31daa"
}

// error
{
    "code": 403,
    "msg": "sign err",
    "data": []
}

该接口与其他接口请求头不同

错误码说明

错误码	描述	解决方案
400	参数错误	确认必传参数是否缺少
401	签名错误	参照 `签名生成` 进行签名生成
500	系统错误	联系我们
602	appkey无效	联系我们

该接口与其他接口**请求头**不同以下所有请求都需要使用header参数

返回字段	字段类型	说明
appId	string	LinkV 分配的 im_app_id
appkey	string	LinkV 分配的 im_app_key
nonce	string	随机字符串
sign	string	参照`签名生成sign`进行签名生成
timestamp	string	秒级时间戳
appUid	string	用户 Id，支持大小写英文字母、数字、部分特殊符号 + = - _ 的组合方式，最大长度 64 字节。是用户在 App 中的唯一标识，必须保证在同一个 App 内不重复，重复的用户 Id 将被当作是同一用户。
cmimToken	string	getToken后返回的 token 内容

单聊消息发送

发送1 v 1聊天消息

URL：api/rest/message/v1/converse/pushConverseData
支持格式：表单参数
请求方式：POST (application/x-www-form-urlencoded)
请求header
查看默认header-

请求参数

参数	必选	类型	说明
appId	true	string	LinkV 分配的im_app_id
fromUserId	true	string	发送用户标识
toUserId	true	string	接收用户标识
content	true	string	消息内容
objectName	true	string	消息类型默认RC:TxtMsg
pushData	false	json	推送消息内容，不传不发推送,格式为json
toUserAppid	false	string	LinkV 分配的im_app_id
toUserExtSysUserId	false	string	接收方外部系统用户id

pushData参数含义

参数名称	apns层级关系	gcm层级关系
title	aps,alert,title	透传
subtitle	aps,alert,subtitle	透传
body	aps,alert,body	透传
launch-image	aps,alert,launch-image	透传
title-loc-key	aps,alert,title-loc-key	透传
title-loc-args	aps,alert,title-loc-args	透传
subtitle-loc-key	aps,alert,subtitle-loc-key	透传
subtitle-loc-args	aps,alert,subtitle-loc-args	透传
body-loc-key	aps,alert,loc-key	透传
body-loc-args	aps,alert,loc-args	透传
badge	aps,badge	透传
sound	aps,sound	透传
thread-id	aps,thread-id	透传
click-action	aps,category	透传
content-available	aps,content-available	透传
mutable-content	aps,mutable-content	透传
target-content-id	aps,target-content-id	透传

返回字段

返回字段字段类型说明
code string 返回结果状态。200：正常.
msg string 返回状态信息
requestID string 本次请求的唯一标识

返回字段	字段类型	说明
code	string	返回结果状态。200：正常.
msg	string	返回状态信息
requestID	string	本次请求的唯一标识

返回示例

// success
{
    "msg": "成功",
    "code": 200,
    "requestID":"xxx"
}

// error
{
    "code": 403,
    "msg": "sign err"
}

错误码说明

错误码	描述	解决方案
400	参数错误	确认必传参数是否缺少
403	签名错误	参照签名生成进行签名生成
500	系统错误	联系我们
10006	参数长度错误	确认userId长度是否超过64位

发送1 v n聊天消息

URL：api/rest/message/v1/converse/pushConverseDatas
支持格式：表单参数
请求方式：POST (application/x-www-form-urlencoded)
请求header
查看默认header-

请求参数

参数	必选	类型	说明
appId	true	string	LinkV 分配的im_app_id
fromUserId	true	string	发送用户标识
toUserIds	true	string	接收用户标识,以"," 号分隔，不能超过1000个
content	true	string	消息内容
objectName	true	string	消息类型
pushData	false	json	推送消息内容，不传不发推送

pushData参数含义

参数名称	apns层级关系	gcm层级关系
title	aps,alert,title	透传
subtitle	aps,alert,subtitle	透传
body	aps,alert,body	透传
launch-image	aps,alert,launch-image	透传
title-loc-key	aps,alert,title-loc-key	透传
title-loc-args	aps,alert,title-loc-args	透传
subtitle-loc-key	aps,alert,subtitle-loc-key	透传
subtitle-loc-args	aps,alert,subtitle-loc-args	透传
body-loc-key	aps,alert,loc-key	透传
body-loc-args	aps,alert,loc-args	透传
badge	aps,badge	透传
sound	aps,sound	透传
thread-id	aps,thread-id	透传
click-action	aps,category	透传
content-available	aps,content-available	透传
mutable-content	aps,mutable-content	透传
target-content-id	aps,target-content-id	透传

返回字段

返回字段字段类型说明
code string 返回结果状态。200：正常.
msg string 返回状态信息
requestID string 本次请求的唯一标识
messageSendResult string 发送userid的单个结果 200:正常

返回字段	字段类型	说明
code	string	返回结果状态。200：正常.
msg	string	返回状态信息
requestID	string	本次请求的唯一标识
messageSendResult	string	发送userid的单个结果 200:正常

返回示例

// success
{
    "msg": "成功",
    "messageSendResult": {
        "113": 200,
        "114": 200,
        "115": 200
    },
    "code": 200,
    "requestID": "043e846885e84269a4d9f817c4c5b2a2-LIVE-106116043"
}

// error
{
    "code": 403,
    "msg": "sign err"
}

错误码说明

错误码	描述	解决方案
400	参数错误	确认必传参数是否缺少
403	签名错误	参照签名生成进行签名生成
500	系统错误	联系我们
10006	参数长度错误	确认userId长度是否超过64位

已经过期不要使用

~~发送1 v 1聊天消息~~

~~URL：api/rest/message/converse/pushConverseData~~
支持格式：表单参数
请求方式：POST (application/x-www-form-urlencoded)
~~请求header~~

|返回字段|字段类型|说明 |

查看默认header-

请求参数

参数	必选	类型	说明
appId	true	string	LinkV 分配的im_app_id
fromUserId	true	string	发送用户标识
toUserId	true	string	接收用户标识
content	true	string	消息内容
objectName	true	string	消息类型默认RC:TxtMsg
toUserAppid	false	string	LinkV 分配的im_app_id
toUserExtSysUserId	false	string	接收方外部系统用户id

返回字段

返回字段字段类型说明
code string 返回结果状态。200：正常。
msg string 返回状态信息
requestID string 本次请求的唯一标识

返回示例

// success
{
    "msg": "成功",
    "code": 200
}

// error
{
    "code": 403,
    "msg": "sign err"
}

错误码说明

错误码	描述	解决方案
400	参数错误	确认必传参数是否缺少
403	签名错误	参照签名生成进行签名生成
500	系统错误	联系我们
10006	参数长度错误	确认userId长度是否超过64位

事件消息发送

非显示类消息内容

URL：/api/rest/v1/sendEventMsg
支持格式：表单参数
请求方式：POST (application/x-www-form-urlencoded)
请求参数

参数	必选	类型	说明
appId	true	string	LinkV 分配的live_app_id
fromUserId	true	string	发送者唯一标识
toUserId	true	string	接收者id
content	true	string	消息内容
objectName	true	string	消息类型

返回字段

返回字段	字段类型	说明
code	string	返回结果状态。200：正常。
msg	string	返回状态信息
requestID	string	本次请求的唯一标识

返回示例

// success
{
    "msg": "",
    "code": 200
}

// error
{
    "code": 403,
    "msg": "sign err"
}

错误码说明

错误码	描述	解决方案
400	参数错误	确认必传参数是否缺少
403	签名错误	参照签名生成进行签名生成
500	系统错误	联系我们
10006	参数长度错误	确认userId长度是否超过64位

已经过期不要使用

~~非显示类消息内容~~

~~URL：/api/rest/sendEventMsg~~
支持格式：表单参数
请求方式：POST (application/x-www-form-urlencoded)
请求参数

参数	必选	类型	说明
appId	true	string	LinkV 分配的live_app_id
fromUserId	true	string	发送者唯一标识
toUserId	true	string	接收者id
content	true	string	消息内容
objectName	true	string	消息类型

返回字段

返回字段	字段类型	说明
code	string	返回结果状态。200：正常。
msg	string	返回状态信息
requestID	string	本次请求的唯一标识

返回示例

// success
{
    "msg": "",
    "code": 200
}

// error
{
    "code": 403,
    "msg": "sign err"
}

错误码说明

错误码	描述	解决方案
400	参数错误	确认必传参数是否缺少
403	签名错误	参照签名生成进行签名生成
500	系统错误	联系我们
10006	参数长度错误	确认userId长度是否超过64位

私信拉黑

批量添加私信黑名单

URL：/api/rest/user/addUserBlack
支持格式：表单参数
请求方式：POST (application/x-www-form-urlencoded)
请求参数

参数	必选	类型	说明
userId	true	string	发送者唯一标识
blackUserIds	true	string	被拉黑用户列表id

返回字段

返回字段	字段类型	说明
code	string	返回结果状态。200：正常。
msg	string	返回状态信息
requestID	string	本次请求的唯一标识

返回示例

// success
{
    "msg": "成功",
    "messageSendResult": {
        "111": 200,
        "222": 200,
        "333": 200
    },
    "code": 200,
    "requestID": "62e2e0ba8c094bea9f35057a61731424-LIVE-106116064"
}

// error
{
    "msg": "成功",
    "messageSendResult": {
        "111": 1,
        "222": 1,
        "333": 1
    },
    "code": 200,
    "requestID": "62e2e0ba8c094bea9f35057a61731424-LIVE-106116064"
}

{
    "msg": "参数错误"
    "code": 10005,
    "requestID": "62e2e0ba8c094bea9f35057a61731424-LIVE-106116064"
}

错误码说明

错误码	描述	解决方案
400	参数错误	确认必传参数是否缺少
403	签名错误	参照签名生成进行签名生成
500	系统错误	联系我们
10005	参数错误	请查看msg ，修改相应参数信息
10006	参数长度错误	确认userId长度是否超过64位

messageSendResult 说明

关键字	说明
key 111	用户id
value 200	添加成功

批量删除私信黑名单

URL：/api/rest/user/removeUserBlack
支持格式：表单参数
请求方式：POST (application/x-www-form-urlencoded)
请求参数

参数	必选	类型	说明
userId	true	string	发送者唯一标识
blackUserIds	true	string	被拉黑用户列表id

返回字段

返回字段	字段类型	说明
code	string	返回结果状态。200：正常。
msg	string	返回状态信息
requestID	string	本次请求的唯一标识

返回示例

// success
{
    "msg": "成功",
    "messageSendResult": {
        "111": 200,
        "222": 200,
        "333": 200
    },
    "code": 200,
    "requestID": "62e2e0ba8c094bea9f35057a61731424-LIVE-106116064"
}

// error
{
    "msg": "成功",
    "messageSendResult": {
        "111": 1,
        "222": 1,
        "333": 1
    },
    "code": 200,
    "requestID": "62e2e0ba8c094bea9f35057a61731424-LIVE-106116064"
}

{
    "msg": "参数错误"
    "code": 10005,
    "requestID": "62e2e0ba8c094bea9f35057a61731424-LIVE-106116064"
}

错误码说明

错误码	描述	解决方案
400	参数错误	确认必传参数是否缺少
403	签名错误	参照签名生成进行签名生成
500	系统错误	联系我们
10005	参数错误	请查看msg ，修改相应参数信息
10006	参数长度错误	确认userId长度是否超过64位

messageSendResult 说明

关键字	说明
key 111	用户id
value 200	添加成功

发送直播间消息

发送直播间消息：发送直播间消息

URL：/api/rest/room/sendRoomMessage
支持格式：表单参数
请求方式：POST (application/x-www-form-urlencoded)
请求参数

参数	必选	类型	说明
roomId	true	string	直播间id
objectName	false	string	用于标识自定义消息类型
content	true	string	消息内容

返回字段

返回字段	字段类型	说明
code	string	返回结果状态。200：正常。
msg	string	返回状态信息
requestID	string	本次请求的唯一标识

返回示例

// success
{
    "msg": "",
    "code": 200
}

// error
{
    "code": 403,
    "msg": "sign err"
}

错误码说明

错误码	描述	解决方案
400	参数错误	确认必传参数是否缺少
403	签名错误	参照签名生成进行签名生成
500	系统错误	联系我们
10006	参数长度错误	确认userId长度是否超过64位

用户封禁

用户封禁：用户封禁

URL：/api/rest/user/block
支持格式：表单参数
请求方式：POST (application/x-www-form-urlencoded)
请求参数

参数	必选	类型	说明
appId	true	string	应用appd
userIds	true	string	用户ID，批量以逗号,分隔
minute	false	int	单位分钟，默认30分钟，最长30天

返回字段

返回字段	字段类型	说明
code	string	返回结果状态。200：正常。
msg	string	返回状态信息

返回示例

// success
{
    "msg": "",
    "code": 200
}

// error
{
    "code": "7002",
    "msg": "参数为空或格式不符合要求"
}

错误码说明

错误码	描述	解决方案
7002	参数为空或格式不符合要求	确认必传参数是否缺少
7005	封禁用户超过10000	解封部分用户
1	系统错误	联系我们

用户封禁：用户解封

URL：/api/rest/user/unblock
支持格式：表单参数
请求方式：POST (application/x-www-form-urlencoded)
请求参数

参数	必选	类型	说明
appId	true	string	应用appd
userIds	true	string	用户ID，批量以逗号,分隔

返回字段

返回字段	字段类型	说明
code	string	返回结果状态。200：正常。
msg	string	返回状态信息

返回示例

// success
{
    "msg": "",
    "code": 200
}

// error
{
    "code": 1,
    "msg": "系统错误"
}

错误码说明

错误码	描述	解决方案
7002	参数为空或格式不符合要求	确认必传参数是否缺少
1	系统错误	联系我们

用户封禁：封禁用户查询

URL：/api/rest/user/block/query
支持格式：表单参数
请求方式：POST (application/x-www-form-urlencoded)
请求参数

参数	必选	类型	说明
appId	true	string	应用appd
page	false	int	默认第1页
size	false	int	默认页大小50

返回字段

返回字段	字段类型	说明
code	string	返回结果状态。200：正常。
msg	string	返回状态信息
data	json	封禁用户信息
data :userId	string	封禁用户ID
data :endTime	string	封禁用户解封时间

返回示例

// success
{
    "msg": "",
    "code": 200,
    "data": [
        {
            "endTime": "2021-07-21 15:32:28",
            "userId": "66422"
        },
        {
            "endTime": "2021-07-21 15:38:15",
            "userId": "33222"
        }
    ]
}

// error
{
    "code": 1,
    "msg": "系统错误"
}

错误码说明

错误码	描述	解决方案
7002	参数为空或格式不符合要求	确认必传参数是否缺少
1	系统错误	联系我们

查询用户信息

查询用户在线状态

URL：/api/rest/userOnlineStatus
支持格式：表单参数
请求方式：POST (application/x-www-form-urlencoded)
请求参数

参数	必选	类型	说明
userId	true	string	用户id
appId	true	string	应用标识

返回字段

返回字段	字段类型	说明
code	string	返回结果状态。200：正常。
msg	string	返回状态信息
data	int32	返回数据 1:用户在线，0:用户离线
requestID	string	本次请求的唯一标识

返回示例

// success
{
    "msg": "成功",
    "code": 200,
    "data": 1
}

// error
{
    "code": 403,
    "msg": "sign err"
}

错误码说明

错误码	描述	解决方案
400	参数错误	确认必传参数是否缺少
403	签名错误	参照签名生成进行签名生成
500	系统错误	联系我们
10006	参数长度错误	确认userId长度是否超过64位

消息路由

支持将单聊消息数据同步到开发者应用服务器。
调用 Server API 接口发送的消息，默认不会通过消息路由服务，如果需要路由可在开发者后台中开通。

请求参数

参数	类型	说明
appId	string	LinkV 分配的im_app_id
fromUserId	string	发送用户标识
toUserId	string	接收用户标识
objectName	string	消息类型，文本消息：0;图片：1;语音：2;视频：3
content	string	消息内容
channelType	string	会话类型，单聊：17
msgTimestamp	string	服务端收到客户端发送消息时的服务器时间（1970年到现在的毫秒数）。
msgUID	string	消息唯一id。
source	string	标识消息的发送源头，包括：PC客户端,WEB端,Android,iOS,iPAD,WinPhone

同步消息时需要服务提供应答 200，收到应答后表示消息同步成功，如果应答超时 4 秒，IM会再尝试推送 2 次，如果仍然失败，IM将不再推送此消息，如短时间内有大面积超时，将暂停推送，2 分钟后会继续推送。

请求示例：

为了验证数据有效性并确保调用者为LinkV Server，每个请求前添加数据签名，签名信息参数signature（下方附生成示例）在接收地址的 URL 上提供。
假设开发者注册的接收地址：http://test.com/receive
请求方法： POST

Request：

POST /receive?signTimestamp=1630912573178&nonce=12345&signature=005d3de765722d6da8d55cf30119c14f HTTP/1.1
Host: test.com
Content-Type: application/x-www-form-urlencoded

fromUserId=123&toUserId=456&objectName=0&content=hello&channelType=10&msgTimestamp=1630912573178&msgUID=1055280621045100544

在进行下面的步骤之前，需要从开发者平台先获取app_secret。

签名信息参数signature生成示例，三个参数appSecret、timestamp、nonce拼接字符串后md5加密。

appSecret="098f6bcd4621d373cade4e832627b4f6"
timestamp ="1630912573178"
nonce ="12312"
signKeyStr = appSecret+nonce+signTimestamp;
signature=MD5(signKeyStr);

消息历史日志

下载地址获取

说明：获取 APP 内指定某天某小时内的所有会话消息记录的下载地址（目前仅支持二人会话消息历史记录下载。），消息记录以日志文件方式提供，并对文件进行压缩。
URL：/api/rest/getHistoryMsgZipUrl
支持格式：表单参数
请求方式：POST (application/x-www-form-urlencoded)
请求参数

参数	必选	类型	说明
date	true	string	指定北京时间某天某小时，格式为2022010101，表示获取 2022 年 1 月 1 日凌晨 1 点至 2 点的数据。
appId	true	string	应用标识

注：IM消息历史日志服务所使用的时间均为北京时间，如您的业务所使用的时间为 UTC 时，获取消息日志时使用的时间需要根据需要自行转换处理。如要下载北京时间 2022010109 的日志，需要输入 2022010101。

返回字段

返回字段	字段类型	说明
code	string	返回结果状态。200：正常。
msg	string	返回状态信息。
data	json	返回数据,date:历史记录时间;url:历史记录下载地址，如没有消息记录数据时，则 url 值为空，下载地址有效期1小时。
requestID	string	本次请求的唯一标识。

返回示例

// success
{
    "code": 200,
    "msg": "成功",
    "data": "{
        "date": 2022010101,
        "url": "https://*.*.*.*/*/2022-01-01-01/2022010101_message.zip?X-Amz-Security-Token=IQoJb3JpZ2luX"
    }",
    "requestID": "xxx"
}

错误码说明

错误码	描述	解决方案
10005	参数错误	确认必传参数是否缺少，长度是否正确。

注：消息记录以日志方式提供，并对文件进行 ZIP 压缩，通过该接口返回消息记录文件下载地址后，请自行下载。消息记录数据每小时产生一次，例如 10 点的数据，在 11 点以后才能调用该接口获取到下载地址，在获取时可能会出现延迟，请尝试多次获取，最晚 1 小时即可获取到下载地址。消息记录日志文件，我们为您在服务器端保存 3 天，无论是否下载过，3 天后都将从服务器删除。

日志文件中，消息格式为 json ：

{
    "appId":"linkvim",
    "fromUserId":"654321",
    "toUserId":"123456",
    "content":"{"content":"Hello"}",
    "objectName":"letter",
    "pushData":"",
    "toUserAppid":"linkvim",
    "toUserExtSysUserId":"1290907488878731265",
    "msgTimestamp":1640836803913,
    "msgId":"4387623446807301120"
}

格式说明

名称	类型	说明
appId	string	LinkV 分配的im_app_id
fromUserId	string	发送用户标识
toUserId	string	接收用户标识
content	string	消息内容
objectName	string	消息类型默认RC:TxtMsg
pushData	json	推送消息内容，不传不发推送,格式为json
toUserAppid	string	LinkV 分配的im_app_id
toUserExtSysUserId	string	接收方外部系统用户id
msgTimestamp	long	发送消息的时间戳
msgId	string	消息ID

示例

Request：

POST /api/rest/getHistoryMsgZipUrl?appId=linkvim&date=2022010101 HTTP/1.1
Host: test.com
Content-Type: application/x-www-form-urlencoded

Response：

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

{
    "code": 200,
    "msg": "成功",
    "data": "{
        "date": 2022010101,
        "url": "https://*.*.*.*/*/2022-01-01-01/2022010101_message.zip?X-Amz-Security-Token=IQoJb3JpZ2luX"
    }",
    "requestID": "xxx"
}

群组服务

功能列表

功能	描述
创建群组	App 内的群组数量没有限制。
加入群组	每个群最大至 1000 人。
退出群组	将用户从群中移除，不再接收该群组的消息。
解散群组	将指定群组解散，所有成员都无法再接收该群的消息。
群成员查询	获取指定群组中群成员用户 Id。
获取群信息	获取指定群组名称与公告信息。
更新群组信息	目前支持更新群组名称。
更新群组公告	目前支持更新群组公告信息。
管理员变更	群组管理员转让。
用户所属群组查询	获取指定用户所属全部群组列表。
群组踢人	将指定群组中的指定用户移除该群组，此用户无法再接收该群组的消息。
群组成员禁言	被禁言用户可以接收查看群组中其他用户消息，但不能发送群组消息。
群组全员禁言	除群组管理员以外，指定群组所有成员不能发送消息。
消息免打扰设置	群组用户设置消息免打扰后将不接收此群组消息推送（Push）。

创建群组

URL：/api/rest/group/create
支持格式：表单参数
请求方式：POST (application/x-www-form-urlencoded)
请求参数

参数	必选	类型	说明
appId	true	string	应用标识
userId	true	string	用户标识ID
groupId	true	string	群组ID
groupName	true	string	群组名称
nickName	true	string	用户群昵称

返回字段

返回字段	字段类型	说明
code	string	返回结果状态。200：正常。
msg	string	返回状态信息
requestID	string	本次请求的唯一标识

返回示例

// success
{
    "msg": "成功",
    "code": 200,
    "requestID": "XXX"
}

加入群组

URL：/api/rest/group/join
支持格式：表单参数
请求方式：POST (application/x-www-form-urlencoded)
请求参数

参数	必选	类型	说明
appId	true	string	应用标识
userId	true	string	用户标识ID
groupId	true	string	群组ID
nickName	true	string	用户群昵称

返回字段

返回字段	字段类型	说明
code	string	返回结果状态。200：正常。
msg	string	返回状态信息
requestID	string	本次请求的唯一标识

返回示例

// success
{
    "msg": "成功",
    "code": 200,
    "requestID": "XXX"
}

退出群组

URL：/api/rest/group/exit
支持格式：表单参数
请求方式：POST (application/x-www-form-urlencoded)
请求参数

参数	必选	类型	说明
appId	true	string	应用标识
userId	true	string	用户标识ID
groupId	true	string	群组ID

返回字段

返回字段	字段类型	说明
code	string	返回结果状态。200：正常。
msg	string	返回状态信息
requestID	string	本次请求的唯一标识

返回示例

// success
{
    "msg": "成功",
    "code": 200,
    "requestID": "XXX"
}

解散群组

URL：/api/rest/group/dissolve
支持格式：表单参数
请求方式：POST (application/x-www-form-urlencoded)
请求参数

参数	必选	类型	说明
appId	true	string	应用标识
userId	true	string	用户标识ID，必须管理员ID操作
groupId	true	string	群组ID

返回字段

返回字段	字段类型	说明
code	string	返回结果状态。200：正常。
msg	string	返回状态信息
requestID	string	本次请求的唯一标识

返回示例

// success
{
    "msg": "成功",
    "code": 200,
    "requestID": "XXX"
}

群成员查询

URL：/api/rest/group/users
支持格式：表单参数
请求方式：POST (application/x-www-form-urlencoded)
请求参数

参数	必选	类型	说明
appId	true	string	应用标识
groupId	true	string	群组ID
page	true	string	起始页，从1开始
size	true	string	每页数量

返回字段

返回字段	字段类型	说明
code	string	返回结果状态。200：正常。
msg	string	返回状态信息
data	string[]	返回群组成员信息数组
requestID	string	本次请求的唯一标识

返回示例

// success
{
    "msg": "成功",
    "code": 200,
    "data": [
        {
        "gid": "xxx",
        "uid": "xxx",
        "createtime": "xxx",
        "nickname": "xxx",
        "appid": "xxx",
        "role": x,
        "gagstatus": x,
        "notifiable": x,
        "status":x
        },
        {
        "gid": "xxx",
        "uid": "xxx",
        "createtime": "xxx",
        "nickname": "xxx",
        "appid": "xxx",
        "role": x,
        "gagstatus": x,
        "notifiable": x,
        "status":x
        }
    ]
    "requestID": "XXX"
}

获取群信息

URL：/api/rest/group/groupInfo
支持格式：表单参数
请求方式：POST (application/x-www-form-urlencoded)
请求参数

参数	必选	类型	说明
appId	true	string	应用标识
groupId	true	string	群组ID

返回字段

返回字段	字段类型	说明
code	string	返回结果状态。200：正常。
msg	string	返回状态信息
data	json	返回群组信息basicInfo与公告信息attach
requestID	string	本次请求的唯一标识

返回示例

// success
{
    "msg": "成功",
    "code": 200,
    "data": {
        "basicInfo": {
            "gid": "xxx",
            "gname": "xxx",
            "block": x,
            "admin": "xxx",
            "createtime": "xxx",
            "appid": "xxx",
            "gagstatus": x,
            "version": x
        },
        "attach": {
            "appid": "xxx",
            "gid": "xxx",
            "topic": "xxx",
            "modifytime": "xxx",
            "author": "xxx"
        }
    },
    "requestID": "XXX"
}

更新群组信息

URL：/api/rest/group/modifyName
支持格式：表单参数
请求方式：POST (application/x-www-form-urlencoded)
请求参数

参数	必选	类型	说明
appId	true	string	应用标识
userId	true	string	用户标识ID，必须管理员ID操作
groupId	true	string	群组ID
groupName	true	string	群组名称

返回字段

返回字段	字段类型	说明
code	string	返回结果状态。200：正常。
msg	string	返回状态信息
requestID	string	本次请求的唯一标识

返回示例

// success
{
    "msg": "成功",
    "code": 200,
    "requestID": "XXX"
}

更新群组公告

URL：/api/rest/group/modifyTopic
支持格式：表单参数
请求方式：POST (application/x-www-form-urlencoded)
请求参数

参数	必选	类型	说明
appId	true	string	应用标识
userId	true	string	用户标识ID，必须管理员ID操作
groupId	true	string	群组ID
topic	true	string	群组公告

返回字段

返回字段	字段类型	说明
code	string	返回结果状态。200：正常。
msg	string	返回状态信息
requestID	string	本次请求的唯一标识

返回示例

// success
{
    "msg": "成功",
    "code": 200,
    "requestID": "XXX"
}

管理员变更

URL：/api/rest/group/transfer
支持格式：表单参数
请求方式：POST (application/x-www-form-urlencoded)
请求参数

参数	必选	类型	说明
appId	true	string	应用标识
groupId	true	string	群组ID
adminUserId	true	string	原管理员ID
toUserId	true	string	转让后管理员ID

返回字段

返回字段	字段类型	说明
code	string	返回结果状态。200：正常。
msg	string	返回状态信息
requestID	string	本次请求的唯一标识

返回示例

// success
{
    "msg": "成功",
    "code": 200,
    "requestID": "XXX"
}

用户所属群组查询

URL：/api/rest/group/groups
支持格式：表单参数
请求方式：POST (application/x-www-form-urlencoded)
请求参数

参数	必选	类型	说明
appId	true	string	应用标识
userId	true	string	用户标识ID
page	true	int	起始页，从1开始
size	true	int	每页数量

返回字段

返回字段	字段类型	说明
code	string	返回结果状态。200：正常。
msg	string	返回状态信息
data	string[]	返回群组信息数组
requestID	string	本次请求的唯一标识

返回示例

// success
{
    "msg": "成功",
    "code": 200,
    "data": [
        {
        "gid": "xxx",
        "gname": "xxx",
        "block": x,
        "admin": "xxx",
        "createtime": "xxx",
        "appid": "xxx",
        "gagstatus": x,
        "version":x
        },
        {
        "gid": "xxx",
        "gname": "xxx",
        "block": x,
        "admin": "xxx",
        "createtime": "xxx",
        "appid": "xxx",
        "gagstatus": x,
        "version":x
        }
    ]
    "requestID": "XXX"
}

群组踢人

URL：/api/rest/group/groupKickUser
支持格式：表单参数
请求方式：POST (application/x-www-form-urlencoded)
请求参数

参数	必选	类型	说明
appId	true	string	应用标识
groupId	true	string	群组ID
fromUserId	true	string	用户标识ID，必须管理员ID操作
toUserId	true	string	用户标识ID，被踢用户ID

返回字段

返回字段	字段类型	说明
code	string	返回结果状态。200：正常。
msg	string	返回状态信息
requestID	string	本次请求的唯一标识

返回示例

// success
{
    "msg": "成功",
    "code": 200,
    "requestID": "XXX"
}

群组成员禁言

URL：/api/rest/group/gagUser
支持格式：表单参数
请求方式：POST (application/x-www-form-urlencoded)
请求参数

参数	必选	类型	说明
appId	true	string	应用标识
groupId	true	string	群组ID
fromUserId	true	string	用户标识ID，必须管理员ID操作
toUserId	true	string	用户标识ID，被禁言用户ID
type	true	int	0:解除禁言；1:禁言

返回字段

返回字段	字段类型	说明
code	string	返回结果状态。200：正常。
msg	string	返回状态信息
requestID	string	本次请求的唯一标识

返回示例

// success
{
    "msg": "成功",
    "code": 200,
    "requestID": "XXX"
}

群组全员禁言

URL：/api/rest/group/gagAllUser
支持格式：表单参数
请求方式：POST (application/x-www-form-urlencoded)
请求参数

参数	必选	类型	说明
appId	true	string	应用标识
groupId	true	string	群组ID
fromUserId	true	string	用户标识ID，必须管理员ID操作
type	true	int	0:解除禁言；1:禁言

返回字段

返回字段	字段类型	说明
code	string	返回结果状态。200：正常。
msg	string	返回状态信息
requestID	string	本次请求的唯一标识

返回示例

// success
{
    "msg": "成功",
    "code": 200,
    "requestID": "XXX"
}

消息免打扰设置

URL：/api/rest/group/setNotifiable
支持格式：表单参数
请求方式：POST (application/x-www-form-urlencoded)
请求参数

参数	必选	类型	说明
appId	true	string	应用标识
groupId	true	string	群组ID
fromUserId	true	string	用户标识ID
type	true	int	消息通知 0:关闭；1:打开接收通知

返回字段

返回字段	字段类型	说明
code	string	返回结果状态。200：正常。
msg	string	返回状态信息
requestID	string	本次请求的唯一标识

返回示例

// success
{
    "msg": "成功",
    "code": 200,
    "requestID": "XXX"
}

错误码说明

错误码	描述	解决方案
10005	参数错误	确认必传参数是否缺少
3000	服务异常	联系我们
3001	保存群组临时消息异常	联系我们
3003	保存群组和人员关系信息失败	查看是否拥有管理员权限或联系我们
3004	保存人员拥有的群组信息失败	联系我们
3007	更新群组信息失败	查看是否拥有管理员权限
3008	更新群组信息失败	查看是否拥有管理员权限
3009	保存群组和人员关系信息失败	查看是否拥有管理员权限或联系我们
3102	管理员退出群组失败,管理员可以解散群不能退出群	查看操作是否正确
3105	参数错误	确认参数是否正确
3106	参数错误	确认群组ID是否重复
3107	群组不存在	确认群组ID是否存在
3108	管理员才能操作	查看是否拥有管理员权限
3109	用户不在群里面	查看用户ID是否正确
3110	群组已经被解散	查看群组ID是否正确
3111	群组人数已满	查看群组人数是否超过1000上限
3112	群组ID已存在	查看群组ID是否正确
3113	重复加入群组失败	查看用户是否已加入过群组
3999	服务异常	联系我们

No newline at end of file

服务端集成签名生成

即时通讯（IM）