关于使用规则，请注意：
关于接口文档，请注意：
目录 |
获取***********用户token(1.0)，具体如下：
接口调用请求说明
http请求方式: POST
{WebPath}/api/***********/GetToken
POST数据说明
POST数据示例如下：
{
userID:"10129580"
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| userID | 是 | 当前登录用户ID |
返回值说明
在调用接口后，会返回JSON数据包。正常时的返回JSON数据包示例：
{
"error": 0,
"token": "asdsadqeqweqweqweqweqw"
}
返回字段说明
| 字段 | 类型 | 说明 | |||
|---|---|---|---|---|---|
| error | int | 返回值:'0'表示成功，'1'表示失败 | |||
| message | string | 'error=1'时错误信息有值返回 | |||
| token | string | 用户*********** token | |||
检查在线状态(1.0)，具体如下：
接口调用请求说明
http请求方式: POST
{WebPath}/api/***********/CheckOnline
POST数据说明
POST数据示例如下：
{
userID:"10129580"
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| userID | 是 | 当前登录用户ID |
返回值说明
在调用接口后，会返回JSON数据包。正常时的返回JSON数据包示例：
{
"error": 0,
"status": 0
}
返回字段说明
| 字段 | 类型 | 说明 | |||
|---|---|---|---|---|---|
| error | int | 返回值:'0'表示成功，'1'表示失败 | |||
| message | string | 'error=1'时错误信息有值返回 | |||
| status | int | 0不在线，1在线 | |||
发送文字信息(1.0)，具体如下：
接口调用请求说明
http请求方式: POST
{WebPath}/api/***********/SendMessagePrivate
POST数据说明
POST数据示例如下：
{
fromUserId:"10129580",
toUserId:[
"10008817"
],
content:"{"content":"hello","extra":"helloExtra"}",
objectName:"RC:TxtMsg"
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| fromUserId | 是 | 发送人ID |
| toUserId | 是 | 接收人ID数组 |
| content | 是 | 格式详情请见融云SDK |
| objectName | 是 | 发送类型参照融云SDK |
返回值说明
在调用接口后，会返回JSON数据包。正常时的返回JSON数据包示例：
{
"error": 0,
"data":{
sendDate:"2017-09-22 10:22"
}
}
返回字段说明
| 字段 | 类型 | 说明 | |||
|---|---|---|---|---|---|
| error | int | 返回值:'0'表示成功，'1'表示失败 | |||
| message | string | 'error=1'时错误信息有值返回 | |||
| data | sendDate | string | 发送时间 | ||
发送信息（群组）(1.0)，具体如下：
接口调用请求说明
http请求方式: POST
{WebPath}/api/***********/SendMessageGroup
POST数据说明
POST数据示例如下：
{
fromUserId:"10129580",
toGroupId:[
"10000001"
],
content:"{"content":"hello","extra":"helloExtra"}",
objectName:"RC:TxtMsg"
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| fromUserId | 是 | 发送人ID |
| toGroupId | 是 | 群组ID数组 |
| content | 是 | content 表示文本内容，extra 为附加信息 |
| objectName | 是 | 发送类型参照融云SDK |
返回值说明
在调用接口后，会返回JSON数据包。正常时的返回JSON数据包示例：
{
"error": 0,
"data":{
sendDate:"2017-09-22 10:22"
}
}
返回字段说明
| 字段 | 类型 | 说明 | |||
|---|---|---|---|---|---|
| error | int | 返回值:'0'表示成功，'1'表示失败 | |||
| message | string | 'error=1'时错误信息有值返回 | |||
| data | sendDate | string | 发送时间 | ||
同步群组(1.0)，具体如下：
接口调用请求说明
http请求方式: POST
{WebPath}/api/***********/SyncGroup
POST数据说明
POST数据示例如下：
{
userID:"10129580",
groups:[
{
id:"10000001",
name:"qwe"
}
]
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| userID | 是 | 发送人ID |
| groups | 是 | 组集合 |
| id | 是 | 组ID |
| name | 是 | 组名称 |
返回值说明
在调用接口后，会返回JSON数据包。正常时的返回JSON数据包示例：
{
"error": 0
}
返回字段说明
| 字段 | 类型 | 说明 | |||
|---|---|---|---|---|---|
| error | int | 返回值:'0'表示成功，'1'表示失败 | |||
| message | string | 'error=1'时错误信息有值返回 | |||
创建群组(1.0)，具体如下：
接口调用请求说明
http请求方式: POST
{WebPath}/api/***********/CreateGroup
POST数据说明
POST数据示例如下：
{
userID:"10008817",
userIds:[
"10008817"
],
groupName:"123",
groupType:0
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| userID | 是 | 创建者ID |
| userIds | 是 | 创建群组的用户ID数组 |
| groupName | 是 | 群组名称 |
| groupType | 是 | 群组类型0固定群组，1自定义群组 |
返回值说明
在调用接口后，会返回JSON数据包。正常时的返回JSON数据包示例：
{
"error": 0,
"data":{
groupID:"13154131351531",
groupName:"123",
createDate:"2017-09-22 14:22:00",
groupType:0
}
}
返回字段说明
| 字段 | 类型 | 说明 | |||
|---|---|---|---|---|---|
| error | int | 返回值:'0'表示成功，'1'表示失败 | |||
| message | string | 'error=1'时错误信息有值返回 | |||
| data | groupID | string | 群组ID | ||
| groupName | string | 群组名称 | |||
| createDate | string | 创建日期 | |||
| userID | string | 创建人ID | |||
| empName | string | 创建人姓名 | |||
| groupType | int | 群组类型0固定群组1自定义群组 | |||
加入群组(1.0)，具体如下：
接口调用请求说明
http请求方式: POST
{WebPath}/api/***********/JoinGroup
POST数据说明
POST数据示例如下：
{
userIds:[
"10008817"
],
groupID:"1123132132132",
groupName:"123"
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| userIds | 是 | 加群的人的ID集合 |
| groupID | 是 | 所加组的ID |
| groupName | 是 | 所加组的名称 |
返回值说明
在调用接口后，会返回JSON数据包。正常时的返回JSON数据包示例：
{
"error": 0
}
返回字段说明
| 字段 | 类型 | 说明 | |||
|---|---|---|---|---|---|
| error | int | 返回值:'0'表示成功，'1'表示失败 | |||
| message | string | 'error=1'时错误信息有值返回 | |||
退出群组(1.0)，具体如下：
接口调用请求说明
http请求方式: POST
{WebPath}/api/***********/QuitGroup
POST数据说明
POST数据示例如下：
{
userIds:[
"10008817"
],
groupID:"1123132132132",
groupName:"123"
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| userIds | 是 | 退群的人的ID集合 |
| groupID | 是 | 所退组的ID |
| groupName | 是 | 所退组的名称 |
返回值说明
在调用接口后，会返回JSON数据包。正常时的返回JSON数据包示例：
{
"error": 0
}
返回字段说明
| 字段 | 类型 | 说明 | |||
|---|---|---|---|---|---|
| error | int | 返回值:'0'表示成功，'1'表示失败 | |||
| message | string | 'error=1'时错误信息有值返回 | |||
解散群组(1.0)，具体如下：
接口调用请求说明
http请求方式: POST
{WebPath}/api/***********/DismissGroup
POST数据说明
POST数据示例如下：
{
userID:"10008817",
groupID:"1123132132132"
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| userID | 是 | 解散人ID |
| groupID | 是 | 要解散的组的ID |
返回值说明
在调用接口后，会返回JSON数据包。正常时的返回JSON数据包示例：
{
"error": 0
}
返回字段说明
| 字段 | 类型 | 说明 | |||
|---|---|---|---|---|---|
| error | int | 返回值:'0'表示成功，'1'表示失败 | |||
| message | string | 'error=1'时错误信息有值返回 | |||
更新群组信息(1.0)，具体如下：
接口调用请求说明
http请求方式: POST
{WebPath}/api/***********/RefreshGroupInfo
POST数据说明
POST数据示例如下：
{
groupID:"1231212312312",
groupName:"123"
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| groupID | 是 | 群组ID |
| groupName | 是 | 群组新名称 |
返回值说明
在调用接口后，会返回JSON数据包。正常时的返回JSON数据包示例：
{
"error": 0
}
返回字段说明
| 字段 | 类型 | 说明 | |||
|---|---|---|---|---|---|
| error | int | 返回值:'0'表示成功，'1'表示失败 | |||
| message | string | 'error=1'时错误信息有值返回 | |||
查询群组成员(1.0)，具体如下：
接口调用请求说明
http请求方式: POST
{WebPath}/api/***********/QueryGroupMember
POST数据说明
POST数据示例如下：
{
groupID:"12312312321321"
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| groupID | 是 | 群组ID |
返回值说明
在调用接口后，会返回JSON数据包。正常时的返回JSON数据包示例：
{
"error": 0
"data":
{
groupName:"12312",
announcement:"12312312",
users:[
{
userID:"12312312",
userName:"123123",
photoPath:"12312"
}
]
}
}
返回字段说明
| 字段 | 类型 | 说明 | |||
|---|---|---|---|---|---|
| error | int | 返回值:'0'表示成功，'1'表示失败 | |||
| message | string | 'error=1'时错误信息有值返回 | |||
| data | groupName | string | 群组名称 | ||
| announcement | string | 群公告 | |||
| userName | string | 用户名称 | |||
| userName | string | 用户名称 | |||
| photoPath | string | 头像 | |||
获取群组列表(1.0)，具体如下：
接口调用请求说明
http请求方式: POST
{WebPath}/api/***********/GetGroupList
POST数据说明
POST数据示例如下：
{
userID:"10008817"
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| userID | 是 | 用户ID |
返回值说明
在调用接口后，会返回JSON数据包。正常时的返回JSON数据包示例：
{
"error": 0
"data":[
{
id:"12312",
name:"12312",
userID:"12312312"
}
]
}
返回字段说明
| 字段 | 类型 | 说明 | |||
|---|---|---|---|---|---|
| error | int | 返回值:'0'表示成功，'1'表示失败 | |||
| message | string | 'error=1'时错误信息有值返回 | |||
| data | id | string | 群组ID | ||
| name | string | 群组名称 | |||
| userID | string | 群组创建人ID | |||
| empName | string | 群组创建人名称 | |||
修改群组公告(1.0)，具体如下：
接口调用请求说明
http请求方式: POST
{WebPath}/api/***********/ModifyGroupAnnouncement
POST数据说明
POST数据示例如下：
{
groupID:"10000001",
content:"1312"
}
参数说明
| 参数 | 是否必须 | 说明 |
|---|---|---|
| groupID | 是 | 群组ID |
| content | 是 | 公告内容 |
返回值说明
在调用接口后，会返回JSON数据包。正常时的返回JSON数据包示例：
{
"error": 0
}
返回字段说明
| 字段 | 类型 | 说明 | |||
|---|---|---|---|---|---|
| error | int | 返回值:'0'表示成功，'1'表示失败 | |||
| message | string | 'error=1'时错误信息有值返回 | |||