云通訊平臺為開發者提供了一套完整的群組管理接口,便于開發者集成群組相關功能。群組管理相關接口包括創建群組,查詢、修改群組屬性,刪除群組,按條件搜索公共群組,用戶申請加入群組,管理員邀請用戶加入群組,管理員刪除成員,成員主動退出群組,設置群組成員角色接口。
1 創建群組
1.1 請求地址
POST /{SoftVersion}/Application/{appId}/IM/Group/CreateGroup
1.2 請求包頭
請參閱《鑒權說明》
1.3 請求包體
屬性 | 類型 | 約束 | 說明 |
---|---|---|---|
userName | String | 可選 | 自定義賬號或通訊賬號 | name | String | 必選 | 群組名字,最長為50個字符 |
type | String | 必選 | 群組類型 0:臨時組(上限100人) 1:付費普通組(上限300人) 2:付費普通組(上限500人) 3:付費普通組 (上限1000人) 4:付費VIP組(上限2000人) 注意:討論組取值范圍0、1、2,如果大于2則默認2 |
permission | String | 可選 |
申請加入模式 0:默認直接加入 1:需要身份驗證 2:私有群組 缺省0 |
declared |
String | 可選 | 群組公告,最長為200個字符 |
target |
String |
可選 |
0 :討論組 1:群組,缺省1 |
groupDomain |
String |
可選 |
用戶擴展字段 |
1.4 請求示例
POST /2013-12-26/Application/20150314000000110000000000000010/IM/Group/CreateGroup?sig=C1F20E7A97 HTTP/1.1 Accept:application/json; Content-Type:application/json;charset=utf-8; Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyM= { "userName": "123", "name": "云通訊技術交流", "type": "0", "declared":"云通訊技術交流", "permission":"0" }
1.5 響應包體
屬性 | 類型 | 約束 | 說明 |
---|---|---|---|
statusCode | String | 必選 | 請求狀態碼,取值000000(成功)。 |
groupId | String | 必選 | 群組ID |
1.6 響應示例
HTTP/1.1 200 OK Content-Length: 641 {"statusCode": "000000", "groupId": "g80000049837291"}
2.修改群組屬性
2.1 請求地址
POST /{SoftVersion}/Application/{appId}/IM/Group/ModifyGroup
2.2 請求包頭
請參閱《鑒權說明》
2.3 請求包體
屬性 | 類型 | 約束 | 說明 |
---|---|---|---|
userName | String | 可選 | 自定義賬號或通訊賬號 |
groupId | String | 必選 | 群組ID |
permission | String | 可選 |
申請加入模式 0:默認直接加入 1:需要身份驗證 2:私有群組 缺省0 |
name | String | 必選 |
群組名字,最長50個字符 |
declared | String | 可選 | 群組公告,最長為200個字符 |
groupDomain |
String |
可選 |
用戶擴展字段 |
2.4 請求示例
POST /2013-12-26/Application/20150314000000110000000000000010/IM/Group/ModifyGroup?sig=C1F20E7A97 HTTP/1.1 Accept:application/json; Content-Type:application/json;charset=utf-8; Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyM= { "userName":"123", "groupId":"g12345678", "name":"云通訊", "declared":"技術交流", "permission":"1" }
2.5 響應包體
屬性 | 類型 | 約束 | 說明 |
---|---|---|---|
statusCode | String | 必選 | 請求狀態碼,取值000000(成功)。 |
2.6 響應示例
HTTP/1.1 200 OK Content-Length: 641 {"statusCode":"000000"}
3 刪除群組
3.1 請求地址
POST /{SoftVersion}/Application/{appId}/IM/Group/DeleteGroup
3.2 請求包頭
請參閱《鑒權說明》
3.3 請求包體
屬性 | 類型 | 約束 | 說明 |
---|---|---|---|
userName | String | 可選 | 自定義賬號或通訊賬號 |
groupId | String | 必選 | 群組ID |
3.4 請求示例
POST /2013-12-26/Application/20150314000000110000000000000010/IM/Group/DeleteGroup?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(成功)。 |
3.6 響應示例
HTTP/1.1 200 OK Content-Length: 641 {"statusCode":"000000"}
4 按條件搜索公共群組
4.1 請求地址
POST /{SoftVersion}/Application/{appId}/IM/Group/SearchPublicGroups
4.2 請求包頭
請參閱《鑒權說明》
4.3 請求包體
屬性 | 類型 | 約束 | 說明 |
---|---|---|---|
userName | String | 可選 | 自定義賬號或通訊賬號 |
groupId | String | 可選 | 根據群組ID查找(同時具備兩個條件,查詢以此為先) |
name | String | 可選 | 根據群組名查找(模糊查詢,群組名稱為純數字或純字母時需要輸入完整的群名稱,結果中不包含私有群組) |
4.4 請求示例
POST /2013-12-26/Application/20150314000000110000000000000010/IM/Group/SearchPublicGroup?sig=C1F20E7A97 HTTP/1.1 Accept:application/json; Content-Type:application/json;charset=utf-8; Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyM= { "userName":"123", "groupId":"g80019283765", "name":"云通訊技術交流" }
4.5 響應包體
屬性 | 類型 | 約束 | 說明 |
---|---|---|---|
statusCode | String | 必選 | 請求狀態碼,取值000000(成功)。 |
groupId | String | 必選 | 群組ID |
name | String | 必選 | 群組名字,最長50個字符 |
type | String | 必選 | 群組類型 0:臨時組(上限100人) 1:付費普通組(上限300人) 2:付費普通組(上限500人) 3:付費普通組 (上限1000人) 4:付費VIP組(上限2000人) |
count | String | 必選 | 群組的成員人數 |
permission | String | 必選 | 申請加入模式 0:默認直接加入 1:需要身份驗證 |
4.6 響應示例
HTTP/1.1 200 OK Content-Length: 641 { "statusCode": "000000", "groups": { "group": { "groupId": "g80000049837921", "name": "云通訊", "count": "100", "type": "1", " permission":"0" } } }
5 查詢群組屬性
5.1 請求地址
POST /{SoftVersion}/Application/{appId}/IM/Group/QueryGroupDetail
5.2 請求包頭
請參閱《鑒權說明》
5.3 請求包體
屬性 | 類型 | 約束 | 說明 |
---|---|---|---|
userName | String | 可選 | 自定義賬號或通訊賬號 |
groupId | String | 必選 | 群組ID |
5.4 請求示例
POST /2013-12-26/Application/20150314000000110000000000000010/IM/Group/QueryGroupDetail?sig=C1F20E7A97 HTTP/1.1 Accept:application/json; Content-Type:application/json;charset=utf-8; Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyM= { "userName":"123", "groupId":"g80000049837291" }
5.5 響應包體
屬性 | 類型 | 約束 | 說明 |
---|---|---|---|
statusCode | String | 必選 | 請求狀態碼,取值000000(成功)。 |
name | String | 必選 | 群組名字,最長為50個字符 |
owner | String | 必選 | 群組所有者(默認為管理員) |
declared | String | 必選 | 群組公告,最長為200個字符 |
count | String | 必選 | 群組成員人數 |
dateCreated | String | 必選 | 群組創建時間,格式為時間戳 |
permission |
String | 必選 | 申請加入模式 0:默認直接加入 1:需要身份驗證 |
target |
String |
必選 |
群組類型 0 :討論組 1:群組 |
groupDomain |
String |
可選 |
用戶擴展字段 |
5.6 響應示例
HTTP/1.1 200 OK Content-Length: 641 { "statusCode": "000000", "name": "云通訊技術交流", "owner": "8002837363838", "type": "0", "declared": "云通訊技術交流", "permission": "0", "count": "100", "dateCreated": "2013-7-25 15:23:30" }
6 用戶申請加入群組
6.1 請求地址
POST /{SoftVersion}/Application/{appId}/IM/Group/JoinGroup
6.2 請求包頭
請參閱《鑒權說明》
6.3 請求包體
屬性 | 類型 | 約束 | 說明 |
---|---|---|---|
userName | String | 可選 | 自定義賬號或通訊賬號 |
groupId | String | 必選 | 群組ID |
declared | String | 可選 | 申請理由,最長為50個字符 |
6.4 請求示例
POST /2013-12-26/Application/20150314000000110000000000000010/IM/Group/JoinGroup?sig=C1F20E7A97 HTTP/1.1 Accept:application/json; Content-Type:application/json;charset=utf-8; Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyM= { "userName":"123", "groupId": "g80000049837291", "declared": "hello" }
6.5 響應包體
屬性 | 類型 | 約束 | 說明 |
---|---|---|---|
statusCode | String | 必選 | 請求狀態碼,取值000000(成功)。 |
6.6 響應示例
HTTP/1.1 200 OK Content-Length: 641 { "statusCode": "000000" }
7 群組管理員邀請用戶加入群組
7.1 請求地址
POST /{SoftVersion}/Application/{appId}/IM/Group/InviteJoinGroup
7.2 請求包頭
請參閱《鑒權說明》
7.3 請求包體
屬性 | 類型 | 約束 | 說明 |
---|---|---|---|
userName | String | 可選 | 自定義賬號或通訊賬號 |
groupId | String | 必選 | 群組ID |
members | String | 必選 | 被邀請成員列表主節點 |
member | String | 必選 | 被邀請成員,一次最多可以邀請50人,且邀請的成員必須是已經在客戶端登陸過的用戶。 |
confirm | String | 可選 |
是否需要被邀請人確認 0 :需要 1:不需要(自動加入群組)缺省1 |
declared | String | 可選 | 邀請理由,最長為50個字符 |
7.4 請求示例
POST /2013-03-22/Application/20150314000000110000000000000010/IM/Group/InviteJoinGroup?sig=C1F20E7A97 HTTP/1.1 Accept:application/json; Content-Type:application/json;charset=utf-8; Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyM= { "groupId": "g80000049837291", "members": { "member": [ "8000000123456789", "8000000123456789" ] }, "declared": "hello", "confirm": "0" }
7.5 響應包體
屬性 | 類型 | 約束 | 說明 |
---|---|---|---|
statusCode | String | 必選 | 請求狀態碼,取值000000(成功)。 |
7.6 響應示例
HTTP/1.1 200 OK Content-Length: 641 { "statusCode": "000000"}
8 群組管理員刪除成員
8.1 請求地址
POST /{SoftVersion}/Application/{appId}/IM/Group/DeleteGroupMember
8.2 請求包頭
請參閱《鑒權說明》
8.3 請求包體
屬性 | 類型 | 約束 | 說明 |
---|---|---|---|
userName | String | 可選 | 自定義賬號或通訊賬號 |
groupId | String | 必選 | 群組ID |
members | String | 必選 | 待刪除成員列表主節點 |
member | String | 必選 | 待刪除成員 |
8.4 請求示例
POST /2013-12-26/Application/20150314000000110000000000000010/IM/Group/DeleteGroupMember?sig=C1F20E7A97 HTTP/1.1 Accept:application/json; Content-Type:application/json;charset=utf-8; Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyM= { "groupId": "g80000049837291", "members": { "member": [ "8000000123456789", "8000000123456789" ] } }
8.5 響應包體
屬性 | 類型 | 約束 | 說明 |
---|---|---|---|
statusCode | String | 必選 | 請求狀態碼,取值000000(成功)。 |
8.6 響應示例
HTTP/1.1 200 OK Content-Length: 641 { "statusCode": "000000"}
9 成員主動退出群組
9.1 請求地址
POST /{SoftVersion}/Application/{appId}/IM/Group/LogoutGroup
9.2 請求包頭
請參閱《鑒權說明》
9.3 請求包體
屬性 | 類型 | 約束 | 說明 |
---|---|---|---|
userName | String | 可選 | 自定義賬號或通訊賬號 |
groupId | String | 必選 | 群組ID |
9.4 請求示例
POST /2013-12-26/Application/20150314000000110000000000000010/IM/Group/LogoutGroup?sig=C1F20E7A97 HTTP/1.1 Accept:application/json; Content-Type:application/json;charset=utf-8; Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyM= { "userName":"123", "groupId": "g80000049837291" }
9.5 響應包體
屬性 | 類型 | 約束 | 說明 |
---|---|---|---|
statusCode | String | 必選 | 請求狀態碼,取值000000(成功)。 |
9.6 響應示例
HTTP/1.1 200 OK Content-Length: 641 { "statusCode": "000000"}
10 設置群組成員角色
10.1 請求地址
POST /{SoftVersion}/Application/{appId}/IM/Group/SetMemberRole
10.2 請求包頭
請參閱《鑒權說明》
10.3 請求包體
屬性 | 類型 | 約束 | 說明 |
---|---|---|---|
userName | String | 可選 | 自定義賬號或通訊賬號 |
groupId | String | 必選 | 群組ID |
member | String | 必選 | 成員帳號 |
role | String | 必選 | 角色 0創建者 1 管理員 2 普通成員 |
10.4 請求示例
POST /2013-12-26/Application/20150314000000110000000000000010/IM/Group/SetMemberRole?sig=C1F20E7A97 HTTP/1.1 Accept:application/json; Content-Type:application/json;charset=utf-8; Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyM= { "userName": "123", "groupId": "g80000049837291", "member": "14128829087", "role": "1" }
10.5 響應包體
屬性 | 類型 | 約束 | 說明 |
---|---|---|---|
statusCode | String | 必選 | 請求狀態碼,取值000000(成功)。 |
10.6 響應示例
HTTP/1.1 200 OK Content-Length: 641 {" statusCode":"000000"}
文檔更新時間:2018年1月18日