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 (See the note below) |
Community | Yes |
These are the preset group types in Chat. For more information, see Group System.
Note:Audio-video groups (AVChatRoom) do not support the transfer of group ownership. If you call this API for such a group, error code 10007 will be returned.
https://xxxxxx/v4/group_open_http_svc/change_group_owner?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
The following table describes the modified parameters when this API is called. For other parameters, see RESTful API Overview.
Parameter | Description |
---|---|
xxxxxx | Domain name corresponding to the country/region where your SDKAppID is located.console.tim.qq.com adminapisgp.im.qcloud.com adminapikr.im.qcloud.com adminapiger.im.qcloud.com adminapiind.im.qcloud.com adminapiusa.im.qcloud.com |
v4/group_open_http_svc/change_group_owner | Request API |
sdkappid | SDKAppID assigned by the Chat console when an app is created |
identifier | App admin account. For more information, see the App Admin section in Login Authentication. |
usersig | Signature generated by the app admin account. For details, see Generating UserSig. |
random | A random 32-bit unsigned integer ranging from 0 to 4294967295. |
contenttype | Request format. The value is fixed to json . |
200 calls per second
Transfer the group ownership to another group member. The new group owner must be a member of the group.
{
"GroupId": "@TGS#1NVTZEAE4", // (Required) ID of the group whose ownership is to be transferred
"NewOwner_Account": "peter" // (Required) ID of the new group owner
}
Field | Type | Required | Description |
---|---|---|---|
GroupId | String | Yes | ID of the group whose ownership is to be transferred |
NewOwner_Account | String | Yes | ID of the new group owner |
{
"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 |
The returned HTTP status code for this API is always 200 unless a network error (such as error 502) occurs. The specific error code and details can be found in the response fields 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 | A system error occurred. Try again or contact technical support. |
10004 | A parameter is invalid. Check the ErrorInfo field in the response packet to see whether the required fields have been specified or whether the fields are set according to protocol requirements. |
10007 | Insufficient operation permissions. Check whether the operator is the app admin. |
10010 | The group does not exist or has been deleted. |
10015 | Invalid group ID. Check whether the group ID is entered correctly. |
Use the RESTful API online debugging tool to debug this API.
Recalling group messages (v4/group_open_http_svc/group_msg_recall)
Was this page helpful?