set_group_info_EX
Brief description
- Modify group information. (If you use this interface, please use setGroupInfoEXBefore and setGroupInfoEXAfter).
Request method
post
Request URL
http://x.x.x.x:10002/group/set_group_info
Header
header name | example value | optional | type | description |
---|---|---|---|---|
operationID | 1646445464564 | required | string | operationID is used for global link tracking |
token | eyJhbxxxx3Xs | required | string | Administrator token |
Request parameter example
{
"groupInfoForSet": {
"groupID": "xadxwr24",
"groupName": "new name",
"notification": "new notification",
"introduction": "new introduction",
"faceURL": "www.newfaceURL.com",
"ex": "new ex",
"needVerification": 1,
"lookMemberInfo": 1,
"applyMemberFriend": 1
}
}
Field Name | Optional | Type | Description |
---|---|---|---|
groupInfoForSet | Required | object | Group information object |
groupInfoForSet.groupID | Required | string | Group ID to be modified |
groupInfoForSet.groupName | Optional | string | New group name |
groupInfoForSet.notification | Optional | string | New group notification |
groupInfoForSet.introduction | Optional | string | New group introduction |
groupInfoForSet.faceURL | Optional | string | New group avatar |
groupInfoForSet.ex | Optional | string | New group extended field |
groupInfoForSet.needVerification | Optional | int | Whether verification is required to join the group; 0: requires approval for joining, members can directly join by invitation, 1: everyone needs verification to join except for group owner and administrators, 2: direct joining |
groupInfoForSet.lookMemberInfo | Optional | int | Whether to allow viewing other group members' information; 0: allows viewing group members' information, 1: does not allow viewing group members' information |
groupInfoForSet.applyMemberFriend | Optional | int | Whether group members can add friends; 0: allows adding friends from group members, 1: does not allow adding |
Successful Response Example
{
"errCode": 0,
"errMsg": "",
"errDlt": ""
}
Parameters Explanation for Success Response
Parameter Name | Type | Description |
---|---|---|
errCode | int | Error code, 0 means success |
errMsg | string | Brief error message, empty if no error |
errDlt | errDlt | Detailed error message, empty if no error |
data | object | General data object, see detailed structure below |
Sample Failure Response
{
"errCode": 1004,
"errMsg": "RecordNotFoundError",
"errDlt": ": [1004]RecordNotFoundError"
}
Parameters Explanation for Failure Response
Parameter Name | Type | Description |
---|---|---|
errCode | int | Error code, see global error code documentation for details |
errMsg | string | Brief error message |
errDlt | errDlt | Detailed error message |