Obtaining Topic Permissions
Feature Overview
App admins can call this API to obtain topic permissions in a permission group.
API Calling Description
Applicable Group Types
Group Type | Whether This RESTful API Is Supported |
Private | Not supported, same as Work (Work Friend Group) in the new version |
Public | Not supported |
ChatRoom | Not supported, same as Meeting (Temporary Meeting Group) in the new version |
AVChatRoom | Not supported |
Community | Supported |
Sample Request URL
https://xxxxxx/v4/group_open_http_svc/get_topic_permission_group?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
Request Parameters
The table below only lists the parameters modified when calling this API and their descriptions. For details on the parameters, refer to RESTful API Overview.
Parameter | Description |
xxxxxx | The dedicated domain name for the country/region where your SDKAppID is located: China: console.tim.qq.com Singapore: adminapisgp.im.qcloud.com Seoul: adminapikr.im.qcloud.com Frankfurt: adminapiger.im.qcloud.com Silicon Valley: adminapiusa.im.qcloud.com Jakarta: adminapiidn.im.qcloud.com |
v4/group_open_http_svc/get_topic_permission_group | 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 fixed value: json |
Maximum Calling Frequency
200 queries/sec.
Sample Request Packet
Obtaining All Topic Permissions
{"GroupId": "@TGS#_@TGS#cV6IHIIM62C4","PermissionGroupId": "@PMG#_test_permission_group_with_topic"}
Obtaining Specified Permission Group
{"GroupId": "@TGS#_@TGS#cV6IHIIM62C4","PermissionGroupId": "@PMG#_test_permission_group_with_topic","TopicIdList": ["@TGS#_@TGS#cV6IHIIM62C4@TOPIC#_@TOPIC#cTEJHIIM62CJ"]}
Description of Request Packet Fields
Field | Type | Attribute | Description |
GroupId | String | Required | Group ID |
PermissionGroupId | String | Required | Permission group ID |
TopicIdList | Array | Required | The list of topic permissions to be retrieved. If this parameter is not specified, all topic permissions will be returned. |
Sample Response Packet
Obtaining All Permission Groups
{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 0,"TopicPermissionResultList": [{"ErrorCode": 0,"ErrorInfo": "","TopicId": "@TGS#_@TGS#cV6IHIIM62C4@TOPIC#_@TOPIC#cKXPQIIM62CD","Permission": 1234},{"ErrorCode": 0,"ErrorInfo": "","TopicId": "@TGS#_@TGS#cV6IHIIM62C4@TOPIC#_@TOPIC#cTEJHIIM62CJ","Permission": 123456}]}
Obtaining Specified Permission Group
{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 0,"TopicPermissionResultList": [{"ErrorCode": 0,"ErrorInfo": "","TopicId": "@TGS#_@TGS#cV6IHIIM62C4@TOPIC#_@TOPIC#cTEJHIIM62CJ","Permission": 123456}]}
Description of Response Packet Fields
Field | Type | Description |
ActionStatus | String | Result of the request processing OK: Indicates successful processing. FAIL: Indicates failure. |
ErrorCode | Integer | Error code 0: Indicates success. Non-zero: Indicates failure. |
ErrorInfo | String | Error message |
TopicPermissionResultList | Array | The results of obtained topic permissions. Each item represents a result. Only the topic permissions with an ErrorCode of 0 are meaningful. |
Error Codes
Unless a network error (such as a 502 error) occurs, the HTTP return code for this API is always 200. The real error code and error message are indicated by ErrorCode and ErrorInfo in the response packet body.
Common error codes (60000 to 79999) can be found in the Error Codes document.
The private error codes for this API are as follows:
Error Code | Description |
10002 | Internal server error. Try again. |
10003 | Illegal request command word |
10004 | Invalid parameter. Check if the request is correct based on the error description. |
10007 | Insufficient operation permissions, such as lacking the permission to create a permission group |
10010 | The group does not exist, or it existed in the past but has now been dissolved. |
10015 | Invalid group ID. Check if the group ID is filled in correctly. |
10016 | The developer backend has denied this operation through third-party callback. |
110006 | The permission group does not exist, or it existed in the past but has now been dissolved. |
110008 | Invalid permission group ID. Check if the permission group ID is filled in correctly. |
110014 | Topic permissions deleted |
API Debugging Tool
References
Adding Topic Permissions (Adding Topic Permissions)
Modifying Topic Permissions (Modifying Topic Permissions)
Deleting Topic Permissions (Deleting Topic Permissions)