- Release Notes
- Product Introduction
- Purchase Guide
- Getting Started with Demos
- Console Guide
- SDK Documentation
- SDK Download
- Quick Integration (Including UI Library)
- General Integration (No UI Library)
- Update Logs (Web & Mini Programs)
- Update Log (Native)
- Update Log (Unity)
- Legacy API Tutorials
- Client APIs
- Server APIs
- Generating UserSig
- RESTful APIs
- RESTful API Overview
- RESTful API List
- Account Management
- One-to-One Messages
- Profile Management
- Pushing to All Users
- Relationship Chain Management
- Group Management
- Getting All Groups in an App
- Creating a Group
- Getting Group Profiles
- Getting Group Member Profiles
- Modifying the Profile of a Group
- Adding Group Members
- Deleting Group Members
- Modifying the Profile of a Group Member
- Disbanding a Group
- Getting the Groups a User Has Joined
- Querying the Roles of Users in a Group
- Bulk Muting and Unmuting
- Getting the List of Muted Group Members
- Sending Ordinary Messages in a Group
- Sending System Messages in a Group
- Recalling Group Messages
- Changing Group Owner
- Importing a Group Profile
- Importing Group Messages
- Importing Group Members
- Setting the Unread Message Count of a Member
- Recalling Messages Sent by a Specified User
- Pulling Historical Messages
- Getting the Number of Online Users in an Audio-Video Group
- Global Mute Management
- Operations Management
- Online States
- Third-Party Callbacks
- Third-Party Callback Overview
- Callback Command List
- Online Status Callbacks
- Relationship Chain Callbacks
- One-to-One Message Callbacks
- Group System Callbacks
- Callback Before Creating a Group
- Callback After Creating a Group
- Callback Before Accepting a Request to Join a Group
- Callback Before Accepting a Request to Add a User to a Group
- Callback After a User Joins a Group
- Callback After a User Leaves a Group
- Callback Before Sending a Group Message
- Callback After Sending a Group Message
- Callback After a Group Is Full
- Callback After Disbanding a Group
- Callback After Modifying Group Profile
- Callback Mutual Authentication Configuration Guide
- Best Practices
- FAQs
- General References
- Error Codes
- Release Notes
- Product Introduction
- Purchase Guide
- Getting Started with Demos
- Console Guide
- SDK Documentation
- SDK Download
- Quick Integration (Including UI Library)
- General Integration (No UI Library)
- Update Logs (Web & Mini Programs)
- Update Log (Native)
- Update Log (Unity)
- Legacy API Tutorials
- Client APIs
- Server APIs
- Generating UserSig
- RESTful APIs
- RESTful API Overview
- RESTful API List
- Account Management
- One-to-One Messages
- Profile Management
- Pushing to All Users
- Relationship Chain Management
- Group Management
- Getting All Groups in an App
- Creating a Group
- Getting Group Profiles
- Getting Group Member Profiles
- Modifying the Profile of a Group
- Adding Group Members
- Deleting Group Members
- Modifying the Profile of a Group Member
- Disbanding a Group
- Getting the Groups a User Has Joined
- Querying the Roles of Users in a Group
- Bulk Muting and Unmuting
- Getting the List of Muted Group Members
- Sending Ordinary Messages in a Group
- Sending System Messages in a Group
- Recalling Group Messages
- Changing Group Owner
- Importing a Group Profile
- Importing Group Messages
- Importing Group Members
- Setting the Unread Message Count of a Member
- Recalling Messages Sent by a Specified User
- Pulling Historical Messages
- Getting the Number of Online Users in an Audio-Video Group
- Global Mute Management
- Operations Management
- Online States
- Third-Party Callbacks
- Third-Party Callback Overview
- Callback Command List
- Online Status Callbacks
- Relationship Chain Callbacks
- One-to-One Message Callbacks
- Group System Callbacks
- Callback Before Creating a Group
- Callback After Creating a Group
- Callback Before Accepting a Request to Join a Group
- Callback Before Accepting a Request to Add a User to a Group
- Callback After a User Joins a Group
- Callback After a User Leaves a Group
- Callback Before Sending a Group Message
- Callback After Sending a Group Message
- Callback After a Group Is Full
- Callback After Disbanding a Group
- Callback After Modifying Group Profile
- Callback Mutual Authentication Configuration Guide
- Best Practices
- FAQs
- General References
- Error Codes
Feature Description
This API is used by app admins to disband a group.
API Calling Description
Applicable group types
| Group Type ID | Is this RESTful API Supported? |
|---|---|
| Private | Yes. Same as Work (work group for friends) in the new version. |
| Public | Yes. |
| ChatRoom | Yes. Same as Meeting (temporary meeting group) in the new version. |
| AVChatRoom | Yes. |
These are the 4 built-in group types in IM. For detailed information, see the Group System.
Sample request URL
https://xxxxxx/v4/group_open_http_svc/destroy_group?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
Request parameters
The list below contains only the parameters commonly used when calling this API and their descriptions. For more parameters, see RESTful API Overview.
| Parameter | Description |
|---|---|
| https | The request protocol is HTTPS, and the request method is POST. |
| xxxxxx | The country/region where your SDKAppID is located.console.tim.qq.comadminapisgp.im.qcloud.comadminapikr.im.qcloud.comadminapiger.im.qcloud.com |
| v4/group_open_http_svc/destroy_group | Request API |
| sdkappid | SDKAppID assigned by the IM console when the application is created |
| identifier | The value must be the app admin account. For more information, see App Admins. |
| usersig | Signature generated by the app admin account. For details on how to generate the signature, see Generating UserSig. |
| random | A random 32-bit unsigned integer ranging from 0 to 4294967295 |
Maximum calling frequency
The maximum calling frequency is 200 calls per second.
Sample request packet
A disbanded group cannot be restored. Therefore, call this API with caution.
{
"GroupId": "@TGS#2J4SZEAEL"
}
Request packet fields
| Field | Type | Required | Description |
|---|---|---|---|
| GroupId | String | Required | ID of the target group |
Sample response packet body
{
"ActionStatus": "OK",
"ErrorInfo": "",
"ErrorCode": 0
}
Response packet fields
| Field | Type | Description |
|---|---|---|
| ActionStatus | String | Result of the request. OK indicates that the request was successful, and FAIL indicates that the request failed. |
| ErrorCode | Integer | Error code. 0 indicates that the request was successful, and any non-zero value indicates that the request failed. |
| ErrorInfo | String | Detailed error information |
Error Codes
Unless a network error (such as error 502) occurs, the returned HTTP status code for this API is always 200. The specific error code and details can be found in the response packet fields such as ErrorCode and ErrorInfo.
For public error codes (60000 to 79999), see Error Codes.
The list below contains error codes specific to this API:
| Error Code | Description |
|---|---|
| 10002 | An internal server error occurred. Please try again. |
| 10003 | The request command word is invalid. |
| 10004 | A parameter is invalid. Check the error description and troubleshoot the issue. |
| 10007 | The operation permissions are insufficient. For example, to remove someone from a public group requires admin permissions. |
| 10010 | The group does not exist, or once existed but has been disbanded. |
| 10015 | The group ID is invalid. Be sure to use the correct group ID. |
API Debugging Tool
Use the online debugging tool for RESTful APIs to debug this API.
Reference
Creating a group (v4/group_open_http_svc/create_group)
Possible Callbacks
Callback when a group is disbanded
Feature Description
This API is used by app admins to disband a group.
API Calling Description
Applicable group types
| Group Type ID | Is this RESTful API Supported? |
|---|---|
| Private | Yes. Same as Work (work group for friends) in the new version. |
| Public | Yes. |
| ChatRoom | Yes. Same as Meeting (temporary meeting group) in the new version. |
| AVChatRoom | Yes. |
These are the 4 built-in group types in IM. For detailed information, see the Group System.
Sample request URL
https://xxxxxx/v4/group_open_http_svc/destroy_group?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
Where, xxxxxx is the country/region-specific domain. Please enter the domain corresponding to the country/region where your SDKAppID is located.
| Country/Region | Domain |
|---|---|
| Singapore | adminapisgp.im.qcloud.com |
Request parameters
The list below contains only the parameters commonly used when calling this API and their descriptions. For more parameters, see RESTful API Overview.
| Parameter | Description |
|---|---|
| v4/group_open_http_svc/destroy_group | Request API |
| sdkappid | SDKAppID assigned by the IM console when the application is created |
| identifier | The value must be the app admin account. For more information, see App Admins. |
| usersig | Signature generated by the app admin account. For details on how to generate the signature, see Generating UserSig. |
| random | A random 32-bit unsigned integer ranging from 0 to 4294967295 |
Maximum calling frequency
The maximum calling frequency is 200 calls per second.
Sample request packet
A disbanded group cannot be restored. Therefore, call this API with caution.
{
"GroupId": "@TGS#2J4SZEAEL"
}
Request packet fields
| Field | Type | Required | Description |
|---|---|---|---|
| GroupId | String | Required | ID of the target group |
Sample response packet body
{
"ActionStatus": "OK",
"ErrorInfo": "",
"ErrorCode": 0
}
Response packet fields
| Field | Type | Description |
|---|---|---|
| ActionStatus | String | Result of the request. OK indicates that the request was successful, and FAIL indicates that the request failed. |
| ErrorCode | Integer | Error code. 0 indicates that the request was successful, and any non-zero value indicates that the request failed. |
| ErrorInfo | String | Detailed error information |
Error Codes
Unless a network error (such as error 502) occurs, the returned HTTP status code for this API is always 200. The specific error code and details can be found in the response packet fields such as ErrorCode and ErrorInfo.
For public error codes (60000 to 79999), see Error Codes.
The list below contains error codes specific to this API:
| Error Code | Description |
|---|---|
| 10002 | An internal server error occurred. Please try again. |
| 10003 | The request command word is invalid. |
| 10004 | A parameter is invalid. Check the error description and troubleshoot the issue. |
| 10007 | The operation permissions are insufficient. For example, to remove someone from a public group requires admin permissions. |
| 10010 | The group does not exist, or once existed but has been disbanded. |
| 10015 | The group ID is invalid. Be sure to use the correct group ID. |
API Debugging Tool
Use the online debugging tool for RESTful APIs to debug this API.
Reference
Creating a group (v4/group_open_http_svc/create_group)
Yes
No
Was this page helpful?