成员管理接口是云通讯平台在群组功能基础上为开发者提供的相关接口,便于开发者管理群组成员。成员管理相关接口包括修改、查询群名片信息,查询群组成员,查询成员所加入的组,管理员验证用户申请加入群组,用户验证管理员邀请加入群组,管理员对用户禁言接口。
1 修改群名片信息
1.1 请求地址
POST /{SoftVersion}/Application/{appId}/IM/Member/ModifyCard
1.2 请求包头
请参阅《鉴权说明》
1.3 请求包体
属性 | 类型 | 约束 | 说明 |
---|---|---|---|
userName | String | 可选 | 自定义账号或通讯账号 |
belong | String | 必选 | 用户所属的群组ID |
voipAccount | String | 可选 | 如请求发起者为群主,则此处可填成员帐号,实现群主修改成员名片的功能 |
display | String | 可选 | 用户名字 |
String | 可选 | 用户邮箱 | |
tel | String | 可选 | 用户电话 |
remark | String | 可选 | 用户备注,最长为50个字符 |
1.4 请求示例
POST /2013-12-26/Application/20150314000000110000000000000010/IM/Member/ModifyCard?sig=C1F20E7A7 HTTP/1.1 Accept:application/json; Content-Type:application/json;charset=utf-8; Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyM= { "userName":"123", "display":"张三", "tel":"13300981249", "mail":"zhang@163.com", "remark":"13800138000", "belong":"g80006123456789" }
1.5 响应包体
属性 | 类型 | 约束 | 说明 |
---|---|---|---|
statusCode | String | 必选 | 请求状态码,取值000000(成功),可参考Rest 错误代码。 |
1.6 响应示例
HTTP/1.1 200 OK Content-Length: 641 {"statusCode":"000000"}
2 查询群名片信息
2.1 请求地址
POST /{SoftVersion}/Application/{appId}/IM/Member/QueryCard
2.2 请求包头
请参阅《鉴权说明》
2.3 请求包体
属性 | 类型 | 约束 | 说明 |
---|---|---|---|
userName | String | 可选 | 自定义账号或通讯账号 |
other | String | 必选 | 群组中成员的账号 |
belong | String | 必选 | 用户所属的群组ID |
2.4 请求示例
POST /2013-12-26/Application/20150314000000110000000000000010/IM/Member/QueryCard?sig=C1F20E7A97 HTTP/1.1 Accept:application/json; Content-Type:application/json;charset=utf-8; Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyM= { "userName": "123", "other": "80006123456789", "belong": "g80006123456789" }
2.5 响应包体
属性 | 类型 | 约束 | 说明 |
---|---|---|---|
statusCode | String | 必选 | 请求状态码,取值000000(成功) |
display | String | 必选 | 用户名字 |
belong | String | 必选 | 用户所属的群组ID |
String | 可选 | 用户邮箱 | |
remark | String | 可选 | 用户备注 |
tel | String | 可选 | 用户电话 |
2.6 响应示例
HTTP/1.1 200 OK Content-Length: 641 { "statusCode":"000000", "display":"张三", "tel":"13300981249", "mail":"zhang@163.com", "remark ":"13800138000", "belong":"g80006123456789" }
3 查询群组成员
3.1 请求地址
POST /{SoftVersion}/Application/{appId}/IM/Member/QueryMember
3.2 请求包头
请参阅《鉴权说明》
3.3 请求包体
属性 | 类型 | 约束 | 说明 |
---|---|---|---|
userName | String | 可选 | 自定义账号或通讯账号 |
groupId | String | 必选 | 群组ID |
3.4 请求示例
POST /2013-12-26/Application/20150314000000110000000000000010/IM/Member/QueryMember?sig=C1F20E7A97 HTTP/1.1 Accept:application/json; Content-Type:application/json;charset=utf-8; Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyM= { "userName":"123", "groupId": "g80000049837291" }
3.5 响应包体
属性 | 类型 | 约束 | 说明 |
---|---|---|---|
statusCode | String | 必选 | 请求状态码,取值000000(成功),可参考Rest 错误代码。 |
members | String | 必选 | 群组成员列表外层节点 |
member | String | 必选 | 群组成员 |
voipAccount | String | 必选 | 成员的账号 |
role | String | 必选 | 角色 0创建者 1 管理员 2 普通成员 |
isBan | String | 必选 | 是否被禁言 0 :可发言 1:被禁言(管理员可见) |
3.6 响应示例
HTTP/1.1 200 OK Content-Length: 641 { "statusCode":"000000", "members":[ {"voipAccount":"80000089765342","isBan":"0","role":"1"}, {"voipAccount":"80000089765343","isBan":"0","role":"1"} ] }
4 查询成员所加入的组
4.1 请求地址
POST /{SoftVersion}/Application/{appId}/IM/Member/QueryGroup
4.2 请求包头
请参阅《鉴权说明》
4.3 请求包体
属性 | 类型 | 约束 | 说明 |
---|---|---|---|
userName | String | 可选 | 自定义账号或通讯账号 |
target |
String | 可选 |
0:讨论组 1:群组 2:所有 缺省1 |
4.4 请求示例
POST /2013-12-26/Application/20150314000000110000000000000010/IM/Member/QueryGroup?sig=C1F20E7A97 HTTP/1.1 Accept:application/json; Content-Type:application/json;charset=utf-8; Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyM= { "userName": "123", "target": "2" }
4.5 响应包体
属性 | 类型 | 约束 | 说明 |
---|---|---|---|
statusCode | String | 必选 | 请求状态码,取值000000(成功),可参考Rest 错误代码。 |
groups | String | 必选 | 成员加入的群组列表外层节点 |
group | String | 必选 | 成员加入的群组 |
groupId | String | 必选 | 群组ID |
name | String | 必选 | 群组名字 |
count | Stirng | 必选 | 群组成员数量 |
type | String | 必选 | 群组类型 0:临时组(上限100人) 1:付费普通组(上限300人) 2:付费普通组(上限500人) 3:付费普通组 (上限1000人) 4:付费VIP组(上限2000人) |
permission |
String | 必选 | 申请加入模式 0:默认直接加入 1:需要身份验证 2:私有群组 |
dateCreated |
String | 必选 | 群组创建时间,格式为时间戳 |
target |
String |
必选 |
0:讨论组 1:群组 |
4.6 响应示例
HTTP/1.1 200 OK Content-Length: 641 { "statusCode":"000000", "groups":[ { "groupId":"g9827362519373", "name":"云通讯", "count":"1", "type":"1", "permission":"0" },{ "groupId":"g9827362519374", "name":"云通讯", "count":"2", "type":"1", "permission":"0"} ]}
5 管理员验证用户申请加入群组
5.1 请求地址
POST /{SoftVersion}/Application/{appId}/IM/Member/AskJoin
5.2 请求包头
请参阅《鉴权说明》
5.3 请求包体
属性 | 类型 | 约束 | 说明 |
---|---|---|---|
userName | String | 可选 | 自定义账号或通讯账号 |
groupId | String | 必选 | 群组ID |
asker | String | 必选 | 申请成员的帐号 |
confirm | String | 可选 | 0 :通过 1:拒绝 |
5.4 请求示例
POST /2013-12-26/Application/20150314000000110000000000000010/IM/Member/AskJoin?sig=C1F20E7A97 HTTP/1.1 Accept:application/json; Content-Type:application/json;charset=utf-8; Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyM= { "userName": "123", "groupId": "g80000012345678", "asker": "80000123456768", "confirm": "0" }
5.5 响应包体
属性 | 类型 | 约束 | 说明 |
---|---|---|---|
statusCode | String | 必选 | 请求状态码,取值000000(成功),可参考Rest 错误代码。 |
5.6 响应示例
HTTP/1.1 200 OK Content-Length: 641 {"statusCode":"000000"}
6 用户验证管理员邀请加入群组
6.1 请求地址
POST /{SoftVersion}/Application/{appId}/IM/Member/InviteGroup
6.2 请求包头
请参阅《鉴权说明》
6.3 请求包体
属性 | 类型 | 约束 | 说明 |
---|---|---|---|
userName | String | 可选 | 自定义账号或通讯账号 |
groupId | String | 必选 | 群组ID |
confirm | String | 可选 | 0 :通过 1:拒绝 |
6.4 请求示例
POST /2013-12-26/Application/20150314000000110000000000000010/IM/Member/InviteGroup?sig=C1F20E7A97 HTTP/1.1 Accept:application/json; Content-Type:application/json;charset=utf-8; Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyM= { "userName": "123", "groupId": "g80000012345678", "confirm": "0" }
6.5 响应包体
属性 | 类型 | 约束 | 说明 |
---|---|---|---|
statusCode | String | 必选 | 请求状态码,取值000000(成功),可参考Rest 错误代码。 |
6.6 响应示例
HTTP/1.1 200 OK Content-Length: 641 {"statusCode":"000000"}
7 管理员对用户禁言
7.1 请求地址
POST /{SoftVersion}/Application/{appId}/IM/Member/ForbidSpeak
7.2 请求包头
请参阅《鉴权说明》
7.3 请求包体
属性 | 类型 | 约束 | 说明 |
---|---|---|---|
userName | String | 可选 | 自定义账号或通讯账号 |
groupId | String | 必选 | 群组ID |
member | String | 必选 | 成员的帐号 |
operation | String | 可选 | 0:可发言(默认)1:禁言 |
7.4 请求示例
POST /2013-12-26/Application/20150314000000110000000000000010/IM/Member/ForbidSpeak?sig=C1F20E7A97 HTTP/1.1 Accept:application/json; Content-Type:application/json;charset=utf-8; Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyM= { "userName":"123", "groupId":"g80000012345678", "member":"80000123456768", "operation":"1" }
7.5 响应包体
属性 | 类型 | 约束 | 说明 |
---|---|---|---|
statusCode | String | 必选 | 请求状态码,取值000000(成功),可参考Rest 错误代码。 |
7.6 响应示例
HTTP/1.1 200 OK Content-Length: 641 {"statusCode":"000000"}
文档更新时间:2018年1月18日