Group Type ID | RESTful API Support |
Private | Yes. Same as work groups (Work) in the new version. |
Public | Yes |
ChatRoom | Yes. Same as the meeting group (Meeting) in the new version. |
AVChatRoom | No |
Community | Yes |
https://xxxxxx/v4/group_open_http_svc/modify_group_member_info?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/modify_group_member_info | 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#2CLUZEAEJ", // Target group (required)"Member_Account": "bob", // Target group member (required)"Role": "Admin" // Set as an admin}
{"GroupId": "@TGS#2CLUZEAEJ", // Target group (required)"Member_Account": "bob", // Target group member (required)"Role": "Member" //Cancel the admin role}
{"GroupId": "@TGS#2CLUZEAEJ", // Target group (required)"Member_Account": "bob", // Target group member (required)"MsgFlag": "AcceptAndNotify" // Message blocking type, which can be AcceptAndNotify, Discard, or AcceptNotNotify}
{"GroupId": "@TGS#2CLUZEAEJ", // Target group (required)"Member_Account": "bob", // Target group member (required)"NameCard": "bob" // Group name card (optional)}
{"GroupId": "@TGS#2CLUZEAEJ", // Target group (required)"Member_Account": "bob", // Target group member (required)"AppMemberDefinedData": [ // Target member custom field (optional){"Key":"MemberDefined1", // Key of the target group member custom field"Value":"ModifyData1" // Value of the key},{"Key":"MemberDefined3","Value":"ModifyData3"}]}
{"GroupId": "@TGS#2CLUZEAEJ", // Target group (required)"Member_Account": "bob", // Target group member (required)"MuteTime":86400 // Muting period for the specified user, in seconds}
Field | Type | Required | Description |
GroupId | String | Yes | The ID of the Group whose historical messages will be modified |
Member_Account | String | Required | Target group member. |
Role | String | Optional | Role of the member. Admin : Set as an admin. Member : Cancel the admin role. (The group owner identity cannot be modified.) |
MsgFlag | String | Optional | Message blocking type. |
NameCard | String | Optional | Group name card (with a maximum length of 50 bytes). |
AppMemberDefinedData | Array | Optional | Group member custom field. By default, this field is not available and needs to be enabled in the Chat console. For details, see Group System. |
MuteTime | Integer | Optional | Muting period, in seconds. 0 : Unmute |
{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 0}
Field | Type | Description |
ActionStatus | String | Request result. OK : successful. FAIL : failed |
ErrorCode | Integer | Error code. 0 : Successful. Other values: Failed |
ErrorInfo | String | Error information |
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. For example, a common member in a public group tries to remove other users from the group, but only the app admin can do so. |
10010 | The group does not exist or has been deleted. |
10015 | Invalid group ID. Use the correct group ID. |
Was this page helpful?