製品の概要
Basic Concepts
ユースケース
機能概要
アカウントシステム
ユーザープロフィールとリレーションシップチェーン
メッセージ管理
グループシステム
Official Account
Audio/Video Call
使用制限
https://xxxxxx/v4/group_open_http_svc/get_appid_group_list?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
Parameter | Description |
xxxxxx | Domain name corresponding to the country/region where your SDKAppID is located. China: console.tim.qq.comSingapore: adminapisgp.im.qcloud.comSeoul: adminapikr.im.qcloud.comTokyo： adminapijpn.im.qcloud.comFrankfurt: adminapiger.im.qcloud.comSilicon Valley: adminapiusa.im.qcloud.comJakarta: adminapiidn.im.qcloud.com |
v4/group_open_http_svc/get_appid_group_list | Request API |
sdkappid | SDKAppID assigned by the Chat console when an app is created |
identifier | |
usersig | |
random | A random 32-bit unsigned integer ranging from 0 to 4294967295. |
contenttype | Request format, which should always be json. |
{}
Limit and Next fields to control the paged pulling:Limit field specifies the maximum number of groups in GroupIdList in the response packet, which cannot exceed 10,000.Next field is used to control pagination. For the initial pagination request, Next is set to 0. For subsequent requests, it is set to the previously returned Next value. If the returned Next value is 0, all groups have been pulled.
For example, if paged pulling is requested and 20 group IDs are displayed per page, the request parameters for the first page are {“Limit” : 20, “Next” : 0}, whereas those for the second page are {“Limit” : 20, “Next” : Previously returned Next value}, and so on.Limit or Next does not affect TotalCount in the response packet.{"Limit": 1000,"Next": 0}
{"GroupType" : "Public" // Type of groups to be pulled. If this parameter is not specified, all types of groups will be pulled.}
{"Limit": 1000,"Next": 0,"GroupType" : "Public" // Type of groups to be pulled. If this parameter is not specified, all types of groups will be pulled.}
Field | Type | Required | Description |
Limit | Integer | No | Maximum number of group IDs to be obtained, which cannot exceed 10,000. If no value is specified, the maximum value 10000 is used by default. |
Next | Integer | No | Paged pulling flag when the number of groups is too large. It is initially set to 0 and subsequently to the Next value returned in the previous response. If the returned Next value is 0, all groups have been pulled. |
GroupType | String | No | To obtain a specified type of groups, you can use GroupType for filtering. In this case, the returned TotalCount value indicates the total number of groups of the specified type in the app. If this field is not specified, all types of groups are obtained. Possible group types are Public, Private, ChatRoom, AVChatRoom, BChatRoom, and Community. |
{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 0,"TotalCount": 2,"GroupIdList": [{"GroupId": "@TGS#2J4SZEAEL"},{"GroupId": "@TGS#2C5SZEAEF"}],"Next": 4454685361}
Field | Type | Description |
ActionStatus | String | Request result. OK: successful; FAIL: failed |
ErrorCode | Integer | Error code. 0: Successful; other values: Failed |
ErrorInfo | String | Error information |
TotalCount | Integer | Total number of existing groups in the app. To obtain a specified type of groups, you can use GroupType for filtering. In this case, the returned TotalCount value indicates the total number of groups of the specified type in the app. If this field is not specified, all types of groups are obtained.For example, assume that the app has total 50,000 groups, including 20,000 public groups. If GroupType in the request packet is set to Public, TotalCount in the response packet is 20,000 regardless of the Limit and Offset values. In addition, groups in GroupIdList are all public groups. |
GroupIdList | Array | List of obtained group IDs. |
Next | Integer | Paged pulling flag. |
ErrorCode and ErrorInfo respectively.
For public error codes (60000 to 79999), see Error Codes.
The following table describes the error codes specific to this API:Error Code | Description |
10002 | Internal server error. Try again. |
10004 | A parameter is incorrect. To correct it, check request parameters such as GroupType based on the error description. |
10007 | The operator does not have the necessary permissions for this operation. Only the app admin can call this API. |
10018 | The response packet exceeds the length limit of 1 MB due to excessive request content. Try to reduce the amount of data in individual single requests. |
フィードバック