Group Type ID | Support for This RESTful API |
Private | Yes. Same as work groups (Work) in the new version. |
Public | Yes |
ChatRoom | Yes. Same as meeting groups (Meeting) in the new version. |
AVChatRoom | No |
Community | Yes |
https://xxxxxx/v4/group_open_http_svc/get_role_in_group?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.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_role_in_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, which should always be json . |
{"GroupId": "@TGS#2C5SZEAEF","User_Account": [ // Up to 500 member accounts are supported"leckie","peter","wesley"]}
Field | Type | Required | Description |
GroupId | String | Yes | The ID of the group to be queried |
User_Account | Array | Yes | User accounts to be queried. Up to 500 accounts are supported. |
{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 0,"UserIdList": [ // Result{"Member_Account": "leckie","Role": "Owner" // Member role: Owner/Admin/Member/NotMember},{"Member_Account": "peter","Role": "Member"},{"Member_Account": "wesley","Role": "NotMember"}]}
Field | Type | Description |
ActionStatus | String | Request result. OK : Successful; FAIL : Failed |
ErrorCode | Integer | Error code. 0 : Successful; other values: Failed |
ErrorInfo | String | Error information |
UserIdList | Array | Member roles that are pulled, including Owner, Admin, Member, and NotMember |
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. |
10003 | Invalid command word. |
10004 | Invalid parameter. Check the error description and troubleshoot the issue. |
10007 | No operation permissions. The operator must have permissions to perform corresponding operations. |
10010 | The group does not exist or has been deleted. |
10015 | Failed to parse the JSON packet. Check whether the packet complies with JSON specifications. |
Was this page helpful?