- 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
Background
- Global muting includes the global muting of one-to-one chat messages and that of group chat messages.
If the global muting of one-to-one chat messages is enabled for an account, during the muting period, no one-to-one chat messages can be sent, the sender receives error code 20012 (for details, see Error Codes), and the callback before sending one-to-one chat messages is not triggered. After the muting period expires, the IM backend system automatically disables the global muting of one-to-one chat messages, and then all one-to-one chat messages can be sent normally. For the permanent global muting of one-to-one chat messages, the muting period never expires. By default, the global muting of one-to-one chat messages is disabled for accounts.
If the global muting of group chat messages is enabled for an account, during the muting period, no group chat messages can be sent, the sender receives error code 10017 (for details, see Error Codes), and the callback before sending group chat messages is not triggered. After the muting period expires, the IM backend system automatically disables the global muting of group chat messages, and then all group chat messages can be sent normally. For the permanent global muting of group chat messages, the muting period never expires. By default, the global muting of group chat messages is disabled for accounts.
Feature Description
- This API is used to enable the global muting of one-to-one chat messages for an account.
- This API is used to enable the global muting of group chat messages for an account.
API Calling Description
Request URL example
https://xxxxxx/v4/openconfigsvr/setnospeaking?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
Request parameters
The following table lists only the parameters to be modified when this API is called. For details on other 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/openconfigsvr/setnospeaking | Request API |
| sdkappid | SDKAppID assigned by the IM console when an app is created |
| identifier | The value must be the app admin account. For details, see App Admins. |
| 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 |
Maximum calling frequency
The maximum calling frequency is 200 times per second.
Request packet example
{
"Set_Account": "lumotuwe",
"C2CmsgNospeakingTime": 4294967295, // C2CmsgNospeakingTime and GroupmsgNospeakingTime are optional, but either of them must be specified.
"GroupmsgNospeakingTime": 7200
}
Request packet fields
| Field | Type | Attribute | Description |
|---|---|---|---|
| Set_Account | String | Required | Account for which muting will be enabled |
| C2CmsgNospeakingTime | Integer | Optional | Muting period (in seconds) of one-to-one chat messages. The value is a non-negative integer, and the maximum value is 4294967295 (0xFFFFFFFF in hexadecimal format).
|
| GroupmsgNospeakingTime | Integer | Optional | Muting period (in seconds) of group chat messages. The value is a non-negative integer, and the maximum value is 4294967295 (0xFFFFFFFF in hexadecimal format).
|
Response packet example
{
"ErrorCode": 0,
"ErrorInfo": "",
}
Response packet fields
| Field | Type | Description |
|---|---|---|
| ErrorCode | Integer | Request error code. 0: succeeded. Others: failed. |
| ErrorInfo | String | Error information |
Error Codes
Unless a network error (such as error 502) occurs, the HTTP return code for this API is always 200. ErrorCode and ErrorInfo in the response packet represent the actual error code and error information, respectively.
For common error codes (60000 to 79999), see Error Codes.
The following table describes the error codes specific to this API.
| Error Code | Description |
|---|---|
| 130001 | Failed to parse the JSON request packet. To correct it, check whether the request packet meets JSON specifications. |
| 130004 | The JSON request packet does not contain the Set_Account field. |
| 130005 | The Set_Account field in the JSON request packet is invalid. |
| 130008 | Neither GroupmsgNospeakingTime nor C2CmsgNospeakingTime in the JSON request packet is specified. |
| 130014 | A system error occurred. To correct it, try again or contact our technical customer service. |
API Commissioning Tool
Use the online commissioning tool for RESTful APIs to commission this API.
References
Querying global muting (v4/openconfigsvr/setnospeaking)
Yes
No
Was this page helpful?