成員管理接口是云通訊平臺在群組功能基礎上為開發者提供的相關接口,便于開發者管理群組成員。成員管理相關接口包括修改、查詢群名片信息,查詢群組成員,查詢成員所加入的組,管理員驗證用戶申請加入群組,用戶驗證管理員邀請加入群組,管理員對用戶禁言接口。
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日